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,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
84
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
self._revision_history_cache = None
102
self._revision_id_to_revno_cache = None
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
def open(base, _unsupported=False):
120
"""Open the branch rooted at base.
122
For instance, if the branch is at URL/.bzr/branch,
123
Branch.open(URL) -> a Branch instance.
125
control = bzrdir.BzrDir.open(base, _unsupported)
126
return control.open_branch(_unsupported)
129
def open_from_transport(transport, _unsupported=False):
130
"""Open the branch rooted at transport"""
131
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url, possible_transports=None):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url,
148
return control.open_branch(), relpath
150
def get_config(self):
151
return BranchConfig(self)
154
return self.get_config().get_nickname()
156
def _set_nick(self, nick):
157
self.get_config().set_user_option('nickname', nick, warn_masked=True)
159
nick = property(_get_nick, _set_nick)
162
raise NotImplementedError(self.is_locked)
164
def lock_write(self):
165
raise NotImplementedError(self.lock_write)
168
raise NotImplementedError(self.lock_read)
171
raise NotImplementedError(self.unlock)
173
def peek_lock_mode(self):
174
"""Return lock mode for the Branch: 'r', 'w' or None"""
175
raise NotImplementedError(self.peek_lock_mode)
177
def get_physical_lock_status(self):
178
raise NotImplementedError(self.get_physical_lock_status)
181
def get_revision_id_to_revno_map(self):
182
"""Return the revision_id => dotted revno map.
184
This will be regenerated on demand, but will be cached.
186
:return: A dictionary mapping revision_id => dotted revno.
187
This dictionary should not be modified by the caller.
189
if self._revision_id_to_revno_cache is not None:
190
mapping = self._revision_id_to_revno_cache
192
mapping = self._gen_revno_map()
193
self._cache_revision_id_to_revno(mapping)
194
# TODO: jam 20070417 Since this is being cached, should we be returning
196
# I would rather not, and instead just declare that users should not
197
# modify the return value.
200
def _gen_revno_map(self):
201
"""Create a new mapping from revision ids to dotted revnos.
203
Dotted revnos are generated based on the current tip in the revision
205
This is the worker function for get_revision_id_to_revno_map, which
206
just caches the return value.
208
:return: A dictionary mapping revision_id => dotted revno.
210
last_revision = self.last_revision()
211
revision_graph = self.repository.get_revision_graph(last_revision)
212
merge_sorted_revisions = tsort.merge_sort(
217
revision_id_to_revno = dict((rev_id, revno)
218
for seq_num, rev_id, depth, revno, end_of_merge
219
in merge_sorted_revisions)
220
return revision_id_to_revno
222
def leave_lock_in_place(self):
223
"""Tell this branch object not to release the physical lock when this
226
If lock_write doesn't return a token, then this method is not supported.
228
self.control_files.leave_in_place()
230
def dont_leave_lock_in_place(self):
231
"""Tell this branch object to release the physical lock when this
232
object is unlocked, even if it didn't originally acquire it.
234
If lock_write doesn't return a token, then this method is not supported.
236
self.control_files.dont_leave_in_place()
238
def abspath(self, name):
239
"""Return absolute filename for something in the branch
241
XXX: Robert Collins 20051017 what is this used for? why is it a branch
242
method and not a tree method.
244
raise NotImplementedError(self.abspath)
246
def bind(self, other):
247
"""Bind the local branch the other branch.
249
:param other: The branch to bind to
252
raise errors.UpgradeRequired(self.base)
255
def fetch(self, from_branch, last_revision=None, pb=None):
256
"""Copy revisions from from_branch into this branch.
258
:param from_branch: Where to copy from.
259
:param last_revision: What revision to stop at (None for at the end
261
:param pb: An optional progress bar to use.
263
Returns the copied revision count and the failed revisions in a tuple:
266
if self.base == from_branch.base:
269
nested_pb = ui.ui_factory.nested_progress_bar()
274
from_branch.lock_read()
276
if last_revision is None:
277
pb.update('get source history')
278
last_revision = from_branch.last_revision()
279
if last_revision is None:
280
last_revision = _mod_revision.NULL_REVISION
281
return self.repository.fetch(from_branch.repository,
282
revision_id=last_revision,
285
if nested_pb is not None:
289
def get_bound_location(self):
290
"""Return the URL of the branch we are bound to.
292
Older format branches cannot bind, please be sure to use a metadir
297
def get_old_bound_location(self):
298
"""Return the URL of the branch we used to be bound to
300
raise errors.UpgradeRequired(self.base)
302
def get_commit_builder(self, parents, config=None, timestamp=None,
303
timezone=None, committer=None, revprops=None,
305
"""Obtain a CommitBuilder for this branch.
307
:param parents: Revision ids of the parents of the new revision.
308
:param config: Optional configuration to use.
309
:param timestamp: Optional timestamp recorded for commit.
310
:param timezone: Optional timezone for timestamp.
311
:param committer: Optional committer to set for commit.
312
:param revprops: Optional dictionary of revision properties.
313
:param revision_id: Optional revision id.
317
config = self.get_config()
319
return self.repository.get_commit_builder(self, parents, config,
320
timestamp, timezone, committer, revprops, revision_id)
322
def get_master_branch(self):
323
"""Return the branch we are bound to.
325
:return: Either a Branch, or None
329
def get_revision_delta(self, revno):
330
"""Return the delta for one revision.
332
The delta is relative to its mainline predecessor, or the
333
empty tree for revision 1.
335
assert isinstance(revno, int)
336
rh = self.revision_history()
337
if not (1 <= revno <= len(rh)):
338
raise InvalidRevisionNumber(revno)
339
return self.repository.get_revision_delta(rh[revno-1])
341
@deprecated_method(zero_sixteen)
342
def get_root_id(self):
343
"""Return the id of this branches root
345
Deprecated: branches don't have root ids-- trees do.
346
Use basis_tree().get_root_id() instead.
348
raise NotImplementedError(self.get_root_id)
350
def print_file(self, file, revision_id):
351
"""Print `file` to stdout."""
352
raise NotImplementedError(self.print_file)
354
def append_revision(self, *revision_ids):
355
raise NotImplementedError(self.append_revision)
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 hashes on to this branch.
410
This method will cache the revision history for as long as it is safe to
413
if self._revision_history_cache is not None:
414
history = self._revision_history_cache
416
history = self._gen_revision_history()
417
self._cache_revision_history(history)
421
"""Return current revision number for this branch.
423
That is equivalent to the number of revisions committed to
426
return len(self.revision_history())
429
"""Older format branches cannot bind or unbind."""
430
raise errors.UpgradeRequired(self.base)
432
def set_append_revisions_only(self, enabled):
433
"""Older format branches are never restricted to append-only"""
434
raise errors.UpgradeRequired(self.base)
436
def last_revision(self):
437
"""Return last revision id, or None"""
438
ph = self.revision_history()
444
def last_revision_info(self):
445
"""Return information about the last revision.
447
:return: A tuple (revno, last_revision_id).
449
rh = self.revision_history()
452
return (revno, rh[-1])
454
return (0, _mod_revision.NULL_REVISION)
456
def missing_revisions(self, other, stop_revision=None):
457
"""Return a list of new revisions that would perfectly fit.
459
If self and other have not diverged, return a list of the revisions
460
present in other, but missing from self.
462
self_history = self.revision_history()
463
self_len = len(self_history)
464
other_history = other.revision_history()
465
other_len = len(other_history)
466
common_index = min(self_len, other_len) -1
467
if common_index >= 0 and \
468
self_history[common_index] != other_history[common_index]:
469
raise DivergedBranches(self, other)
471
if stop_revision is None:
472
stop_revision = other_len
474
assert isinstance(stop_revision, int)
475
if stop_revision > other_len:
476
raise errors.NoSuchRevision(self, stop_revision)
477
return other_history[self_len:stop_revision]
479
def update_revisions(self, other, stop_revision=None):
480
"""Pull in new perfect-fit revisions.
482
:param other: Another Branch to pull from
483
:param stop_revision: Updated until the given revision
486
raise NotImplementedError(self.update_revisions)
488
def revision_id_to_revno(self, revision_id):
489
"""Given a revision id, return its revno"""
490
if _mod_revision.is_null(revision_id):
492
revision_id = osutils.safe_revision_id(revision_id)
493
history = self.revision_history()
495
return history.index(revision_id) + 1
497
raise errors.NoSuchRevision(self, revision_id)
499
def get_rev_id(self, revno, history=None):
500
"""Find the revision id of the specified revno."""
504
history = self.revision_history()
505
if revno <= 0 or revno > len(history):
506
raise errors.NoSuchRevision(self, revno)
507
return history[revno - 1]
509
def pull(self, source, overwrite=False, stop_revision=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 after a commit operation completes.
1005
# the api signature is
1006
# (local, master, old_revno, old_revid, new_revno, new_revid)
1007
# old_revid is NULL_REVISION for the first commit to a branch.
1008
self['post_commit'] = []
1009
# invoked after a uncommit operation completes.
1010
# the api signature is
1011
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1012
# local is the local branch or None, master is the target branch,
1013
# and an empty branch recieves new_revno of 0, new_revid of None.
1014
self['post_uncommit'] = []
1017
# install the default hooks into the Branch class.
1018
Branch.hooks = BranchHooks()
1021
class BzrBranchFormat4(BranchFormat):
1022
"""Bzr branch format 4.
1025
- a revision-history file.
1026
- a branch-lock lock file [ to be shared with the bzrdir ]
1029
def get_format_description(self):
1030
"""See BranchFormat.get_format_description()."""
1031
return "Branch format 4"
1033
def initialize(self, a_bzrdir):
1034
"""Create a branch of this format in a_bzrdir."""
1035
utf8_files = [('revision-history', ''),
1036
('branch-name', ''),
1038
return self._initialize_helper(a_bzrdir, utf8_files,
1039
lock_type='branch4', set_format=False)
1042
super(BzrBranchFormat4, self).__init__()
1043
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1045
def open(self, a_bzrdir, _found=False):
1046
"""Return the branch object for a_bzrdir
1048
_found is a private parameter, do not use it. It is used to indicate
1049
if format probing has already be done.
1052
# we are being called directly and must probe.
1053
raise NotImplementedError
1054
return BzrBranch(_format=self,
1055
_control_files=a_bzrdir._control_files,
1057
_repository=a_bzrdir.open_repository())
1060
return "Bazaar-NG branch format 4"
1063
class BzrBranchFormat5(BranchFormat):
1064
"""Bzr branch format 5.
1067
- a revision-history file.
1069
- a lock dir guarding the branch itself
1070
- all of this stored in a branch/ subdirectory
1071
- works with shared repositories.
1073
This format is new in bzr 0.8.
1076
def get_format_string(self):
1077
"""See BranchFormat.get_format_string()."""
1078
return "Bazaar-NG branch format 5\n"
1080
def get_format_description(self):
1081
"""See BranchFormat.get_format_description()."""
1082
return "Branch format 5"
1084
def initialize(self, a_bzrdir):
1085
"""Create a branch of this format in a_bzrdir."""
1086
utf8_files = [('revision-history', ''),
1087
('branch-name', ''),
1089
return self._initialize_helper(a_bzrdir, utf8_files)
1092
super(BzrBranchFormat5, self).__init__()
1093
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1095
def open(self, a_bzrdir, _found=False):
1096
"""Return the branch object for a_bzrdir
1098
_found is a private parameter, do not use it. It is used to indicate
1099
if format probing has already be done.
1102
format = BranchFormat.find_format(a_bzrdir)
1103
assert format.__class__ == self.__class__
1105
transport = a_bzrdir.get_branch_transport(None)
1106
control_files = lockable_files.LockableFiles(transport, 'lock',
1108
return BzrBranch5(_format=self,
1109
_control_files=control_files,
1111
_repository=a_bzrdir.find_repository())
1113
raise NotBranchError(path=transport.base)
1116
class BzrBranchFormat6(BzrBranchFormat5):
1117
"""Branch format with last-revision
1119
Unlike previous formats, this has no explicit revision history. Instead,
1120
this just stores the last-revision, and the left-hand history leading
1121
up to there is the history.
1123
This format was introduced in bzr 0.15
1126
def get_format_string(self):
1127
"""See BranchFormat.get_format_string()."""
1128
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1130
def get_format_description(self):
1131
"""See BranchFormat.get_format_description()."""
1132
return "Branch format 6"
1134
def initialize(self, a_bzrdir):
1135
"""Create a branch of this format in a_bzrdir."""
1136
utf8_files = [('last-revision', '0 null:\n'),
1137
('branch-name', ''),
1138
('branch.conf', ''),
1141
return self._initialize_helper(a_bzrdir, utf8_files)
1143
def open(self, a_bzrdir, _found=False):
1144
"""Return the branch object for a_bzrdir
1146
_found is a private parameter, do not use it. It is used to indicate
1147
if format probing has already be done.
1150
format = BranchFormat.find_format(a_bzrdir)
1151
assert format.__class__ == self.__class__
1152
transport = a_bzrdir.get_branch_transport(None)
1153
control_files = lockable_files.LockableFiles(transport, 'lock',
1155
return BzrBranch6(_format=self,
1156
_control_files=control_files,
1158
_repository=a_bzrdir.find_repository())
1160
def supports_tags(self):
1164
class BranchReferenceFormat(BranchFormat):
1165
"""Bzr branch reference format.
1167
Branch references are used in implementing checkouts, they
1168
act as an alias to the real branch which is at some other url.
1175
def get_format_string(self):
1176
"""See BranchFormat.get_format_string()."""
1177
return "Bazaar-NG Branch Reference Format 1\n"
1179
def get_format_description(self):
1180
"""See BranchFormat.get_format_description()."""
1181
return "Checkout reference format 1"
1183
def get_reference(self, a_bzrdir):
1184
"""See BranchFormat.get_reference()."""
1185
transport = a_bzrdir.get_branch_transport(None)
1186
return transport.get('location').read()
1188
def initialize(self, a_bzrdir, target_branch=None):
1189
"""Create a branch of this format in a_bzrdir."""
1190
if target_branch is None:
1191
# this format does not implement branch itself, thus the implicit
1192
# creation contract must see it as uninitializable
1193
raise errors.UninitializableFormat(self)
1194
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1195
branch_transport = a_bzrdir.get_branch_transport(self)
1196
branch_transport.put_bytes('location',
1197
target_branch.bzrdir.root_transport.base)
1198
branch_transport.put_bytes('format', self.get_format_string())
1199
return self.open(a_bzrdir, _found=True)
1202
super(BranchReferenceFormat, self).__init__()
1203
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1205
def _make_reference_clone_function(format, a_branch):
1206
"""Create a clone() routine for a branch dynamically."""
1207
def clone(to_bzrdir, revision_id=None):
1208
"""See Branch.clone()."""
1209
return format.initialize(to_bzrdir, a_branch)
1210
# cannot obey revision_id limits when cloning a reference ...
1211
# FIXME RBC 20060210 either nuke revision_id for clone, or
1212
# emit some sort of warning/error to the caller ?!
1215
def open(self, a_bzrdir, _found=False, location=None):
1216
"""Return the branch that the branch reference in a_bzrdir points at.
1218
_found is a private parameter, do not use it. It is used to indicate
1219
if format probing has already be done.
1222
format = BranchFormat.find_format(a_bzrdir)
1223
assert format.__class__ == self.__class__
1224
if location is None:
1225
location = self.get_reference(a_bzrdir)
1226
real_bzrdir = bzrdir.BzrDir.open(location)
1227
result = real_bzrdir.open_branch()
1228
# this changes the behaviour of result.clone to create a new reference
1229
# rather than a copy of the content of the branch.
1230
# I did not use a proxy object because that needs much more extensive
1231
# testing, and we are only changing one behaviour at the moment.
1232
# If we decide to alter more behaviours - i.e. the implicit nickname
1233
# then this should be refactored to introduce a tested proxy branch
1234
# and a subclass of that for use in overriding clone() and ....
1236
result.clone = self._make_reference_clone_function(result)
1240
# formats which have no format string are not discoverable
1241
# and not independently creatable, so are not registered.
1242
__default_format = BzrBranchFormat5()
1243
BranchFormat.register_format(__default_format)
1244
BranchFormat.register_format(BranchReferenceFormat())
1245
BranchFormat.register_format(BzrBranchFormat6())
1246
BranchFormat.set_default_format(__default_format)
1247
_legacy_formats = [BzrBranchFormat4(),
1250
class BzrBranch(Branch):
1251
"""A branch stored in the actual filesystem.
1253
Note that it's "local" in the context of the filesystem; it doesn't
1254
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1255
it's writable, and can be accessed via the normal filesystem API.
1258
def __init__(self, _format=None,
1259
_control_files=None, a_bzrdir=None, _repository=None):
1260
"""Create new branch object at a particular location."""
1261
Branch.__init__(self)
1262
if a_bzrdir is None:
1263
raise ValueError('a_bzrdir must be supplied')
1265
self.bzrdir = a_bzrdir
1266
# self._transport used to point to the directory containing the
1267
# control directory, but was not used - now it's just the transport
1268
# for the branch control files. mbp 20070212
1269
self._base = self.bzrdir.transport.clone('..').base
1270
self._format = _format
1271
if _control_files is None:
1272
raise ValueError('BzrBranch _control_files is None')
1273
self.control_files = _control_files
1274
self._transport = _control_files._transport
1275
self.repository = _repository
1278
return '%s(%r)' % (self.__class__.__name__, self.base)
1282
def _get_base(self):
1283
"""Returns the directory containing the control directory."""
1286
base = property(_get_base, doc="The URL for the root of this branch.")
1288
def abspath(self, name):
1289
"""See Branch.abspath."""
1290
return self.control_files._transport.abspath(name)
1293
@deprecated_method(zero_sixteen)
1295
def get_root_id(self):
1296
"""See Branch.get_root_id."""
1297
tree = self.repository.revision_tree(self.last_revision())
1298
return tree.inventory.root.file_id
1300
def is_locked(self):
1301
return self.control_files.is_locked()
1303
def lock_write(self, token=None):
1304
repo_token = self.repository.lock_write()
1306
token = self.control_files.lock_write(token=token)
1308
self.repository.unlock()
1312
def lock_read(self):
1313
self.repository.lock_read()
1315
self.control_files.lock_read()
1317
self.repository.unlock()
1321
# TODO: test for failed two phase locks. This is known broken.
1323
self.control_files.unlock()
1325
self.repository.unlock()
1326
if not self.control_files.is_locked():
1327
# we just released the lock
1328
self._clear_cached_state()
1330
def peek_lock_mode(self):
1331
if self.control_files._lock_count == 0:
1334
return self.control_files._lock_mode
1336
def get_physical_lock_status(self):
1337
return self.control_files.get_physical_lock_status()
1340
def print_file(self, file, revision_id):
1341
"""See Branch.print_file."""
1342
return self.repository.print_file(file, revision_id)
1345
def append_revision(self, *revision_ids):
1346
"""See Branch.append_revision."""
1347
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1348
for revision_id in revision_ids:
1349
_mod_revision.check_not_reserved_id(revision_id)
1350
mutter("add {%s} to revision-history" % revision_id)
1351
rev_history = self.revision_history()
1352
rev_history.extend(revision_ids)
1353
self.set_revision_history(rev_history)
1355
def _write_revision_history(self, history):
1356
"""Factored out of set_revision_history.
1358
This performs the actual writing to disk.
1359
It is intended to be called by BzrBranch5.set_revision_history."""
1360
self.control_files.put_bytes(
1361
'revision-history', '\n'.join(history))
1364
def set_revision_history(self, rev_history):
1365
"""See Branch.set_revision_history."""
1366
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1367
self._clear_cached_state()
1368
self._write_revision_history(rev_history)
1369
self._cache_revision_history(rev_history)
1370
for hook in Branch.hooks['set_rh']:
1371
hook(self, rev_history)
1374
def set_last_revision_info(self, revno, revision_id):
1375
revision_id = osutils.safe_revision_id(revision_id)
1376
history = self._lefthand_history(revision_id)
1377
assert len(history) == revno, '%d != %d' % (len(history), revno)
1378
self.set_revision_history(history)
1380
def _gen_revision_history(self):
1381
history = self.control_files.get('revision-history').read().split('\n')
1382
if history[-1:] == ['']:
1383
# There shouldn't be a trailing newline, but just in case.
1387
def _lefthand_history(self, revision_id, last_rev=None,
1389
# stop_revision must be a descendant of last_revision
1390
stop_graph = self.repository.get_revision_graph(revision_id)
1391
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1392
and last_rev not in stop_graph):
1393
# our previous tip is not merged into stop_revision
1394
raise errors.DivergedBranches(self, other_branch)
1395
# make a new revision history from the graph
1396
current_rev_id = revision_id
1398
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1399
new_history.append(current_rev_id)
1400
current_rev_id_parents = stop_graph[current_rev_id]
1402
current_rev_id = current_rev_id_parents[0]
1404
current_rev_id = None
1405
new_history.reverse()
1409
def generate_revision_history(self, revision_id, last_rev=None,
1411
"""Create a new revision history that will finish with revision_id.
1413
:param revision_id: the new tip to use.
1414
:param last_rev: The previous last_revision. If not None, then this
1415
must be a ancestory of revision_id, or DivergedBranches is raised.
1416
:param other_branch: The other branch that DivergedBranches should
1417
raise with respect to.
1419
revision_id = osutils.safe_revision_id(revision_id)
1420
self.set_revision_history(self._lefthand_history(revision_id,
1421
last_rev, other_branch))
1424
def update_revisions(self, other, stop_revision=None):
1425
"""See Branch.update_revisions."""
1428
if stop_revision is None:
1429
stop_revision = other.last_revision()
1430
if stop_revision is None:
1431
# if there are no commits, we're done.
1434
stop_revision = osutils.safe_revision_id(stop_revision)
1435
# whats the current last revision, before we fetch [and change it
1437
last_rev = _mod_revision.ensure_null(self.last_revision())
1438
# we fetch here regardless of whether we need to so that we pickup
1440
self.fetch(other, stop_revision)
1441
if self.repository.get_graph().is_ancestor(stop_revision,
1444
self.generate_revision_history(stop_revision, last_rev=last_rev,
1449
def basis_tree(self):
1450
"""See Branch.basis_tree."""
1451
return self.repository.revision_tree(self.last_revision())
1454
def pull(self, source, overwrite=False, stop_revision=None,
1455
_hook_master=None, run_hooks=True):
1458
:param _hook_master: Private parameter - set the branch to
1459
be supplied as the master to push hooks.
1460
:param run_hooks: Private parameter - if false, this branch
1461
is being called because it's the master of the primary branch,
1462
so it should not run its hooks.
1464
result = PullResult()
1465
result.source_branch = source
1466
result.target_branch = self
1469
result.old_revno, result.old_revid = self.last_revision_info()
1471
self.update_revisions(source, stop_revision)
1472
except DivergedBranches:
1476
if stop_revision is None:
1477
stop_revision = source.last_revision()
1478
self.generate_revision_history(stop_revision)
1479
result.tag_conflicts = source.tags.merge_to(self.tags)
1480
result.new_revno, result.new_revid = self.last_revision_info()
1482
result.master_branch = _hook_master
1483
result.local_branch = self
1485
result.master_branch = self
1486
result.local_branch = None
1488
for hook in Branch.hooks['post_pull']:
1494
def _get_parent_location(self):
1495
_locs = ['parent', 'pull', 'x-pull']
1498
return self.control_files.get(l).read().strip('\n')
1504
def push(self, target, overwrite=False, stop_revision=None,
1505
_override_hook_source_branch=None):
1508
This is the basic concrete implementation of push()
1510
:param _override_hook_source_branch: If specified, run
1511
the hooks passing this Branch as the source, rather than self.
1512
This is for use of RemoteBranch, where push is delegated to the
1513
underlying vfs-based Branch.
1515
# TODO: Public option to disable running hooks - should be trivial but
1519
result = self._push_with_bound_branches(target, overwrite,
1521
_override_hook_source_branch=_override_hook_source_branch)
1526
def _push_with_bound_branches(self, target, overwrite,
1528
_override_hook_source_branch=None):
1529
"""Push from self into target, and into target's master if any.
1531
This is on the base BzrBranch class even though it doesn't support
1532
bound branches because the *target* might be bound.
1535
if _override_hook_source_branch:
1536
result.source_branch = _override_hook_source_branch
1537
for hook in Branch.hooks['post_push']:
1540
bound_location = target.get_bound_location()
1541
if bound_location and target.base != bound_location:
1542
# there is a master branch.
1544
# XXX: Why the second check? Is it even supported for a branch to
1545
# be bound to itself? -- mbp 20070507
1546
master_branch = target.get_master_branch()
1547
master_branch.lock_write()
1549
# push into the master from this branch.
1550
self._basic_push(master_branch, overwrite, stop_revision)
1551
# and push into the target branch from this. Note that we push from
1552
# this branch again, because its considered the highest bandwidth
1554
result = self._basic_push(target, overwrite, stop_revision)
1555
result.master_branch = master_branch
1556
result.local_branch = target
1560
master_branch.unlock()
1563
result = self._basic_push(target, overwrite, stop_revision)
1564
# TODO: Why set master_branch and local_branch if there's no
1565
# binding? Maybe cleaner to just leave them unset? -- mbp
1567
result.master_branch = target
1568
result.local_branch = None
1572
def _basic_push(self, target, overwrite, stop_revision):
1573
"""Basic implementation of push without bound branches or hooks.
1575
Must be called with self read locked and target write locked.
1577
result = PushResult()
1578
result.source_branch = self
1579
result.target_branch = target
1580
result.old_revno, result.old_revid = target.last_revision_info()
1582
target.update_revisions(self, stop_revision)
1583
except DivergedBranches:
1587
target.set_revision_history(self.revision_history())
1588
result.tag_conflicts = self.tags.merge_to(target.tags)
1589
result.new_revno, result.new_revid = target.last_revision_info()
1592
def get_parent(self):
1593
"""See Branch.get_parent."""
1595
assert self.base[-1] == '/'
1596
parent = self._get_parent_location()
1599
# This is an old-format absolute path to a local branch
1600
# turn it into a url
1601
if parent.startswith('/'):
1602
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1604
return urlutils.join(self.base[:-1], parent)
1605
except errors.InvalidURLJoin, e:
1606
raise errors.InaccessibleParent(parent, self.base)
1608
def set_push_location(self, location):
1609
"""See Branch.set_push_location."""
1610
self.get_config().set_user_option(
1611
'push_location', location,
1612
store=_mod_config.STORE_LOCATION_NORECURSE)
1615
def set_parent(self, url):
1616
"""See Branch.set_parent."""
1617
# TODO: Maybe delete old location files?
1618
# URLs should never be unicode, even on the local fs,
1619
# FIXUP this and get_parent in a future branch format bump:
1620
# read and rewrite the file, and have the new format code read
1621
# using .get not .get_utf8. RBC 20060125
1623
if isinstance(url, unicode):
1625
url = url.encode('ascii')
1626
except UnicodeEncodeError:
1627
raise errors.InvalidURL(url,
1628
"Urls must be 7-bit ascii, "
1629
"use bzrlib.urlutils.escape")
1630
url = urlutils.relative_url(self.base, url)
1631
self._set_parent_location(url)
1633
def _set_parent_location(self, url):
1635
self.control_files._transport.delete('parent')
1637
assert isinstance(url, str)
1638
self.control_files.put_bytes('parent', url + '\n')
1641
class BzrBranch5(BzrBranch):
1642
"""A format 5 branch. This supports new features over plan branches.
1644
It has support for a master_branch which is the data for bound branches.
1652
super(BzrBranch5, self).__init__(_format=_format,
1653
_control_files=_control_files,
1655
_repository=_repository)
1658
def pull(self, source, overwrite=False, stop_revision=None,
1660
"""Pull from source into self, updating my master if any.
1662
:param run_hooks: Private parameter - if false, this branch
1663
is being called because it's the master of the primary branch,
1664
so it should not run its hooks.
1666
bound_location = self.get_bound_location()
1667
master_branch = None
1668
if bound_location and source.base != bound_location:
1669
# not pulling from master, so we need to update master.
1670
master_branch = self.get_master_branch()
1671
master_branch.lock_write()
1674
# pull from source into master.
1675
master_branch.pull(source, overwrite, stop_revision,
1677
return super(BzrBranch5, self).pull(source, overwrite,
1678
stop_revision, _hook_master=master_branch,
1679
run_hooks=run_hooks)
1682
master_branch.unlock()
1684
def get_bound_location(self):
1686
return self.control_files.get_utf8('bound').read()[:-1]
1687
except errors.NoSuchFile:
1691
def get_master_branch(self):
1692
"""Return the branch we are bound to.
1694
:return: Either a Branch, or None
1696
This could memoise the branch, but if thats done
1697
it must be revalidated on each new lock.
1698
So for now we just don't memoise it.
1699
# RBC 20060304 review this decision.
1701
bound_loc = self.get_bound_location()
1705
return Branch.open(bound_loc)
1706
except (errors.NotBranchError, errors.ConnectionError), e:
1707
raise errors.BoundBranchConnectionFailure(
1711
def set_bound_location(self, location):
1712
"""Set the target where this branch is bound to.
1714
:param location: URL to the target branch
1717
self.control_files.put_utf8('bound', location+'\n')
1720
self.control_files._transport.delete('bound')
1726
def bind(self, other):
1727
"""Bind this branch to the branch other.
1729
This does not push or pull data between the branches, though it does
1730
check for divergence to raise an error when the branches are not
1731
either the same, or one a prefix of the other. That behaviour may not
1732
be useful, so that check may be removed in future.
1734
:param other: The branch to bind to
1737
# TODO: jam 20051230 Consider checking if the target is bound
1738
# It is debatable whether you should be able to bind to
1739
# a branch which is itself bound.
1740
# Committing is obviously forbidden,
1741
# but binding itself may not be.
1742
# Since we *have* to check at commit time, we don't
1743
# *need* to check here
1745
# we want to raise diverged if:
1746
# last_rev is not in the other_last_rev history, AND
1747
# other_last_rev is not in our history, and do it without pulling
1749
last_rev = _mod_revision.ensure_null(self.last_revision())
1750
if last_rev != _mod_revision.NULL_REVISION:
1753
other_last_rev = other.last_revision()
1754
if not _mod_revision.is_null(other_last_rev):
1755
# neither branch is new, we have to do some work to
1756
# ascertain diversion.
1757
remote_graph = other.repository.get_revision_graph(
1759
local_graph = self.repository.get_revision_graph(last_rev)
1760
if (last_rev not in remote_graph and
1761
other_last_rev not in local_graph):
1762
raise errors.DivergedBranches(self, other)
1765
self.set_bound_location(other.base)
1769
"""If bound, unbind"""
1770
return self.set_bound_location(None)
1774
"""Synchronise this branch with the master branch if any.
1776
:return: None or the last_revision that was pivoted out during the
1779
master = self.get_master_branch()
1780
if master is not None:
1781
old_tip = _mod_revision.ensure_null(self.last_revision())
1782
self.pull(master, overwrite=True)
1783
if self.repository.get_graph().is_ancestor(old_tip,
1784
_mod_revision.ensure_null(self.last_revision())):
1790
class BzrBranchExperimental(BzrBranch5):
1791
"""Bzr experimental branch format
1794
- a revision-history file.
1796
- a lock dir guarding the branch itself
1797
- all of this stored in a branch/ subdirectory
1798
- works with shared repositories.
1799
- a tag dictionary in the branch
1801
This format is new in bzr 0.15, but shouldn't be used for real data,
1804
This class acts as it's own BranchFormat.
1807
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1810
def get_format_string(cls):
1811
"""See BranchFormat.get_format_string()."""
1812
return "Bazaar-NG branch format experimental\n"
1815
def get_format_description(cls):
1816
"""See BranchFormat.get_format_description()."""
1817
return "Experimental branch format"
1820
def get_reference(cls, a_bzrdir):
1821
"""Get the target reference of the branch in a_bzrdir.
1823
format probing must have been completed before calling
1824
this method - it is assumed that the format of the branch
1825
in a_bzrdir is correct.
1827
:param a_bzrdir: The bzrdir to get the branch data from.
1828
:return: None if the branch is not a reference branch.
1833
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1835
branch_transport = a_bzrdir.get_branch_transport(cls)
1836
control_files = lockable_files.LockableFiles(branch_transport,
1837
lock_filename, lock_class)
1838
control_files.create_lock()
1839
control_files.lock_write()
1841
for filename, content in utf8_files:
1842
control_files.put_utf8(filename, content)
1844
control_files.unlock()
1847
def initialize(cls, a_bzrdir):
1848
"""Create a branch of this format in a_bzrdir."""
1849
utf8_files = [('format', cls.get_format_string()),
1850
('revision-history', ''),
1851
('branch-name', ''),
1854
cls._initialize_control_files(a_bzrdir, utf8_files,
1855
'lock', lockdir.LockDir)
1856
return cls.open(a_bzrdir, _found=True)
1859
def open(cls, a_bzrdir, _found=False):
1860
"""Return the branch object for a_bzrdir
1862
_found is a private parameter, do not use it. It is used to indicate
1863
if format probing has already be done.
1866
format = BranchFormat.find_format(a_bzrdir)
1867
assert format.__class__ == cls
1868
transport = a_bzrdir.get_branch_transport(None)
1869
control_files = lockable_files.LockableFiles(transport, 'lock',
1871
return cls(_format=cls,
1872
_control_files=control_files,
1874
_repository=a_bzrdir.find_repository())
1877
def is_supported(cls):
1880
def _make_tags(self):
1881
return BasicTags(self)
1884
def supports_tags(cls):
1888
BranchFormat.register_format(BzrBranchExperimental)
1891
class BzrBranch6(BzrBranch5):
1894
def last_revision_info(self):
1895
revision_string = self.control_files.get('last-revision').read()
1896
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1897
revision_id = cache_utf8.get_cached_utf8(revision_id)
1899
return revno, revision_id
1901
def last_revision(self):
1902
"""Return last revision id, or None"""
1903
revision_id = self.last_revision_info()[1]
1904
if revision_id == _mod_revision.NULL_REVISION:
1908
def _write_last_revision_info(self, revno, revision_id):
1909
"""Simply write out the revision id, with no checks.
1911
Use set_last_revision_info to perform this safely.
1913
Does not update the revision_history cache.
1914
Intended to be called by set_last_revision_info and
1915
_write_revision_history.
1917
if revision_id is None:
1918
revision_id = 'null:'
1919
out_string = '%d %s\n' % (revno, revision_id)
1920
self.control_files.put_bytes('last-revision', out_string)
1923
def set_last_revision_info(self, revno, revision_id):
1924
revision_id = osutils.safe_revision_id(revision_id)
1925
if self._get_append_revisions_only():
1926
self._check_history_violation(revision_id)
1927
self._write_last_revision_info(revno, revision_id)
1928
self._clear_cached_state()
1930
def _check_history_violation(self, revision_id):
1931
last_revision = _mod_revision.ensure_null(self.last_revision())
1932
if _mod_revision.is_null(last_revision):
1934
if last_revision not in self._lefthand_history(revision_id):
1935
raise errors.AppendRevisionsOnlyViolation(self.base)
1937
def _gen_revision_history(self):
1938
"""Generate the revision history from last revision
1940
history = list(self.repository.iter_reverse_revision_history(
1941
self.last_revision()))
1945
def _write_revision_history(self, history):
1946
"""Factored out of set_revision_history.
1948
This performs the actual writing to disk, with format-specific checks.
1949
It is intended to be called by BzrBranch5.set_revision_history.
1951
if len(history) == 0:
1952
last_revision = 'null:'
1954
if history != self._lefthand_history(history[-1]):
1955
raise errors.NotLefthandHistory(history)
1956
last_revision = history[-1]
1957
if self._get_append_revisions_only():
1958
self._check_history_violation(last_revision)
1959
self._write_last_revision_info(len(history), last_revision)
1962
def append_revision(self, *revision_ids):
1963
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1964
if len(revision_ids) == 0:
1966
prev_revno, prev_revision = self.last_revision_info()
1967
for revision in self.repository.get_revisions(revision_ids):
1968
if prev_revision == _mod_revision.NULL_REVISION:
1969
if revision.parent_ids != []:
1970
raise errors.NotLeftParentDescendant(self, prev_revision,
1971
revision.revision_id)
1973
if revision.parent_ids[0] != prev_revision:
1974
raise errors.NotLeftParentDescendant(self, prev_revision,
1975
revision.revision_id)
1976
prev_revision = revision.revision_id
1977
self.set_last_revision_info(prev_revno + len(revision_ids),
1981
def _set_parent_location(self, url):
1982
"""Set the parent branch"""
1983
self._set_config_location('parent_location', url, make_relative=True)
1986
def _get_parent_location(self):
1987
"""Set the parent branch"""
1988
return self._get_config_location('parent_location')
1990
def set_push_location(self, location):
1991
"""See Branch.set_push_location."""
1992
self._set_config_location('push_location', location)
1994
def set_bound_location(self, location):
1995
"""See Branch.set_push_location."""
1997
config = self.get_config()
1998
if location is None:
1999
if config.get_user_option('bound') != 'True':
2002
config.set_user_option('bound', 'False', warn_masked=True)
2005
self._set_config_location('bound_location', location,
2007
config.set_user_option('bound', 'True', warn_masked=True)
2010
def _get_bound_location(self, bound):
2011
"""Return the bound location in the config file.
2013
Return None if the bound parameter does not match"""
2014
config = self.get_config()
2015
config_bound = (config.get_user_option('bound') == 'True')
2016
if config_bound != bound:
2018
return self._get_config_location('bound_location', config=config)
2020
def get_bound_location(self):
2021
"""See Branch.set_push_location."""
2022
return self._get_bound_location(True)
2024
def get_old_bound_location(self):
2025
"""See Branch.get_old_bound_location"""
2026
return self._get_bound_location(False)
2028
def set_append_revisions_only(self, enabled):
2033
self.get_config().set_user_option('append_revisions_only', value,
2036
def _get_append_revisions_only(self):
2037
value = self.get_config().get_user_option('append_revisions_only')
2038
return value == 'True'
2040
def _synchronize_history(self, destination, revision_id):
2041
"""Synchronize last revision and revision history between branches.
2043
This version is most efficient when the destination is also a
2044
BzrBranch6, but works for BzrBranch5, as long as the destination's
2045
repository contains all the lefthand ancestors of the intended
2046
last_revision. If not, set_last_revision_info will fail.
2048
:param destination: The branch to copy the history into
2049
:param revision_id: The revision-id to truncate history at. May
2050
be None to copy complete history.
2052
if revision_id is None:
2053
revno, revision_id = self.last_revision_info()
2055
# To figure out the revno for a random revision, we need to build
2056
# the revision history, and count its length.
2057
# We don't care about the order, just how long it is.
2058
# Alternatively, we could start at the current location, and count
2059
# backwards. But there is no guarantee that we will find it since
2060
# it may be a merged revision.
2061
revno = len(list(self.repository.iter_reverse_revision_history(
2063
destination.set_last_revision_info(revno, revision_id)
2065
def _make_tags(self):
2066
return BasicTags(self)
2069
######################################################################
2070
# results of operations
2073
class _Result(object):
2075
def _show_tag_conficts(self, to_file):
2076
if not getattr(self, 'tag_conflicts', None):
2078
to_file.write('Conflicting tags:\n')
2079
for name, value1, value2 in self.tag_conflicts:
2080
to_file.write(' %s\n' % (name, ))
2083
class PullResult(_Result):
2084
"""Result of a Branch.pull operation.
2086
:ivar old_revno: Revision number before pull.
2087
:ivar new_revno: Revision number after pull.
2088
:ivar old_revid: Tip revision id before pull.
2089
:ivar new_revid: Tip revision id after pull.
2090
:ivar source_branch: Source (local) branch object.
2091
:ivar master_branch: Master branch of the target, or None.
2092
:ivar target_branch: Target/destination branch object.
2096
# DEPRECATED: pull used to return the change in revno
2097
return self.new_revno - self.old_revno
2099
def report(self, to_file):
2100
if self.old_revid == self.new_revid:
2101
to_file.write('No revisions to pull.\n')
2103
to_file.write('Now on revision %d.\n' % self.new_revno)
2104
self._show_tag_conficts(to_file)
2107
class PushResult(_Result):
2108
"""Result of a Branch.push operation.
2110
:ivar old_revno: Revision number before push.
2111
:ivar new_revno: Revision number after push.
2112
:ivar old_revid: Tip revision id before push.
2113
:ivar new_revid: Tip revision id after push.
2114
:ivar source_branch: Source branch object.
2115
:ivar master_branch: Master branch of the target, or None.
2116
:ivar target_branch: Target/destination branch object.
2120
# DEPRECATED: push used to return the change in revno
2121
return self.new_revno - self.old_revno
2123
def report(self, to_file):
2124
"""Write a human-readable description of the result."""
2125
if self.old_revid == self.new_revid:
2126
to_file.write('No new revisions to push.\n')
2128
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2129
self._show_tag_conficts(to_file)
2132
class BranchCheckResult(object):
2133
"""Results of checking branch consistency.
2138
def __init__(self, branch):
2139
self.branch = branch
2141
def report_results(self, verbose):
2142
"""Report the check results via trace.note.
2144
:param verbose: Requests more detailed display of what was checked,
2147
note('checked branch %s format %s',
2149
self.branch._format)
2152
class Converter5to6(object):
2153
"""Perform an in-place upgrade of format 5 to format 6"""
2155
def convert(self, branch):
2156
# Data for 5 and 6 can peacefully coexist.
2157
format = BzrBranchFormat6()
2158
new_branch = format.open(branch.bzrdir, _found=True)
2160
# Copy source data into target
2161
new_branch.set_last_revision_info(*branch.last_revision_info())
2162
new_branch.set_parent(branch.get_parent())
2163
new_branch.set_bound_location(branch.get_bound_location())
2164
new_branch.set_push_location(branch.get_push_location())
2166
# New branch has no tags by default
2167
new_branch.tags._set_tag_dict({})
2169
# Copying done; now update target format
2170
new_branch.control_files.put_utf8('format',
2171
format.get_format_string())
2173
# Clean up old files
2174
new_branch.control_files._transport.delete('revision-history')
2176
branch.set_parent(None)
2179
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
