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):
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
return control.open_branch(_unsupported)
130
def open_from_transport(transport, _unsupported=False):
131
"""Open the branch rooted at transport"""
132
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
133
return control.open_branch(_unsupported)
136
def open_containing(url, possible_transports=None):
137
"""Open an existing branch which contains url.
139
This probes for a branch at url, and searches upwards from there.
141
Basically we keep looking up until we find the control directory or
142
run into the root. If there isn't one, raises NotBranchError.
143
If there is one and it is either an unrecognised format or an unsupported
144
format, UnknownFormatError or UnsupportedFormatError are raised.
145
If there is one, it is returned, along with the unused portion of url.
147
control, relpath = bzrdir.BzrDir.open_containing(url,
149
return control.open_branch(), relpath
151
def get_config(self):
152
return BranchConfig(self)
155
return self.get_config().get_nickname()
157
def _set_nick(self, nick):
158
self.get_config().set_user_option('nickname', nick, warn_masked=True)
160
nick = property(_get_nick, _set_nick)
163
raise NotImplementedError(self.is_locked)
165
def lock_write(self):
166
raise NotImplementedError(self.lock_write)
169
raise NotImplementedError(self.lock_read)
172
raise NotImplementedError(self.unlock)
174
def peek_lock_mode(self):
175
"""Return lock mode for the Branch: 'r', 'w' or None"""
176
raise NotImplementedError(self.peek_lock_mode)
178
def get_physical_lock_status(self):
179
raise NotImplementedError(self.get_physical_lock_status)
182
def get_revision_id_to_revno_map(self):
183
"""Return the revision_id => dotted revno map.
185
This will be regenerated on demand, but will be cached.
187
:return: A dictionary mapping revision_id => dotted revno.
188
This dictionary should not be modified by the caller.
190
if self._revision_id_to_revno_cache is not None:
191
mapping = self._revision_id_to_revno_cache
193
mapping = self._gen_revno_map()
194
self._cache_revision_id_to_revno(mapping)
195
# TODO: jam 20070417 Since this is being cached, should we be returning
197
# I would rather not, and instead just declare that users should not
198
# modify the return value.
201
def _gen_revno_map(self):
202
"""Create a new mapping from revision ids to dotted revnos.
204
Dotted revnos are generated based on the current tip in the revision
206
This is the worker function for get_revision_id_to_revno_map, which
207
just caches the return value.
209
:return: A dictionary mapping revision_id => dotted revno.
211
last_revision = self.last_revision()
212
revision_graph = self.repository.get_revision_graph(last_revision)
213
merge_sorted_revisions = tsort.merge_sort(
218
revision_id_to_revno = dict((rev_id, revno)
219
for seq_num, rev_id, depth, revno, end_of_merge
220
in merge_sorted_revisions)
221
return revision_id_to_revno
223
def leave_lock_in_place(self):
224
"""Tell this branch object not to release the physical lock when this
227
If lock_write doesn't return a token, then this method is not supported.
229
self.control_files.leave_in_place()
231
def dont_leave_lock_in_place(self):
232
"""Tell this branch object to release the physical lock when this
233
object is unlocked, even if it didn't originally acquire it.
235
If lock_write doesn't return a token, then this method is not supported.
237
self.control_files.dont_leave_in_place()
239
def abspath(self, name):
240
"""Return absolute filename for something in the branch
242
XXX: Robert Collins 20051017 what is this used for? why is it a branch
243
method and not a tree method.
245
raise NotImplementedError(self.abspath)
247
def bind(self, other):
248
"""Bind the local branch the other branch.
250
:param other: The branch to bind to
253
raise errors.UpgradeRequired(self.base)
256
def fetch(self, from_branch, last_revision=None, pb=None):
257
"""Copy revisions from from_branch into this branch.
259
:param from_branch: Where to copy from.
260
:param last_revision: What revision to stop at (None for at the end
262
:param pb: An optional progress bar to use.
264
Returns the copied revision count and the failed revisions in a tuple:
267
if self.base == from_branch.base:
270
nested_pb = ui.ui_factory.nested_progress_bar()
275
from_branch.lock_read()
277
if last_revision is None:
278
pb.update('get source history')
279
last_revision = from_branch.last_revision()
280
if last_revision is None:
281
last_revision = _mod_revision.NULL_REVISION
282
return self.repository.fetch(from_branch.repository,
283
revision_id=last_revision,
286
if nested_pb is not None:
290
def get_bound_location(self):
291
"""Return the URL of the branch we are bound to.
293
Older format branches cannot bind, please be sure to use a metadir
298
def get_old_bound_location(self):
299
"""Return the URL of the branch we used to be bound to
301
raise errors.UpgradeRequired(self.base)
303
def get_commit_builder(self, parents, config=None, timestamp=None,
304
timezone=None, committer=None, revprops=None,
306
"""Obtain a CommitBuilder for this branch.
308
:param parents: Revision ids of the parents of the new revision.
309
:param config: Optional configuration to use.
310
:param timestamp: Optional timestamp recorded for commit.
311
:param timezone: Optional timezone for timestamp.
312
:param committer: Optional committer to set for commit.
313
:param revprops: Optional dictionary of revision properties.
314
:param revision_id: Optional revision id.
318
config = self.get_config()
320
return self.repository.get_commit_builder(self, parents, config,
321
timestamp, timezone, committer, revprops, revision_id)
323
def get_master_branch(self):
324
"""Return the branch we are bound to.
326
:return: Either a Branch, or None
330
def get_revision_delta(self, revno):
331
"""Return the delta for one revision.
333
The delta is relative to its mainline predecessor, or the
334
empty tree for revision 1.
336
assert isinstance(revno, int)
337
rh = self.revision_history()
338
if not (1 <= revno <= len(rh)):
339
raise InvalidRevisionNumber(revno)
340
return self.repository.get_revision_delta(rh[revno-1])
342
@deprecated_method(zero_sixteen)
343
def get_root_id(self):
344
"""Return the id of this branches root
346
Deprecated: branches don't have root ids-- trees do.
347
Use basis_tree().get_root_id() instead.
349
raise NotImplementedError(self.get_root_id)
351
def print_file(self, file, revision_id):
352
"""Print `file` to stdout."""
353
raise NotImplementedError(self.print_file)
355
def set_revision_history(self, rev_history):
356
raise NotImplementedError(self.set_revision_history)
358
def _cache_revision_history(self, rev_history):
359
"""Set the cached revision history to rev_history.
361
The revision_history method will use this cache to avoid regenerating
362
the revision history.
364
This API is semi-public; it only for use by subclasses, all other code
365
should consider it to be private.
367
self._revision_history_cache = rev_history
369
def _cache_revision_id_to_revno(self, revision_id_to_revno):
370
"""Set the cached revision_id => revno map to revision_id_to_revno.
372
This API is semi-public; it only for use by subclasses, all other code
373
should consider it to be private.
375
self._revision_id_to_revno_cache = revision_id_to_revno
377
def _clear_cached_state(self):
378
"""Clear any cached data on this branch, e.g. cached revision history.
380
This means the next call to revision_history will need to call
381
_gen_revision_history.
383
This API is semi-public; it only for use by subclasses, all other code
384
should consider it to be private.
386
self._revision_history_cache = None
387
self._revision_id_to_revno_cache = None
389
def _gen_revision_history(self):
390
"""Return sequence of revision hashes on to this branch.
392
Unlike revision_history, this method always regenerates or rereads the
393
revision history, i.e. it does not cache the result, so repeated calls
396
Concrete subclasses should override this instead of revision_history so
397
that subclasses do not need to deal with caching logic.
399
This API is semi-public; it only for use by subclasses, all other code
400
should consider it to be private.
402
raise NotImplementedError(self._gen_revision_history)
405
def revision_history(self):
406
"""Return sequence of revision hashes on to this branch.
408
This method will cache the revision history for as long as it is safe to
411
if self._revision_history_cache is not None:
412
history = self._revision_history_cache
414
history = self._gen_revision_history()
415
self._cache_revision_history(history)
419
"""Return current revision number for this branch.
421
That is equivalent to the number of revisions committed to
424
return len(self.revision_history())
427
"""Older format branches cannot bind or unbind."""
428
raise errors.UpgradeRequired(self.base)
430
def set_append_revisions_only(self, enabled):
431
"""Older format branches are never restricted to append-only"""
432
raise errors.UpgradeRequired(self.base)
434
def last_revision(self):
435
"""Return last revision id, or None"""
436
ph = self.revision_history()
440
return _mod_revision.NULL_REVISION
442
def last_revision_info(self):
443
"""Return information about the last revision.
445
:return: A tuple (revno, last_revision_id).
447
rh = self.revision_history()
450
return (revno, rh[-1])
452
return (0, _mod_revision.NULL_REVISION)
454
def missing_revisions(self, other, stop_revision=None):
455
"""Return a list of new revisions that would perfectly fit.
457
If self and other have not diverged, return a list of the revisions
458
present in other, but missing from self.
460
self_history = self.revision_history()
461
self_len = len(self_history)
462
other_history = other.revision_history()
463
other_len = len(other_history)
464
common_index = min(self_len, other_len) -1
465
if common_index >= 0 and \
466
self_history[common_index] != other_history[common_index]:
467
raise DivergedBranches(self, other)
469
if stop_revision is None:
470
stop_revision = other_len
472
assert isinstance(stop_revision, int)
473
if stop_revision > other_len:
474
raise errors.NoSuchRevision(self, stop_revision)
475
return other_history[self_len:stop_revision]
477
def update_revisions(self, other, stop_revision=None):
478
"""Pull in new perfect-fit revisions.
480
:param other: Another Branch to pull from
481
:param stop_revision: Updated until the given revision
484
raise NotImplementedError(self.update_revisions)
486
def revision_id_to_revno(self, revision_id):
487
"""Given a revision id, return its revno"""
488
if _mod_revision.is_null(revision_id):
490
revision_id = osutils.safe_revision_id(revision_id)
491
history = self.revision_history()
493
return history.index(revision_id) + 1
495
raise errors.NoSuchRevision(self, revision_id)
497
def get_rev_id(self, revno, history=None):
498
"""Find the revision id of the specified revno."""
500
return _mod_revision.NULL_REVISION
502
history = self.revision_history()
503
if revno <= 0 or revno > len(history):
504
raise errors.NoSuchRevision(self, revno)
505
return history[revno - 1]
507
def pull(self, source, overwrite=False, stop_revision=None):
508
"""Mirror source into this branch.
510
This branch is considered to be 'local', having low latency.
512
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
516
def push(self, target, overwrite=False, stop_revision=None):
517
"""Mirror this branch into target.
519
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
523
def basis_tree(self):
524
"""Return `Tree` object for last revision."""
525
return self.repository.revision_tree(self.last_revision())
527
def rename_one(self, from_rel, to_rel):
530
This can change the directory or the filename or both.
532
raise NotImplementedError(self.rename_one)
534
def move(self, from_paths, to_name):
537
to_name must exist as a versioned directory.
539
If to_name exists and is a directory, the files are moved into
540
it, keeping their old names. If it is a directory,
542
Note that to_name is only the last component of the new name;
543
this doesn't change the directory.
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
def get_parent(self):
551
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
554
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
559
def _set_config_location(self, name, url, config=None,
560
make_relative=False):
562
config = self.get_config()
566
url = urlutils.relative_url(self.base, url)
567
config.set_user_option(name, url, warn_masked=True)
569
def _get_config_location(self, name, config=None):
571
config = self.get_config()
572
location = config.get_user_option(name)
577
def get_submit_branch(self):
578
"""Return the submit location of the branch.
580
This is the default location for bundle. The usual
581
pattern is that the user can override it by specifying a
584
return self.get_config().get_user_option('submit_branch')
586
def set_submit_branch(self, location):
587
"""Return the submit location of the branch.
589
This is the default location for bundle. The usual
590
pattern is that the user can override it by specifying a
593
self.get_config().set_user_option('submit_branch', location,
596
def get_public_branch(self):
597
"""Return the public location of the branch.
599
This is is used by merge directives.
601
return self._get_config_location('public_branch')
603
def set_public_branch(self, location):
604
"""Return the submit location of the branch.
606
This is the default location for bundle. The usual
607
pattern is that the user can override it by specifying a
610
self._set_config_location('public_branch', location)
612
def get_push_location(self):
613
"""Return the None or the location to push this branch to."""
614
push_loc = self.get_config().get_user_option('push_location')
617
def set_push_location(self, location):
618
"""Set a new push location for this branch."""
619
raise NotImplementedError(self.set_push_location)
621
def set_parent(self, url):
622
raise NotImplementedError(self.set_parent)
626
"""Synchronise this branch with the master branch if any.
628
:return: None or the last_revision pivoted out during the update.
632
def check_revno(self, revno):
634
Check whether a revno corresponds to any revision.
635
Zero (the NULL revision) is considered valid.
638
self.check_real_revno(revno)
640
def check_real_revno(self, revno):
642
Check whether a revno corresponds to a real revision.
643
Zero (the NULL revision) is considered invalid
645
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
649
def clone(self, to_bzrdir, revision_id=None):
650
"""Clone this branch into to_bzrdir preserving all semantic values.
652
revision_id: if not None, the revision history in the new branch will
653
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=revision_id)
660
def sprout(self, to_bzrdir, revision_id=None):
661
"""Create a new line of development from the branch, into to_bzrdir.
663
revision_id: if not None, the revision history in the new branch will
664
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
671
def _synchronize_history(self, destination, revision_id):
672
"""Synchronize last revision and revision history between branches.
674
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
680
:param destination: The branch to copy the history into
681
:param revision_id: The revision-id to truncate history at. May
682
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
688
revision_id = osutils.safe_revision_id(revision_id)
690
new_history = new_history[:new_history.index(revision_id) + 1]
692
rev = self.repository.get_revision(revision_id)
693
new_history = rev.get_history(self.repository)[1:]
694
destination.set_revision_history(new_history)
697
def copy_content_into(self, destination, revision_id=None):
698
"""Copy the content of self into destination.
700
revision_id: if not None, the revision history in the new branch will
701
be truncated to end with revision_id.
703
self._synchronize_history(destination, revision_id)
705
parent = self.get_parent()
706
except errors.InaccessibleParent, e:
707
mutter('parent was not accessible to copy: %s', e)
710
destination.set_parent(parent)
711
self.tags.merge_to(destination.tags)
715
"""Check consistency of the branch.
717
In particular this checks that revisions given in the revision-history
718
do actually match up in the revision graph, and that they're all
719
present in the repository.
721
Callers will typically also want to check the repository.
723
:return: A BranchCheckResult.
725
mainline_parent_id = None
726
for revision_id in self.revision_history():
728
revision = self.repository.get_revision(revision_id)
729
except errors.NoSuchRevision, e:
730
raise errors.BzrCheckError("mainline revision {%s} not in repository"
732
# In general the first entry on the revision history has no parents.
733
# But it's not illegal for it to have parents listed; this can happen
734
# in imports from Arch when the parents weren't reachable.
735
if mainline_parent_id is not None:
736
if mainline_parent_id not in revision.parent_ids:
737
raise errors.BzrCheckError("previous revision {%s} not listed among "
739
% (mainline_parent_id, revision_id))
740
mainline_parent_id = revision_id
741
return BranchCheckResult(self)
743
def _get_checkout_format(self):
744
"""Return the most suitable metadir for a checkout of this branch.
745
Weaves are used if this branch's repository uses weaves.
747
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
748
from bzrlib.repofmt import weaverepo
749
format = bzrdir.BzrDirMetaFormat1()
750
format.repository_format = weaverepo.RepositoryFormat7()
752
format = self.repository.bzrdir.checkout_metadir()
753
format.set_branch_format(self._format)
756
def create_checkout(self, to_location, revision_id=None,
758
"""Create a checkout of a branch.
760
:param to_location: The url to produce the checkout at
761
:param revision_id: The revision to check out
762
:param lightweight: If True, produce a lightweight checkout, otherwise,
763
produce a bound branch (heavyweight checkout)
764
:return: The tree of the created checkout
766
t = transport.get_transport(to_location)
769
format = self._get_checkout_format()
770
checkout = format.initialize_on_transport(t)
771
BranchReferenceFormat().initialize(checkout, self)
773
format = self._get_checkout_format()
774
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
775
to_location, force_new_tree=False, format=format)
776
checkout = checkout_branch.bzrdir
777
checkout_branch.bind(self)
778
# pull up to the specified revision_id to set the initial
779
# branch tip correctly, and seed it with history.
780
checkout_branch.pull(self, stop_revision=revision_id)
781
tree = checkout.create_workingtree(revision_id)
782
basis_tree = tree.basis_tree()
783
basis_tree.lock_read()
785
for path, file_id in basis_tree.iter_references():
786
reference_parent = self.reference_parent(file_id, path)
787
reference_parent.create_checkout(tree.abspath(path),
788
basis_tree.get_reference_revision(file_id, path),
794
def reference_parent(self, file_id, path):
795
"""Return the parent branch for a tree-reference file_id
796
:param file_id: The file_id of the tree reference
797
:param path: The path of the file_id in the tree
798
:return: A branch associated with the file_id
800
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
def supports_tags(self):
804
return self._format.supports_tags()
807
class BranchFormat(object):
808
"""An encapsulation of the initialization and open routines for a format.
810
Formats provide three things:
811
* An initialization routine,
815
Formats are placed in an dict by their format string for reference
816
during branch opening. Its not required that these be instances, they
817
can be classes themselves with class methods - it simply depends on
818
whether state is needed for a given format or not.
820
Once a format is deprecated, just deprecate the initialize and open
821
methods on the format class. Do not deprecate the object, as the
822
object will be created every time regardless.
825
_default_format = None
826
"""The default format used for new branches."""
829
"""The known formats."""
831
def __eq__(self, other):
832
return self.__class__ is other.__class__
834
def __ne__(self, other):
835
return not (self == other)
838
def find_format(klass, a_bzrdir):
839
"""Return the format for the branch object in a_bzrdir."""
841
transport = a_bzrdir.get_branch_transport(None)
842
format_string = transport.get("format").read()
843
return klass._formats[format_string]
845
raise NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string)
850
def get_default_format(klass):
851
"""Return the current default format."""
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
857
format probing must have been completed before calling
858
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
862
:return: None if the branch is not a reference branch.
866
def get_format_string(self):
867
"""Return the ASCII format string that identifies this format."""
868
raise NotImplementedError(self.get_format_string)
870
def get_format_description(self):
871
"""Return the short format description for this format."""
872
raise NotImplementedError(self.get_format_description)
874
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
876
"""Initialize a branch in a bzrdir, with specified files
878
:param a_bzrdir: The bzrdir to initialize the branch in
879
:param utf8_files: The files to create as a list of
880
(filename, content) tuples
881
:param set_format: If True, set the format with
882
self.get_format_string. (BzrBranch4 has its format set
884
:return: a branch in this format
886
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
887
branch_transport = a_bzrdir.get_branch_transport(self)
889
'metadir': ('lock', lockdir.LockDir),
890
'branch4': ('branch-lock', lockable_files.TransportLock),
892
lock_name, lock_class = lock_map[lock_type]
893
control_files = lockable_files.LockableFiles(branch_transport,
894
lock_name, lock_class)
895
control_files.create_lock()
896
control_files.lock_write()
898
control_files.put_utf8('format', self.get_format_string())
900
for file, content in utf8_files:
901
control_files.put_utf8(file, content)
903
control_files.unlock()
904
return self.open(a_bzrdir, _found=True)
906
def initialize(self, a_bzrdir):
907
"""Create a branch of this format in a_bzrdir."""
908
raise NotImplementedError(self.initialize)
910
def is_supported(self):
911
"""Is this format supported?
913
Supported formats can be initialized and opened.
914
Unsupported formats may not support initialization or committing or
915
some other features depending on the reason for not being supported.
919
def open(self, a_bzrdir, _found=False):
920
"""Return the branch object for a_bzrdir
922
_found is a private parameter, do not use it. It is used to indicate
923
if format probing has already be done.
925
raise NotImplementedError(self.open)
928
def register_format(klass, format):
929
klass._formats[format.get_format_string()] = format
932
def set_default_format(klass, format):
933
klass._default_format = format
936
def unregister_format(klass, format):
937
assert klass._formats[format.get_format_string()] is format
938
del klass._formats[format.get_format_string()]
941
return self.get_format_string().rstrip()
943
def supports_tags(self):
944
"""True if this format supports tags stored in the branch"""
945
return False # by default
947
# XXX: Probably doesn't really belong here -- mbp 20070212
948
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
950
branch_transport = a_bzrdir.get_branch_transport(self)
951
control_files = lockable_files.LockableFiles(branch_transport,
952
lock_filename, lock_class)
953
control_files.create_lock()
954
control_files.lock_write()
956
for filename, content in utf8_files:
957
control_files.put_utf8(filename, content)
959
control_files.unlock()
962
class BranchHooks(Hooks):
963
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
970
"""Create the default hooks.
972
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked before a commit operation takes place.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, future_revno, future_revid,
1005
# affected_ids, future_revision_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# affected_ids is a dictionary of (change_type, ids) pairs where ids
1008
# is a list of inventory entry ids and change_type is a string
1009
# describing the change (added, deleted, renamed, etc.)
1010
# future_revision_tree is an in-memory tree obtained from
1011
# CommitBuilder.revision_tree()
1012
self['pre_commit'] = []
1013
# invoked after a commit operation completes.
1014
# the api signature is
1015
# (local, master, old_revno, old_revid, new_revno, new_revid)
1016
# old_revid is NULL_REVISION for the first commit to a branch.
1017
self['post_commit'] = []
1018
# invoked after a uncommit operation completes.
1019
# the api signature is
1020
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1021
# local is the local branch or None, master is the target branch,
1022
# and an empty branch recieves new_revno of 0, new_revid of None.
1023
self['post_uncommit'] = []
1026
# install the default hooks into the Branch class.
1027
Branch.hooks = BranchHooks()
1030
class BzrBranchFormat4(BranchFormat):
1031
"""Bzr branch format 4.
1034
- a revision-history file.
1035
- a branch-lock lock file [ to be shared with the bzrdir ]
1038
def get_format_description(self):
1039
"""See BranchFormat.get_format_description()."""
1040
return "Branch format 4"
1042
def initialize(self, a_bzrdir):
1043
"""Create a branch of this format in a_bzrdir."""
1044
utf8_files = [('revision-history', ''),
1045
('branch-name', ''),
1047
return self._initialize_helper(a_bzrdir, utf8_files,
1048
lock_type='branch4', set_format=False)
1051
super(BzrBranchFormat4, self).__init__()
1052
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1054
def open(self, a_bzrdir, _found=False):
1055
"""Return the branch object for a_bzrdir
1057
_found is a private parameter, do not use it. It is used to indicate
1058
if format probing has already be done.
1061
# we are being called directly and must probe.
1062
raise NotImplementedError
1063
return BzrBranch(_format=self,
1064
_control_files=a_bzrdir._control_files,
1066
_repository=a_bzrdir.open_repository())
1069
return "Bazaar-NG branch format 4"
1072
class BzrBranchFormat5(BranchFormat):
1073
"""Bzr branch format 5.
1076
- a revision-history file.
1078
- a lock dir guarding the branch itself
1079
- all of this stored in a branch/ subdirectory
1080
- works with shared repositories.
1082
This format is new in bzr 0.8.
1085
def get_format_string(self):
1086
"""See BranchFormat.get_format_string()."""
1087
return "Bazaar-NG branch format 5\n"
1089
def get_format_description(self):
1090
"""See BranchFormat.get_format_description()."""
1091
return "Branch format 5"
1093
def initialize(self, a_bzrdir):
1094
"""Create a branch of this format in a_bzrdir."""
1095
utf8_files = [('revision-history', ''),
1096
('branch-name', ''),
1098
return self._initialize_helper(a_bzrdir, utf8_files)
1101
super(BzrBranchFormat5, self).__init__()
1102
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1104
def open(self, a_bzrdir, _found=False):
1105
"""Return the branch object for a_bzrdir
1107
_found is a private parameter, do not use it. It is used to indicate
1108
if format probing has already be done.
1111
format = BranchFormat.find_format(a_bzrdir)
1112
assert format.__class__ == self.__class__
1114
transport = a_bzrdir.get_branch_transport(None)
1115
control_files = lockable_files.LockableFiles(transport, 'lock',
1117
return BzrBranch5(_format=self,
1118
_control_files=control_files,
1120
_repository=a_bzrdir.find_repository())
1122
raise NotBranchError(path=transport.base)
1125
class BzrBranchFormat6(BzrBranchFormat5):
1126
"""Branch format with last-revision and tags.
1128
Unlike previous formats, this has no explicit revision history. Instead,
1129
this just stores the last-revision, and the left-hand history leading
1130
up to there is the history.
1132
This format was introduced in bzr 0.15
1133
and became the default in 0.91.
1136
def get_format_string(self):
1137
"""See BranchFormat.get_format_string()."""
1138
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1140
def get_format_description(self):
1141
"""See BranchFormat.get_format_description()."""
1142
return "Branch format 6"
1144
def initialize(self, a_bzrdir):
1145
"""Create a branch of this format in a_bzrdir."""
1146
utf8_files = [('last-revision', '0 null:\n'),
1147
('branch-name', ''),
1148
('branch.conf', ''),
1151
return self._initialize_helper(a_bzrdir, utf8_files)
1153
def open(self, a_bzrdir, _found=False):
1154
"""Return the branch object for a_bzrdir
1156
_found is a private parameter, do not use it. It is used to indicate
1157
if format probing has already be done.
1160
format = BranchFormat.find_format(a_bzrdir)
1161
assert format.__class__ == self.__class__
1162
transport = a_bzrdir.get_branch_transport(None)
1163
control_files = lockable_files.LockableFiles(transport, 'lock',
1165
return BzrBranch6(_format=self,
1166
_control_files=control_files,
1168
_repository=a_bzrdir.find_repository())
1170
def supports_tags(self):
1174
class BranchReferenceFormat(BranchFormat):
1175
"""Bzr branch reference format.
1177
Branch references are used in implementing checkouts, they
1178
act as an alias to the real branch which is at some other url.
1185
def get_format_string(self):
1186
"""See BranchFormat.get_format_string()."""
1187
return "Bazaar-NG Branch Reference Format 1\n"
1189
def get_format_description(self):
1190
"""See BranchFormat.get_format_description()."""
1191
return "Checkout reference format 1"
1193
def get_reference(self, a_bzrdir):
1194
"""See BranchFormat.get_reference()."""
1195
transport = a_bzrdir.get_branch_transport(None)
1196
return transport.get('location').read()
1198
def initialize(self, a_bzrdir, target_branch=None):
1199
"""Create a branch of this format in a_bzrdir."""
1200
if target_branch is None:
1201
# this format does not implement branch itself, thus the implicit
1202
# creation contract must see it as uninitializable
1203
raise errors.UninitializableFormat(self)
1204
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1205
branch_transport = a_bzrdir.get_branch_transport(self)
1206
branch_transport.put_bytes('location',
1207
target_branch.bzrdir.root_transport.base)
1208
branch_transport.put_bytes('format', self.get_format_string())
1209
return self.open(a_bzrdir, _found=True)
1212
super(BranchReferenceFormat, self).__init__()
1213
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1215
def _make_reference_clone_function(format, a_branch):
1216
"""Create a clone() routine for a branch dynamically."""
1217
def clone(to_bzrdir, revision_id=None):
1218
"""See Branch.clone()."""
1219
return format.initialize(to_bzrdir, a_branch)
1220
# cannot obey revision_id limits when cloning a reference ...
1221
# FIXME RBC 20060210 either nuke revision_id for clone, or
1222
# emit some sort of warning/error to the caller ?!
1225
def open(self, a_bzrdir, _found=False, location=None):
1226
"""Return the branch that the branch reference in a_bzrdir points at.
1228
_found is a private parameter, do not use it. It is used to indicate
1229
if format probing has already be done.
1232
format = BranchFormat.find_format(a_bzrdir)
1233
assert format.__class__ == self.__class__
1234
if location is None:
1235
location = self.get_reference(a_bzrdir)
1236
real_bzrdir = bzrdir.BzrDir.open(location)
1237
result = real_bzrdir.open_branch()
1238
# this changes the behaviour of result.clone to create a new reference
1239
# rather than a copy of the content of the branch.
1240
# I did not use a proxy object because that needs much more extensive
1241
# testing, and we are only changing one behaviour at the moment.
1242
# If we decide to alter more behaviours - i.e. the implicit nickname
1243
# then this should be refactored to introduce a tested proxy branch
1244
# and a subclass of that for use in overriding clone() and ....
1246
result.clone = self._make_reference_clone_function(result)
1250
# formats which have no format string are not discoverable
1251
# and not independently creatable, so are not registered.
1252
__format5 = BzrBranchFormat5()
1253
__format6 = BzrBranchFormat6()
1254
BranchFormat.register_format(__format5)
1255
BranchFormat.register_format(BranchReferenceFormat())
1256
BranchFormat.register_format(__format6)
1257
BranchFormat.set_default_format(__format6)
1258
_legacy_formats = [BzrBranchFormat4(),
1261
class BzrBranch(Branch):
1262
"""A branch stored in the actual filesystem.
1264
Note that it's "local" in the context of the filesystem; it doesn't
1265
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
it's writable, and can be accessed via the normal filesystem API.
1269
def __init__(self, _format=None,
1270
_control_files=None, a_bzrdir=None, _repository=None):
1271
"""Create new branch object at a particular location."""
1272
Branch.__init__(self)
1273
if a_bzrdir is None:
1274
raise ValueError('a_bzrdir must be supplied')
1276
self.bzrdir = a_bzrdir
1277
# self._transport used to point to the directory containing the
1278
# control directory, but was not used - now it's just the transport
1279
# for the branch control files. mbp 20070212
1280
self._base = self.bzrdir.transport.clone('..').base
1281
self._format = _format
1282
if _control_files is None:
1283
raise ValueError('BzrBranch _control_files is None')
1284
self.control_files = _control_files
1285
self._transport = _control_files._transport
1286
self.repository = _repository
1289
return '%s(%r)' % (self.__class__.__name__, self.base)
1293
def _get_base(self):
1294
"""Returns the directory containing the control directory."""
1297
base = property(_get_base, doc="The URL for the root of this branch.")
1299
def abspath(self, name):
1300
"""See Branch.abspath."""
1301
return self.control_files._transport.abspath(name)
1304
@deprecated_method(zero_sixteen)
1306
def get_root_id(self):
1307
"""See Branch.get_root_id."""
1308
tree = self.repository.revision_tree(self.last_revision())
1309
return tree.inventory.root.file_id
1311
def is_locked(self):
1312
return self.control_files.is_locked()
1314
def lock_write(self, token=None):
1315
repo_token = self.repository.lock_write()
1317
token = self.control_files.lock_write(token=token)
1319
self.repository.unlock()
1323
def lock_read(self):
1324
self.repository.lock_read()
1326
self.control_files.lock_read()
1328
self.repository.unlock()
1332
# TODO: test for failed two phase locks. This is known broken.
1334
self.control_files.unlock()
1336
self.repository.unlock()
1337
if not self.control_files.is_locked():
1338
# we just released the lock
1339
self._clear_cached_state()
1341
def peek_lock_mode(self):
1342
if self.control_files._lock_count == 0:
1345
return self.control_files._lock_mode
1347
def get_physical_lock_status(self):
1348
return self.control_files.get_physical_lock_status()
1351
def print_file(self, file, revision_id):
1352
"""See Branch.print_file."""
1353
return self.repository.print_file(file, revision_id)
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
"""Set the last revision of this branch.
1377
The caller is responsible for checking that the revno is correct
1378
for this revision id.
1380
It may be possible to set the branch last revision to an id not
1381
present in the repository. However, branches can also be
1382
configured to check constraints on history, in which case this may not
1385
revision_id = osutils.safe_revision_id(revision_id)
1386
history = self._lefthand_history(revision_id)
1387
assert len(history) == revno, '%d != %d' % (len(history), revno)
1388
self.set_revision_history(history)
1390
def _gen_revision_history(self):
1391
history = self.control_files.get('revision-history').read().split('\n')
1392
if history[-1:] == ['']:
1393
# There shouldn't be a trailing newline, but just in case.
1397
def _lefthand_history(self, revision_id, last_rev=None,
1399
# stop_revision must be a descendant of last_revision
1400
stop_graph = self.repository.get_revision_graph(revision_id)
1401
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1402
and last_rev not in stop_graph):
1403
# our previous tip is not merged into stop_revision
1404
raise errors.DivergedBranches(self, other_branch)
1405
# make a new revision history from the graph
1406
current_rev_id = revision_id
1408
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
new_history.append(current_rev_id)
1410
current_rev_id_parents = stop_graph[current_rev_id]
1412
current_rev_id = current_rev_id_parents[0]
1414
current_rev_id = None
1415
new_history.reverse()
1419
def generate_revision_history(self, revision_id, last_rev=None,
1421
"""Create a new revision history that will finish with revision_id.
1423
:param revision_id: the new tip to use.
1424
:param last_rev: The previous last_revision. If not None, then this
1425
must be a ancestory of revision_id, or DivergedBranches is raised.
1426
:param other_branch: The other branch that DivergedBranches should
1427
raise with respect to.
1429
revision_id = osutils.safe_revision_id(revision_id)
1430
self.set_revision_history(self._lefthand_history(revision_id,
1431
last_rev, other_branch))
1434
def update_revisions(self, other, stop_revision=None):
1435
"""See Branch.update_revisions."""
1438
if stop_revision is None:
1439
stop_revision = other.last_revision()
1440
if stop_revision is None:
1441
# if there are no commits, we're done.
1444
stop_revision = osutils.safe_revision_id(stop_revision)
1445
# whats the current last revision, before we fetch [and change it
1447
last_rev = _mod_revision.ensure_null(self.last_revision())
1448
# we fetch here regardless of whether we need to so that we pickup
1450
self.fetch(other, stop_revision)
1451
if self.repository.get_graph().is_ancestor(stop_revision,
1454
self.generate_revision_history(stop_revision, last_rev=last_rev,
1459
def basis_tree(self):
1460
"""See Branch.basis_tree."""
1461
return self.repository.revision_tree(self.last_revision())
1464
def pull(self, source, overwrite=False, stop_revision=None,
1465
_hook_master=None, run_hooks=True):
1468
:param _hook_master: Private parameter - set the branch to
1469
be supplied as the master to push hooks.
1470
:param run_hooks: Private parameter - if false, this branch
1471
is being called because it's the master of the primary branch,
1472
so it should not run its hooks.
1474
result = PullResult()
1475
result.source_branch = source
1476
result.target_branch = self
1479
result.old_revno, result.old_revid = self.last_revision_info()
1481
self.update_revisions(source, stop_revision)
1482
except DivergedBranches:
1486
if stop_revision is None:
1487
stop_revision = source.last_revision()
1488
self.generate_revision_history(stop_revision)
1489
result.tag_conflicts = source.tags.merge_to(self.tags)
1490
result.new_revno, result.new_revid = self.last_revision_info()
1492
result.master_branch = _hook_master
1493
result.local_branch = self
1495
result.master_branch = self
1496
result.local_branch = None
1498
for hook in Branch.hooks['post_pull']:
1504
def _get_parent_location(self):
1505
_locs = ['parent', 'pull', 'x-pull']
1508
return self.control_files.get(l).read().strip('\n')
1514
def push(self, target, overwrite=False, stop_revision=None,
1515
_override_hook_source_branch=None):
1518
This is the basic concrete implementation of push()
1520
:param _override_hook_source_branch: If specified, run
1521
the hooks passing this Branch as the source, rather than self.
1522
This is for use of RemoteBranch, where push is delegated to the
1523
underlying vfs-based Branch.
1525
# TODO: Public option to disable running hooks - should be trivial but
1529
result = self._push_with_bound_branches(target, overwrite,
1531
_override_hook_source_branch=_override_hook_source_branch)
1536
def _push_with_bound_branches(self, target, overwrite,
1538
_override_hook_source_branch=None):
1539
"""Push from self into target, and into target's master if any.
1541
This is on the base BzrBranch class even though it doesn't support
1542
bound branches because the *target* might be bound.
1545
if _override_hook_source_branch:
1546
result.source_branch = _override_hook_source_branch
1547
for hook in Branch.hooks['post_push']:
1550
bound_location = target.get_bound_location()
1551
if bound_location and target.base != bound_location:
1552
# there is a master branch.
1554
# XXX: Why the second check? Is it even supported for a branch to
1555
# be bound to itself? -- mbp 20070507
1556
master_branch = target.get_master_branch()
1557
master_branch.lock_write()
1559
# push into the master from this branch.
1560
self._basic_push(master_branch, overwrite, stop_revision)
1561
# and push into the target branch from this. Note that we push from
1562
# this branch again, because its considered the highest bandwidth
1564
result = self._basic_push(target, overwrite, stop_revision)
1565
result.master_branch = master_branch
1566
result.local_branch = target
1570
master_branch.unlock()
1573
result = self._basic_push(target, overwrite, stop_revision)
1574
# TODO: Why set master_branch and local_branch if there's no
1575
# binding? Maybe cleaner to just leave them unset? -- mbp
1577
result.master_branch = target
1578
result.local_branch = None
1582
def _basic_push(self, target, overwrite, stop_revision):
1583
"""Basic implementation of push without bound branches or hooks.
1585
Must be called with self read locked and target write locked.
1587
result = PushResult()
1588
result.source_branch = self
1589
result.target_branch = target
1590
result.old_revno, result.old_revid = target.last_revision_info()
1592
target.update_revisions(self, stop_revision)
1593
except DivergedBranches:
1597
target.set_revision_history(self.revision_history())
1598
result.tag_conflicts = self.tags.merge_to(target.tags)
1599
result.new_revno, result.new_revid = target.last_revision_info()
1602
def get_parent(self):
1603
"""See Branch.get_parent."""
1605
assert self.base[-1] == '/'
1606
parent = self._get_parent_location()
1609
# This is an old-format absolute path to a local branch
1610
# turn it into a url
1611
if parent.startswith('/'):
1612
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1614
return urlutils.join(self.base[:-1], parent)
1615
except errors.InvalidURLJoin, e:
1616
raise errors.InaccessibleParent(parent, self.base)
1618
def set_push_location(self, location):
1619
"""See Branch.set_push_location."""
1620
self.get_config().set_user_option(
1621
'push_location', location,
1622
store=_mod_config.STORE_LOCATION_NORECURSE)
1625
def set_parent(self, url):
1626
"""See Branch.set_parent."""
1627
# TODO: Maybe delete old location files?
1628
# URLs should never be unicode, even on the local fs,
1629
# FIXUP this and get_parent in a future branch format bump:
1630
# read and rewrite the file, and have the new format code read
1631
# using .get not .get_utf8. RBC 20060125
1633
if isinstance(url, unicode):
1635
url = url.encode('ascii')
1636
except UnicodeEncodeError:
1637
raise errors.InvalidURL(url,
1638
"Urls must be 7-bit ascii, "
1639
"use bzrlib.urlutils.escape")
1640
url = urlutils.relative_url(self.base, url)
1641
self._set_parent_location(url)
1643
def _set_parent_location(self, url):
1645
self.control_files._transport.delete('parent')
1647
assert isinstance(url, str)
1648
self.control_files.put_bytes('parent', url + '\n')
1651
class BzrBranch5(BzrBranch):
1652
"""A format 5 branch. This supports new features over plan branches.
1654
It has support for a master_branch which is the data for bound branches.
1662
super(BzrBranch5, self).__init__(_format=_format,
1663
_control_files=_control_files,
1665
_repository=_repository)
1668
def pull(self, source, overwrite=False, stop_revision=None,
1670
"""Pull from source into self, updating my master if any.
1672
:param run_hooks: Private parameter - if false, this branch
1673
is being called because it's the master of the primary branch,
1674
so it should not run its hooks.
1676
bound_location = self.get_bound_location()
1677
master_branch = None
1678
if bound_location and source.base != bound_location:
1679
# not pulling from master, so we need to update master.
1680
master_branch = self.get_master_branch()
1681
master_branch.lock_write()
1684
# pull from source into master.
1685
master_branch.pull(source, overwrite, stop_revision,
1687
return super(BzrBranch5, self).pull(source, overwrite,
1688
stop_revision, _hook_master=master_branch,
1689
run_hooks=run_hooks)
1692
master_branch.unlock()
1694
def get_bound_location(self):
1696
return self.control_files.get_utf8('bound').read()[:-1]
1697
except errors.NoSuchFile:
1701
def get_master_branch(self):
1702
"""Return the branch we are bound to.
1704
:return: Either a Branch, or None
1706
This could memoise the branch, but if thats done
1707
it must be revalidated on each new lock.
1708
So for now we just don't memoise it.
1709
# RBC 20060304 review this decision.
1711
bound_loc = self.get_bound_location()
1715
return Branch.open(bound_loc)
1716
except (errors.NotBranchError, errors.ConnectionError), e:
1717
raise errors.BoundBranchConnectionFailure(
1721
def set_bound_location(self, location):
1722
"""Set the target where this branch is bound to.
1724
:param location: URL to the target branch
1727
self.control_files.put_utf8('bound', location+'\n')
1730
self.control_files._transport.delete('bound')
1736
def bind(self, other):
1737
"""Bind this branch to the branch other.
1739
This does not push or pull data between the branches, though it does
1740
check for divergence to raise an error when the branches are not
1741
either the same, or one a prefix of the other. That behaviour may not
1742
be useful, so that check may be removed in future.
1744
:param other: The branch to bind to
1747
# TODO: jam 20051230 Consider checking if the target is bound
1748
# It is debatable whether you should be able to bind to
1749
# a branch which is itself bound.
1750
# Committing is obviously forbidden,
1751
# but binding itself may not be.
1752
# Since we *have* to check at commit time, we don't
1753
# *need* to check here
1755
# we want to raise diverged if:
1756
# last_rev is not in the other_last_rev history, AND
1757
# other_last_rev is not in our history, and do it without pulling
1759
last_rev = _mod_revision.ensure_null(self.last_revision())
1760
if last_rev != _mod_revision.NULL_REVISION:
1763
other_last_rev = other.last_revision()
1764
if not _mod_revision.is_null(other_last_rev):
1765
# neither branch is new, we have to do some work to
1766
# ascertain diversion.
1767
remote_graph = other.repository.get_revision_graph(
1769
local_graph = self.repository.get_revision_graph(last_rev)
1770
if (last_rev not in remote_graph and
1771
other_last_rev not in local_graph):
1772
raise errors.DivergedBranches(self, other)
1775
self.set_bound_location(other.base)
1779
"""If bound, unbind"""
1780
return self.set_bound_location(None)
1784
"""Synchronise this branch with the master branch if any.
1786
:return: None or the last_revision that was pivoted out during the
1789
master = self.get_master_branch()
1790
if master is not None:
1791
old_tip = _mod_revision.ensure_null(self.last_revision())
1792
self.pull(master, overwrite=True)
1793
if self.repository.get_graph().is_ancestor(old_tip,
1794
_mod_revision.ensure_null(self.last_revision())):
1800
class BzrBranchExperimental(BzrBranch5):
1801
"""Bzr experimental branch format
1804
- a revision-history file.
1806
- a lock dir guarding the branch itself
1807
- all of this stored in a branch/ subdirectory
1808
- works with shared repositories.
1809
- a tag dictionary in the branch
1811
This format is new in bzr 0.15, but shouldn't be used for real data,
1814
This class acts as it's own BranchFormat.
1817
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1820
def get_format_string(cls):
1821
"""See BranchFormat.get_format_string()."""
1822
return "Bazaar-NG branch format experimental\n"
1825
def get_format_description(cls):
1826
"""See BranchFormat.get_format_description()."""
1827
return "Experimental branch format"
1830
def get_reference(cls, a_bzrdir):
1831
"""Get the target reference of the branch in a_bzrdir.
1833
format probing must have been completed before calling
1834
this method - it is assumed that the format of the branch
1835
in a_bzrdir is correct.
1837
:param a_bzrdir: The bzrdir to get the branch data from.
1838
:return: None if the branch is not a reference branch.
1843
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1845
branch_transport = a_bzrdir.get_branch_transport(cls)
1846
control_files = lockable_files.LockableFiles(branch_transport,
1847
lock_filename, lock_class)
1848
control_files.create_lock()
1849
control_files.lock_write()
1851
for filename, content in utf8_files:
1852
control_files.put_utf8(filename, content)
1854
control_files.unlock()
1857
def initialize(cls, a_bzrdir):
1858
"""Create a branch of this format in a_bzrdir."""
1859
utf8_files = [('format', cls.get_format_string()),
1860
('revision-history', ''),
1861
('branch-name', ''),
1864
cls._initialize_control_files(a_bzrdir, utf8_files,
1865
'lock', lockdir.LockDir)
1866
return cls.open(a_bzrdir, _found=True)
1869
def open(cls, a_bzrdir, _found=False):
1870
"""Return the branch object for a_bzrdir
1872
_found is a private parameter, do not use it. It is used to indicate
1873
if format probing has already be done.
1876
format = BranchFormat.find_format(a_bzrdir)
1877
assert format.__class__ == cls
1878
transport = a_bzrdir.get_branch_transport(None)
1879
control_files = lockable_files.LockableFiles(transport, 'lock',
1881
return cls(_format=cls,
1882
_control_files=control_files,
1884
_repository=a_bzrdir.find_repository())
1887
def is_supported(cls):
1890
def _make_tags(self):
1891
return BasicTags(self)
1894
def supports_tags(cls):
1898
BranchFormat.register_format(BzrBranchExperimental)
1901
class BzrBranch6(BzrBranch5):
1904
def last_revision_info(self):
1905
revision_string = self.control_files.get('last-revision').read()
1906
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1907
revision_id = cache_utf8.get_cached_utf8(revision_id)
1909
return revno, revision_id
1911
def last_revision(self):
1912
"""Return last revision id, or None"""
1913
revision_id = self.last_revision_info()[1]
1916
def _write_last_revision_info(self, revno, revision_id):
1917
"""Simply write out the revision id, with no checks.
1919
Use set_last_revision_info to perform this safely.
1921
Does not update the revision_history cache.
1922
Intended to be called by set_last_revision_info and
1923
_write_revision_history.
1925
if revision_id is None:
1926
revision_id = 'null:'
1927
out_string = '%d %s\n' % (revno, revision_id)
1928
self.control_files.put_bytes('last-revision', out_string)
1931
def set_last_revision_info(self, revno, revision_id):
1932
revision_id = osutils.safe_revision_id(revision_id)
1933
if self._get_append_revisions_only():
1934
self._check_history_violation(revision_id)
1935
self._write_last_revision_info(revno, revision_id)
1936
self._clear_cached_state()
1938
def _check_history_violation(self, revision_id):
1939
last_revision = _mod_revision.ensure_null(self.last_revision())
1940
if _mod_revision.is_null(last_revision):
1942
if last_revision not in self._lefthand_history(revision_id):
1943
raise errors.AppendRevisionsOnlyViolation(self.base)
1945
def _gen_revision_history(self):
1946
"""Generate the revision history from last revision
1948
history = list(self.repository.iter_reverse_revision_history(
1949
self.last_revision()))
1953
def _write_revision_history(self, history):
1954
"""Factored out of set_revision_history.
1956
This performs the actual writing to disk, with format-specific checks.
1957
It is intended to be called by BzrBranch5.set_revision_history.
1959
if len(history) == 0:
1960
last_revision = 'null:'
1962
if history != self._lefthand_history(history[-1]):
1963
raise errors.NotLefthandHistory(history)
1964
last_revision = history[-1]
1965
if self._get_append_revisions_only():
1966
self._check_history_violation(last_revision)
1967
self._write_last_revision_info(len(history), last_revision)
1970
def _set_parent_location(self, url):
1971
"""Set the parent branch"""
1972
self._set_config_location('parent_location', url, make_relative=True)
1975
def _get_parent_location(self):
1976
"""Set the parent branch"""
1977
return self._get_config_location('parent_location')
1979
def set_push_location(self, location):
1980
"""See Branch.set_push_location."""
1981
self._set_config_location('push_location', location)
1983
def set_bound_location(self, location):
1984
"""See Branch.set_push_location."""
1986
config = self.get_config()
1987
if location is None:
1988
if config.get_user_option('bound') != 'True':
1991
config.set_user_option('bound', 'False', warn_masked=True)
1994
self._set_config_location('bound_location', location,
1996
config.set_user_option('bound', 'True', warn_masked=True)
1999
def _get_bound_location(self, bound):
2000
"""Return the bound location in the config file.
2002
Return None if the bound parameter does not match"""
2003
config = self.get_config()
2004
config_bound = (config.get_user_option('bound') == 'True')
2005
if config_bound != bound:
2007
return self._get_config_location('bound_location', config=config)
2009
def get_bound_location(self):
2010
"""See Branch.set_push_location."""
2011
return self._get_bound_location(True)
2013
def get_old_bound_location(self):
2014
"""See Branch.get_old_bound_location"""
2015
return self._get_bound_location(False)
2017
def set_append_revisions_only(self, enabled):
2022
self.get_config().set_user_option('append_revisions_only', value,
2025
def _get_append_revisions_only(self):
2026
value = self.get_config().get_user_option('append_revisions_only')
2027
return value == 'True'
2029
def _synchronize_history(self, destination, revision_id):
2030
"""Synchronize last revision and revision history between branches.
2032
This version is most efficient when the destination is also a
2033
BzrBranch6, but works for BzrBranch5, as long as the destination's
2034
repository contains all the lefthand ancestors of the intended
2035
last_revision. If not, set_last_revision_info will fail.
2037
:param destination: The branch to copy the history into
2038
:param revision_id: The revision-id to truncate history at. May
2039
be None to copy complete history.
2041
source_revno, source_revision_id = self.last_revision_info()
2042
if revision_id is None:
2043
revno, revision_id = source_revno, source_revision_id
2044
elif source_revision_id == revision_id:
2045
# we know the revno without needing to walk all of history
2046
revno = source_revno
2048
# To figure out the revno for a random revision, we need to build
2049
# the revision history, and count its length.
2050
# We don't care about the order, just how long it is.
2051
# Alternatively, we could start at the current location, and count
2052
# backwards. But there is no guarantee that we will find it since
2053
# it may be a merged revision.
2054
revno = len(list(self.repository.iter_reverse_revision_history(
2056
destination.set_last_revision_info(revno, revision_id)
2058
def _make_tags(self):
2059
return BasicTags(self)
2062
######################################################################
2063
# results of operations
2066
class _Result(object):
2068
def _show_tag_conficts(self, to_file):
2069
if not getattr(self, 'tag_conflicts', None):
2071
to_file.write('Conflicting tags:\n')
2072
for name, value1, value2 in self.tag_conflicts:
2073
to_file.write(' %s\n' % (name, ))
2076
class PullResult(_Result):
2077
"""Result of a Branch.pull operation.
2079
:ivar old_revno: Revision number before pull.
2080
:ivar new_revno: Revision number after pull.
2081
:ivar old_revid: Tip revision id before pull.
2082
:ivar new_revid: Tip revision id after pull.
2083
:ivar source_branch: Source (local) branch object.
2084
:ivar master_branch: Master branch of the target, or None.
2085
:ivar target_branch: Target/destination branch object.
2089
# DEPRECATED: pull used to return the change in revno
2090
return self.new_revno - self.old_revno
2092
def report(self, to_file):
2093
if self.old_revid == self.new_revid:
2094
to_file.write('No revisions to pull.\n')
2096
to_file.write('Now on revision %d.\n' % self.new_revno)
2097
self._show_tag_conficts(to_file)
2100
class PushResult(_Result):
2101
"""Result of a Branch.push operation.
2103
:ivar old_revno: Revision number before push.
2104
:ivar new_revno: Revision number after push.
2105
:ivar old_revid: Tip revision id before push.
2106
:ivar new_revid: Tip revision id after push.
2107
:ivar source_branch: Source branch object.
2108
:ivar master_branch: Master branch of the target, or None.
2109
:ivar target_branch: Target/destination branch object.
2113
# DEPRECATED: push used to return the change in revno
2114
return self.new_revno - self.old_revno
2116
def report(self, to_file):
2117
"""Write a human-readable description of the result."""
2118
if self.old_revid == self.new_revid:
2119
to_file.write('No new revisions to push.\n')
2121
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2122
self._show_tag_conficts(to_file)
2125
class BranchCheckResult(object):
2126
"""Results of checking branch consistency.
2131
def __init__(self, branch):
2132
self.branch = branch
2134
def report_results(self, verbose):
2135
"""Report the check results via trace.note.
2137
:param verbose: Requests more detailed display of what was checked,
2140
note('checked branch %s format %s',
2142
self.branch._format)
2145
class Converter5to6(object):
2146
"""Perform an in-place upgrade of format 5 to format 6"""
2148
def convert(self, branch):
2149
# Data for 5 and 6 can peacefully coexist.
2150
format = BzrBranchFormat6()
2151
new_branch = format.open(branch.bzrdir, _found=True)
2153
# Copy source data into target
2154
new_branch.set_last_revision_info(*branch.last_revision_info())
2155
new_branch.set_parent(branch.get_parent())
2156
new_branch.set_bound_location(branch.get_bound_location())
2157
new_branch.set_push_location(branch.get_push_location())
2159
# New branch has no tags by default
2160
new_branch.tags._set_tag_dict({})
2162
# Copying done; now update target format
2163
new_branch.control_files.put_utf8('format',
2164
format.get_format_string())
2166
# Clean up old files
2167
new_branch.control_files._transport.delete('revision-history')
2169
branch.set_parent(None)
2172
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
