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 cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from warnings import warn
28
config as _mod_config,
34
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
zero_eight, zero_nine, zero_sixteen,
65
from bzrlib.trace import mutter, mutter_callsite, note
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
93
# this is really an instance variable - FIXME move it there
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
109
Uses the ui factory to ask for confirmation if the lock may be from
112
This will probe the repository for its lock as well.
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
121
def open(base, _unsupported=False, possible_transports=None):
122
"""Open the branch rooted at base.
124
For instance, if the branch is at URL/.bzr/branch,
125
Branch.open(URL) -> a Branch instance.
127
control = bzrdir.BzrDir.open(base, _unsupported,
128
possible_transports=possible_transports)
129
return control.open_branch(_unsupported)
132
def open_from_transport(transport, _unsupported=False):
133
"""Open the branch rooted at transport"""
134
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
135
return control.open_branch(_unsupported)
138
def open_containing(url, possible_transports=None):
139
"""Open an existing branch which contains url.
141
This probes for a branch at url, and searches upwards from there.
143
Basically we keep looking up until we find the control directory or
144
run into the root. If there isn't one, raises NotBranchError.
145
If there is one and it is either an unrecognised format or an unsupported
146
format, UnknownFormatError or UnsupportedFormatError are raised.
147
If there is one, it is returned, along with the unused portion of url.
149
control, relpath = bzrdir.BzrDir.open_containing(url,
151
return control.open_branch(), relpath
153
def get_config(self):
154
return BranchConfig(self)
157
return self.get_config().get_nickname()
159
def _set_nick(self, nick):
160
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
nick = property(_get_nick, _set_nick)
165
raise NotImplementedError(self.is_locked)
167
def lock_write(self):
168
raise NotImplementedError(self.lock_write)
171
raise NotImplementedError(self.lock_read)
174
raise NotImplementedError(self.unlock)
176
def peek_lock_mode(self):
177
"""Return lock mode for the Branch: 'r', 'w' or None"""
178
raise NotImplementedError(self.peek_lock_mode)
180
def get_physical_lock_status(self):
181
raise NotImplementedError(self.get_physical_lock_status)
184
def get_revision_id_to_revno_map(self):
185
"""Return the revision_id => dotted revno map.
187
This will be regenerated on demand, but will be cached.
189
:return: A dictionary mapping revision_id => dotted revno.
190
This dictionary should not be modified by the caller.
192
if self._revision_id_to_revno_cache is not None:
193
mapping = self._revision_id_to_revno_cache
195
mapping = self._gen_revno_map()
196
self._cache_revision_id_to_revno(mapping)
197
# TODO: jam 20070417 Since this is being cached, should we be returning
199
# I would rather not, and instead just declare that users should not
200
# modify the return value.
203
def _gen_revno_map(self):
204
"""Create a new mapping from revision ids to dotted revnos.
206
Dotted revnos are generated based on the current tip in the revision
208
This is the worker function for get_revision_id_to_revno_map, which
209
just caches the return value.
211
:return: A dictionary mapping revision_id => dotted revno.
213
last_revision = self.last_revision()
214
revision_graph = self.repository.get_revision_graph(last_revision)
215
merge_sorted_revisions = tsort.merge_sort(
220
revision_id_to_revno = dict((rev_id, revno)
221
for seq_num, rev_id, depth, revno, end_of_merge
222
in merge_sorted_revisions)
223
return revision_id_to_revno
225
def leave_lock_in_place(self):
226
"""Tell this branch object not to release the physical lock when this
229
If lock_write doesn't return a token, then this method is not supported.
231
self.control_files.leave_in_place()
233
def dont_leave_lock_in_place(self):
234
"""Tell this branch object to release the physical lock when this
235
object is unlocked, even if it didn't originally acquire it.
237
If lock_write doesn't return a token, then this method is not supported.
239
self.control_files.dont_leave_in_place()
241
def abspath(self, name):
242
"""Return absolute filename for something in the branch
244
XXX: Robert Collins 20051017 what is this used for? why is it a branch
245
method and not a tree method.
247
raise NotImplementedError(self.abspath)
249
def bind(self, other):
250
"""Bind the local branch the other branch.
252
:param other: The branch to bind to
255
raise errors.UpgradeRequired(self.base)
258
def fetch(self, from_branch, last_revision=None, pb=None):
259
"""Copy revisions from from_branch into this branch.
261
:param from_branch: Where to copy from.
262
:param last_revision: What revision to stop at (None for at the end
264
:param pb: An optional progress bar to use.
266
Returns the copied revision count and the failed revisions in a tuple:
269
if self.base == from_branch.base:
272
nested_pb = ui.ui_factory.nested_progress_bar()
277
from_branch.lock_read()
279
if last_revision is None:
280
pb.update('get source history')
281
last_revision = from_branch.last_revision()
282
if last_revision is None:
283
last_revision = _mod_revision.NULL_REVISION
284
return self.repository.fetch(from_branch.repository,
285
revision_id=last_revision,
288
if nested_pb is not None:
292
def get_bound_location(self):
293
"""Return the URL of the branch we are bound to.
295
Older format branches cannot bind, please be sure to use a metadir
300
def get_old_bound_location(self):
301
"""Return the URL of the branch we used to be bound to
303
raise errors.UpgradeRequired(self.base)
305
def get_commit_builder(self, parents, config=None, timestamp=None,
306
timezone=None, committer=None, revprops=None,
308
"""Obtain a CommitBuilder for this branch.
310
:param parents: Revision ids of the parents of the new revision.
311
:param config: Optional configuration to use.
312
:param timestamp: Optional timestamp recorded for commit.
313
:param timezone: Optional timezone for timestamp.
314
:param committer: Optional committer to set for commit.
315
:param revprops: Optional dictionary of revision properties.
316
:param revision_id: Optional revision id.
320
config = self.get_config()
322
return self.repository.get_commit_builder(self, parents, config,
323
timestamp, timezone, committer, revprops, revision_id)
325
def get_master_branch(self, possible_transports=None):
326
"""Return the branch we are bound to.
328
:return: Either a Branch, or None
332
def get_revision_delta(self, revno):
333
"""Return the delta for one revision.
335
The delta is relative to its mainline predecessor, or the
336
empty tree for revision 1.
338
assert isinstance(revno, int)
339
rh = self.revision_history()
340
if not (1 <= revno <= len(rh)):
341
raise InvalidRevisionNumber(revno)
342
return self.repository.get_revision_delta(rh[revno-1])
344
@deprecated_method(zero_sixteen)
345
def get_root_id(self):
346
"""Return the id of this branches root
348
Deprecated: branches don't have root ids-- trees do.
349
Use basis_tree().get_root_id() instead.
351
raise NotImplementedError(self.get_root_id)
353
def print_file(self, file, revision_id):
354
"""Print `file` to stdout."""
355
raise NotImplementedError(self.print_file)
357
def set_revision_history(self, rev_history):
358
raise NotImplementedError(self.set_revision_history)
360
def _cache_revision_history(self, rev_history):
361
"""Set the cached revision history to rev_history.
363
The revision_history method will use this cache to avoid regenerating
364
the revision history.
366
This API is semi-public; it only for use by subclasses, all other code
367
should consider it to be private.
369
self._revision_history_cache = rev_history
371
def _cache_revision_id_to_revno(self, revision_id_to_revno):
372
"""Set the cached revision_id => revno map to revision_id_to_revno.
374
This API is semi-public; it only for use by subclasses, all other code
375
should consider it to be private.
377
self._revision_id_to_revno_cache = revision_id_to_revno
379
def _clear_cached_state(self):
380
"""Clear any cached data on this branch, e.g. cached revision history.
382
This means the next call to revision_history will need to call
383
_gen_revision_history.
385
This API is semi-public; it only for use by subclasses, all other code
386
should consider it to be private.
388
self._revision_history_cache = None
389
self._revision_id_to_revno_cache = None
391
def _gen_revision_history(self):
392
"""Return sequence of revision hashes on to this branch.
394
Unlike revision_history, this method always regenerates or rereads the
395
revision history, i.e. it does not cache the result, so repeated calls
398
Concrete subclasses should override this instead of revision_history so
399
that subclasses do not need to deal with caching logic.
401
This API is semi-public; it only for use by subclasses, all other code
402
should consider it to be private.
404
raise NotImplementedError(self._gen_revision_history)
407
def revision_history(self):
408
"""Return sequence of revision ids on this branch.
410
This method will cache the revision history for as long as it is safe to
413
if 'evil' in debug.debug_flags:
414
mutter_callsite(3, "revision_history scales with history.")
415
if self._revision_history_cache is not None:
416
history = self._revision_history_cache
418
history = self._gen_revision_history()
419
self._cache_revision_history(history)
423
"""Return current revision number for this branch.
425
That is equivalent to the number of revisions committed to
428
return len(self.revision_history())
431
"""Older format branches cannot bind or unbind."""
432
raise errors.UpgradeRequired(self.base)
434
def set_append_revisions_only(self, enabled):
435
"""Older format branches are never restricted to append-only"""
436
raise errors.UpgradeRequired(self.base)
438
def last_revision(self):
439
"""Return last revision id, or None"""
440
ph = self.revision_history()
444
return _mod_revision.NULL_REVISION
446
def last_revision_info(self):
447
"""Return information about the last revision.
449
:return: A tuple (revno, last_revision_id).
451
rh = self.revision_history()
454
return (revno, rh[-1])
456
return (0, _mod_revision.NULL_REVISION)
458
def missing_revisions(self, other, stop_revision=None):
459
"""Return a list of new revisions that would perfectly fit.
461
If self and other have not diverged, return a list of the revisions
462
present in other, but missing from self.
464
self_history = self.revision_history()
465
self_len = len(self_history)
466
other_history = other.revision_history()
467
other_len = len(other_history)
468
common_index = min(self_len, other_len) -1
469
if common_index >= 0 and \
470
self_history[common_index] != other_history[common_index]:
471
raise DivergedBranches(self, other)
473
if stop_revision is None:
474
stop_revision = other_len
476
assert isinstance(stop_revision, int)
477
if stop_revision > other_len:
478
raise errors.NoSuchRevision(self, stop_revision)
479
return other_history[self_len:stop_revision]
481
def update_revisions(self, other, stop_revision=None):
482
"""Pull in new perfect-fit revisions.
484
:param other: Another Branch to pull from
485
:param stop_revision: Updated until the given revision
488
raise NotImplementedError(self.update_revisions)
490
def revision_id_to_revno(self, revision_id):
491
"""Given a revision id, return its revno"""
492
if _mod_revision.is_null(revision_id):
494
history = self.revision_history()
496
return history.index(revision_id) + 1
498
raise errors.NoSuchRevision(self, revision_id)
500
def get_rev_id(self, revno, history=None):
501
"""Find the revision id of the specified revno."""
503
return _mod_revision.NULL_REVISION
505
history = self.revision_history()
506
if revno <= 0 or revno > len(history):
507
raise errors.NoSuchRevision(self, revno)
508
return history[revno - 1]
510
def pull(self, source, overwrite=False, stop_revision=None,
511
possible_transports=None):
512
"""Mirror source into this branch.
514
This branch is considered to be 'local', having low latency.
516
:returns: PullResult instance
518
raise NotImplementedError(self.pull)
520
def push(self, target, overwrite=False, stop_revision=None):
521
"""Mirror this branch into target.
523
This branch is considered to be 'local', having low latency.
525
raise NotImplementedError(self.push)
527
def basis_tree(self):
528
"""Return `Tree` object for last revision."""
529
return self.repository.revision_tree(self.last_revision())
531
def rename_one(self, from_rel, to_rel):
534
This can change the directory or the filename or both.
536
raise NotImplementedError(self.rename_one)
538
def move(self, from_paths, to_name):
541
to_name must exist as a versioned directory.
543
If to_name exists and is a directory, the files are moved into
544
it, keeping their old names. If it is a directory,
546
Note that to_name is only the last component of the new name;
547
this doesn't change the directory.
549
This returns a list of (from_path, to_path) pairs for each
552
raise NotImplementedError(self.move)
554
def get_parent(self):
555
"""Return the parent location of the branch.
557
This is the default location for push/pull/missing. The usual
558
pattern is that the user can override it by specifying a
561
raise NotImplementedError(self.get_parent)
563
def _set_config_location(self, name, url, config=None,
564
make_relative=False):
566
config = self.get_config()
570
url = urlutils.relative_url(self.base, url)
571
config.set_user_option(name, url, warn_masked=True)
573
def _get_config_location(self, name, config=None):
575
config = self.get_config()
576
location = config.get_user_option(name)
581
def get_submit_branch(self):
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
return self.get_config().get_user_option('submit_branch')
590
def set_submit_branch(self, location):
591
"""Return the submit location of the branch.
593
This is the default location for bundle. The usual
594
pattern is that the user can override it by specifying a
597
self.get_config().set_user_option('submit_branch', location,
600
def get_public_branch(self):
601
"""Return the public location of the branch.
603
This is is used by merge directives.
605
return self._get_config_location('public_branch')
607
def set_public_branch(self, location):
608
"""Return the submit location of the branch.
610
This is the default location for bundle. The usual
611
pattern is that the user can override it by specifying a
614
self._set_config_location('public_branch', location)
616
def get_push_location(self):
617
"""Return the None or the location to push this branch to."""
618
push_loc = self.get_config().get_user_option('push_location')
621
def set_push_location(self, location):
622
"""Set a new push location for this branch."""
623
raise NotImplementedError(self.set_push_location)
625
def set_parent(self, url):
626
raise NotImplementedError(self.set_parent)
630
"""Synchronise this branch with the master branch if any.
632
:return: None or the last_revision pivoted out during the update.
636
def check_revno(self, revno):
638
Check whether a revno corresponds to any revision.
639
Zero (the NULL revision) is considered valid.
642
self.check_real_revno(revno)
644
def check_real_revno(self, revno):
646
Check whether a revno corresponds to a real revision.
647
Zero (the NULL revision) is considered invalid
649
if revno < 1 or revno > self.revno():
650
raise InvalidRevisionNumber(revno)
653
def clone(self, to_bzrdir, revision_id=None):
654
"""Clone this branch into to_bzrdir preserving all semantic values.
656
revision_id: if not None, the revision history in the new branch will
657
be truncated to end with revision_id.
659
result = self._format.initialize(to_bzrdir)
660
self.copy_content_into(result, revision_id=revision_id)
664
def sprout(self, to_bzrdir, revision_id=None):
665
"""Create a new line of development from the branch, into to_bzrdir.
667
revision_id: if not None, the revision history in the new branch will
668
be truncated to end with revision_id.
670
result = self._format.initialize(to_bzrdir)
671
self.copy_content_into(result, revision_id=revision_id)
672
result.set_parent(self.bzrdir.root_transport.base)
675
def _synchronize_history(self, destination, revision_id):
676
"""Synchronize last revision and revision history between branches.
678
This version is most efficient when the destination is also a
679
BzrBranch5, but works for BzrBranch6 as long as the revision
680
history is the true lefthand parent history, and all of the revisions
681
are in the destination's repository. If not, set_revision_history
684
:param destination: The branch to copy the history into
685
:param revision_id: The revision-id to truncate history at. May
686
be None to copy complete history.
688
if revision_id == _mod_revision.NULL_REVISION:
690
new_history = self.revision_history()
691
if revision_id is not None and new_history != []:
693
new_history = new_history[:new_history.index(revision_id) + 1]
695
rev = self.repository.get_revision(revision_id)
696
new_history = rev.get_history(self.repository)[1:]
697
destination.set_revision_history(new_history)
700
def copy_content_into(self, destination, revision_id=None):
701
"""Copy the content of self into destination.
703
revision_id: if not None, the revision history in the new branch will
704
be truncated to end with revision_id.
706
self._synchronize_history(destination, revision_id)
708
parent = self.get_parent()
709
except errors.InaccessibleParent, e:
710
mutter('parent was not accessible to copy: %s', e)
713
destination.set_parent(parent)
714
self.tags.merge_to(destination.tags)
718
"""Check consistency of the branch.
720
In particular this checks that revisions given in the revision-history
721
do actually match up in the revision graph, and that they're all
722
present in the repository.
724
Callers will typically also want to check the repository.
726
:return: A BranchCheckResult.
728
mainline_parent_id = None
729
for revision_id in self.revision_history():
731
revision = self.repository.get_revision(revision_id)
732
except errors.NoSuchRevision, e:
733
raise errors.BzrCheckError("mainline revision {%s} not in repository"
735
# In general the first entry on the revision history has no parents.
736
# But it's not illegal for it to have parents listed; this can happen
737
# in imports from Arch when the parents weren't reachable.
738
if mainline_parent_id is not None:
739
if mainline_parent_id not in revision.parent_ids:
740
raise errors.BzrCheckError("previous revision {%s} not listed among "
742
% (mainline_parent_id, revision_id))
743
mainline_parent_id = revision_id
744
return BranchCheckResult(self)
746
def _get_checkout_format(self):
747
"""Return the most suitable metadir for a checkout of this branch.
748
Weaves are used if this branch's repository uses weaves.
750
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
751
from bzrlib.repofmt import weaverepo
752
format = bzrdir.BzrDirMetaFormat1()
753
format.repository_format = weaverepo.RepositoryFormat7()
755
format = self.repository.bzrdir.checkout_metadir()
756
format.set_branch_format(self._format)
759
def create_checkout(self, to_location, revision_id=None,
761
"""Create a checkout of a branch.
763
:param to_location: The url to produce the checkout at
764
:param revision_id: The revision to check out
765
:param lightweight: If True, produce a lightweight checkout, otherwise,
766
produce a bound branch (heavyweight checkout)
767
:return: The tree of the created checkout
769
t = transport.get_transport(to_location)
772
format = self._get_checkout_format()
773
checkout = format.initialize_on_transport(t)
774
BranchReferenceFormat().initialize(checkout, self)
776
format = self._get_checkout_format()
777
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
778
to_location, force_new_tree=False, format=format)
779
checkout = checkout_branch.bzrdir
780
checkout_branch.bind(self)
781
# pull up to the specified revision_id to set the initial
782
# branch tip correctly, and seed it with history.
783
checkout_branch.pull(self, stop_revision=revision_id)
784
tree = checkout.create_workingtree(revision_id)
785
basis_tree = tree.basis_tree()
786
basis_tree.lock_read()
788
for path, file_id in basis_tree.iter_references():
789
reference_parent = self.reference_parent(file_id, path)
790
reference_parent.create_checkout(tree.abspath(path),
791
basis_tree.get_reference_revision(file_id, path),
797
def reference_parent(self, file_id, path):
798
"""Return the parent branch for a tree-reference file_id
799
:param file_id: The file_id of the tree reference
800
:param path: The path of the file_id in the tree
801
:return: A branch associated with the file_id
803
# FIXME should provide multiple branches, based on config
804
return Branch.open(self.bzrdir.root_transport.clone(path).base)
806
def supports_tags(self):
807
return self._format.supports_tags()
810
class BranchFormat(object):
811
"""An encapsulation of the initialization and open routines for a format.
813
Formats provide three things:
814
* An initialization routine,
818
Formats are placed in an dict by their format string for reference
819
during branch opening. Its not required that these be instances, they
820
can be classes themselves with class methods - it simply depends on
821
whether state is needed for a given format or not.
823
Once a format is deprecated, just deprecate the initialize and open
824
methods on the format class. Do not deprecate the object, as the
825
object will be created every time regardless.
828
_default_format = None
829
"""The default format used for new branches."""
832
"""The known formats."""
834
def __eq__(self, other):
835
return self.__class__ is other.__class__
837
def __ne__(self, other):
838
return not (self == other)
841
def find_format(klass, a_bzrdir):
842
"""Return the format for the branch object in a_bzrdir."""
844
transport = a_bzrdir.get_branch_transport(None)
845
format_string = transport.get("format").read()
846
return klass._formats[format_string]
848
raise NotBranchError(path=transport.base)
850
raise errors.UnknownFormatError(format=format_string)
853
def get_default_format(klass):
854
"""Return the current default format."""
855
return klass._default_format
857
def get_reference(self, a_bzrdir):
858
"""Get the target reference of the branch in a_bzrdir.
860
format probing must have been completed before calling
861
this method - it is assumed that the format of the branch
862
in a_bzrdir is correct.
864
:param a_bzrdir: The bzrdir to get the branch data from.
865
:return: None if the branch is not a reference branch.
869
def get_format_string(self):
870
"""Return the ASCII format string that identifies this format."""
871
raise NotImplementedError(self.get_format_string)
873
def get_format_description(self):
874
"""Return the short format description for this format."""
875
raise NotImplementedError(self.get_format_description)
877
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
879
"""Initialize a branch in a bzrdir, with specified files
881
:param a_bzrdir: The bzrdir to initialize the branch in
882
:param utf8_files: The files to create as a list of
883
(filename, content) tuples
884
:param set_format: If True, set the format with
885
self.get_format_string. (BzrBranch4 has its format set
887
:return: a branch in this format
889
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
890
branch_transport = a_bzrdir.get_branch_transport(self)
892
'metadir': ('lock', lockdir.LockDir),
893
'branch4': ('branch-lock', lockable_files.TransportLock),
895
lock_name, lock_class = lock_map[lock_type]
896
control_files = lockable_files.LockableFiles(branch_transport,
897
lock_name, lock_class)
898
control_files.create_lock()
899
control_files.lock_write()
901
control_files.put_utf8('format', self.get_format_string())
903
for file, content in utf8_files:
904
control_files.put_utf8(file, content)
906
control_files.unlock()
907
return self.open(a_bzrdir, _found=True)
909
def initialize(self, a_bzrdir):
910
"""Create a branch of this format in a_bzrdir."""
911
raise NotImplementedError(self.initialize)
913
def is_supported(self):
914
"""Is this format supported?
916
Supported formats can be initialized and opened.
917
Unsupported formats may not support initialization or committing or
918
some other features depending on the reason for not being supported.
922
def open(self, a_bzrdir, _found=False):
923
"""Return the branch object for a_bzrdir
925
_found is a private parameter, do not use it. It is used to indicate
926
if format probing has already be done.
928
raise NotImplementedError(self.open)
931
def register_format(klass, format):
932
klass._formats[format.get_format_string()] = format
935
def set_default_format(klass, format):
936
klass._default_format = format
939
def unregister_format(klass, format):
940
assert klass._formats[format.get_format_string()] is format
941
del klass._formats[format.get_format_string()]
944
return self.get_format_string().rstrip()
946
def supports_tags(self):
947
"""True if this format supports tags stored in the branch"""
948
return False # by default
950
# XXX: Probably doesn't really belong here -- mbp 20070212
951
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
953
branch_transport = a_bzrdir.get_branch_transport(self)
954
control_files = lockable_files.LockableFiles(branch_transport,
955
lock_filename, lock_class)
956
control_files.create_lock()
957
control_files.lock_write()
959
for filename, content in utf8_files:
960
control_files.put_utf8(filename, content)
962
control_files.unlock()
965
class BranchHooks(Hooks):
966
"""A dictionary mapping hook name to a list of callables for branch hooks.
968
e.g. ['set_rh'] Is the list of items to be called when the
969
set_revision_history function is invoked.
973
"""Create the default hooks.
975
These are all empty initially, because by default nothing should get
979
# Introduced in 0.15:
980
# invoked whenever the revision history has been set
981
# with set_revision_history. The api signature is
982
# (branch, revision_history), and the branch will
985
# invoked after a push operation completes.
986
# the api signature is
988
# containing the members
989
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
990
# where local is the local target branch or None, master is the target
991
# master branch, and the rest should be self explanatory. The source
992
# is read locked and the target branches write locked. Source will
993
# be the local low-latency branch.
994
self['post_push'] = []
995
# invoked after a pull operation completes.
996
# the api signature is
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. The local
1003
# branch is the low-latency branch.
1004
self['post_pull'] = []
1005
# invoked before a commit operation takes place.
1006
# the api signature is
1007
# (local, master, old_revno, old_revid, future_revno, future_revid,
1008
# tree_delta, future_tree).
1009
# old_revid is NULL_REVISION for the first commit to a branch
1010
# tree_delta is a TreeDelta object describing changes from the basis
1011
# revision, hooks MUST NOT modify this delta
1012
# future_tree is an in-memory tree obtained from
1013
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1014
self['pre_commit'] = []
1015
# invoked after a commit operation completes.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, new_revno, new_revid)
1018
# old_revid is NULL_REVISION for the first commit to a branch.
1019
self['post_commit'] = []
1020
# invoked after a uncommit operation completes.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
# local is the local branch or None, master is the target branch,
1024
# and an empty branch recieves new_revno of 0, new_revid of None.
1025
self['post_uncommit'] = []
1028
# install the default hooks into the Branch class.
1029
Branch.hooks = BranchHooks()
1032
class BzrBranchFormat4(BranchFormat):
1033
"""Bzr branch format 4.
1036
- a revision-history file.
1037
- a branch-lock lock file [ to be shared with the bzrdir ]
1040
def get_format_description(self):
1041
"""See BranchFormat.get_format_description()."""
1042
return "Branch format 4"
1044
def initialize(self, a_bzrdir):
1045
"""Create a branch of this format in a_bzrdir."""
1046
utf8_files = [('revision-history', ''),
1047
('branch-name', ''),
1049
return self._initialize_helper(a_bzrdir, utf8_files,
1050
lock_type='branch4', set_format=False)
1053
super(BzrBranchFormat4, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1059
_found is a private parameter, do not use it. It is used to indicate
1060
if format probing has already be done.
1063
# we are being called directly and must probe.
1064
raise NotImplementedError
1065
return BzrBranch(_format=self,
1066
_control_files=a_bzrdir._control_files,
1068
_repository=a_bzrdir.open_repository())
1071
return "Bazaar-NG branch format 4"
1074
class BzrBranchFormat5(BranchFormat):
1075
"""Bzr branch format 5.
1078
- a revision-history file.
1080
- a lock dir guarding the branch itself
1081
- all of this stored in a branch/ subdirectory
1082
- works with shared repositories.
1084
This format is new in bzr 0.8.
1087
def get_format_string(self):
1088
"""See BranchFormat.get_format_string()."""
1089
return "Bazaar-NG branch format 5\n"
1091
def get_format_description(self):
1092
"""See BranchFormat.get_format_description()."""
1093
return "Branch format 5"
1095
def initialize(self, a_bzrdir):
1096
"""Create a branch of this format in a_bzrdir."""
1097
utf8_files = [('revision-history', ''),
1098
('branch-name', ''),
1100
return self._initialize_helper(a_bzrdir, utf8_files)
1103
super(BzrBranchFormat5, self).__init__()
1104
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1106
def open(self, a_bzrdir, _found=False):
1107
"""Return the branch object for a_bzrdir
1109
_found is a private parameter, do not use it. It is used to indicate
1110
if format probing has already be done.
1113
format = BranchFormat.find_format(a_bzrdir)
1114
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
1119
return BzrBranch5(_format=self,
1120
_control_files=control_files,
1122
_repository=a_bzrdir.find_repository())
1124
raise NotBranchError(path=transport.base)
1127
class BzrBranchFormat6(BzrBranchFormat5):
1128
"""Branch format with last-revision and tags.
1130
Unlike previous formats, this has no explicit revision history. Instead,
1131
this just stores the last-revision, and the left-hand history leading
1132
up to there is the history.
1134
This format was introduced in bzr 0.15
1135
and became the default in 0.91.
1138
def get_format_string(self):
1139
"""See BranchFormat.get_format_string()."""
1140
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1142
def get_format_description(self):
1143
"""See BranchFormat.get_format_description()."""
1144
return "Branch format 6"
1146
def initialize(self, a_bzrdir):
1147
"""Create a branch of this format in a_bzrdir."""
1148
utf8_files = [('last-revision', '0 null:\n'),
1149
('branch-name', ''),
1150
('branch.conf', ''),
1153
return self._initialize_helper(a_bzrdir, utf8_files)
1155
def open(self, a_bzrdir, _found=False):
1156
"""Return the branch object for a_bzrdir
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
control_files = lockable_files.LockableFiles(transport, 'lock',
1167
return BzrBranch6(_format=self,
1168
_control_files=control_files,
1170
_repository=a_bzrdir.find_repository())
1172
def supports_tags(self):
1176
class BranchReferenceFormat(BranchFormat):
1177
"""Bzr branch reference format.
1179
Branch references are used in implementing checkouts, they
1180
act as an alias to the real branch which is at some other url.
1187
def get_format_string(self):
1188
"""See BranchFormat.get_format_string()."""
1189
return "Bazaar-NG Branch Reference Format 1\n"
1191
def get_format_description(self):
1192
"""See BranchFormat.get_format_description()."""
1193
return "Checkout reference format 1"
1195
def get_reference(self, a_bzrdir):
1196
"""See BranchFormat.get_reference()."""
1197
transport = a_bzrdir.get_branch_transport(None)
1198
return transport.get('location').read()
1200
def initialize(self, a_bzrdir, target_branch=None):
1201
"""Create a branch of this format in a_bzrdir."""
1202
if target_branch is None:
1203
# this format does not implement branch itself, thus the implicit
1204
# creation contract must see it as uninitializable
1205
raise errors.UninitializableFormat(self)
1206
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1207
branch_transport = a_bzrdir.get_branch_transport(self)
1208
branch_transport.put_bytes('location',
1209
target_branch.bzrdir.root_transport.base)
1210
branch_transport.put_bytes('format', self.get_format_string())
1211
return self.open(a_bzrdir, _found=True)
1214
super(BranchReferenceFormat, self).__init__()
1215
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1217
def _make_reference_clone_function(format, a_branch):
1218
"""Create a clone() routine for a branch dynamically."""
1219
def clone(to_bzrdir, revision_id=None):
1220
"""See Branch.clone()."""
1221
return format.initialize(to_bzrdir, a_branch)
1222
# cannot obey revision_id limits when cloning a reference ...
1223
# FIXME RBC 20060210 either nuke revision_id for clone, or
1224
# emit some sort of warning/error to the caller ?!
1227
def open(self, a_bzrdir, _found=False, location=None):
1228
"""Return the branch that the branch reference in a_bzrdir points at.
1230
_found is a private parameter, do not use it. It is used to indicate
1231
if format probing has already be done.
1234
format = BranchFormat.find_format(a_bzrdir)
1235
assert format.__class__ == self.__class__
1236
if location is None:
1237
location = self.get_reference(a_bzrdir)
1238
real_bzrdir = bzrdir.BzrDir.open(location)
1239
result = real_bzrdir.open_branch()
1240
# this changes the behaviour of result.clone to create a new reference
1241
# rather than a copy of the content of the branch.
1242
# I did not use a proxy object because that needs much more extensive
1243
# testing, and we are only changing one behaviour at the moment.
1244
# If we decide to alter more behaviours - i.e. the implicit nickname
1245
# then this should be refactored to introduce a tested proxy branch
1246
# and a subclass of that for use in overriding clone() and ....
1248
result.clone = self._make_reference_clone_function(result)
1252
# formats which have no format string are not discoverable
1253
# and not independently creatable, so are not registered.
1254
__format5 = BzrBranchFormat5()
1255
__format6 = BzrBranchFormat6()
1256
BranchFormat.register_format(__format5)
1257
BranchFormat.register_format(BranchReferenceFormat())
1258
BranchFormat.register_format(__format6)
1259
BranchFormat.set_default_format(__format6)
1260
_legacy_formats = [BzrBranchFormat4(),
1263
class BzrBranch(Branch):
1264
"""A branch stored in the actual filesystem.
1266
Note that it's "local" in the context of the filesystem; it doesn't
1267
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1268
it's writable, and can be accessed via the normal filesystem API.
1271
def __init__(self, _format=None,
1272
_control_files=None, a_bzrdir=None, _repository=None):
1273
"""Create new branch object at a particular location."""
1274
Branch.__init__(self)
1275
if a_bzrdir is None:
1276
raise ValueError('a_bzrdir must be supplied')
1278
self.bzrdir = a_bzrdir
1279
# self._transport used to point to the directory containing the
1280
# control directory, but was not used - now it's just the transport
1281
# for the branch control files. mbp 20070212
1282
self._base = self.bzrdir.transport.clone('..').base
1283
self._format = _format
1284
if _control_files is None:
1285
raise ValueError('BzrBranch _control_files is None')
1286
self.control_files = _control_files
1287
self._transport = _control_files._transport
1288
self.repository = _repository
1291
return '%s(%r)' % (self.__class__.__name__, self.base)
1295
def _get_base(self):
1296
"""Returns the directory containing the control directory."""
1299
base = property(_get_base, doc="The URL for the root of this branch.")
1301
def abspath(self, name):
1302
"""See Branch.abspath."""
1303
return self.control_files._transport.abspath(name)
1306
@deprecated_method(zero_sixteen)
1308
def get_root_id(self):
1309
"""See Branch.get_root_id."""
1310
tree = self.repository.revision_tree(self.last_revision())
1311
return tree.inventory.root.file_id
1313
def is_locked(self):
1314
return self.control_files.is_locked()
1316
def lock_write(self, token=None):
1317
repo_token = self.repository.lock_write()
1319
token = self.control_files.lock_write(token=token)
1321
self.repository.unlock()
1325
def lock_read(self):
1326
self.repository.lock_read()
1328
self.control_files.lock_read()
1330
self.repository.unlock()
1334
# TODO: test for failed two phase locks. This is known broken.
1336
self.control_files.unlock()
1338
self.repository.unlock()
1339
if not self.control_files.is_locked():
1340
# we just released the lock
1341
self._clear_cached_state()
1343
def peek_lock_mode(self):
1344
if self.control_files._lock_count == 0:
1347
return self.control_files._lock_mode
1349
def get_physical_lock_status(self):
1350
return self.control_files.get_physical_lock_status()
1353
def print_file(self, file, revision_id):
1354
"""See Branch.print_file."""
1355
return self.repository.print_file(file, revision_id)
1357
def _write_revision_history(self, history):
1358
"""Factored out of set_revision_history.
1360
This performs the actual writing to disk.
1361
It is intended to be called by BzrBranch5.set_revision_history."""
1362
self.control_files.put_bytes(
1363
'revision-history', '\n'.join(history))
1366
def set_revision_history(self, rev_history):
1367
"""See Branch.set_revision_history."""
1368
if 'evil' in debug.debug_flags:
1369
mutter_callsite(3, "set_revision_history scales with history.")
1370
self._clear_cached_state()
1371
self._write_revision_history(rev_history)
1372
self._cache_revision_history(rev_history)
1373
for hook in Branch.hooks['set_rh']:
1374
hook(self, rev_history)
1377
def set_last_revision_info(self, revno, revision_id):
1378
"""Set the last revision of this branch.
1380
The caller is responsible for checking that the revno is correct
1381
for this revision id.
1383
It may be possible to set the branch last revision to an id not
1384
present in the repository. However, branches can also be
1385
configured to check constraints on history, in which case this may not
1388
history = self._lefthand_history(revision_id)
1389
assert len(history) == revno, '%d != %d' % (len(history), revno)
1390
self.set_revision_history(history)
1392
def _gen_revision_history(self):
1393
history = self.control_files.get('revision-history').read().split('\n')
1394
if history[-1:] == ['']:
1395
# There shouldn't be a trailing newline, but just in case.
1399
def _lefthand_history(self, revision_id, last_rev=None,
1401
if 'evil' in debug.debug_flags:
1402
mutter_callsite(4, "_lefthand_history scales with history.")
1403
# stop_revision must be a descendant of last_revision
1404
stop_graph = self.repository.get_revision_graph(revision_id)
1405
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1406
and last_rev not in stop_graph):
1407
# our previous tip is not merged into stop_revision
1408
raise errors.DivergedBranches(self, other_branch)
1409
# make a new revision history from the graph
1410
current_rev_id = revision_id
1412
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1413
new_history.append(current_rev_id)
1414
current_rev_id_parents = stop_graph[current_rev_id]
1416
current_rev_id = current_rev_id_parents[0]
1418
current_rev_id = None
1419
new_history.reverse()
1423
def generate_revision_history(self, revision_id, last_rev=None,
1425
"""Create a new revision history that will finish with revision_id.
1427
:param revision_id: the new tip to use.
1428
:param last_rev: The previous last_revision. If not None, then this
1429
must be a ancestory of revision_id, or DivergedBranches is raised.
1430
:param other_branch: The other branch that DivergedBranches should
1431
raise with respect to.
1433
self.set_revision_history(self._lefthand_history(revision_id,
1434
last_rev, other_branch))
1437
def update_revisions(self, other, stop_revision=None):
1438
"""See Branch.update_revisions."""
1441
if stop_revision is None:
1442
stop_revision = other.last_revision()
1443
if stop_revision is None:
1444
# if there are no commits, we're done.
1446
# whats the current last revision, before we fetch [and change it
1448
last_rev = _mod_revision.ensure_null(self.last_revision())
1449
# we fetch here so that we don't process data twice in the common
1450
# case of having something to pull, and so that the check for
1451
# already merged can operate on the just fetched graph, which will
1452
# be cached in memory.
1453
self.fetch(other, stop_revision)
1454
if self.repository.get_graph().is_ancestor(stop_revision,
1457
self.generate_revision_history(stop_revision, last_rev=last_rev,
1462
def basis_tree(self):
1463
"""See Branch.basis_tree."""
1464
return self.repository.revision_tree(self.last_revision())
1467
def pull(self, source, overwrite=False, stop_revision=None,
1468
_hook_master=None, run_hooks=True, possible_transports=None):
1471
:param _hook_master: Private parameter - set the branch to
1472
be supplied as the master to push hooks.
1473
:param run_hooks: Private parameter - if false, this branch
1474
is being called because it's the master of the primary branch,
1475
so it should not run its hooks.
1477
result = PullResult()
1478
result.source_branch = source
1479
result.target_branch = self
1482
result.old_revno, result.old_revid = self.last_revision_info()
1484
self.update_revisions(source, stop_revision)
1485
except DivergedBranches:
1489
if stop_revision is None:
1490
stop_revision = source.last_revision()
1491
self.generate_revision_history(stop_revision)
1492
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1493
result.new_revno, result.new_revid = self.last_revision_info()
1495
result.master_branch = _hook_master
1496
result.local_branch = self
1498
result.master_branch = self
1499
result.local_branch = None
1501
for hook in Branch.hooks['post_pull']:
1507
def _get_parent_location(self):
1508
_locs = ['parent', 'pull', 'x-pull']
1511
return self.control_files.get(l).read().strip('\n')
1517
def push(self, target, overwrite=False, stop_revision=None,
1518
_override_hook_source_branch=None):
1521
This is the basic concrete implementation of push()
1523
:param _override_hook_source_branch: If specified, run
1524
the hooks passing this Branch as the source, rather than self.
1525
This is for use of RemoteBranch, where push is delegated to the
1526
underlying vfs-based Branch.
1528
# TODO: Public option to disable running hooks - should be trivial but
1532
result = self._push_with_bound_branches(target, overwrite,
1534
_override_hook_source_branch=_override_hook_source_branch)
1539
def _push_with_bound_branches(self, target, overwrite,
1541
_override_hook_source_branch=None):
1542
"""Push from self into target, and into target's master if any.
1544
This is on the base BzrBranch class even though it doesn't support
1545
bound branches because the *target* might be bound.
1548
if _override_hook_source_branch:
1549
result.source_branch = _override_hook_source_branch
1550
for hook in Branch.hooks['post_push']:
1553
bound_location = target.get_bound_location()
1554
if bound_location and target.base != bound_location:
1555
# there is a master branch.
1557
# XXX: Why the second check? Is it even supported for a branch to
1558
# be bound to itself? -- mbp 20070507
1559
master_branch = target.get_master_branch()
1560
master_branch.lock_write()
1562
# push into the master from this branch.
1563
self._basic_push(master_branch, overwrite, stop_revision)
1564
# and push into the target branch from this. Note that we push from
1565
# this branch again, because its considered the highest bandwidth
1567
result = self._basic_push(target, overwrite, stop_revision)
1568
result.master_branch = master_branch
1569
result.local_branch = target
1573
master_branch.unlock()
1576
result = self._basic_push(target, overwrite, stop_revision)
1577
# TODO: Why set master_branch and local_branch if there's no
1578
# binding? Maybe cleaner to just leave them unset? -- mbp
1580
result.master_branch = target
1581
result.local_branch = None
1585
def _basic_push(self, target, overwrite, stop_revision):
1586
"""Basic implementation of push without bound branches or hooks.
1588
Must be called with self read locked and target write locked.
1590
result = PushResult()
1591
result.source_branch = self
1592
result.target_branch = target
1593
result.old_revno, result.old_revid = target.last_revision_info()
1595
target.update_revisions(self, stop_revision)
1596
except DivergedBranches:
1600
target.set_revision_history(self.revision_history())
1601
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1602
result.new_revno, result.new_revid = target.last_revision_info()
1605
def get_parent(self):
1606
"""See Branch.get_parent."""
1608
assert self.base[-1] == '/'
1609
parent = self._get_parent_location()
1612
# This is an old-format absolute path to a local branch
1613
# turn it into a url
1614
if parent.startswith('/'):
1615
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1617
return urlutils.join(self.base[:-1], parent)
1618
except errors.InvalidURLJoin, e:
1619
raise errors.InaccessibleParent(parent, self.base)
1621
def set_push_location(self, location):
1622
"""See Branch.set_push_location."""
1623
self.get_config().set_user_option(
1624
'push_location', location,
1625
store=_mod_config.STORE_LOCATION_NORECURSE)
1628
def set_parent(self, url):
1629
"""See Branch.set_parent."""
1630
# TODO: Maybe delete old location files?
1631
# URLs should never be unicode, even on the local fs,
1632
# FIXUP this and get_parent in a future branch format bump:
1633
# read and rewrite the file, and have the new format code read
1634
# using .get not .get_utf8. RBC 20060125
1636
if isinstance(url, unicode):
1638
url = url.encode('ascii')
1639
except UnicodeEncodeError:
1640
raise errors.InvalidURL(url,
1641
"Urls must be 7-bit ascii, "
1642
"use bzrlib.urlutils.escape")
1643
url = urlutils.relative_url(self.base, url)
1644
self._set_parent_location(url)
1646
def _set_parent_location(self, url):
1648
self.control_files._transport.delete('parent')
1650
assert isinstance(url, str)
1651
self.control_files.put_bytes('parent', url + '\n')
1654
class BzrBranch5(BzrBranch):
1655
"""A format 5 branch. This supports new features over plain branches.
1657
It has support for a master_branch which is the data for bound branches.
1665
super(BzrBranch5, self).__init__(_format=_format,
1666
_control_files=_control_files,
1668
_repository=_repository)
1671
def pull(self, source, overwrite=False, stop_revision=None,
1672
run_hooks=True, possible_transports=None):
1673
"""Pull from source into self, updating my master if any.
1675
:param run_hooks: Private parameter - if false, this branch
1676
is being called because it's the master of the primary branch,
1677
so it should not run its hooks.
1679
bound_location = self.get_bound_location()
1680
master_branch = None
1681
if bound_location and source.base != bound_location:
1682
# not pulling from master, so we need to update master.
1683
master_branch = self.get_master_branch(possible_transports)
1684
master_branch.lock_write()
1687
# pull from source into master.
1688
master_branch.pull(source, overwrite, stop_revision,
1690
return super(BzrBranch5, self).pull(source, overwrite,
1691
stop_revision, _hook_master=master_branch,
1692
run_hooks=run_hooks)
1695
master_branch.unlock()
1697
def get_bound_location(self):
1699
return self.control_files.get_utf8('bound').read()[:-1]
1700
except errors.NoSuchFile:
1704
def get_master_branch(self, possible_transports=None):
1705
"""Return the branch we are bound to.
1707
:return: Either a Branch, or None
1709
This could memoise the branch, but if thats done
1710
it must be revalidated on each new lock.
1711
So for now we just don't memoise it.
1712
# RBC 20060304 review this decision.
1714
bound_loc = self.get_bound_location()
1718
return Branch.open(bound_loc,
1719
possible_transports=possible_transports)
1720
except (errors.NotBranchError, errors.ConnectionError), e:
1721
raise errors.BoundBranchConnectionFailure(
1725
def set_bound_location(self, location):
1726
"""Set the target where this branch is bound to.
1728
:param location: URL to the target branch
1731
self.control_files.put_utf8('bound', location+'\n')
1734
self.control_files._transport.delete('bound')
1740
def bind(self, other):
1741
"""Bind this branch to the branch other.
1743
This does not push or pull data between the branches, though it does
1744
check for divergence to raise an error when the branches are not
1745
either the same, or one a prefix of the other. That behaviour may not
1746
be useful, so that check may be removed in future.
1748
:param other: The branch to bind to
1751
# TODO: jam 20051230 Consider checking if the target is bound
1752
# It is debatable whether you should be able to bind to
1753
# a branch which is itself bound.
1754
# Committing is obviously forbidden,
1755
# but binding itself may not be.
1756
# Since we *have* to check at commit time, we don't
1757
# *need* to check here
1759
# we want to raise diverged if:
1760
# last_rev is not in the other_last_rev history, AND
1761
# other_last_rev is not in our history, and do it without pulling
1763
last_rev = _mod_revision.ensure_null(self.last_revision())
1764
if last_rev != _mod_revision.NULL_REVISION:
1767
other_last_rev = other.last_revision()
1768
if not _mod_revision.is_null(other_last_rev):
1769
# neither branch is new, we have to do some work to
1770
# ascertain diversion.
1771
remote_graph = other.repository.get_revision_graph(
1773
local_graph = self.repository.get_revision_graph(last_rev)
1774
if (last_rev not in remote_graph and
1775
other_last_rev not in local_graph):
1776
raise errors.DivergedBranches(self, other)
1779
self.set_bound_location(other.base)
1783
"""If bound, unbind"""
1784
return self.set_bound_location(None)
1787
def update(self, possible_transports=None):
1788
"""Synchronise this branch with the master branch if any.
1790
:return: None or the last_revision that was pivoted out during the
1793
master = self.get_master_branch(possible_transports)
1794
if master is not None:
1795
old_tip = _mod_revision.ensure_null(self.last_revision())
1796
self.pull(master, overwrite=True)
1797
if self.repository.get_graph().is_ancestor(old_tip,
1798
_mod_revision.ensure_null(self.last_revision())):
1804
class BzrBranchExperimental(BzrBranch5):
1805
"""Bzr experimental branch format
1808
- a revision-history file.
1810
- a lock dir guarding the branch itself
1811
- all of this stored in a branch/ subdirectory
1812
- works with shared repositories.
1813
- a tag dictionary in the branch
1815
This format is new in bzr 0.15, but shouldn't be used for real data,
1818
This class acts as it's own BranchFormat.
1821
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1824
def get_format_string(cls):
1825
"""See BranchFormat.get_format_string()."""
1826
return "Bazaar-NG branch format experimental\n"
1829
def get_format_description(cls):
1830
"""See BranchFormat.get_format_description()."""
1831
return "Experimental branch format"
1834
def get_reference(cls, a_bzrdir):
1835
"""Get the target reference of the branch in a_bzrdir.
1837
format probing must have been completed before calling
1838
this method - it is assumed that the format of the branch
1839
in a_bzrdir is correct.
1841
:param a_bzrdir: The bzrdir to get the branch data from.
1842
:return: None if the branch is not a reference branch.
1847
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1849
branch_transport = a_bzrdir.get_branch_transport(cls)
1850
control_files = lockable_files.LockableFiles(branch_transport,
1851
lock_filename, lock_class)
1852
control_files.create_lock()
1853
control_files.lock_write()
1855
for filename, content in utf8_files:
1856
control_files.put_utf8(filename, content)
1858
control_files.unlock()
1861
def initialize(cls, a_bzrdir):
1862
"""Create a branch of this format in a_bzrdir."""
1863
utf8_files = [('format', cls.get_format_string()),
1864
('revision-history', ''),
1865
('branch-name', ''),
1868
cls._initialize_control_files(a_bzrdir, utf8_files,
1869
'lock', lockdir.LockDir)
1870
return cls.open(a_bzrdir, _found=True)
1873
def open(cls, a_bzrdir, _found=False):
1874
"""Return the branch object for a_bzrdir
1876
_found is a private parameter, do not use it. It is used to indicate
1877
if format probing has already be done.
1880
format = BranchFormat.find_format(a_bzrdir)
1881
assert format.__class__ == cls
1882
transport = a_bzrdir.get_branch_transport(None)
1883
control_files = lockable_files.LockableFiles(transport, 'lock',
1885
return cls(_format=cls,
1886
_control_files=control_files,
1888
_repository=a_bzrdir.find_repository())
1891
def is_supported(cls):
1894
def _make_tags(self):
1895
return BasicTags(self)
1898
def supports_tags(cls):
1902
BranchFormat.register_format(BzrBranchExperimental)
1905
class BzrBranch6(BzrBranch5):
1908
def last_revision_info(self):
1909
revision_string = self.control_files.get('last-revision').read()
1910
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1911
revision_id = cache_utf8.get_cached_utf8(revision_id)
1913
return revno, revision_id
1915
def last_revision(self):
1916
"""Return last revision id, or None"""
1917
revision_id = self.last_revision_info()[1]
1920
def _write_last_revision_info(self, revno, revision_id):
1921
"""Simply write out the revision id, with no checks.
1923
Use set_last_revision_info to perform this safely.
1925
Does not update the revision_history cache.
1926
Intended to be called by set_last_revision_info and
1927
_write_revision_history.
1929
if revision_id is None:
1930
revision_id = 'null:'
1931
out_string = '%d %s\n' % (revno, revision_id)
1932
self.control_files.put_bytes('last-revision', out_string)
1935
def set_last_revision_info(self, revno, revision_id):
1936
if self._get_append_revisions_only():
1937
self._check_history_violation(revision_id)
1938
self._write_last_revision_info(revno, revision_id)
1939
self._clear_cached_state()
1941
def _check_history_violation(self, revision_id):
1942
last_revision = _mod_revision.ensure_null(self.last_revision())
1943
if _mod_revision.is_null(last_revision):
1945
if last_revision not in self._lefthand_history(revision_id):
1946
raise errors.AppendRevisionsOnlyViolation(self.base)
1948
def _gen_revision_history(self):
1949
"""Generate the revision history from last revision
1951
history = list(self.repository.iter_reverse_revision_history(
1952
self.last_revision()))
1956
def _write_revision_history(self, history):
1957
"""Factored out of set_revision_history.
1959
This performs the actual writing to disk, with format-specific checks.
1960
It is intended to be called by BzrBranch5.set_revision_history.
1962
if len(history) == 0:
1963
last_revision = 'null:'
1965
if history != self._lefthand_history(history[-1]):
1966
raise errors.NotLefthandHistory(history)
1967
last_revision = history[-1]
1968
if self._get_append_revisions_only():
1969
self._check_history_violation(last_revision)
1970
self._write_last_revision_info(len(history), last_revision)
1973
def _set_parent_location(self, url):
1974
"""Set the parent branch"""
1975
self._set_config_location('parent_location', url, make_relative=True)
1978
def _get_parent_location(self):
1979
"""Set the parent branch"""
1980
return self._get_config_location('parent_location')
1982
def set_push_location(self, location):
1983
"""See Branch.set_push_location."""
1984
self._set_config_location('push_location', location)
1986
def set_bound_location(self, location):
1987
"""See Branch.set_push_location."""
1989
config = self.get_config()
1990
if location is None:
1991
if config.get_user_option('bound') != 'True':
1994
config.set_user_option('bound', 'False', warn_masked=True)
1997
self._set_config_location('bound_location', location,
1999
config.set_user_option('bound', 'True', warn_masked=True)
2002
def _get_bound_location(self, bound):
2003
"""Return the bound location in the config file.
2005
Return None if the bound parameter does not match"""
2006
config = self.get_config()
2007
config_bound = (config.get_user_option('bound') == 'True')
2008
if config_bound != bound:
2010
return self._get_config_location('bound_location', config=config)
2012
def get_bound_location(self):
2013
"""See Branch.set_push_location."""
2014
return self._get_bound_location(True)
2016
def get_old_bound_location(self):
2017
"""See Branch.get_old_bound_location"""
2018
return self._get_bound_location(False)
2020
def set_append_revisions_only(self, enabled):
2025
self.get_config().set_user_option('append_revisions_only', value,
2028
def _get_append_revisions_only(self):
2029
value = self.get_config().get_user_option('append_revisions_only')
2030
return value == 'True'
2032
def _synchronize_history(self, destination, revision_id):
2033
"""Synchronize last revision and revision history between branches.
2035
This version is most efficient when the destination is also a
2036
BzrBranch6, but works for BzrBranch5, as long as the destination's
2037
repository contains all the lefthand ancestors of the intended
2038
last_revision. If not, set_last_revision_info will fail.
2040
:param destination: The branch to copy the history into
2041
:param revision_id: The revision-id to truncate history at. May
2042
be None to copy complete history.
2044
source_revno, source_revision_id = self.last_revision_info()
2045
if revision_id is None:
2046
revno, revision_id = source_revno, source_revision_id
2047
elif source_revision_id == revision_id:
2048
# we know the revno without needing to walk all of history
2049
revno = source_revno
2051
# To figure out the revno for a random revision, we need to build
2052
# the revision history, and count its length.
2053
# We don't care about the order, just how long it is.
2054
# Alternatively, we could start at the current location, and count
2055
# backwards. But there is no guarantee that we will find it since
2056
# it may be a merged revision.
2057
revno = len(list(self.repository.iter_reverse_revision_history(
2059
destination.set_last_revision_info(revno, revision_id)
2061
def _make_tags(self):
2062
return BasicTags(self)
2065
######################################################################
2066
# results of operations
2069
class _Result(object):
2071
def _show_tag_conficts(self, to_file):
2072
if not getattr(self, 'tag_conflicts', None):
2074
to_file.write('Conflicting tags:\n')
2075
for name, value1, value2 in self.tag_conflicts:
2076
to_file.write(' %s\n' % (name, ))
2079
class PullResult(_Result):
2080
"""Result of a Branch.pull operation.
2082
:ivar old_revno: Revision number before pull.
2083
:ivar new_revno: Revision number after pull.
2084
:ivar old_revid: Tip revision id before pull.
2085
:ivar new_revid: Tip revision id after pull.
2086
:ivar source_branch: Source (local) branch object.
2087
:ivar master_branch: Master branch of the target, or None.
2088
:ivar target_branch: Target/destination branch object.
2092
# DEPRECATED: pull used to return the change in revno
2093
return self.new_revno - self.old_revno
2095
def report(self, to_file):
2096
if self.old_revid == self.new_revid:
2097
to_file.write('No revisions to pull.\n')
2099
to_file.write('Now on revision %d.\n' % self.new_revno)
2100
self._show_tag_conficts(to_file)
2103
class PushResult(_Result):
2104
"""Result of a Branch.push operation.
2106
:ivar old_revno: Revision number before push.
2107
:ivar new_revno: Revision number after push.
2108
:ivar old_revid: Tip revision id before push.
2109
:ivar new_revid: Tip revision id after push.
2110
:ivar source_branch: Source branch object.
2111
:ivar master_branch: Master branch of the target, or None.
2112
:ivar target_branch: Target/destination branch object.
2116
# DEPRECATED: push used to return the change in revno
2117
return self.new_revno - self.old_revno
2119
def report(self, to_file):
2120
"""Write a human-readable description of the result."""
2121
if self.old_revid == self.new_revid:
2122
to_file.write('No new revisions to push.\n')
2124
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2125
self._show_tag_conficts(to_file)
2128
class BranchCheckResult(object):
2129
"""Results of checking branch consistency.
2134
def __init__(self, branch):
2135
self.branch = branch
2137
def report_results(self, verbose):
2138
"""Report the check results via trace.note.
2140
:param verbose: Requests more detailed display of what was checked,
2143
note('checked branch %s format %s',
2145
self.branch._format)
2148
class Converter5to6(object):
2149
"""Perform an in-place upgrade of format 5 to format 6"""
2151
def convert(self, branch):
2152
# Data for 5 and 6 can peacefully coexist.
2153
format = BzrBranchFormat6()
2154
new_branch = format.open(branch.bzrdir, _found=True)
2156
# Copy source data into target
2157
new_branch.set_last_revision_info(*branch.last_revision_info())
2158
new_branch.set_parent(branch.get_parent())
2159
new_branch.set_bound_location(branch.get_bound_location())
2160
new_branch.set_push_location(branch.get_push_location())
2162
# New branch has no tags by default
2163
new_branch.tags._set_tag_dict({})
2165
# Copying done; now update target format
2166
new_branch.control_files.put_utf8('format',
2167
format.get_format_string())
2169
# Clean up old files
2170
new_branch.control_files._transport.delete('revision-history')
2172
branch.set_parent(None)
2175
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
