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
utf8_files += [('format', self.get_format_string())]
922
for (filename, content) in utf8_files:
923
branch_transport.put_bytes(
925
mode=control_files._file_mode)
927
control_files.unlock()
928
return self.open(a_bzrdir, _found=True)
930
def initialize(self, a_bzrdir):
931
"""Create a branch of this format in a_bzrdir."""
932
raise NotImplementedError(self.initialize)
934
def is_supported(self):
935
"""Is this format supported?
937
Supported formats can be initialized and opened.
938
Unsupported formats may not support initialization or committing or
939
some other features depending on the reason for not being supported.
943
def open(self, a_bzrdir, _found=False):
944
"""Return the branch object for a_bzrdir
946
_found is a private parameter, do not use it. It is used to indicate
947
if format probing has already be done.
949
raise NotImplementedError(self.open)
952
def register_format(klass, format):
953
klass._formats[format.get_format_string()] = format
956
def set_default_format(klass, format):
957
klass._default_format = format
960
def unregister_format(klass, format):
961
assert klass._formats[format.get_format_string()] is format
962
del klass._formats[format.get_format_string()]
965
return self.get_format_string().rstrip()
967
def supports_tags(self):
968
"""True if this format supports tags stored in the branch"""
969
return False # by default
972
class BranchHooks(Hooks):
973
"""A dictionary mapping hook name to a list of callables for branch hooks.
975
e.g. ['set_rh'] Is the list of items to be called when the
976
set_revision_history function is invoked.
980
"""Create the default hooks.
982
These are all empty initially, because by default nothing should get
986
# Introduced in 0.15:
987
# invoked whenever the revision history has been set
988
# with set_revision_history. The api signature is
989
# (branch, revision_history), and the branch will
992
# invoked after a push operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local target branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. Source will
1000
# be the local low-latency branch.
1001
self['post_push'] = []
1002
# invoked after a pull operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. The local
1010
# branch is the low-latency branch.
1011
self['post_pull'] = []
1012
# invoked before a commit operation takes place.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, future_revno, future_revid,
1015
# tree_delta, future_tree).
1016
# old_revid is NULL_REVISION for the first commit to a branch
1017
# tree_delta is a TreeDelta object describing changes from the basis
1018
# revision, hooks MUST NOT modify this delta
1019
# future_tree is an in-memory tree obtained from
1020
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1021
self['pre_commit'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1034
# Invoked after the tip of a branch changes.
1035
# the api signature is
1036
# (params) where params is a ChangeBranchTipParams with the members
1037
# (branch, old_revno, new_revno, old_revid, new_revid)
1038
self['post_change_branch_tip'] = []
1041
# install the default hooks into the Branch class.
1042
Branch.hooks = BranchHooks()
1045
class ChangeBranchTipParams(object):
1046
"""Object holding parameters passed to *_change_branch_tip hooks.
1048
There are 5 fields that hooks may wish to access:
1050
:ivar branch: the branch being changed
1051
:ivar old_revno: revision number before the change
1052
:ivar new_revno: revision number after the change
1053
:ivar old_revid: revision id before the change
1054
:ivar new_revid: revision id after the change
1056
The revid fields are strings. The revno fields are integers.
1059
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1060
"""Create a group of ChangeBranchTip parameters.
1062
:param branch: The branch being changed.
1063
:param old_revno: Revision number before the change.
1064
:param new_revno: Revision number after the change.
1065
:param old_revid: Tip revision id before the change.
1066
:param new_revid: Tip revision id after the change.
1068
self.branch = branch
1069
self.old_revno = old_revno
1070
self.new_revno = new_revno
1071
self.old_revid = old_revid
1072
self.new_revid = new_revid
1075
class BzrBranchFormat4(BranchFormat):
1076
"""Bzr branch format 4.
1079
- a revision-history file.
1080
- a branch-lock lock file [ to be shared with the bzrdir ]
1083
def get_format_description(self):
1084
"""See BranchFormat.get_format_description()."""
1085
return "Branch format 4"
1087
def initialize(self, a_bzrdir):
1088
"""Create a branch of this format in a_bzrdir."""
1089
utf8_files = [('revision-history', ''),
1090
('branch-name', ''),
1092
return self._initialize_helper(a_bzrdir, utf8_files,
1093
lock_type='branch4', set_format=False)
1096
super(BzrBranchFormat4, self).__init__()
1097
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1099
def open(self, a_bzrdir, _found=False):
1100
"""Return the branch object for a_bzrdir
1102
_found is a private parameter, do not use it. It is used to indicate
1103
if format probing has already be done.
1106
# we are being called directly and must probe.
1107
raise NotImplementedError
1108
return BzrBranch(_format=self,
1109
_control_files=a_bzrdir._control_files,
1111
_repository=a_bzrdir.open_repository())
1114
return "Bazaar-NG branch format 4"
1117
class BzrBranchFormat5(BranchFormat):
1118
"""Bzr branch format 5.
1121
- a revision-history file.
1123
- a lock dir guarding the branch itself
1124
- all of this stored in a branch/ subdirectory
1125
- works with shared repositories.
1127
This format is new in bzr 0.8.
1130
def get_format_string(self):
1131
"""See BranchFormat.get_format_string()."""
1132
return "Bazaar-NG branch format 5\n"
1134
def get_format_description(self):
1135
"""See BranchFormat.get_format_description()."""
1136
return "Branch format 5"
1138
def initialize(self, a_bzrdir):
1139
"""Create a branch of this format in a_bzrdir."""
1140
utf8_files = [('revision-history', ''),
1141
('branch-name', ''),
1143
return self._initialize_helper(a_bzrdir, utf8_files)
1146
super(BzrBranchFormat5, self).__init__()
1147
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1149
def open(self, a_bzrdir, _found=False):
1150
"""Return the branch object for a_bzrdir
1152
_found is a private parameter, do not use it. It is used to indicate
1153
if format probing has already be done.
1156
format = BranchFormat.find_format(a_bzrdir)
1157
assert format.__class__ == self.__class__
1159
transport = a_bzrdir.get_branch_transport(None)
1160
control_files = lockable_files.LockableFiles(transport, 'lock',
1162
return BzrBranch5(_format=self,
1163
_control_files=control_files,
1165
_repository=a_bzrdir.find_repository())
1166
except errors.NoSuchFile:
1167
raise errors.NotBranchError(path=transport.base)
1170
class BzrBranchFormat6(BzrBranchFormat5):
1171
"""Branch format with last-revision and tags.
1173
Unlike previous formats, this has no explicit revision history. Instead,
1174
this just stores the last-revision, and the left-hand history leading
1175
up to there is the history.
1177
This format was introduced in bzr 0.15
1178
and became the default in 0.91.
1181
def get_format_string(self):
1182
"""See BranchFormat.get_format_string()."""
1183
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1185
def get_format_description(self):
1186
"""See BranchFormat.get_format_description()."""
1187
return "Branch format 6"
1189
def initialize(self, a_bzrdir):
1190
"""Create a branch of this format in a_bzrdir."""
1191
utf8_files = [('last-revision', '0 null:\n'),
1192
('branch.conf', ''),
1195
return self._initialize_helper(a_bzrdir, utf8_files)
1197
def open(self, a_bzrdir, _found=False):
1198
"""Return the branch object for a_bzrdir
1200
_found is a private parameter, do not use it. It is used to indicate
1201
if format probing has already be done.
1204
format = BranchFormat.find_format(a_bzrdir)
1205
assert format.__class__ == self.__class__
1206
transport = a_bzrdir.get_branch_transport(None)
1207
control_files = lockable_files.LockableFiles(transport, 'lock',
1209
return BzrBranch6(_format=self,
1210
_control_files=control_files,
1212
_repository=a_bzrdir.find_repository())
1214
def supports_tags(self):
1218
class BranchReferenceFormat(BranchFormat):
1219
"""Bzr branch reference format.
1221
Branch references are used in implementing checkouts, they
1222
act as an alias to the real branch which is at some other url.
1229
def get_format_string(self):
1230
"""See BranchFormat.get_format_string()."""
1231
return "Bazaar-NG Branch Reference Format 1\n"
1233
def get_format_description(self):
1234
"""See BranchFormat.get_format_description()."""
1235
return "Checkout reference format 1"
1237
def get_reference(self, a_bzrdir):
1238
"""See BranchFormat.get_reference()."""
1239
transport = a_bzrdir.get_branch_transport(None)
1240
return transport.get('location').read()
1242
def set_reference(self, a_bzrdir, to_branch):
1243
"""See BranchFormat.set_reference()."""
1244
transport = a_bzrdir.get_branch_transport(None)
1245
location = transport.put_bytes('location', to_branch.base)
1247
def initialize(self, a_bzrdir, target_branch=None):
1248
"""Create a branch of this format in a_bzrdir."""
1249
if target_branch is None:
1250
# this format does not implement branch itself, thus the implicit
1251
# creation contract must see it as uninitializable
1252
raise errors.UninitializableFormat(self)
1253
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1254
branch_transport = a_bzrdir.get_branch_transport(self)
1255
branch_transport.put_bytes('location',
1256
target_branch.bzrdir.root_transport.base)
1257
branch_transport.put_bytes('format', self.get_format_string())
1259
a_bzrdir, _found=True,
1260
possible_transports=[target_branch.bzrdir.root_transport])
1263
super(BranchReferenceFormat, self).__init__()
1264
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1266
def _make_reference_clone_function(format, a_branch):
1267
"""Create a clone() routine for a branch dynamically."""
1268
def clone(to_bzrdir, revision_id=None):
1269
"""See Branch.clone()."""
1270
return format.initialize(to_bzrdir, a_branch)
1271
# cannot obey revision_id limits when cloning a reference ...
1272
# FIXME RBC 20060210 either nuke revision_id for clone, or
1273
# emit some sort of warning/error to the caller ?!
1276
def open(self, a_bzrdir, _found=False, location=None,
1277
possible_transports=None):
1278
"""Return the branch that the branch reference in a_bzrdir points at.
1280
_found is a private parameter, do not use it. It is used to indicate
1281
if format probing has already be done.
1284
format = BranchFormat.find_format(a_bzrdir)
1285
assert format.__class__ == self.__class__
1286
if location is None:
1287
location = self.get_reference(a_bzrdir)
1288
real_bzrdir = bzrdir.BzrDir.open(
1289
location, possible_transports=possible_transports)
1290
result = real_bzrdir.open_branch()
1291
# this changes the behaviour of result.clone to create a new reference
1292
# rather than a copy of the content of the branch.
1293
# I did not use a proxy object because that needs much more extensive
1294
# testing, and we are only changing one behaviour at the moment.
1295
# If we decide to alter more behaviours - i.e. the implicit nickname
1296
# then this should be refactored to introduce a tested proxy branch
1297
# and a subclass of that for use in overriding clone() and ....
1299
result.clone = self._make_reference_clone_function(result)
1303
# formats which have no format string are not discoverable
1304
# and not independently creatable, so are not registered.
1305
__format5 = BzrBranchFormat5()
1306
__format6 = BzrBranchFormat6()
1307
BranchFormat.register_format(__format5)
1308
BranchFormat.register_format(BranchReferenceFormat())
1309
BranchFormat.register_format(__format6)
1310
BranchFormat.set_default_format(__format6)
1311
_legacy_formats = [BzrBranchFormat4(),
1314
class BzrBranch(Branch):
1315
"""A branch stored in the actual filesystem.
1317
Note that it's "local" in the context of the filesystem; it doesn't
1318
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1319
it's writable, and can be accessed via the normal filesystem API.
1322
def __init__(self, _format=None,
1323
_control_files=None, a_bzrdir=None, _repository=None):
1324
"""Create new branch object at a particular location."""
1325
Branch.__init__(self)
1326
if a_bzrdir is None:
1327
raise ValueError('a_bzrdir must be supplied')
1329
self.bzrdir = a_bzrdir
1330
self._base = self.bzrdir.transport.clone('..').base
1331
self._format = _format
1332
if _control_files is None:
1333
raise ValueError('BzrBranch _control_files is None')
1334
self.control_files = _control_files
1335
self._transport = _control_files._transport
1336
self.repository = _repository
1339
return '%s(%r)' % (self.__class__.__name__, self.base)
1343
def _get_base(self):
1344
"""Returns the directory containing the control directory."""
1347
base = property(_get_base, doc="The URL for the root of this branch.")
1349
def abspath(self, name):
1350
"""See Branch.abspath."""
1351
return self._transport.abspath(name)
1353
@deprecated_method(zero_sixteen)
1355
def get_root_id(self):
1356
"""See Branch.get_root_id."""
1357
tree = self.repository.revision_tree(self.last_revision())
1358
return tree.get_root_id()
1360
def is_locked(self):
1361
return self.control_files.is_locked()
1363
def lock_write(self, token=None):
1364
repo_token = self.repository.lock_write()
1366
token = self.control_files.lock_write(token=token)
1368
self.repository.unlock()
1372
def lock_read(self):
1373
self.repository.lock_read()
1375
self.control_files.lock_read()
1377
self.repository.unlock()
1381
# TODO: test for failed two phase locks. This is known broken.
1383
self.control_files.unlock()
1385
self.repository.unlock()
1386
if not self.control_files.is_locked():
1387
# we just released the lock
1388
self._clear_cached_state()
1390
def peek_lock_mode(self):
1391
if self.control_files._lock_count == 0:
1394
return self.control_files._lock_mode
1396
def get_physical_lock_status(self):
1397
return self.control_files.get_physical_lock_status()
1400
def print_file(self, file, revision_id):
1401
"""See Branch.print_file."""
1402
return self.repository.print_file(file, revision_id)
1404
def _write_revision_history(self, history):
1405
"""Factored out of set_revision_history.
1407
This performs the actual writing to disk.
1408
It is intended to be called by BzrBranch5.set_revision_history."""
1409
self._transport.put_bytes(
1410
'revision-history', '\n'.join(history),
1411
mode=self.control_files._file_mode)
1414
def set_revision_history(self, rev_history):
1415
"""See Branch.set_revision_history."""
1416
if 'evil' in debug.debug_flags:
1417
mutter_callsite(3, "set_revision_history scales with history.")
1418
self._write_revision_history(rev_history)
1419
self._clear_cached_state()
1420
self._cache_revision_history(rev_history)
1421
for hook in Branch.hooks['set_rh']:
1422
hook(self, rev_history)
1424
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1425
"""Run the post_change_branch_tip hooks."""
1426
hooks = Branch.hooks['post_change_branch_tip']
1429
new_revno, new_revid = self.last_revision_info()
1430
params = ChangeBranchTipParams(
1431
self, old_revno, new_revno, old_revid, new_revid)
1436
def set_last_revision_info(self, revno, revision_id):
1437
"""Set the last revision of this branch.
1439
The caller is responsible for checking that the revno is correct
1440
for this revision id.
1442
It may be possible to set the branch last revision to an id not
1443
present in the repository. However, branches can also be
1444
configured to check constraints on history, in which case this may not
1447
revision_id = _mod_revision.ensure_null(revision_id)
1448
old_revno, old_revid = self.last_revision_info()
1449
history = self._lefthand_history(revision_id)
1450
assert len(history) == revno, '%d != %d' % (len(history), revno)
1451
self.set_revision_history(history)
1452
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1454
def _gen_revision_history(self):
1455
history = self._transport.get_bytes('revision-history').split('\n')
1456
if history[-1:] == ['']:
1457
# There shouldn't be a trailing newline, but just in case.
1461
def _lefthand_history(self, revision_id, last_rev=None,
1463
if 'evil' in debug.debug_flags:
1464
mutter_callsite(4, "_lefthand_history scales with history.")
1465
# stop_revision must be a descendant of last_revision
1466
graph = self.repository.get_graph()
1467
if last_rev is not None:
1468
if not graph.is_ancestor(last_rev, revision_id):
1469
# our previous tip is not merged into stop_revision
1470
raise errors.DivergedBranches(self, other_branch)
1471
# make a new revision history from the graph
1472
parents_map = graph.get_parent_map([revision_id])
1473
if revision_id not in parents_map:
1474
raise errors.NoSuchRevision(self, revision_id)
1475
current_rev_id = revision_id
1477
# Do not include ghosts or graph origin in revision_history
1478
while (current_rev_id in parents_map and
1479
len(parents_map[current_rev_id]) > 0):
1480
new_history.append(current_rev_id)
1481
current_rev_id = parents_map[current_rev_id][0]
1482
parents_map = graph.get_parent_map([current_rev_id])
1483
new_history.reverse()
1487
def generate_revision_history(self, revision_id, last_rev=None,
1489
"""Create a new revision history that will finish with revision_id.
1491
:param revision_id: the new tip to use.
1492
:param last_rev: The previous last_revision. If not None, then this
1493
must be a ancestory of revision_id, or DivergedBranches is raised.
1494
:param other_branch: The other branch that DivergedBranches should
1495
raise with respect to.
1497
self.set_revision_history(self._lefthand_history(revision_id,
1498
last_rev, other_branch))
1501
def update_revisions(self, other, stop_revision=None, overwrite=False):
1502
"""See Branch.update_revisions."""
1505
other_last_revno, other_last_revision = other.last_revision_info()
1506
if stop_revision is None:
1507
stop_revision = other_last_revision
1508
if _mod_revision.is_null(stop_revision):
1509
# if there are no commits, we're done.
1511
# whats the current last revision, before we fetch [and change it
1513
last_rev = _mod_revision.ensure_null(self.last_revision())
1514
# we fetch here so that we don't process data twice in the common
1515
# case of having something to pull, and so that the check for
1516
# already merged can operate on the just fetched graph, which will
1517
# be cached in memory.
1518
self.fetch(other, stop_revision)
1519
# Check to see if one is an ancestor of the other
1521
heads = self.repository.get_graph().heads([stop_revision,
1523
if heads == set([last_rev]):
1524
# The current revision is a decendent of the target,
1527
elif heads == set([stop_revision, last_rev]):
1528
# These branches have diverged
1529
raise errors.DivergedBranches(self, other)
1530
assert heads == set([stop_revision])
1531
if other_last_revision == stop_revision:
1532
self.set_last_revision_info(other_last_revno,
1533
other_last_revision)
1535
# TODO: jam 2007-11-29 Is there a way to determine the
1536
# revno without searching all of history??
1538
self.generate_revision_history(stop_revision)
1540
self.generate_revision_history(stop_revision,
1541
last_rev=last_rev, other_branch=other)
1545
def basis_tree(self):
1546
"""See Branch.basis_tree."""
1547
return self.repository.revision_tree(self.last_revision())
1550
def pull(self, source, overwrite=False, stop_revision=None,
1551
_hook_master=None, run_hooks=True, possible_transports=None):
1554
:param _hook_master: Private parameter - set the branch to
1555
be supplied as the master to push hooks.
1556
:param run_hooks: Private parameter - if false, this branch
1557
is being called because it's the master of the primary branch,
1558
so it should not run its hooks.
1560
result = PullResult()
1561
result.source_branch = source
1562
result.target_branch = self
1565
result.old_revno, result.old_revid = self.last_revision_info()
1566
self.update_revisions(source, stop_revision, overwrite=overwrite)
1567
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1568
result.new_revno, result.new_revid = self.last_revision_info()
1570
result.master_branch = _hook_master
1571
result.local_branch = self
1573
result.master_branch = self
1574
result.local_branch = None
1576
for hook in Branch.hooks['post_pull']:
1582
def _get_parent_location(self):
1583
_locs = ['parent', 'pull', 'x-pull']
1586
return self._transport.get_bytes(l).strip('\n')
1587
except errors.NoSuchFile:
1592
def push(self, target, overwrite=False, stop_revision=None,
1593
_override_hook_source_branch=None):
1596
This is the basic concrete implementation of push()
1598
:param _override_hook_source_branch: If specified, run
1599
the hooks passing this Branch as the source, rather than self.
1600
This is for use of RemoteBranch, where push is delegated to the
1601
underlying vfs-based Branch.
1603
# TODO: Public option to disable running hooks - should be trivial but
1607
result = self._push_with_bound_branches(target, overwrite,
1609
_override_hook_source_branch=_override_hook_source_branch)
1614
def _push_with_bound_branches(self, target, overwrite,
1616
_override_hook_source_branch=None):
1617
"""Push from self into target, and into target's master if any.
1619
This is on the base BzrBranch class even though it doesn't support
1620
bound branches because the *target* might be bound.
1623
if _override_hook_source_branch:
1624
result.source_branch = _override_hook_source_branch
1625
for hook in Branch.hooks['post_push']:
1628
bound_location = target.get_bound_location()
1629
if bound_location and target.base != bound_location:
1630
# there is a master branch.
1632
# XXX: Why the second check? Is it even supported for a branch to
1633
# be bound to itself? -- mbp 20070507
1634
master_branch = target.get_master_branch()
1635
master_branch.lock_write()
1637
# push into the master from this branch.
1638
self._basic_push(master_branch, overwrite, stop_revision)
1639
# and push into the target branch from this. Note that we push from
1640
# this branch again, because its considered the highest bandwidth
1642
result = self._basic_push(target, overwrite, stop_revision)
1643
result.master_branch = master_branch
1644
result.local_branch = target
1648
master_branch.unlock()
1651
result = self._basic_push(target, overwrite, stop_revision)
1652
# TODO: Why set master_branch and local_branch if there's no
1653
# binding? Maybe cleaner to just leave them unset? -- mbp
1655
result.master_branch = target
1656
result.local_branch = None
1660
def _basic_push(self, target, overwrite, stop_revision):
1661
"""Basic implementation of push without bound branches or hooks.
1663
Must be called with self read locked and target write locked.
1665
result = PushResult()
1666
result.source_branch = self
1667
result.target_branch = target
1668
result.old_revno, result.old_revid = target.last_revision_info()
1670
target.update_revisions(self, stop_revision)
1671
except errors.DivergedBranches:
1675
target.set_revision_history(self.revision_history())
1676
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1677
result.new_revno, result.new_revid = target.last_revision_info()
1680
def get_parent(self):
1681
"""See Branch.get_parent."""
1683
assert self.base[-1] == '/'
1684
parent = self._get_parent_location()
1687
# This is an old-format absolute path to a local branch
1688
# turn it into a url
1689
if parent.startswith('/'):
1690
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1692
return urlutils.join(self.base[:-1], parent)
1693
except errors.InvalidURLJoin, e:
1694
raise errors.InaccessibleParent(parent, self.base)
1696
def set_push_location(self, location):
1697
"""See Branch.set_push_location."""
1698
self.get_config().set_user_option(
1699
'push_location', location,
1700
store=_mod_config.STORE_LOCATION_NORECURSE)
1703
def set_parent(self, url):
1704
"""See Branch.set_parent."""
1705
# TODO: Maybe delete old location files?
1706
# URLs should never be unicode, even on the local fs,
1707
# FIXUP this and get_parent in a future branch format bump:
1708
# read and rewrite the file. RBC 20060125
1710
if isinstance(url, unicode):
1712
url = url.encode('ascii')
1713
except UnicodeEncodeError:
1714
raise errors.InvalidURL(url,
1715
"Urls must be 7-bit ascii, "
1716
"use bzrlib.urlutils.escape")
1717
url = urlutils.relative_url(self.base, url)
1718
self._set_parent_location(url)
1720
def _set_parent_location(self, url):
1722
self._transport.delete('parent')
1724
assert isinstance(url, str)
1725
self._transport.put_bytes('parent', url + '\n',
1726
mode=self.control_files._file_mode)
1729
class BzrBranch5(BzrBranch):
1730
"""A format 5 branch. This supports new features over plain branches.
1732
It has support for a master_branch which is the data for bound branches.
1740
super(BzrBranch5, self).__init__(_format=_format,
1741
_control_files=_control_files,
1743
_repository=_repository)
1746
def pull(self, source, overwrite=False, stop_revision=None,
1747
run_hooks=True, possible_transports=None):
1748
"""Pull from source into self, updating my master if any.
1750
:param run_hooks: Private parameter - if false, this branch
1751
is being called because it's the master of the primary branch,
1752
so it should not run its hooks.
1754
bound_location = self.get_bound_location()
1755
master_branch = None
1756
if bound_location and source.base != bound_location:
1757
# not pulling from master, so we need to update master.
1758
master_branch = self.get_master_branch(possible_transports)
1759
master_branch.lock_write()
1762
# pull from source into master.
1763
master_branch.pull(source, overwrite, stop_revision,
1765
return super(BzrBranch5, self).pull(source, overwrite,
1766
stop_revision, _hook_master=master_branch,
1767
run_hooks=run_hooks)
1770
master_branch.unlock()
1772
def get_bound_location(self):
1774
return self._transport.get_bytes('bound')[:-1]
1775
except errors.NoSuchFile:
1779
def get_master_branch(self, possible_transports=None):
1780
"""Return the branch we are bound to.
1782
:return: Either a Branch, or None
1784
This could memoise the branch, but if thats done
1785
it must be revalidated on each new lock.
1786
So for now we just don't memoise it.
1787
# RBC 20060304 review this decision.
1789
bound_loc = self.get_bound_location()
1793
return Branch.open(bound_loc,
1794
possible_transports=possible_transports)
1795
except (errors.NotBranchError, errors.ConnectionError), e:
1796
raise errors.BoundBranchConnectionFailure(
1800
def set_bound_location(self, location):
1801
"""Set the target where this branch is bound to.
1803
:param location: URL to the target branch
1806
self._transport.put_bytes('bound', location+'\n')
1809
self._transport.delete('bound')
1810
except errors.NoSuchFile:
1815
def bind(self, other):
1816
"""Bind this branch to the branch other.
1818
This does not push or pull data between the branches, though it does
1819
check for divergence to raise an error when the branches are not
1820
either the same, or one a prefix of the other. That behaviour may not
1821
be useful, so that check may be removed in future.
1823
:param other: The branch to bind to
1826
# TODO: jam 20051230 Consider checking if the target is bound
1827
# It is debatable whether you should be able to bind to
1828
# a branch which is itself bound.
1829
# Committing is obviously forbidden,
1830
# but binding itself may not be.
1831
# Since we *have* to check at commit time, we don't
1832
# *need* to check here
1834
# we want to raise diverged if:
1835
# last_rev is not in the other_last_rev history, AND
1836
# other_last_rev is not in our history, and do it without pulling
1838
self.set_bound_location(other.base)
1842
"""If bound, unbind"""
1843
return self.set_bound_location(None)
1846
def update(self, possible_transports=None):
1847
"""Synchronise this branch with the master branch if any.
1849
:return: None or the last_revision that was pivoted out during the
1852
master = self.get_master_branch(possible_transports)
1853
if master is not None:
1854
old_tip = _mod_revision.ensure_null(self.last_revision())
1855
self.pull(master, overwrite=True)
1856
if self.repository.get_graph().is_ancestor(old_tip,
1857
_mod_revision.ensure_null(self.last_revision())):
1863
class BzrBranch6(BzrBranch5):
1865
def __init__(self, *args, **kwargs):
1866
super(BzrBranch6, self).__init__(*args, **kwargs)
1867
self._last_revision_info_cache = None
1868
self._partial_revision_history_cache = []
1870
def _clear_cached_state(self):
1871
super(BzrBranch6, self)._clear_cached_state()
1872
self._last_revision_info_cache = None
1873
self._partial_revision_history_cache = []
1876
def last_revision_info(self):
1877
"""Return information about the last revision.
1879
:return: A tuple (revno, revision_id).
1881
if self._last_revision_info_cache is None:
1882
self._last_revision_info_cache = self._last_revision_info()
1883
return self._last_revision_info_cache
1885
def _last_revision_info(self):
1886
revision_string = self._transport.get_bytes('last-revision')
1887
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1888
revision_id = cache_utf8.get_cached_utf8(revision_id)
1890
return revno, revision_id
1892
def _write_last_revision_info(self, revno, revision_id):
1893
"""Simply write out the revision id, with no checks.
1895
Use set_last_revision_info to perform this safely.
1897
Does not update the revision_history cache.
1898
Intended to be called by set_last_revision_info and
1899
_write_revision_history.
1901
assert revision_id is not None, "Use NULL_REVISION, not None"
1902
out_string = '%d %s\n' % (revno, revision_id)
1903
self._transport.put_bytes('last-revision', out_string,
1904
mode=self.control_files._file_mode)
1907
def set_last_revision_info(self, revno, revision_id):
1908
revision_id = _mod_revision.ensure_null(revision_id)
1909
old_revno, old_revid = self.last_revision_info()
1910
if self._get_append_revisions_only():
1911
self._check_history_violation(revision_id)
1912
self._write_last_revision_info(revno, revision_id)
1913
self._clear_cached_state()
1914
self._last_revision_info_cache = revno, revision_id
1915
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1917
def _check_history_violation(self, revision_id):
1918
last_revision = _mod_revision.ensure_null(self.last_revision())
1919
if _mod_revision.is_null(last_revision):
1921
if last_revision not in self._lefthand_history(revision_id):
1922
raise errors.AppendRevisionsOnlyViolation(self.base)
1924
def _gen_revision_history(self):
1925
"""Generate the revision history from last revision
1927
self._extend_partial_history()
1928
return list(reversed(self._partial_revision_history_cache))
1930
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1931
"""Extend the partial history to include a given index
1933
If a stop_index is supplied, stop when that index has been reached.
1934
If a stop_revision is supplied, stop when that revision is
1935
encountered. Otherwise, stop when the beginning of history is
1938
:param stop_index: The index which should be present. When it is
1939
present, history extension will stop.
1940
:param revision_id: The revision id which should be present. When
1941
it is encountered, history extension will stop.
1943
repo = self.repository
1944
if len(self._partial_revision_history_cache) == 0:
1945
iterator = repo.iter_reverse_revision_history(self.last_revision())
1947
start_revision = self._partial_revision_history_cache[-1]
1948
iterator = repo.iter_reverse_revision_history(start_revision)
1949
#skip the last revision in the list
1950
next_revision = iterator.next()
1951
assert next_revision == start_revision
1952
for revision_id in iterator:
1953
self._partial_revision_history_cache.append(revision_id)
1954
if (stop_index is not None and
1955
len(self._partial_revision_history_cache) > stop_index):
1957
if revision_id == stop_revision:
1960
def _write_revision_history(self, history):
1961
"""Factored out of set_revision_history.
1963
This performs the actual writing to disk, with format-specific checks.
1964
It is intended to be called by BzrBranch5.set_revision_history.
1966
if len(history) == 0:
1967
last_revision = 'null:'
1969
if history != self._lefthand_history(history[-1]):
1970
raise errors.NotLefthandHistory(history)
1971
last_revision = history[-1]
1972
if self._get_append_revisions_only():
1973
self._check_history_violation(last_revision)
1974
self._write_last_revision_info(len(history), last_revision)
1977
def _set_parent_location(self, url):
1978
"""Set the parent branch"""
1979
self._set_config_location('parent_location', url, make_relative=True)
1982
def _get_parent_location(self):
1983
"""Set the parent branch"""
1984
return self._get_config_location('parent_location')
1986
def set_push_location(self, location):
1987
"""See Branch.set_push_location."""
1988
self._set_config_location('push_location', location)
1990
def set_bound_location(self, location):
1991
"""See Branch.set_push_location."""
1993
config = self.get_config()
1994
if location is None:
1995
if config.get_user_option('bound') != 'True':
1998
config.set_user_option('bound', 'False', warn_masked=True)
2001
self._set_config_location('bound_location', location,
2003
config.set_user_option('bound', 'True', warn_masked=True)
2006
def _get_bound_location(self, bound):
2007
"""Return the bound location in the config file.
2009
Return None if the bound parameter does not match"""
2010
config = self.get_config()
2011
config_bound = (config.get_user_option('bound') == 'True')
2012
if config_bound != bound:
2014
return self._get_config_location('bound_location', config=config)
2016
def get_bound_location(self):
2017
"""See Branch.set_push_location."""
2018
return self._get_bound_location(True)
2020
def get_old_bound_location(self):
2021
"""See Branch.get_old_bound_location"""
2022
return self._get_bound_location(False)
2024
def set_append_revisions_only(self, enabled):
2029
self.get_config().set_user_option('append_revisions_only', value,
2032
def _get_append_revisions_only(self):
2033
value = self.get_config().get_user_option('append_revisions_only')
2034
return value == 'True'
2036
def _synchronize_history(self, destination, revision_id):
2037
"""Synchronize last revision and revision history between branches.
2039
This version is most efficient when the destination is also a
2040
BzrBranch6, but works for BzrBranch5, as long as the destination's
2041
repository contains all the lefthand ancestors of the intended
2042
last_revision. If not, set_last_revision_info will fail.
2044
:param destination: The branch to copy the history into
2045
:param revision_id: The revision-id to truncate history at. May
2046
be None to copy complete history.
2048
source_revno, source_revision_id = self.last_revision_info()
2049
if revision_id is None:
2050
revno, revision_id = source_revno, source_revision_id
2051
elif source_revision_id == revision_id:
2052
# we know the revno without needing to walk all of history
2053
revno = source_revno
2055
# To figure out the revno for a random revision, we need to build
2056
# the revision history, and count its length.
2057
# We don't care about the order, just how long it is.
2058
# Alternatively, we could start at the current location, and count
2059
# backwards. But there is no guarantee that we will find it since
2060
# it may be a merged revision.
2061
revno = len(list(self.repository.iter_reverse_revision_history(
2063
destination.set_last_revision_info(revno, revision_id)
2065
def _make_tags(self):
2066
return BasicTags(self)
2069
def generate_revision_history(self, revision_id, last_rev=None,
2071
"""See BzrBranch5.generate_revision_history"""
2072
history = self._lefthand_history(revision_id, last_rev, other_branch)
2073
revno = len(history)
2074
self.set_last_revision_info(revno, revision_id)
2077
def get_rev_id(self, revno, history=None):
2078
"""Find the revision id of the specified revno."""
2080
return _mod_revision.NULL_REVISION
2082
last_revno, last_revision_id = self.last_revision_info()
2083
if revno <= 0 or revno > last_revno:
2084
raise errors.NoSuchRevision(self, revno)
2086
if history is not None:
2087
assert len(history) == last_revno, 'revno/history mismatch'
2088
return history[revno - 1]
2090
index = last_revno - revno
2091
if len(self._partial_revision_history_cache) <= index:
2092
self._extend_partial_history(stop_index=index)
2093
if len(self._partial_revision_history_cache) > index:
2094
return self._partial_revision_history_cache[index]
2096
raise errors.NoSuchRevision(self, revno)
2099
def revision_id_to_revno(self, revision_id):
2100
"""Given a revision id, return its revno"""
2101
if _mod_revision.is_null(revision_id):
2104
index = self._partial_revision_history_cache.index(revision_id)
2106
self._extend_partial_history(stop_revision=revision_id)
2107
index = len(self._partial_revision_history_cache) - 1
2108
if self._partial_revision_history_cache[index] != revision_id:
2109
raise errors.NoSuchRevision(self, revision_id)
2110
return self.revno() - index
2113
######################################################################
2114
# results of operations
2117
class _Result(object):
2119
def _show_tag_conficts(self, to_file):
2120
if not getattr(self, 'tag_conflicts', None):
2122
to_file.write('Conflicting tags:\n')
2123
for name, value1, value2 in self.tag_conflicts:
2124
to_file.write(' %s\n' % (name, ))
2127
class PullResult(_Result):
2128
"""Result of a Branch.pull operation.
2130
:ivar old_revno: Revision number before pull.
2131
:ivar new_revno: Revision number after pull.
2132
:ivar old_revid: Tip revision id before pull.
2133
:ivar new_revid: Tip revision id after pull.
2134
:ivar source_branch: Source (local) branch object.
2135
:ivar master_branch: Master branch of the target, or None.
2136
:ivar target_branch: Target/destination branch object.
2140
# DEPRECATED: pull used to return the change in revno
2141
return self.new_revno - self.old_revno
2143
def report(self, to_file):
2145
if self.old_revid == self.new_revid:
2146
to_file.write('No revisions to pull.\n')
2148
to_file.write('Now on revision %d.\n' % self.new_revno)
2149
self._show_tag_conficts(to_file)
2152
class PushResult(_Result):
2153
"""Result of a Branch.push operation.
2155
:ivar old_revno: Revision number before push.
2156
:ivar new_revno: Revision number after push.
2157
:ivar old_revid: Tip revision id before push.
2158
:ivar new_revid: Tip revision id after push.
2159
:ivar source_branch: Source branch object.
2160
:ivar master_branch: Master branch of the target, or None.
2161
:ivar target_branch: Target/destination branch object.
2165
# DEPRECATED: push used to return the change in revno
2166
return self.new_revno - self.old_revno
2168
def report(self, to_file):
2169
"""Write a human-readable description of the result."""
2170
if self.old_revid == self.new_revid:
2171
to_file.write('No new revisions to push.\n')
2173
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2174
self._show_tag_conficts(to_file)
2177
class BranchCheckResult(object):
2178
"""Results of checking branch consistency.
2183
def __init__(self, branch):
2184
self.branch = branch
2186
def report_results(self, verbose):
2187
"""Report the check results via trace.note.
2189
:param verbose: Requests more detailed display of what was checked,
2192
note('checked branch %s format %s',
2194
self.branch._format)
2197
class Converter5to6(object):
2198
"""Perform an in-place upgrade of format 5 to format 6"""
2200
def convert(self, branch):
2201
# Data for 5 and 6 can peacefully coexist.
2202
format = BzrBranchFormat6()
2203
new_branch = format.open(branch.bzrdir, _found=True)
2205
# Copy source data into target
2206
new_branch._write_last_revision_info(*branch.last_revision_info())
2207
new_branch.set_parent(branch.get_parent())
2208
new_branch.set_bound_location(branch.get_bound_location())
2209
new_branch.set_push_location(branch.get_push_location())
2211
# New branch has no tags by default
2212
new_branch.tags._set_tag_dict({})
2214
# Copying done; now update target format
2215
new_branch._transport.put_bytes('format',
2216
format.get_format_string(),
2217
mode=new_branch.control_files._file_mode)
2219
# Clean up old files
2220
new_branch.control_files._transport.delete('revision-history')
2222
branch.set_parent(None)
2223
except errors.NoSuchFile:
2225
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
