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
# tree_delta, future_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# tree_delta is a TreeDelta object describing changes from the basis
1008
# revision, hooks MUST NOT modify this delta
1009
# future_tree is an in-memory tree obtained from
1010
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1011
self['pre_commit'] = []
1012
# invoked after a commit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid)
1015
# old_revid is NULL_REVISION for the first commit to a branch.
1016
self['post_commit'] = []
1017
# invoked after a uncommit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1020
# local is the local branch or None, master is the target branch,
1021
# and an empty branch recieves new_revno of 0, new_revid of None.
1022
self['post_uncommit'] = []
1025
# install the default hooks into the Branch class.
1026
Branch.hooks = BranchHooks()
1029
class BzrBranchFormat4(BranchFormat):
1030
"""Bzr branch format 4.
1033
- a revision-history file.
1034
- a branch-lock lock file [ to be shared with the bzrdir ]
1037
def get_format_description(self):
1038
"""See BranchFormat.get_format_description()."""
1039
return "Branch format 4"
1041
def initialize(self, a_bzrdir):
1042
"""Create a branch of this format in a_bzrdir."""
1043
utf8_files = [('revision-history', ''),
1044
('branch-name', ''),
1046
return self._initialize_helper(a_bzrdir, utf8_files,
1047
lock_type='branch4', set_format=False)
1050
super(BzrBranchFormat4, self).__init__()
1051
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1053
def open(self, a_bzrdir, _found=False):
1054
"""Return the branch object for a_bzrdir
1056
_found is a private parameter, do not use it. It is used to indicate
1057
if format probing has already be done.
1060
# we are being called directly and must probe.
1061
raise NotImplementedError
1062
return BzrBranch(_format=self,
1063
_control_files=a_bzrdir._control_files,
1065
_repository=a_bzrdir.open_repository())
1068
return "Bazaar-NG branch format 4"
1071
class BzrBranchFormat5(BranchFormat):
1072
"""Bzr branch format 5.
1075
- a revision-history file.
1077
- a lock dir guarding the branch itself
1078
- all of this stored in a branch/ subdirectory
1079
- works with shared repositories.
1081
This format is new in bzr 0.8.
1084
def get_format_string(self):
1085
"""See BranchFormat.get_format_string()."""
1086
return "Bazaar-NG branch format 5\n"
1088
def get_format_description(self):
1089
"""See BranchFormat.get_format_description()."""
1090
return "Branch format 5"
1092
def initialize(self, a_bzrdir):
1093
"""Create a branch of this format in a_bzrdir."""
1094
utf8_files = [('revision-history', ''),
1095
('branch-name', ''),
1097
return self._initialize_helper(a_bzrdir, utf8_files)
1100
super(BzrBranchFormat5, self).__init__()
1101
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1103
def open(self, a_bzrdir, _found=False):
1104
"""Return the branch object for a_bzrdir
1106
_found is a private parameter, do not use it. It is used to indicate
1107
if format probing has already be done.
1110
format = BranchFormat.find_format(a_bzrdir)
1111
assert format.__class__ == self.__class__
1113
transport = a_bzrdir.get_branch_transport(None)
1114
control_files = lockable_files.LockableFiles(transport, 'lock',
1116
return BzrBranch5(_format=self,
1117
_control_files=control_files,
1119
_repository=a_bzrdir.find_repository())
1121
raise NotBranchError(path=transport.base)
1124
class BzrBranchFormat6(BzrBranchFormat5):
1125
"""Branch format with last-revision and tags.
1127
Unlike previous formats, this has no explicit revision history. Instead,
1128
this just stores the last-revision, and the left-hand history leading
1129
up to there is the history.
1131
This format was introduced in bzr 0.15
1132
and became the default in 0.91.
1135
def get_format_string(self):
1136
"""See BranchFormat.get_format_string()."""
1137
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1139
def get_format_description(self):
1140
"""See BranchFormat.get_format_description()."""
1141
return "Branch format 6"
1143
def initialize(self, a_bzrdir):
1144
"""Create a branch of this format in a_bzrdir."""
1145
utf8_files = [('last-revision', '0 null:\n'),
1146
('branch-name', ''),
1147
('branch.conf', ''),
1150
return self._initialize_helper(a_bzrdir, utf8_files)
1152
def open(self, a_bzrdir, _found=False):
1153
"""Return the branch object for a_bzrdir
1155
_found is a private parameter, do not use it. It is used to indicate
1156
if format probing has already be done.
1159
format = BranchFormat.find_format(a_bzrdir)
1160
assert format.__class__ == self.__class__
1161
transport = a_bzrdir.get_branch_transport(None)
1162
control_files = lockable_files.LockableFiles(transport, 'lock',
1164
return BzrBranch6(_format=self,
1165
_control_files=control_files,
1167
_repository=a_bzrdir.find_repository())
1169
def supports_tags(self):
1173
class BranchReferenceFormat(BranchFormat):
1174
"""Bzr branch reference format.
1176
Branch references are used in implementing checkouts, they
1177
act as an alias to the real branch which is at some other url.
1184
def get_format_string(self):
1185
"""See BranchFormat.get_format_string()."""
1186
return "Bazaar-NG Branch Reference Format 1\n"
1188
def get_format_description(self):
1189
"""See BranchFormat.get_format_description()."""
1190
return "Checkout reference format 1"
1192
def get_reference(self, a_bzrdir):
1193
"""See BranchFormat.get_reference()."""
1194
transport = a_bzrdir.get_branch_transport(None)
1195
return transport.get('location').read()
1197
def initialize(self, a_bzrdir, target_branch=None):
1198
"""Create a branch of this format in a_bzrdir."""
1199
if target_branch is None:
1200
# this format does not implement branch itself, thus the implicit
1201
# creation contract must see it as uninitializable
1202
raise errors.UninitializableFormat(self)
1203
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1204
branch_transport = a_bzrdir.get_branch_transport(self)
1205
branch_transport.put_bytes('location',
1206
target_branch.bzrdir.root_transport.base)
1207
branch_transport.put_bytes('format', self.get_format_string())
1208
return self.open(a_bzrdir, _found=True)
1211
super(BranchReferenceFormat, self).__init__()
1212
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1214
def _make_reference_clone_function(format, a_branch):
1215
"""Create a clone() routine for a branch dynamically."""
1216
def clone(to_bzrdir, revision_id=None):
1217
"""See Branch.clone()."""
1218
return format.initialize(to_bzrdir, a_branch)
1219
# cannot obey revision_id limits when cloning a reference ...
1220
# FIXME RBC 20060210 either nuke revision_id for clone, or
1221
# emit some sort of warning/error to the caller ?!
1224
def open(self, a_bzrdir, _found=False, location=None):
1225
"""Return the branch that the branch reference in a_bzrdir points at.
1227
_found is a private parameter, do not use it. It is used to indicate
1228
if format probing has already be done.
1231
format = BranchFormat.find_format(a_bzrdir)
1232
assert format.__class__ == self.__class__
1233
if location is None:
1234
location = self.get_reference(a_bzrdir)
1235
real_bzrdir = bzrdir.BzrDir.open(location)
1236
result = real_bzrdir.open_branch()
1237
# this changes the behaviour of result.clone to create a new reference
1238
# rather than a copy of the content of the branch.
1239
# I did not use a proxy object because that needs much more extensive
1240
# testing, and we are only changing one behaviour at the moment.
1241
# If we decide to alter more behaviours - i.e. the implicit nickname
1242
# then this should be refactored to introduce a tested proxy branch
1243
# and a subclass of that for use in overriding clone() and ....
1245
result.clone = self._make_reference_clone_function(result)
1249
# formats which have no format string are not discoverable
1250
# and not independently creatable, so are not registered.
1251
__format5 = BzrBranchFormat5()
1252
__format6 = BzrBranchFormat6()
1253
BranchFormat.register_format(__format5)
1254
BranchFormat.register_format(BranchReferenceFormat())
1255
BranchFormat.register_format(__format6)
1256
BranchFormat.set_default_format(__format6)
1257
_legacy_formats = [BzrBranchFormat4(),
1260
class BzrBranch(Branch):
1261
"""A branch stored in the actual filesystem.
1263
Note that it's "local" in the context of the filesystem; it doesn't
1264
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1265
it's writable, and can be accessed via the normal filesystem API.
1268
def __init__(self, _format=None,
1269
_control_files=None, a_bzrdir=None, _repository=None):
1270
"""Create new branch object at a particular location."""
1271
Branch.__init__(self)
1272
if a_bzrdir is None:
1273
raise ValueError('a_bzrdir must be supplied')
1275
self.bzrdir = a_bzrdir
1276
# self._transport used to point to the directory containing the
1277
# control directory, but was not used - now it's just the transport
1278
# for the branch control files. mbp 20070212
1279
self._base = self.bzrdir.transport.clone('..').base
1280
self._format = _format
1281
if _control_files is None:
1282
raise ValueError('BzrBranch _control_files is None')
1283
self.control_files = _control_files
1284
self._transport = _control_files._transport
1285
self.repository = _repository
1288
return '%s(%r)' % (self.__class__.__name__, self.base)
1292
def _get_base(self):
1293
"""Returns the directory containing the control directory."""
1296
base = property(_get_base, doc="The URL for the root of this branch.")
1298
def abspath(self, name):
1299
"""See Branch.abspath."""
1300
return self.control_files._transport.abspath(name)
1303
@deprecated_method(zero_sixteen)
1305
def get_root_id(self):
1306
"""See Branch.get_root_id."""
1307
tree = self.repository.revision_tree(self.last_revision())
1308
return tree.inventory.root.file_id
1310
def is_locked(self):
1311
return self.control_files.is_locked()
1313
def lock_write(self, token=None):
1314
repo_token = self.repository.lock_write()
1316
token = self.control_files.lock_write(token=token)
1318
self.repository.unlock()
1322
def lock_read(self):
1323
self.repository.lock_read()
1325
self.control_files.lock_read()
1327
self.repository.unlock()
1331
# TODO: test for failed two phase locks. This is known broken.
1333
self.control_files.unlock()
1335
self.repository.unlock()
1336
if not self.control_files.is_locked():
1337
# we just released the lock
1338
self._clear_cached_state()
1340
def peek_lock_mode(self):
1341
if self.control_files._lock_count == 0:
1344
return self.control_files._lock_mode
1346
def get_physical_lock_status(self):
1347
return self.control_files.get_physical_lock_status()
1350
def print_file(self, file, revision_id):
1351
"""See Branch.print_file."""
1352
return self.repository.print_file(file, revision_id)
1354
def _write_revision_history(self, history):
1355
"""Factored out of set_revision_history.
1357
This performs the actual writing to disk.
1358
It is intended to be called by BzrBranch5.set_revision_history."""
1359
self.control_files.put_bytes(
1360
'revision-history', '\n'.join(history))
1363
def set_revision_history(self, rev_history):
1364
"""See Branch.set_revision_history."""
1365
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1366
self._clear_cached_state()
1367
self._write_revision_history(rev_history)
1368
self._cache_revision_history(rev_history)
1369
for hook in Branch.hooks['set_rh']:
1370
hook(self, rev_history)
1373
def set_last_revision_info(self, revno, revision_id):
1374
"""Set the last revision of this branch.
1376
The caller is responsible for checking that the revno is correct
1377
for this revision id.
1379
It may be possible to set the branch last revision to an id not
1380
present in the repository. However, branches can also be
1381
configured to check constraints on history, in which case this may not
1384
revision_id = osutils.safe_revision_id(revision_id)
1385
history = self._lefthand_history(revision_id)
1386
assert len(history) == revno, '%d != %d' % (len(history), revno)
1387
self.set_revision_history(history)
1389
def _gen_revision_history(self):
1390
history = self.control_files.get('revision-history').read().split('\n')
1391
if history[-1:] == ['']:
1392
# There shouldn't be a trailing newline, but just in case.
1396
def _lefthand_history(self, revision_id, last_rev=None,
1398
# stop_revision must be a descendant of last_revision
1399
stop_graph = self.repository.get_revision_graph(revision_id)
1400
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1401
and last_rev not in stop_graph):
1402
# our previous tip is not merged into stop_revision
1403
raise errors.DivergedBranches(self, other_branch)
1404
# make a new revision history from the graph
1405
current_rev_id = revision_id
1407
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1408
new_history.append(current_rev_id)
1409
current_rev_id_parents = stop_graph[current_rev_id]
1411
current_rev_id = current_rev_id_parents[0]
1413
current_rev_id = None
1414
new_history.reverse()
1418
def generate_revision_history(self, revision_id, last_rev=None,
1420
"""Create a new revision history that will finish with revision_id.
1422
:param revision_id: the new tip to use.
1423
:param last_rev: The previous last_revision. If not None, then this
1424
must be a ancestory of revision_id, or DivergedBranches is raised.
1425
:param other_branch: The other branch that DivergedBranches should
1426
raise with respect to.
1428
revision_id = osutils.safe_revision_id(revision_id)
1429
self.set_revision_history(self._lefthand_history(revision_id,
1430
last_rev, other_branch))
1433
def update_revisions(self, other, stop_revision=None):
1434
"""See Branch.update_revisions."""
1437
if stop_revision is None:
1438
stop_revision = other.last_revision()
1439
if stop_revision is None:
1440
# if there are no commits, we're done.
1443
stop_revision = osutils.safe_revision_id(stop_revision)
1444
# whats the current last revision, before we fetch [and change it
1446
last_rev = _mod_revision.ensure_null(self.last_revision())
1447
# we fetch here regardless of whether we need to so that we pickup
1449
self.fetch(other, stop_revision)
1450
if self.repository.get_graph().is_ancestor(stop_revision,
1453
self.generate_revision_history(stop_revision, last_rev=last_rev,
1458
def basis_tree(self):
1459
"""See Branch.basis_tree."""
1460
return self.repository.revision_tree(self.last_revision())
1463
def pull(self, source, overwrite=False, stop_revision=None,
1464
_hook_master=None, run_hooks=True):
1467
:param _hook_master: Private parameter - set the branch to
1468
be supplied as the master to push hooks.
1469
:param run_hooks: Private parameter - if false, this branch
1470
is being called because it's the master of the primary branch,
1471
so it should not run its hooks.
1473
result = PullResult()
1474
result.source_branch = source
1475
result.target_branch = self
1478
result.old_revno, result.old_revid = self.last_revision_info()
1480
self.update_revisions(source, stop_revision)
1481
except DivergedBranches:
1485
if stop_revision is None:
1486
stop_revision = source.last_revision()
1487
self.generate_revision_history(stop_revision)
1488
result.tag_conflicts = source.tags.merge_to(self.tags)
1489
result.new_revno, result.new_revid = self.last_revision_info()
1491
result.master_branch = _hook_master
1492
result.local_branch = self
1494
result.master_branch = self
1495
result.local_branch = None
1497
for hook in Branch.hooks['post_pull']:
1503
def _get_parent_location(self):
1504
_locs = ['parent', 'pull', 'x-pull']
1507
return self.control_files.get(l).read().strip('\n')
1513
def push(self, target, overwrite=False, stop_revision=None,
1514
_override_hook_source_branch=None):
1517
This is the basic concrete implementation of push()
1519
:param _override_hook_source_branch: If specified, run
1520
the hooks passing this Branch as the source, rather than self.
1521
This is for use of RemoteBranch, where push is delegated to the
1522
underlying vfs-based Branch.
1524
# TODO: Public option to disable running hooks - should be trivial but
1528
result = self._push_with_bound_branches(target, overwrite,
1530
_override_hook_source_branch=_override_hook_source_branch)
1535
def _push_with_bound_branches(self, target, overwrite,
1537
_override_hook_source_branch=None):
1538
"""Push from self into target, and into target's master if any.
1540
This is on the base BzrBranch class even though it doesn't support
1541
bound branches because the *target* might be bound.
1544
if _override_hook_source_branch:
1545
result.source_branch = _override_hook_source_branch
1546
for hook in Branch.hooks['post_push']:
1549
bound_location = target.get_bound_location()
1550
if bound_location and target.base != bound_location:
1551
# there is a master branch.
1553
# XXX: Why the second check? Is it even supported for a branch to
1554
# be bound to itself? -- mbp 20070507
1555
master_branch = target.get_master_branch()
1556
master_branch.lock_write()
1558
# push into the master from this branch.
1559
self._basic_push(master_branch, overwrite, stop_revision)
1560
# and push into the target branch from this. Note that we push from
1561
# this branch again, because its considered the highest bandwidth
1563
result = self._basic_push(target, overwrite, stop_revision)
1564
result.master_branch = master_branch
1565
result.local_branch = target
1569
master_branch.unlock()
1572
result = self._basic_push(target, overwrite, stop_revision)
1573
# TODO: Why set master_branch and local_branch if there's no
1574
# binding? Maybe cleaner to just leave them unset? -- mbp
1576
result.master_branch = target
1577
result.local_branch = None
1581
def _basic_push(self, target, overwrite, stop_revision):
1582
"""Basic implementation of push without bound branches or hooks.
1584
Must be called with self read locked and target write locked.
1586
result = PushResult()
1587
result.source_branch = self
1588
result.target_branch = target
1589
result.old_revno, result.old_revid = target.last_revision_info()
1591
target.update_revisions(self, stop_revision)
1592
except DivergedBranches:
1596
target.set_revision_history(self.revision_history())
1597
result.tag_conflicts = self.tags.merge_to(target.tags)
1598
result.new_revno, result.new_revid = target.last_revision_info()
1601
def get_parent(self):
1602
"""See Branch.get_parent."""
1604
assert self.base[-1] == '/'
1605
parent = self._get_parent_location()
1608
# This is an old-format absolute path to a local branch
1609
# turn it into a url
1610
if parent.startswith('/'):
1611
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1613
return urlutils.join(self.base[:-1], parent)
1614
except errors.InvalidURLJoin, e:
1615
raise errors.InaccessibleParent(parent, self.base)
1617
def set_push_location(self, location):
1618
"""See Branch.set_push_location."""
1619
self.get_config().set_user_option(
1620
'push_location', location,
1621
store=_mod_config.STORE_LOCATION_NORECURSE)
1624
def set_parent(self, url):
1625
"""See Branch.set_parent."""
1626
# TODO: Maybe delete old location files?
1627
# URLs should never be unicode, even on the local fs,
1628
# FIXUP this and get_parent in a future branch format bump:
1629
# read and rewrite the file, and have the new format code read
1630
# using .get not .get_utf8. RBC 20060125
1632
if isinstance(url, unicode):
1634
url = url.encode('ascii')
1635
except UnicodeEncodeError:
1636
raise errors.InvalidURL(url,
1637
"Urls must be 7-bit ascii, "
1638
"use bzrlib.urlutils.escape")
1639
url = urlutils.relative_url(self.base, url)
1640
self._set_parent_location(url)
1642
def _set_parent_location(self, url):
1644
self.control_files._transport.delete('parent')
1646
assert isinstance(url, str)
1647
self.control_files.put_bytes('parent', url + '\n')
1650
class BzrBranch5(BzrBranch):
1651
"""A format 5 branch. This supports new features over plan branches.
1653
It has support for a master_branch which is the data for bound branches.
1661
super(BzrBranch5, self).__init__(_format=_format,
1662
_control_files=_control_files,
1664
_repository=_repository)
1667
def pull(self, source, overwrite=False, stop_revision=None,
1669
"""Pull from source into self, updating my master if any.
1671
:param run_hooks: Private parameter - if false, this branch
1672
is being called because it's the master of the primary branch,
1673
so it should not run its hooks.
1675
bound_location = self.get_bound_location()
1676
master_branch = None
1677
if bound_location and source.base != bound_location:
1678
# not pulling from master, so we need to update master.
1679
master_branch = self.get_master_branch()
1680
master_branch.lock_write()
1683
# pull from source into master.
1684
master_branch.pull(source, overwrite, stop_revision,
1686
return super(BzrBranch5, self).pull(source, overwrite,
1687
stop_revision, _hook_master=master_branch,
1688
run_hooks=run_hooks)
1691
master_branch.unlock()
1693
def get_bound_location(self):
1695
return self.control_files.get_utf8('bound').read()[:-1]
1696
except errors.NoSuchFile:
1700
def get_master_branch(self):
1701
"""Return the branch we are bound to.
1703
:return: Either a Branch, or None
1705
This could memoise the branch, but if thats done
1706
it must be revalidated on each new lock.
1707
So for now we just don't memoise it.
1708
# RBC 20060304 review this decision.
1710
bound_loc = self.get_bound_location()
1714
return Branch.open(bound_loc)
1715
except (errors.NotBranchError, errors.ConnectionError), e:
1716
raise errors.BoundBranchConnectionFailure(
1720
def set_bound_location(self, location):
1721
"""Set the target where this branch is bound to.
1723
:param location: URL to the target branch
1726
self.control_files.put_utf8('bound', location+'\n')
1729
self.control_files._transport.delete('bound')
1735
def bind(self, other):
1736
"""Bind this branch to the branch other.
1738
This does not push or pull data between the branches, though it does
1739
check for divergence to raise an error when the branches are not
1740
either the same, or one a prefix of the other. That behaviour may not
1741
be useful, so that check may be removed in future.
1743
:param other: The branch to bind to
1746
# TODO: jam 20051230 Consider checking if the target is bound
1747
# It is debatable whether you should be able to bind to
1748
# a branch which is itself bound.
1749
# Committing is obviously forbidden,
1750
# but binding itself may not be.
1751
# Since we *have* to check at commit time, we don't
1752
# *need* to check here
1754
# we want to raise diverged if:
1755
# last_rev is not in the other_last_rev history, AND
1756
# other_last_rev is not in our history, and do it without pulling
1758
last_rev = _mod_revision.ensure_null(self.last_revision())
1759
if last_rev != _mod_revision.NULL_REVISION:
1762
other_last_rev = other.last_revision()
1763
if not _mod_revision.is_null(other_last_rev):
1764
# neither branch is new, we have to do some work to
1765
# ascertain diversion.
1766
remote_graph = other.repository.get_revision_graph(
1768
local_graph = self.repository.get_revision_graph(last_rev)
1769
if (last_rev not in remote_graph and
1770
other_last_rev not in local_graph):
1771
raise errors.DivergedBranches(self, other)
1774
self.set_bound_location(other.base)
1778
"""If bound, unbind"""
1779
return self.set_bound_location(None)
1783
"""Synchronise this branch with the master branch if any.
1785
:return: None or the last_revision that was pivoted out during the
1788
master = self.get_master_branch()
1789
if master is not None:
1790
old_tip = _mod_revision.ensure_null(self.last_revision())
1791
self.pull(master, overwrite=True)
1792
if self.repository.get_graph().is_ancestor(old_tip,
1793
_mod_revision.ensure_null(self.last_revision())):
1799
class BzrBranchExperimental(BzrBranch5):
1800
"""Bzr experimental branch format
1803
- a revision-history file.
1805
- a lock dir guarding the branch itself
1806
- all of this stored in a branch/ subdirectory
1807
- works with shared repositories.
1808
- a tag dictionary in the branch
1810
This format is new in bzr 0.15, but shouldn't be used for real data,
1813
This class acts as it's own BranchFormat.
1816
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1819
def get_format_string(cls):
1820
"""See BranchFormat.get_format_string()."""
1821
return "Bazaar-NG branch format experimental\n"
1824
def get_format_description(cls):
1825
"""See BranchFormat.get_format_description()."""
1826
return "Experimental branch format"
1829
def get_reference(cls, a_bzrdir):
1830
"""Get the target reference of the branch in a_bzrdir.
1832
format probing must have been completed before calling
1833
this method - it is assumed that the format of the branch
1834
in a_bzrdir is correct.
1836
:param a_bzrdir: The bzrdir to get the branch data from.
1837
:return: None if the branch is not a reference branch.
1842
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1844
branch_transport = a_bzrdir.get_branch_transport(cls)
1845
control_files = lockable_files.LockableFiles(branch_transport,
1846
lock_filename, lock_class)
1847
control_files.create_lock()
1848
control_files.lock_write()
1850
for filename, content in utf8_files:
1851
control_files.put_utf8(filename, content)
1853
control_files.unlock()
1856
def initialize(cls, a_bzrdir):
1857
"""Create a branch of this format in a_bzrdir."""
1858
utf8_files = [('format', cls.get_format_string()),
1859
('revision-history', ''),
1860
('branch-name', ''),
1863
cls._initialize_control_files(a_bzrdir, utf8_files,
1864
'lock', lockdir.LockDir)
1865
return cls.open(a_bzrdir, _found=True)
1868
def open(cls, a_bzrdir, _found=False):
1869
"""Return the branch object for a_bzrdir
1871
_found is a private parameter, do not use it. It is used to indicate
1872
if format probing has already be done.
1875
format = BranchFormat.find_format(a_bzrdir)
1876
assert format.__class__ == cls
1877
transport = a_bzrdir.get_branch_transport(None)
1878
control_files = lockable_files.LockableFiles(transport, 'lock',
1880
return cls(_format=cls,
1881
_control_files=control_files,
1883
_repository=a_bzrdir.find_repository())
1886
def is_supported(cls):
1889
def _make_tags(self):
1890
return BasicTags(self)
1893
def supports_tags(cls):
1897
BranchFormat.register_format(BzrBranchExperimental)
1900
class BzrBranch6(BzrBranch5):
1903
def last_revision_info(self):
1904
revision_string = self.control_files.get('last-revision').read()
1905
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1906
revision_id = cache_utf8.get_cached_utf8(revision_id)
1908
return revno, revision_id
1910
def last_revision(self):
1911
"""Return last revision id, or None"""
1912
revision_id = self.last_revision_info()[1]
1915
def _write_last_revision_info(self, revno, revision_id):
1916
"""Simply write out the revision id, with no checks.
1918
Use set_last_revision_info to perform this safely.
1920
Does not update the revision_history cache.
1921
Intended to be called by set_last_revision_info and
1922
_write_revision_history.
1924
if revision_id is None:
1925
revision_id = 'null:'
1926
out_string = '%d %s\n' % (revno, revision_id)
1927
self.control_files.put_bytes('last-revision', out_string)
1930
def set_last_revision_info(self, revno, revision_id):
1931
revision_id = osutils.safe_revision_id(revision_id)
1932
if self._get_append_revisions_only():
1933
self._check_history_violation(revision_id)
1934
self._write_last_revision_info(revno, revision_id)
1935
self._clear_cached_state()
1937
def _check_history_violation(self, revision_id):
1938
last_revision = _mod_revision.ensure_null(self.last_revision())
1939
if _mod_revision.is_null(last_revision):
1941
if last_revision not in self._lefthand_history(revision_id):
1942
raise errors.AppendRevisionsOnlyViolation(self.base)
1944
def _gen_revision_history(self):
1945
"""Generate the revision history from last revision
1947
history = list(self.repository.iter_reverse_revision_history(
1948
self.last_revision()))
1952
def _write_revision_history(self, history):
1953
"""Factored out of set_revision_history.
1955
This performs the actual writing to disk, with format-specific checks.
1956
It is intended to be called by BzrBranch5.set_revision_history.
1958
if len(history) == 0:
1959
last_revision = 'null:'
1961
if history != self._lefthand_history(history[-1]):
1962
raise errors.NotLefthandHistory(history)
1963
last_revision = history[-1]
1964
if self._get_append_revisions_only():
1965
self._check_history_violation(last_revision)
1966
self._write_last_revision_info(len(history), last_revision)
1969
def _set_parent_location(self, url):
1970
"""Set the parent branch"""
1971
self._set_config_location('parent_location', url, make_relative=True)
1974
def _get_parent_location(self):
1975
"""Set the parent branch"""
1976
return self._get_config_location('parent_location')
1978
def set_push_location(self, location):
1979
"""See Branch.set_push_location."""
1980
self._set_config_location('push_location', location)
1982
def set_bound_location(self, location):
1983
"""See Branch.set_push_location."""
1985
config = self.get_config()
1986
if location is None:
1987
if config.get_user_option('bound') != 'True':
1990
config.set_user_option('bound', 'False', warn_masked=True)
1993
self._set_config_location('bound_location', location,
1995
config.set_user_option('bound', 'True', warn_masked=True)
1998
def _get_bound_location(self, bound):
1999
"""Return the bound location in the config file.
2001
Return None if the bound parameter does not match"""
2002
config = self.get_config()
2003
config_bound = (config.get_user_option('bound') == 'True')
2004
if config_bound != bound:
2006
return self._get_config_location('bound_location', config=config)
2008
def get_bound_location(self):
2009
"""See Branch.set_push_location."""
2010
return self._get_bound_location(True)
2012
def get_old_bound_location(self):
2013
"""See Branch.get_old_bound_location"""
2014
return self._get_bound_location(False)
2016
def set_append_revisions_only(self, enabled):
2021
self.get_config().set_user_option('append_revisions_only', value,
2024
def _get_append_revisions_only(self):
2025
value = self.get_config().get_user_option('append_revisions_only')
2026
return value == 'True'
2028
def _synchronize_history(self, destination, revision_id):
2029
"""Synchronize last revision and revision history between branches.
2031
This version is most efficient when the destination is also a
2032
BzrBranch6, but works for BzrBranch5, as long as the destination's
2033
repository contains all the lefthand ancestors of the intended
2034
last_revision. If not, set_last_revision_info will fail.
2036
:param destination: The branch to copy the history into
2037
:param revision_id: The revision-id to truncate history at. May
2038
be None to copy complete history.
2040
source_revno, source_revision_id = self.last_revision_info()
2041
if revision_id is None:
2042
revno, revision_id = source_revno, source_revision_id
2043
elif source_revision_id == revision_id:
2044
# we know the revno without needing to walk all of history
2045
revno = source_revno
2047
# To figure out the revno for a random revision, we need to build
2048
# the revision history, and count its length.
2049
# We don't care about the order, just how long it is.
2050
# Alternatively, we could start at the current location, and count
2051
# backwards. But there is no guarantee that we will find it since
2052
# it may be a merged revision.
2053
revno = len(list(self.repository.iter_reverse_revision_history(
2055
destination.set_last_revision_info(revno, revision_id)
2057
def _make_tags(self):
2058
return BasicTags(self)
2061
######################################################################
2062
# results of operations
2065
class _Result(object):
2067
def _show_tag_conficts(self, to_file):
2068
if not getattr(self, 'tag_conflicts', None):
2070
to_file.write('Conflicting tags:\n')
2071
for name, value1, value2 in self.tag_conflicts:
2072
to_file.write(' %s\n' % (name, ))
2075
class PullResult(_Result):
2076
"""Result of a Branch.pull operation.
2078
:ivar old_revno: Revision number before pull.
2079
:ivar new_revno: Revision number after pull.
2080
:ivar old_revid: Tip revision id before pull.
2081
:ivar new_revid: Tip revision id after pull.
2082
:ivar source_branch: Source (local) branch object.
2083
:ivar master_branch: Master branch of the target, or None.
2084
:ivar target_branch: Target/destination branch object.
2088
# DEPRECATED: pull used to return the change in revno
2089
return self.new_revno - self.old_revno
2091
def report(self, to_file):
2092
if self.old_revid == self.new_revid:
2093
to_file.write('No revisions to pull.\n')
2095
to_file.write('Now on revision %d.\n' % self.new_revno)
2096
self._show_tag_conficts(to_file)
2099
class PushResult(_Result):
2100
"""Result of a Branch.push operation.
2102
:ivar old_revno: Revision number before push.
2103
:ivar new_revno: Revision number after push.
2104
:ivar old_revid: Tip revision id before push.
2105
:ivar new_revid: Tip revision id after push.
2106
:ivar source_branch: Source branch object.
2107
:ivar master_branch: Master branch of the target, or None.
2108
:ivar target_branch: Target/destination branch object.
2112
# DEPRECATED: push used to return the change in revno
2113
return self.new_revno - self.old_revno
2115
def report(self, to_file):
2116
"""Write a human-readable description of the result."""
2117
if self.old_revid == self.new_revid:
2118
to_file.write('No new revisions to push.\n')
2120
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2121
self._show_tag_conficts(to_file)
2124
class BranchCheckResult(object):
2125
"""Results of checking branch consistency.
2130
def __init__(self, branch):
2131
self.branch = branch
2133
def report_results(self, verbose):
2134
"""Report the check results via trace.note.
2136
:param verbose: Requests more detailed display of what was checked,
2139
note('checked branch %s format %s',
2141
self.branch._format)
2144
class Converter5to6(object):
2145
"""Perform an in-place upgrade of format 5 to format 6"""
2147
def convert(self, branch):
2148
# Data for 5 and 6 can peacefully coexist.
2149
format = BzrBranchFormat6()
2150
new_branch = format.open(branch.bzrdir, _found=True)
2152
# Copy source data into target
2153
new_branch.set_last_revision_info(*branch.last_revision_info())
2154
new_branch.set_parent(branch.get_parent())
2155
new_branch.set_bound_location(branch.get_bound_location())
2156
new_branch.set_push_location(branch.get_push_location())
2158
# New branch has no tags by default
2159
new_branch.tags._set_tag_dict({})
2161
# Copying done; now update target format
2162
new_branch.control_files.put_utf8('format',
2163
format.get_format_string())
2165
# Clean up old files
2166
new_branch.control_files._transport.delete('revision-history')
2168
branch.set_parent(None)
2171
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
