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,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
# TODO: Maybe include checks for common corruption of newlines, etc?
74
# TODO: Some operations like log might retrieve the same revisions
75
# repeatedly to calculate deltas. We could perhaps have a weakref
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
81
######################################################################
85
"""Branch holding a history of revisions.
88
Base directory/url of the branch.
90
hooks: An instance of BranchHooks.
92
# this is really an instance variable - FIXME move it there
96
# override this to set the strategy for storing tags
98
return DisabledTags(self)
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
102
self._revision_history_cache = None
103
self._revision_id_to_revno_cache = None
105
def break_lock(self):
106
"""Break a lock if one is present from another instance.
108
Uses the ui factory to ask for confirmation if the lock may be from
111
This will probe the repository for its lock as well.
113
self.control_files.break_lock()
114
self.repository.break_lock()
115
master = self.get_master_branch()
116
if master is not None:
120
def open(base, _unsupported=False, possible_transports=None):
121
"""Open the branch rooted at base.
123
For instance, if the branch is at URL/.bzr/branch,
124
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported,
127
possible_transports=possible_transports)
128
return control.open_branch(_unsupported)
131
def open_from_transport(transport, _unsupported=False):
132
"""Open the branch rooted at transport"""
133
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url, possible_transports=None):
138
"""Open an existing branch which contains url.
140
This probes for a branch at url, and searches upwards from there.
142
Basically we keep looking up until we find the control directory or
143
run into the root. If there isn't one, raises NotBranchError.
144
If there is one and it is either an unrecognised format or an unsupported
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
If there is one, it is returned, along with the unused portion of url.
148
control, relpath = bzrdir.BzrDir.open_containing(url,
150
return control.open_branch(), relpath
152
def get_config(self):
153
return BranchConfig(self)
156
return self.get_config().get_nickname()
158
def _set_nick(self, nick):
159
self.get_config().set_user_option('nickname', nick, warn_masked=True)
161
nick = property(_get_nick, _set_nick)
164
raise NotImplementedError(self.is_locked)
166
def lock_write(self):
167
raise NotImplementedError(self.lock_write)
170
raise NotImplementedError(self.lock_read)
173
raise NotImplementedError(self.unlock)
175
def peek_lock_mode(self):
176
"""Return lock mode for the Branch: 'r', 'w' or None"""
177
raise NotImplementedError(self.peek_lock_mode)
179
def get_physical_lock_status(self):
180
raise NotImplementedError(self.get_physical_lock_status)
183
def get_revision_id_to_revno_map(self):
184
"""Return the revision_id => dotted revno map.
186
This will be regenerated on demand, but will be cached.
188
:return: A dictionary mapping revision_id => dotted revno.
189
This dictionary should not be modified by the caller.
191
if self._revision_id_to_revno_cache is not None:
192
mapping = self._revision_id_to_revno_cache
194
mapping = self._gen_revno_map()
195
self._cache_revision_id_to_revno(mapping)
196
# TODO: jam 20070417 Since this is being cached, should we be returning
198
# I would rather not, and instead just declare that users should not
199
# modify the return value.
202
def _gen_revno_map(self):
203
"""Create a new mapping from revision ids to dotted revnos.
205
Dotted revnos are generated based on the current tip in the revision
207
This is the worker function for get_revision_id_to_revno_map, which
208
just caches the return value.
210
:return: A dictionary mapping revision_id => dotted revno.
212
last_revision = self.last_revision()
213
revision_graph = self.repository.get_revision_graph(last_revision)
214
merge_sorted_revisions = tsort.merge_sort(
219
revision_id_to_revno = dict((rev_id, revno)
220
for seq_num, rev_id, depth, revno, end_of_merge
221
in merge_sorted_revisions)
222
return revision_id_to_revno
224
def leave_lock_in_place(self):
225
"""Tell this branch object not to release the physical lock when this
228
If lock_write doesn't return a token, then this method is not supported.
230
self.control_files.leave_in_place()
232
def dont_leave_lock_in_place(self):
233
"""Tell this branch object to release the physical lock when this
234
object is unlocked, even if it didn't originally acquire it.
236
If lock_write doesn't return a token, then this method is not supported.
238
self.control_files.dont_leave_in_place()
240
def abspath(self, name):
241
"""Return absolute filename for something in the branch
243
XXX: Robert Collins 20051017 what is this used for? why is it a branch
244
method and not a tree method.
246
raise NotImplementedError(self.abspath)
248
def bind(self, other):
249
"""Bind the local branch the other branch.
251
:param other: The branch to bind to
254
raise errors.UpgradeRequired(self.base)
257
def fetch(self, from_branch, last_revision=None, pb=None):
258
"""Copy revisions from from_branch into this branch.
260
:param from_branch: Where to copy from.
261
:param last_revision: What revision to stop at (None for at the end
263
:param pb: An optional progress bar to use.
265
Returns the copied revision count and the failed revisions in a tuple:
268
if self.base == from_branch.base:
271
nested_pb = ui.ui_factory.nested_progress_bar()
276
from_branch.lock_read()
278
if last_revision is None:
279
pb.update('get source history')
280
last_revision = from_branch.last_revision()
281
if last_revision is None:
282
last_revision = _mod_revision.NULL_REVISION
283
return self.repository.fetch(from_branch.repository,
284
revision_id=last_revision,
287
if nested_pb is not None:
291
def get_bound_location(self):
292
"""Return the URL of the branch we are bound to.
294
Older format branches cannot bind, please be sure to use a metadir
299
def get_old_bound_location(self):
300
"""Return the URL of the branch we used to be bound to
302
raise errors.UpgradeRequired(self.base)
304
def get_commit_builder(self, parents, config=None, timestamp=None,
305
timezone=None, committer=None, revprops=None,
307
"""Obtain a CommitBuilder for this branch.
309
:param parents: Revision ids of the parents of the new revision.
310
:param config: Optional configuration to use.
311
:param timestamp: Optional timestamp recorded for commit.
312
:param timezone: Optional timezone for timestamp.
313
:param committer: Optional committer to set for commit.
314
:param revprops: Optional dictionary of revision properties.
315
:param revision_id: Optional revision id.
319
config = self.get_config()
321
return self.repository.get_commit_builder(self, parents, config,
322
timestamp, timezone, committer, revprops, revision_id)
324
def get_master_branch(self, possible_transports=None):
325
"""Return the branch we are bound to.
327
:return: Either a Branch, or None
331
def get_revision_delta(self, revno):
332
"""Return the delta for one revision.
334
The delta is relative to its mainline predecessor, or the
335
empty tree for revision 1.
337
assert isinstance(revno, int)
338
rh = self.revision_history()
339
if not (1 <= revno <= len(rh)):
340
raise InvalidRevisionNumber(revno)
341
return self.repository.get_revision_delta(rh[revno-1])
343
@deprecated_method(zero_sixteen)
344
def get_root_id(self):
345
"""Return the id of this branches root
347
Deprecated: branches don't have root ids-- trees do.
348
Use basis_tree().get_root_id() instead.
350
raise NotImplementedError(self.get_root_id)
352
def print_file(self, file, revision_id):
353
"""Print `file` to stdout."""
354
raise NotImplementedError(self.print_file)
356
def set_revision_history(self, rev_history):
357
raise NotImplementedError(self.set_revision_history)
359
def _cache_revision_history(self, rev_history):
360
"""Set the cached revision history to rev_history.
362
The revision_history method will use this cache to avoid regenerating
363
the revision history.
365
This API is semi-public; it only for use by subclasses, all other code
366
should consider it to be private.
368
self._revision_history_cache = rev_history
370
def _cache_revision_id_to_revno(self, revision_id_to_revno):
371
"""Set the cached revision_id => revno map to revision_id_to_revno.
373
This API is semi-public; it only for use by subclasses, all other code
374
should consider it to be private.
376
self._revision_id_to_revno_cache = revision_id_to_revno
378
def _clear_cached_state(self):
379
"""Clear any cached data on this branch, e.g. cached revision history.
381
This means the next call to revision_history will need to call
382
_gen_revision_history.
384
This API is semi-public; it only for use by subclasses, all other code
385
should consider it to be private.
387
self._revision_history_cache = None
388
self._revision_id_to_revno_cache = None
390
def _gen_revision_history(self):
391
"""Return sequence of revision hashes on to this branch.
393
Unlike revision_history, this method always regenerates or rereads the
394
revision history, i.e. it does not cache the result, so repeated calls
397
Concrete subclasses should override this instead of revision_history so
398
that subclasses do not need to deal with caching logic.
400
This API is semi-public; it only for use by subclasses, all other code
401
should consider it to be private.
403
raise NotImplementedError(self._gen_revision_history)
406
def revision_history(self):
407
"""Return sequence of revision hashes on to this branch.
409
This method will cache the revision history for as long as it is safe to
412
if self._revision_history_cache is not None:
413
history = self._revision_history_cache
415
history = self._gen_revision_history()
416
self._cache_revision_history(history)
420
"""Return current revision number for this branch.
422
That is equivalent to the number of revisions committed to
425
return len(self.revision_history())
428
"""Older format branches cannot bind or unbind."""
429
raise errors.UpgradeRequired(self.base)
431
def set_append_revisions_only(self, enabled):
432
"""Older format branches are never restricted to append-only"""
433
raise errors.UpgradeRequired(self.base)
435
def last_revision(self):
436
"""Return last revision id, or None"""
437
ph = self.revision_history()
441
return _mod_revision.NULL_REVISION
443
def last_revision_info(self):
444
"""Return information about the last revision.
446
:return: A tuple (revno, last_revision_id).
448
rh = self.revision_history()
451
return (revno, rh[-1])
453
return (0, _mod_revision.NULL_REVISION)
455
def missing_revisions(self, other, stop_revision=None):
456
"""Return a list of new revisions that would perfectly fit.
458
If self and other have not diverged, return a list of the revisions
459
present in other, but missing from self.
461
self_history = self.revision_history()
462
self_len = len(self_history)
463
other_history = other.revision_history()
464
other_len = len(other_history)
465
common_index = min(self_len, other_len) -1
466
if common_index >= 0 and \
467
self_history[common_index] != other_history[common_index]:
468
raise DivergedBranches(self, other)
470
if stop_revision is None:
471
stop_revision = other_len
473
assert isinstance(stop_revision, int)
474
if stop_revision > other_len:
475
raise errors.NoSuchRevision(self, stop_revision)
476
return other_history[self_len:stop_revision]
478
def update_revisions(self, other, stop_revision=None):
479
"""Pull in new perfect-fit revisions.
481
:param other: Another Branch to pull from
482
:param stop_revision: Updated until the given revision
485
raise NotImplementedError(self.update_revisions)
487
def revision_id_to_revno(self, revision_id):
488
"""Given a revision id, return its revno"""
489
if _mod_revision.is_null(revision_id):
491
revision_id = osutils.safe_revision_id(revision_id)
492
history = self.revision_history()
494
return history.index(revision_id) + 1
496
raise errors.NoSuchRevision(self, revision_id)
498
def get_rev_id(self, revno, history=None):
499
"""Find the revision id of the specified revno."""
501
return _mod_revision.NULL_REVISION
503
history = self.revision_history()
504
if revno <= 0 or revno > len(history):
505
raise errors.NoSuchRevision(self, revno)
506
return history[revno - 1]
508
def pull(self, source, overwrite=False, stop_revision=None,
509
possible_transports=None):
510
"""Mirror source into this branch.
512
This branch is considered to be 'local', having low latency.
514
:returns: PullResult instance
516
raise NotImplementedError(self.pull)
518
def push(self, target, overwrite=False, stop_revision=None):
519
"""Mirror this branch into target.
521
This branch is considered to be 'local', having low latency.
523
raise NotImplementedError(self.push)
525
def basis_tree(self):
526
"""Return `Tree` object for last revision."""
527
return self.repository.revision_tree(self.last_revision())
529
def rename_one(self, from_rel, to_rel):
532
This can change the directory or the filename or both.
534
raise NotImplementedError(self.rename_one)
536
def move(self, from_paths, to_name):
539
to_name must exist as a versioned directory.
541
If to_name exists and is a directory, the files are moved into
542
it, keeping their old names. If it is a directory,
544
Note that to_name is only the last component of the new name;
545
this doesn't change the directory.
547
This returns a list of (from_path, to_path) pairs for each
550
raise NotImplementedError(self.move)
552
def get_parent(self):
553
"""Return the parent location of the branch.
555
This is the default location for push/pull/missing. The usual
556
pattern is that the user can override it by specifying a
559
raise NotImplementedError(self.get_parent)
561
def _set_config_location(self, name, url, config=None,
562
make_relative=False):
564
config = self.get_config()
568
url = urlutils.relative_url(self.base, url)
569
config.set_user_option(name, url, warn_masked=True)
571
def _get_config_location(self, name, config=None):
573
config = self.get_config()
574
location = config.get_user_option(name)
579
def get_submit_branch(self):
580
"""Return the submit location of the branch.
582
This is the default location for bundle. The usual
583
pattern is that the user can override it by specifying a
586
return self.get_config().get_user_option('submit_branch')
588
def set_submit_branch(self, location):
589
"""Return the submit location of the branch.
591
This is the default location for bundle. The usual
592
pattern is that the user can override it by specifying a
595
self.get_config().set_user_option('submit_branch', location,
598
def get_public_branch(self):
599
"""Return the public location of the branch.
601
This is is used by merge directives.
603
return self._get_config_location('public_branch')
605
def set_public_branch(self, location):
606
"""Return the submit location of the branch.
608
This is the default location for bundle. The usual
609
pattern is that the user can override it by specifying a
612
self._set_config_location('public_branch', location)
614
def get_push_location(self):
615
"""Return the None or the location to push this branch to."""
616
push_loc = self.get_config().get_user_option('push_location')
619
def set_push_location(self, location):
620
"""Set a new push location for this branch."""
621
raise NotImplementedError(self.set_push_location)
623
def set_parent(self, url):
624
raise NotImplementedError(self.set_parent)
628
"""Synchronise this branch with the master branch if any.
630
:return: None or the last_revision pivoted out during the update.
634
def check_revno(self, revno):
636
Check whether a revno corresponds to any revision.
637
Zero (the NULL revision) is considered valid.
640
self.check_real_revno(revno)
642
def check_real_revno(self, revno):
644
Check whether a revno corresponds to a real revision.
645
Zero (the NULL revision) is considered invalid
647
if revno < 1 or revno > self.revno():
648
raise InvalidRevisionNumber(revno)
651
def clone(self, to_bzrdir, revision_id=None):
652
"""Clone this branch into to_bzrdir preserving all semantic values.
654
revision_id: if not None, the revision history in the new branch will
655
be truncated to end with revision_id.
657
result = self._format.initialize(to_bzrdir)
658
self.copy_content_into(result, revision_id=revision_id)
662
def sprout(self, to_bzrdir, revision_id=None):
663
"""Create a new line of development from the branch, into to_bzrdir.
665
revision_id: if not None, the revision history in the new branch will
666
be truncated to end with revision_id.
668
result = self._format.initialize(to_bzrdir)
669
self.copy_content_into(result, revision_id=revision_id)
670
result.set_parent(self.bzrdir.root_transport.base)
673
def _synchronize_history(self, destination, revision_id):
674
"""Synchronize last revision and revision history between branches.
676
This version is most efficient when the destination is also a
677
BzrBranch5, but works for BzrBranch6 as long as the revision
678
history is the true lefthand parent history, and all of the revisions
679
are in the destination's repository. If not, set_revision_history
682
:param destination: The branch to copy the history into
683
:param revision_id: The revision-id to truncate history at. May
684
be None to copy complete history.
686
if revision_id == _mod_revision.NULL_REVISION:
688
new_history = self.revision_history()
689
if revision_id is not None and new_history != []:
690
revision_id = osutils.safe_revision_id(revision_id)
692
new_history = new_history[:new_history.index(revision_id) + 1]
694
rev = self.repository.get_revision(revision_id)
695
new_history = rev.get_history(self.repository)[1:]
696
destination.set_revision_history(new_history)
699
def copy_content_into(self, destination, revision_id=None):
700
"""Copy the content of self into destination.
702
revision_id: if not None, the revision history in the new branch will
703
be truncated to end with revision_id.
705
self._synchronize_history(destination, revision_id)
707
parent = self.get_parent()
708
except errors.InaccessibleParent, e:
709
mutter('parent was not accessible to copy: %s', e)
712
destination.set_parent(parent)
713
self.tags.merge_to(destination.tags)
717
"""Check consistency of the branch.
719
In particular this checks that revisions given in the revision-history
720
do actually match up in the revision graph, and that they're all
721
present in the repository.
723
Callers will typically also want to check the repository.
725
:return: A BranchCheckResult.
727
mainline_parent_id = None
728
for revision_id in self.revision_history():
730
revision = self.repository.get_revision(revision_id)
731
except errors.NoSuchRevision, e:
732
raise errors.BzrCheckError("mainline revision {%s} not in repository"
734
# In general the first entry on the revision history has no parents.
735
# But it's not illegal for it to have parents listed; this can happen
736
# in imports from Arch when the parents weren't reachable.
737
if mainline_parent_id is not None:
738
if mainline_parent_id not in revision.parent_ids:
739
raise errors.BzrCheckError("previous revision {%s} not listed among "
741
% (mainline_parent_id, revision_id))
742
mainline_parent_id = revision_id
743
return BranchCheckResult(self)
745
def _get_checkout_format(self):
746
"""Return the most suitable metadir for a checkout of this branch.
747
Weaves are used if this branch's repository uses weaves.
749
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
750
from bzrlib.repofmt import weaverepo
751
format = bzrdir.BzrDirMetaFormat1()
752
format.repository_format = weaverepo.RepositoryFormat7()
754
format = self.repository.bzrdir.checkout_metadir()
755
format.set_branch_format(self._format)
758
def create_checkout(self, to_location, revision_id=None,
760
"""Create a checkout of a branch.
762
:param to_location: The url to produce the checkout at
763
:param revision_id: The revision to check out
764
:param lightweight: If True, produce a lightweight checkout, otherwise,
765
produce a bound branch (heavyweight checkout)
766
:return: The tree of the created checkout
768
t = transport.get_transport(to_location)
771
format = self._get_checkout_format()
772
checkout = format.initialize_on_transport(t)
773
BranchReferenceFormat().initialize(checkout, self)
775
format = self._get_checkout_format()
776
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
777
to_location, force_new_tree=False, format=format)
778
checkout = checkout_branch.bzrdir
779
checkout_branch.bind(self)
780
# pull up to the specified revision_id to set the initial
781
# branch tip correctly, and seed it with history.
782
checkout_branch.pull(self, stop_revision=revision_id)
783
tree = checkout.create_workingtree(revision_id)
784
basis_tree = tree.basis_tree()
785
basis_tree.lock_read()
787
for path, file_id in basis_tree.iter_references():
788
reference_parent = self.reference_parent(file_id, path)
789
reference_parent.create_checkout(tree.abspath(path),
790
basis_tree.get_reference_revision(file_id, path),
796
def reference_parent(self, file_id, path):
797
"""Return the parent branch for a tree-reference file_id
798
:param file_id: The file_id of the tree reference
799
:param path: The path of the file_id in the tree
800
:return: A branch associated with the file_id
802
# FIXME should provide multiple branches, based on config
803
return Branch.open(self.bzrdir.root_transport.clone(path).base)
805
def supports_tags(self):
806
return self._format.supports_tags()
809
class BranchFormat(object):
810
"""An encapsulation of the initialization and open routines for a format.
812
Formats provide three things:
813
* An initialization routine,
817
Formats are placed in an dict by their format string for reference
818
during branch opening. Its not required that these be instances, they
819
can be classes themselves with class methods - it simply depends on
820
whether state is needed for a given format or not.
822
Once a format is deprecated, just deprecate the initialize and open
823
methods on the format class. Do not deprecate the object, as the
824
object will be created every time regardless.
827
_default_format = None
828
"""The default format used for new branches."""
831
"""The known formats."""
833
def __eq__(self, other):
834
return self.__class__ is other.__class__
836
def __ne__(self, other):
837
return not (self == other)
840
def find_format(klass, a_bzrdir):
841
"""Return the format for the branch object in a_bzrdir."""
843
transport = a_bzrdir.get_branch_transport(None)
844
format_string = transport.get("format").read()
845
return klass._formats[format_string]
847
raise NotBranchError(path=transport.base)
849
raise errors.UnknownFormatError(format=format_string)
852
def get_default_format(klass):
853
"""Return the current default format."""
854
return klass._default_format
856
def get_reference(self, a_bzrdir):
857
"""Get the target reference of the branch in a_bzrdir.
859
format probing must have been completed before calling
860
this method - it is assumed that the format of the branch
861
in a_bzrdir is correct.
863
:param a_bzrdir: The bzrdir to get the branch data from.
864
:return: None if the branch is not a reference branch.
868
def get_format_string(self):
869
"""Return the ASCII format string that identifies this format."""
870
raise NotImplementedError(self.get_format_string)
872
def get_format_description(self):
873
"""Return the short format description for this format."""
874
raise NotImplementedError(self.get_format_description)
876
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
878
"""Initialize a branch in a bzrdir, with specified files
880
:param a_bzrdir: The bzrdir to initialize the branch in
881
:param utf8_files: The files to create as a list of
882
(filename, content) tuples
883
:param set_format: If True, set the format with
884
self.get_format_string. (BzrBranch4 has its format set
886
:return: a branch in this format
888
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
889
branch_transport = a_bzrdir.get_branch_transport(self)
891
'metadir': ('lock', lockdir.LockDir),
892
'branch4': ('branch-lock', lockable_files.TransportLock),
894
lock_name, lock_class = lock_map[lock_type]
895
control_files = lockable_files.LockableFiles(branch_transport,
896
lock_name, lock_class)
897
control_files.create_lock()
898
control_files.lock_write()
900
control_files.put_utf8('format', self.get_format_string())
902
for file, content in utf8_files:
903
control_files.put_utf8(file, content)
905
control_files.unlock()
906
return self.open(a_bzrdir, _found=True)
908
def initialize(self, a_bzrdir):
909
"""Create a branch of this format in a_bzrdir."""
910
raise NotImplementedError(self.initialize)
912
def is_supported(self):
913
"""Is this format supported?
915
Supported formats can be initialized and opened.
916
Unsupported formats may not support initialization or committing or
917
some other features depending on the reason for not being supported.
921
def open(self, a_bzrdir, _found=False):
922
"""Return the branch object for a_bzrdir
924
_found is a private parameter, do not use it. It is used to indicate
925
if format probing has already be done.
927
raise NotImplementedError(self.open)
930
def register_format(klass, format):
931
klass._formats[format.get_format_string()] = format
934
def set_default_format(klass, format):
935
klass._default_format = format
938
def unregister_format(klass, format):
939
assert klass._formats[format.get_format_string()] is format
940
del klass._formats[format.get_format_string()]
943
return self.get_format_string().rstrip()
945
def supports_tags(self):
946
"""True if this format supports tags stored in the branch"""
947
return False # by default
949
# XXX: Probably doesn't really belong here -- mbp 20070212
950
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
952
branch_transport = a_bzrdir.get_branch_transport(self)
953
control_files = lockable_files.LockableFiles(branch_transport,
954
lock_filename, lock_class)
955
control_files.create_lock()
956
control_files.lock_write()
958
for filename, content in utf8_files:
959
control_files.put_utf8(filename, content)
961
control_files.unlock()
964
class BranchHooks(Hooks):
965
"""A dictionary mapping hook name to a list of callables for branch hooks.
967
e.g. ['set_rh'] Is the list of items to be called when the
968
set_revision_history function is invoked.
972
"""Create the default hooks.
974
These are all empty initially, because by default nothing should get
978
# Introduced in 0.15:
979
# invoked whenever the revision history has been set
980
# with set_revision_history. The api signature is
981
# (branch, revision_history), and the branch will
984
# invoked after a push operation completes.
985
# the api signature is
987
# containing the members
988
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
989
# where local is the local target branch or None, master is the target
990
# master branch, and the rest should be self explanatory. The source
991
# is read locked and the target branches write locked. Source will
992
# be the local low-latency branch.
993
self['post_push'] = []
994
# invoked after a pull operation completes.
995
# the api signature is
997
# containing the members
998
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
999
# where local is the local branch or None, master is the target
1000
# master branch, and the rest should be self explanatory. The source
1001
# is read locked and the target branches write locked. The local
1002
# branch is the low-latency branch.
1003
self['post_pull'] = []
1004
# invoked before a commit operation takes place.
1005
# the api signature is
1006
# (local, master, old_revno, old_revid, future_revno, future_revid,
1007
# tree_delta, future_tree).
1008
# old_revid is NULL_REVISION for the first commit to a branch
1009
# tree_delta is a TreeDelta object describing changes from the basis
1010
# revision, hooks MUST NOT modify this delta
1011
# future_tree is an in-memory tree obtained from
1012
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1013
self['pre_commit'] = []
1014
# invoked after a commit operation completes.
1015
# the api signature is
1016
# (local, master, old_revno, old_revid, new_revno, new_revid)
1017
# old_revid is NULL_REVISION for the first commit to a branch.
1018
self['post_commit'] = []
1019
# invoked after a uncommit operation completes.
1020
# the api signature is
1021
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1022
# local is the local branch or None, master is the target branch,
1023
# and an empty branch recieves new_revno of 0, new_revid of None.
1024
self['post_uncommit'] = []
1027
# install the default hooks into the Branch class.
1028
Branch.hooks = BranchHooks()
1031
class BzrBranchFormat4(BranchFormat):
1032
"""Bzr branch format 4.
1035
- a revision-history file.
1036
- a branch-lock lock file [ to be shared with the bzrdir ]
1039
def get_format_description(self):
1040
"""See BranchFormat.get_format_description()."""
1041
return "Branch format 4"
1043
def initialize(self, a_bzrdir):
1044
"""Create a branch of this format in a_bzrdir."""
1045
utf8_files = [('revision-history', ''),
1046
('branch-name', ''),
1048
return self._initialize_helper(a_bzrdir, utf8_files,
1049
lock_type='branch4', set_format=False)
1052
super(BzrBranchFormat4, self).__init__()
1053
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1055
def open(self, a_bzrdir, _found=False):
1056
"""Return the branch object for a_bzrdir
1058
_found is a private parameter, do not use it. It is used to indicate
1059
if format probing has already be done.
1062
# we are being called directly and must probe.
1063
raise NotImplementedError
1064
return BzrBranch(_format=self,
1065
_control_files=a_bzrdir._control_files,
1067
_repository=a_bzrdir.open_repository())
1070
return "Bazaar-NG branch format 4"
1073
class BzrBranchFormat5(BranchFormat):
1074
"""Bzr branch format 5.
1077
- a revision-history file.
1079
- a lock dir guarding the branch itself
1080
- all of this stored in a branch/ subdirectory
1081
- works with shared repositories.
1083
This format is new in bzr 0.8.
1086
def get_format_string(self):
1087
"""See BranchFormat.get_format_string()."""
1088
return "Bazaar-NG branch format 5\n"
1090
def get_format_description(self):
1091
"""See BranchFormat.get_format_description()."""
1092
return "Branch format 5"
1094
def initialize(self, a_bzrdir):
1095
"""Create a branch of this format in a_bzrdir."""
1096
utf8_files = [('revision-history', ''),
1097
('branch-name', ''),
1099
return self._initialize_helper(a_bzrdir, utf8_files)
1102
super(BzrBranchFormat5, self).__init__()
1103
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1105
def open(self, a_bzrdir, _found=False):
1106
"""Return the branch object for a_bzrdir
1108
_found is a private parameter, do not use it. It is used to indicate
1109
if format probing has already be done.
1112
format = BranchFormat.find_format(a_bzrdir)
1113
assert format.__class__ == self.__class__
1115
transport = a_bzrdir.get_branch_transport(None)
1116
control_files = lockable_files.LockableFiles(transport, 'lock',
1118
return BzrBranch5(_format=self,
1119
_control_files=control_files,
1121
_repository=a_bzrdir.find_repository())
1123
raise NotBranchError(path=transport.base)
1126
class BzrBranchFormat6(BzrBranchFormat5):
1127
"""Branch format with last-revision and tags.
1129
Unlike previous formats, this has no explicit revision history. Instead,
1130
this just stores the last-revision, and the left-hand history leading
1131
up to there is the history.
1133
This format was introduced in bzr 0.15
1134
and became the default in 0.91.
1137
def get_format_string(self):
1138
"""See BranchFormat.get_format_string()."""
1139
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1141
def get_format_description(self):
1142
"""See BranchFormat.get_format_description()."""
1143
return "Branch format 6"
1145
def initialize(self, a_bzrdir):
1146
"""Create a branch of this format in a_bzrdir."""
1147
utf8_files = [('last-revision', '0 null:\n'),
1148
('branch-name', ''),
1149
('branch.conf', ''),
1152
return self._initialize_helper(a_bzrdir, utf8_files)
1154
def open(self, a_bzrdir, _found=False):
1155
"""Return the branch object for a_bzrdir
1157
_found is a private parameter, do not use it. It is used to indicate
1158
if format probing has already be done.
1161
format = BranchFormat.find_format(a_bzrdir)
1162
assert format.__class__ == self.__class__
1163
transport = a_bzrdir.get_branch_transport(None)
1164
control_files = lockable_files.LockableFiles(transport, 'lock',
1166
return BzrBranch6(_format=self,
1167
_control_files=control_files,
1169
_repository=a_bzrdir.find_repository())
1171
def supports_tags(self):
1175
class BranchReferenceFormat(BranchFormat):
1176
"""Bzr branch reference format.
1178
Branch references are used in implementing checkouts, they
1179
act as an alias to the real branch which is at some other url.
1186
def get_format_string(self):
1187
"""See BranchFormat.get_format_string()."""
1188
return "Bazaar-NG Branch Reference Format 1\n"
1190
def get_format_description(self):
1191
"""See BranchFormat.get_format_description()."""
1192
return "Checkout reference format 1"
1194
def get_reference(self, a_bzrdir):
1195
"""See BranchFormat.get_reference()."""
1196
transport = a_bzrdir.get_branch_transport(None)
1197
return transport.get('location').read()
1199
def initialize(self, a_bzrdir, target_branch=None):
1200
"""Create a branch of this format in a_bzrdir."""
1201
if target_branch is None:
1202
# this format does not implement branch itself, thus the implicit
1203
# creation contract must see it as uninitializable
1204
raise errors.UninitializableFormat(self)
1205
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1206
branch_transport = a_bzrdir.get_branch_transport(self)
1207
branch_transport.put_bytes('location',
1208
target_branch.bzrdir.root_transport.base)
1209
branch_transport.put_bytes('format', self.get_format_string())
1210
return self.open(a_bzrdir, _found=True)
1213
super(BranchReferenceFormat, self).__init__()
1214
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1216
def _make_reference_clone_function(format, a_branch):
1217
"""Create a clone() routine for a branch dynamically."""
1218
def clone(to_bzrdir, revision_id=None):
1219
"""See Branch.clone()."""
1220
return format.initialize(to_bzrdir, a_branch)
1221
# cannot obey revision_id limits when cloning a reference ...
1222
# FIXME RBC 20060210 either nuke revision_id for clone, or
1223
# emit some sort of warning/error to the caller ?!
1226
def open(self, a_bzrdir, _found=False, location=None):
1227
"""Return the branch that the branch reference in a_bzrdir points at.
1229
_found is a private parameter, do not use it. It is used to indicate
1230
if format probing has already be done.
1233
format = BranchFormat.find_format(a_bzrdir)
1234
assert format.__class__ == self.__class__
1235
if location is None:
1236
location = self.get_reference(a_bzrdir)
1237
real_bzrdir = bzrdir.BzrDir.open(location)
1238
result = real_bzrdir.open_branch()
1239
# this changes the behaviour of result.clone to create a new reference
1240
# rather than a copy of the content of the branch.
1241
# I did not use a proxy object because that needs much more extensive
1242
# testing, and we are only changing one behaviour at the moment.
1243
# If we decide to alter more behaviours - i.e. the implicit nickname
1244
# then this should be refactored to introduce a tested proxy branch
1245
# and a subclass of that for use in overriding clone() and ....
1247
result.clone = self._make_reference_clone_function(result)
1251
# formats which have no format string are not discoverable
1252
# and not independently creatable, so are not registered.
1253
__format5 = BzrBranchFormat5()
1254
__format6 = BzrBranchFormat6()
1255
BranchFormat.register_format(__format5)
1256
BranchFormat.register_format(BranchReferenceFormat())
1257
BranchFormat.register_format(__format6)
1258
BranchFormat.set_default_format(__format6)
1259
_legacy_formats = [BzrBranchFormat4(),
1262
class BzrBranch(Branch):
1263
"""A branch stored in the actual filesystem.
1265
Note that it's "local" in the context of the filesystem; it doesn't
1266
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1267
it's writable, and can be accessed via the normal filesystem API.
1270
def __init__(self, _format=None,
1271
_control_files=None, a_bzrdir=None, _repository=None):
1272
"""Create new branch object at a particular location."""
1273
Branch.__init__(self)
1274
if a_bzrdir is None:
1275
raise ValueError('a_bzrdir must be supplied')
1277
self.bzrdir = a_bzrdir
1278
# self._transport used to point to the directory containing the
1279
# control directory, but was not used - now it's just the transport
1280
# for the branch control files. mbp 20070212
1281
self._base = self.bzrdir.transport.clone('..').base
1282
self._format = _format
1283
if _control_files is None:
1284
raise ValueError('BzrBranch _control_files is None')
1285
self.control_files = _control_files
1286
self._transport = _control_files._transport
1287
self.repository = _repository
1290
return '%s(%r)' % (self.__class__.__name__, self.base)
1294
def _get_base(self):
1295
"""Returns the directory containing the control directory."""
1298
base = property(_get_base, doc="The URL for the root of this branch.")
1300
def abspath(self, name):
1301
"""See Branch.abspath."""
1302
return self.control_files._transport.abspath(name)
1305
@deprecated_method(zero_sixteen)
1307
def get_root_id(self):
1308
"""See Branch.get_root_id."""
1309
tree = self.repository.revision_tree(self.last_revision())
1310
return tree.inventory.root.file_id
1312
def is_locked(self):
1313
return self.control_files.is_locked()
1315
def lock_write(self, token=None):
1316
repo_token = self.repository.lock_write()
1318
token = self.control_files.lock_write(token=token)
1320
self.repository.unlock()
1324
def lock_read(self):
1325
self.repository.lock_read()
1327
self.control_files.lock_read()
1329
self.repository.unlock()
1333
# TODO: test for failed two phase locks. This is known broken.
1335
self.control_files.unlock()
1337
self.repository.unlock()
1338
if not self.control_files.is_locked():
1339
# we just released the lock
1340
self._clear_cached_state()
1342
def peek_lock_mode(self):
1343
if self.control_files._lock_count == 0:
1346
return self.control_files._lock_mode
1348
def get_physical_lock_status(self):
1349
return self.control_files.get_physical_lock_status()
1352
def print_file(self, file, revision_id):
1353
"""See Branch.print_file."""
1354
return self.repository.print_file(file, revision_id)
1356
def _write_revision_history(self, history):
1357
"""Factored out of set_revision_history.
1359
This performs the actual writing to disk.
1360
It is intended to be called by BzrBranch5.set_revision_history."""
1361
self.control_files.put_bytes(
1362
'revision-history', '\n'.join(history))
1365
def set_revision_history(self, rev_history):
1366
"""See Branch.set_revision_history."""
1367
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1368
self._clear_cached_state()
1369
self._write_revision_history(rev_history)
1370
self._cache_revision_history(rev_history)
1371
for hook in Branch.hooks['set_rh']:
1372
hook(self, rev_history)
1375
def set_last_revision_info(self, revno, revision_id):
1376
"""Set the last revision of this branch.
1378
The caller is responsible for checking that the revno is correct
1379
for this revision id.
1381
It may be possible to set the branch last revision to an id not
1382
present in the repository. However, branches can also be
1383
configured to check constraints on history, in which case this may not
1386
revision_id = osutils.safe_revision_id(revision_id)
1387
history = self._lefthand_history(revision_id)
1388
assert len(history) == revno, '%d != %d' % (len(history), revno)
1389
self.set_revision_history(history)
1391
def _gen_revision_history(self):
1392
history = self.control_files.get('revision-history').read().split('\n')
1393
if history[-1:] == ['']:
1394
# There shouldn't be a trailing newline, but just in case.
1398
def _lefthand_history(self, revision_id, last_rev=None,
1400
# stop_revision must be a descendant of last_revision
1401
stop_graph = self.repository.get_revision_graph(revision_id)
1402
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1403
and last_rev not in stop_graph):
1404
# our previous tip is not merged into stop_revision
1405
raise errors.DivergedBranches(self, other_branch)
1406
# make a new revision history from the graph
1407
current_rev_id = revision_id
1409
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1410
new_history.append(current_rev_id)
1411
current_rev_id_parents = stop_graph[current_rev_id]
1413
current_rev_id = current_rev_id_parents[0]
1415
current_rev_id = None
1416
new_history.reverse()
1420
def generate_revision_history(self, revision_id, last_rev=None,
1422
"""Create a new revision history that will finish with revision_id.
1424
:param revision_id: the new tip to use.
1425
:param last_rev: The previous last_revision. If not None, then this
1426
must be a ancestory of revision_id, or DivergedBranches is raised.
1427
:param other_branch: The other branch that DivergedBranches should
1428
raise with respect to.
1430
revision_id = osutils.safe_revision_id(revision_id)
1431
self.set_revision_history(self._lefthand_history(revision_id,
1432
last_rev, other_branch))
1435
def update_revisions(self, other, stop_revision=None):
1436
"""See Branch.update_revisions."""
1439
if stop_revision is None:
1440
stop_revision = other.last_revision()
1441
if stop_revision is None:
1442
# if there are no commits, we're done.
1445
stop_revision = osutils.safe_revision_id(stop_revision)
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 regardless of whether we need to so that we pickup
1451
self.fetch(other, stop_revision)
1452
if self.repository.get_graph().is_ancestor(stop_revision,
1455
self.generate_revision_history(stop_revision, last_rev=last_rev,
1460
def basis_tree(self):
1461
"""See Branch.basis_tree."""
1462
return self.repository.revision_tree(self.last_revision())
1465
def pull(self, source, overwrite=False, stop_revision=None,
1466
_hook_master=None, run_hooks=True, possible_transports=None):
1469
:param _hook_master: Private parameter - set the branch to
1470
be supplied as the master to push hooks.
1471
:param run_hooks: Private parameter - if false, this branch
1472
is being called because it's the master of the primary branch,
1473
so it should not run its hooks.
1475
result = PullResult()
1476
result.source_branch = source
1477
result.target_branch = self
1480
result.old_revno, result.old_revid = self.last_revision_info()
1482
self.update_revisions(source, stop_revision)
1483
except DivergedBranches:
1487
if stop_revision is None:
1488
stop_revision = source.last_revision()
1489
self.generate_revision_history(stop_revision)
1490
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1491
result.new_revno, result.new_revid = self.last_revision_info()
1493
result.master_branch = _hook_master
1494
result.local_branch = self
1496
result.master_branch = self
1497
result.local_branch = None
1499
for hook in Branch.hooks['post_pull']:
1505
def _get_parent_location(self):
1506
_locs = ['parent', 'pull', 'x-pull']
1509
return self.control_files.get(l).read().strip('\n')
1515
def push(self, target, overwrite=False, stop_revision=None,
1516
_override_hook_source_branch=None):
1519
This is the basic concrete implementation of push()
1521
:param _override_hook_source_branch: If specified, run
1522
the hooks passing this Branch as the source, rather than self.
1523
This is for use of RemoteBranch, where push is delegated to the
1524
underlying vfs-based Branch.
1526
# TODO: Public option to disable running hooks - should be trivial but
1530
result = self._push_with_bound_branches(target, overwrite,
1532
_override_hook_source_branch=_override_hook_source_branch)
1537
def _push_with_bound_branches(self, target, overwrite,
1539
_override_hook_source_branch=None):
1540
"""Push from self into target, and into target's master if any.
1542
This is on the base BzrBranch class even though it doesn't support
1543
bound branches because the *target* might be bound.
1546
if _override_hook_source_branch:
1547
result.source_branch = _override_hook_source_branch
1548
for hook in Branch.hooks['post_push']:
1551
bound_location = target.get_bound_location()
1552
if bound_location and target.base != bound_location:
1553
# there is a master branch.
1555
# XXX: Why the second check? Is it even supported for a branch to
1556
# be bound to itself? -- mbp 20070507
1557
master_branch = target.get_master_branch()
1558
master_branch.lock_write()
1560
# push into the master from this branch.
1561
self._basic_push(master_branch, overwrite, stop_revision)
1562
# and push into the target branch from this. Note that we push from
1563
# this branch again, because its considered the highest bandwidth
1565
result = self._basic_push(target, overwrite, stop_revision)
1566
result.master_branch = master_branch
1567
result.local_branch = target
1571
master_branch.unlock()
1574
result = self._basic_push(target, overwrite, stop_revision)
1575
# TODO: Why set master_branch and local_branch if there's no
1576
# binding? Maybe cleaner to just leave them unset? -- mbp
1578
result.master_branch = target
1579
result.local_branch = None
1583
def _basic_push(self, target, overwrite, stop_revision):
1584
"""Basic implementation of push without bound branches or hooks.
1586
Must be called with self read locked and target write locked.
1588
result = PushResult()
1589
result.source_branch = self
1590
result.target_branch = target
1591
result.old_revno, result.old_revid = target.last_revision_info()
1593
target.update_revisions(self, stop_revision)
1594
except DivergedBranches:
1598
target.set_revision_history(self.revision_history())
1599
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1600
result.new_revno, result.new_revid = target.last_revision_info()
1603
def get_parent(self):
1604
"""See Branch.get_parent."""
1606
assert self.base[-1] == '/'
1607
parent = self._get_parent_location()
1610
# This is an old-format absolute path to a local branch
1611
# turn it into a url
1612
if parent.startswith('/'):
1613
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1615
return urlutils.join(self.base[:-1], parent)
1616
except errors.InvalidURLJoin, e:
1617
raise errors.InaccessibleParent(parent, self.base)
1619
def set_push_location(self, location):
1620
"""See Branch.set_push_location."""
1621
self.get_config().set_user_option(
1622
'push_location', location,
1623
store=_mod_config.STORE_LOCATION_NORECURSE)
1626
def set_parent(self, url):
1627
"""See Branch.set_parent."""
1628
# TODO: Maybe delete old location files?
1629
# URLs should never be unicode, even on the local fs,
1630
# FIXUP this and get_parent in a future branch format bump:
1631
# read and rewrite the file, and have the new format code read
1632
# using .get not .get_utf8. RBC 20060125
1634
if isinstance(url, unicode):
1636
url = url.encode('ascii')
1637
except UnicodeEncodeError:
1638
raise errors.InvalidURL(url,
1639
"Urls must be 7-bit ascii, "
1640
"use bzrlib.urlutils.escape")
1641
url = urlutils.relative_url(self.base, url)
1642
self._set_parent_location(url)
1644
def _set_parent_location(self, url):
1646
self.control_files._transport.delete('parent')
1648
assert isinstance(url, str)
1649
self.control_files.put_bytes('parent', url + '\n')
1652
class BzrBranch5(BzrBranch):
1653
"""A format 5 branch. This supports new features over plain branches.
1655
It has support for a master_branch which is the data for bound branches.
1663
super(BzrBranch5, self).__init__(_format=_format,
1664
_control_files=_control_files,
1666
_repository=_repository)
1669
def pull(self, source, overwrite=False, stop_revision=None,
1670
run_hooks=True, possible_transports=None):
1671
"""Pull from source into self, updating my master if any.
1673
:param run_hooks: Private parameter - if false, this branch
1674
is being called because it's the master of the primary branch,
1675
so it should not run its hooks.
1677
bound_location = self.get_bound_location()
1678
master_branch = None
1679
if bound_location and source.base != bound_location:
1680
# not pulling from master, so we need to update master.
1681
master_branch = self.get_master_branch(possible_transports)
1682
master_branch.lock_write()
1685
# pull from source into master.
1686
master_branch.pull(source, overwrite, stop_revision,
1688
return super(BzrBranch5, self).pull(source, overwrite,
1689
stop_revision, _hook_master=master_branch,
1690
run_hooks=run_hooks)
1693
master_branch.unlock()
1695
def get_bound_location(self):
1697
return self.control_files.get_utf8('bound').read()[:-1]
1698
except errors.NoSuchFile:
1702
def get_master_branch(self, possible_transports=None):
1703
"""Return the branch we are bound to.
1705
:return: Either a Branch, or None
1707
This could memoise the branch, but if thats done
1708
it must be revalidated on each new lock.
1709
So for now we just don't memoise it.
1710
# RBC 20060304 review this decision.
1712
bound_loc = self.get_bound_location()
1716
return Branch.open(bound_loc,
1717
possible_transports=possible_transports)
1718
except (errors.NotBranchError, errors.ConnectionError), e:
1719
raise errors.BoundBranchConnectionFailure(
1723
def set_bound_location(self, location):
1724
"""Set the target where this branch is bound to.
1726
:param location: URL to the target branch
1729
self.control_files.put_utf8('bound', location+'\n')
1732
self.control_files._transport.delete('bound')
1738
def bind(self, other):
1739
"""Bind this branch to the branch other.
1741
This does not push or pull data between the branches, though it does
1742
check for divergence to raise an error when the branches are not
1743
either the same, or one a prefix of the other. That behaviour may not
1744
be useful, so that check may be removed in future.
1746
:param other: The branch to bind to
1749
# TODO: jam 20051230 Consider checking if the target is bound
1750
# It is debatable whether you should be able to bind to
1751
# a branch which is itself bound.
1752
# Committing is obviously forbidden,
1753
# but binding itself may not be.
1754
# Since we *have* to check at commit time, we don't
1755
# *need* to check here
1757
# we want to raise diverged if:
1758
# last_rev is not in the other_last_rev history, AND
1759
# other_last_rev is not in our history, and do it without pulling
1761
last_rev = _mod_revision.ensure_null(self.last_revision())
1762
if last_rev != _mod_revision.NULL_REVISION:
1765
other_last_rev = other.last_revision()
1766
if not _mod_revision.is_null(other_last_rev):
1767
# neither branch is new, we have to do some work to
1768
# ascertain diversion.
1769
remote_graph = other.repository.get_revision_graph(
1771
local_graph = self.repository.get_revision_graph(last_rev)
1772
if (last_rev not in remote_graph and
1773
other_last_rev not in local_graph):
1774
raise errors.DivergedBranches(self, other)
1777
self.set_bound_location(other.base)
1781
"""If bound, unbind"""
1782
return self.set_bound_location(None)
1785
def update(self, possible_transports=None):
1786
"""Synchronise this branch with the master branch if any.
1788
:return: None or the last_revision that was pivoted out during the
1791
master = self.get_master_branch(possible_transports)
1792
if master is not None:
1793
old_tip = _mod_revision.ensure_null(self.last_revision())
1794
self.pull(master, overwrite=True)
1795
if self.repository.get_graph().is_ancestor(old_tip,
1796
_mod_revision.ensure_null(self.last_revision())):
1802
class BzrBranchExperimental(BzrBranch5):
1803
"""Bzr experimental branch format
1806
- a revision-history file.
1808
- a lock dir guarding the branch itself
1809
- all of this stored in a branch/ subdirectory
1810
- works with shared repositories.
1811
- a tag dictionary in the branch
1813
This format is new in bzr 0.15, but shouldn't be used for real data,
1816
This class acts as it's own BranchFormat.
1819
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1822
def get_format_string(cls):
1823
"""See BranchFormat.get_format_string()."""
1824
return "Bazaar-NG branch format experimental\n"
1827
def get_format_description(cls):
1828
"""See BranchFormat.get_format_description()."""
1829
return "Experimental branch format"
1832
def get_reference(cls, a_bzrdir):
1833
"""Get the target reference of the branch in a_bzrdir.
1835
format probing must have been completed before calling
1836
this method - it is assumed that the format of the branch
1837
in a_bzrdir is correct.
1839
:param a_bzrdir: The bzrdir to get the branch data from.
1840
:return: None if the branch is not a reference branch.
1845
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1847
branch_transport = a_bzrdir.get_branch_transport(cls)
1848
control_files = lockable_files.LockableFiles(branch_transport,
1849
lock_filename, lock_class)
1850
control_files.create_lock()
1851
control_files.lock_write()
1853
for filename, content in utf8_files:
1854
control_files.put_utf8(filename, content)
1856
control_files.unlock()
1859
def initialize(cls, a_bzrdir):
1860
"""Create a branch of this format in a_bzrdir."""
1861
utf8_files = [('format', cls.get_format_string()),
1862
('revision-history', ''),
1863
('branch-name', ''),
1866
cls._initialize_control_files(a_bzrdir, utf8_files,
1867
'lock', lockdir.LockDir)
1868
return cls.open(a_bzrdir, _found=True)
1871
def open(cls, a_bzrdir, _found=False):
1872
"""Return the branch object for a_bzrdir
1874
_found is a private parameter, do not use it. It is used to indicate
1875
if format probing has already be done.
1878
format = BranchFormat.find_format(a_bzrdir)
1879
assert format.__class__ == cls
1880
transport = a_bzrdir.get_branch_transport(None)
1881
control_files = lockable_files.LockableFiles(transport, 'lock',
1883
return cls(_format=cls,
1884
_control_files=control_files,
1886
_repository=a_bzrdir.find_repository())
1889
def is_supported(cls):
1892
def _make_tags(self):
1893
return BasicTags(self)
1896
def supports_tags(cls):
1900
BranchFormat.register_format(BzrBranchExperimental)
1903
class BzrBranch6(BzrBranch5):
1906
def last_revision_info(self):
1907
revision_string = self.control_files.get('last-revision').read()
1908
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1909
revision_id = cache_utf8.get_cached_utf8(revision_id)
1911
return revno, revision_id
1913
def last_revision(self):
1914
"""Return last revision id, or None"""
1915
revision_id = self.last_revision_info()[1]
1918
def _write_last_revision_info(self, revno, revision_id):
1919
"""Simply write out the revision id, with no checks.
1921
Use set_last_revision_info to perform this safely.
1923
Does not update the revision_history cache.
1924
Intended to be called by set_last_revision_info and
1925
_write_revision_history.
1927
if revision_id is None:
1928
revision_id = 'null:'
1929
out_string = '%d %s\n' % (revno, revision_id)
1930
self.control_files.put_bytes('last-revision', out_string)
1933
def set_last_revision_info(self, revno, revision_id):
1934
revision_id = osutils.safe_revision_id(revision_id)
1935
if self._get_append_revisions_only():
1936
self._check_history_violation(revision_id)
1937
self._write_last_revision_info(revno, revision_id)
1938
self._clear_cached_state()
1940
def _check_history_violation(self, revision_id):
1941
last_revision = _mod_revision.ensure_null(self.last_revision())
1942
if _mod_revision.is_null(last_revision):
1944
if last_revision not in self._lefthand_history(revision_id):
1945
raise errors.AppendRevisionsOnlyViolation(self.base)
1947
def _gen_revision_history(self):
1948
"""Generate the revision history from last revision
1950
history = list(self.repository.iter_reverse_revision_history(
1951
self.last_revision()))
1955
def _write_revision_history(self, history):
1956
"""Factored out of set_revision_history.
1958
This performs the actual writing to disk, with format-specific checks.
1959
It is intended to be called by BzrBranch5.set_revision_history.
1961
if len(history) == 0:
1962
last_revision = 'null:'
1964
if history != self._lefthand_history(history[-1]):
1965
raise errors.NotLefthandHistory(history)
1966
last_revision = history[-1]
1967
if self._get_append_revisions_only():
1968
self._check_history_violation(last_revision)
1969
self._write_last_revision_info(len(history), last_revision)
1972
def _set_parent_location(self, url):
1973
"""Set the parent branch"""
1974
self._set_config_location('parent_location', url, make_relative=True)
1977
def _get_parent_location(self):
1978
"""Set the parent branch"""
1979
return self._get_config_location('parent_location')
1981
def set_push_location(self, location):
1982
"""See Branch.set_push_location."""
1983
self._set_config_location('push_location', location)
1985
def set_bound_location(self, location):
1986
"""See Branch.set_push_location."""
1988
config = self.get_config()
1989
if location is None:
1990
if config.get_user_option('bound') != 'True':
1993
config.set_user_option('bound', 'False', warn_masked=True)
1996
self._set_config_location('bound_location', location,
1998
config.set_user_option('bound', 'True', warn_masked=True)
2001
def _get_bound_location(self, bound):
2002
"""Return the bound location in the config file.
2004
Return None if the bound parameter does not match"""
2005
config = self.get_config()
2006
config_bound = (config.get_user_option('bound') == 'True')
2007
if config_bound != bound:
2009
return self._get_config_location('bound_location', config=config)
2011
def get_bound_location(self):
2012
"""See Branch.set_push_location."""
2013
return self._get_bound_location(True)
2015
def get_old_bound_location(self):
2016
"""See Branch.get_old_bound_location"""
2017
return self._get_bound_location(False)
2019
def set_append_revisions_only(self, enabled):
2024
self.get_config().set_user_option('append_revisions_only', value,
2027
def _get_append_revisions_only(self):
2028
value = self.get_config().get_user_option('append_revisions_only')
2029
return value == 'True'
2031
def _synchronize_history(self, destination, revision_id):
2032
"""Synchronize last revision and revision history between branches.
2034
This version is most efficient when the destination is also a
2035
BzrBranch6, but works for BzrBranch5, as long as the destination's
2036
repository contains all the lefthand ancestors of the intended
2037
last_revision. If not, set_last_revision_info will fail.
2039
:param destination: The branch to copy the history into
2040
:param revision_id: The revision-id to truncate history at. May
2041
be None to copy complete history.
2043
source_revno, source_revision_id = self.last_revision_info()
2044
if revision_id is None:
2045
revno, revision_id = source_revno, source_revision_id
2046
elif source_revision_id == revision_id:
2047
# we know the revno without needing to walk all of history
2048
revno = source_revno
2050
# To figure out the revno for a random revision, we need to build
2051
# the revision history, and count its length.
2052
# We don't care about the order, just how long it is.
2053
# Alternatively, we could start at the current location, and count
2054
# backwards. But there is no guarantee that we will find it since
2055
# it may be a merged revision.
2056
revno = len(list(self.repository.iter_reverse_revision_history(
2058
destination.set_last_revision_info(revno, revision_id)
2060
def _make_tags(self):
2061
return BasicTags(self)
2064
######################################################################
2065
# results of operations
2068
class _Result(object):
2070
def _show_tag_conficts(self, to_file):
2071
if not getattr(self, 'tag_conflicts', None):
2073
to_file.write('Conflicting tags:\n')
2074
for name, value1, value2 in self.tag_conflicts:
2075
to_file.write(' %s\n' % (name, ))
2078
class PullResult(_Result):
2079
"""Result of a Branch.pull operation.
2081
:ivar old_revno: Revision number before pull.
2082
:ivar new_revno: Revision number after pull.
2083
:ivar old_revid: Tip revision id before pull.
2084
:ivar new_revid: Tip revision id after pull.
2085
:ivar source_branch: Source (local) branch object.
2086
:ivar master_branch: Master branch of the target, or None.
2087
:ivar target_branch: Target/destination branch object.
2091
# DEPRECATED: pull used to return the change in revno
2092
return self.new_revno - self.old_revno
2094
def report(self, to_file):
2095
if self.old_revid == self.new_revid:
2096
to_file.write('No revisions to pull.\n')
2098
to_file.write('Now on revision %d.\n' % self.new_revno)
2099
self._show_tag_conficts(to_file)
2102
class PushResult(_Result):
2103
"""Result of a Branch.push operation.
2105
:ivar old_revno: Revision number before push.
2106
:ivar new_revno: Revision number after push.
2107
:ivar old_revid: Tip revision id before push.
2108
:ivar new_revid: Tip revision id after push.
2109
:ivar source_branch: Source branch object.
2110
:ivar master_branch: Master branch of the target, or None.
2111
:ivar target_branch: Target/destination branch object.
2115
# DEPRECATED: push used to return the change in revno
2116
return self.new_revno - self.old_revno
2118
def report(self, to_file):
2119
"""Write a human-readable description of the result."""
2120
if self.old_revid == self.new_revid:
2121
to_file.write('No new revisions to push.\n')
2123
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2124
self._show_tag_conficts(to_file)
2127
class BranchCheckResult(object):
2128
"""Results of checking branch consistency.
2133
def __init__(self, branch):
2134
self.branch = branch
2136
def report_results(self, verbose):
2137
"""Report the check results via trace.note.
2139
:param verbose: Requests more detailed display of what was checked,
2142
note('checked branch %s format %s',
2144
self.branch._format)
2147
class Converter5to6(object):
2148
"""Perform an in-place upgrade of format 5 to format 6"""
2150
def convert(self, branch):
2151
# Data for 5 and 6 can peacefully coexist.
2152
format = BzrBranchFormat6()
2153
new_branch = format.open(branch.bzrdir, _found=True)
2155
# Copy source data into target
2156
new_branch.set_last_revision_info(*branch.last_revision_info())
2157
new_branch.set_parent(branch.get_parent())
2158
new_branch.set_bound_location(branch.get_bound_location())
2159
new_branch.set_push_location(branch.get_push_location())
2161
# New branch has no tags by default
2162
new_branch.tags._set_tag_dict({})
2164
# Copying done; now update target format
2165
new_branch.control_files.put_utf8('format',
2166
format.get_format_string())
2168
# Clean up old files
2169
new_branch.control_files._transport.delete('revision-history')
2171
branch.set_parent(None)
2174
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
