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 copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.hooks import Hooks
58
from bzrlib.symbol_versioning import (deprecated_function,
62
zero_eight, zero_nine, zero_sixteen,
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
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
147
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
168
def get_config(self):
169
return BranchConfig(self)
172
return self.get_config().get_nickname()
174
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick)
177
nick = property(_get_nick, _set_nick)
180
raise NotImplementedError(self.is_locked)
182
def lock_write(self):
183
raise NotImplementedError(self.lock_write)
186
raise NotImplementedError(self.lock_read)
189
raise NotImplementedError(self.unlock)
191
def peek_lock_mode(self):
192
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
raise NotImplementedError(self.peek_lock_mode)
195
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
198
def leave_lock_in_place(self):
199
"""Tell this branch object not to release the physical lock when this
202
If lock_write doesn't return a token, then this method is not supported.
204
self.control_files.leave_in_place()
206
def dont_leave_lock_in_place(self):
207
"""Tell this branch object to release the physical lock when this
208
object is unlocked, even if it didn't originally acquire it.
210
If lock_write doesn't return a token, then this method is not supported.
212
self.control_files.dont_leave_in_place()
214
def abspath(self, name):
215
"""Return absolute filename for something in the branch
217
XXX: Robert Collins 20051017 what is this used for? why is it a branch
218
method and not a tree method.
220
raise NotImplementedError(self.abspath)
222
def bind(self, other):
223
"""Bind the local branch the other branch.
225
:param other: The branch to bind to
228
raise errors.UpgradeRequired(self.base)
231
def fetch(self, from_branch, last_revision=None, pb=None):
232
"""Copy revisions from from_branch into this branch.
234
:param from_branch: Where to copy from.
235
:param last_revision: What revision to stop at (None for at the end
237
:param pb: An optional progress bar to use.
239
Returns the copied revision count and the failed revisions in a tuple:
242
if self.base == from_branch.base:
245
nested_pb = ui.ui_factory.nested_progress_bar()
250
from_branch.lock_read()
252
if last_revision is None:
253
pb.update('get source history')
254
last_revision = from_branch.last_revision()
255
if last_revision is None:
256
last_revision = _mod_revision.NULL_REVISION
257
return self.repository.fetch(from_branch.repository,
258
revision_id=last_revision,
261
if nested_pb is not None:
265
def get_bound_location(self):
266
"""Return the URL of the branch we are bound to.
268
Older format branches cannot bind, please be sure to use a metadir
273
def get_old_bound_location(self):
274
"""Return the URL of the branch we used to be bound to
276
raise errors.UpgradeRequired(self.base)
278
def get_commit_builder(self, parents, config=None, timestamp=None,
279
timezone=None, committer=None, revprops=None,
281
"""Obtain a CommitBuilder for this branch.
283
:param parents: Revision ids of the parents of the new revision.
284
:param config: Optional configuration to use.
285
:param timestamp: Optional timestamp recorded for commit.
286
:param timezone: Optional timezone for timestamp.
287
:param committer: Optional committer to set for commit.
288
:param revprops: Optional dictionary of revision properties.
289
:param revision_id: Optional revision id.
293
config = self.get_config()
295
return self.repository.get_commit_builder(self, parents, config,
296
timestamp, timezone, committer, revprops, revision_id)
298
def get_master_branch(self):
299
"""Return the branch we are bound to.
301
:return: Either a Branch, or None
305
def get_revision_delta(self, revno):
306
"""Return the delta for one revision.
308
The delta is relative to its mainline predecessor, or the
309
empty tree for revision 1.
311
assert isinstance(revno, int)
312
rh = self.revision_history()
313
if not (1 <= revno <= len(rh)):
314
raise InvalidRevisionNumber(revno)
315
return self.repository.get_revision_delta(rh[revno-1])
317
@deprecated_method(zero_sixteen)
318
def get_root_id(self):
319
"""Return the id of this branches root
321
Deprecated: branches don't have root ids-- trees do.
322
Use basis_tree().get_root_id() instead.
324
raise NotImplementedError(self.get_root_id)
326
def print_file(self, file, revision_id):
327
"""Print `file` to stdout."""
328
raise NotImplementedError(self.print_file)
330
def append_revision(self, *revision_ids):
331
raise NotImplementedError(self.append_revision)
333
def set_revision_history(self, rev_history):
334
raise NotImplementedError(self.set_revision_history)
336
def _cache_revision_history(self, rev_history):
337
"""Set the cached revision history to rev_history.
339
The revision_history method will use this cache to avoid regenerating
340
the revision history.
342
This API is semi-public; it only for use by subclasses, all other code
343
should consider it to be private.
345
self._revision_history_cache = rev_history
347
def _clear_cached_state(self):
348
"""Clear any cached data on this branch, e.g. cached revision history.
350
This means the next call to revision_history will need to call
351
_gen_revision_history.
353
This API is semi-public; it only for use by subclasses, all other code
354
should consider it to be private.
356
self._revision_history_cache = None
358
def _gen_revision_history(self):
359
"""Return sequence of revision hashes on to this branch.
361
Unlike revision_history, this method always regenerates or rereads the
362
revision history, i.e. it does not cache the result, so repeated calls
365
Concrete subclasses should override this instead of revision_history so
366
that subclasses do not need to deal with caching logic.
368
This API is semi-public; it only for use by subclasses, all other code
369
should consider it to be private.
371
raise NotImplementedError(self._gen_revision_history)
374
def revision_history(self):
375
"""Return sequence of revision hashes on to this branch.
377
This method will cache the revision history for as long as it is safe to
380
if self._revision_history_cache is not None:
381
history = self._revision_history_cache
383
history = self._gen_revision_history()
384
self._cache_revision_history(history)
388
"""Return current revision number for this branch.
390
That is equivalent to the number of revisions committed to
393
return len(self.revision_history())
396
"""Older format branches cannot bind or unbind."""
397
raise errors.UpgradeRequired(self.base)
399
def set_append_revisions_only(self, enabled):
400
"""Older format branches are never restricted to append-only"""
401
raise errors.UpgradeRequired(self.base)
403
def last_revision(self):
404
"""Return last revision id, or None"""
405
ph = self.revision_history()
411
def last_revision_info(self):
412
"""Return information about the last revision.
414
:return: A tuple (revno, last_revision_id).
416
rh = self.revision_history()
419
return (revno, rh[-1])
421
return (0, _mod_revision.NULL_REVISION)
423
def missing_revisions(self, other, stop_revision=None):
424
"""Return a list of new revisions that would perfectly fit.
426
If self and other have not diverged, return a list of the revisions
427
present in other, but missing from self.
429
self_history = self.revision_history()
430
self_len = len(self_history)
431
other_history = other.revision_history()
432
other_len = len(other_history)
433
common_index = min(self_len, other_len) -1
434
if common_index >= 0 and \
435
self_history[common_index] != other_history[common_index]:
436
raise DivergedBranches(self, other)
438
if stop_revision is None:
439
stop_revision = other_len
441
assert isinstance(stop_revision, int)
442
if stop_revision > other_len:
443
raise errors.NoSuchRevision(self, stop_revision)
444
return other_history[self_len:stop_revision]
446
def update_revisions(self, other, stop_revision=None):
447
"""Pull in new perfect-fit revisions.
449
:param other: Another Branch to pull from
450
:param stop_revision: Updated until the given revision
453
raise NotImplementedError(self.update_revisions)
455
def revision_id_to_revno(self, revision_id):
456
"""Given a revision id, return its revno"""
457
if revision_id is None:
459
revision_id = osutils.safe_revision_id(revision_id)
460
history = self.revision_history()
462
return history.index(revision_id) + 1
464
raise bzrlib.errors.NoSuchRevision(self, revision_id)
466
def get_rev_id(self, revno, history=None):
467
"""Find the revision id of the specified revno."""
471
history = self.revision_history()
472
if revno <= 0 or revno > len(history):
473
raise bzrlib.errors.NoSuchRevision(self, revno)
474
return history[revno - 1]
476
def pull(self, source, overwrite=False, stop_revision=None):
477
"""Mirror source into this branch.
479
This branch is considered to be 'local', having low latency.
481
:returns: PullResult instance
483
raise NotImplementedError(self.pull)
485
def push(self, target, overwrite=False, stop_revision=None):
486
"""Mirror this branch into target.
488
This branch is considered to be 'local', having low latency.
490
raise NotImplementedError(self.push)
492
def basis_tree(self):
493
"""Return `Tree` object for last revision."""
494
return self.repository.revision_tree(self.last_revision())
496
def rename_one(self, from_rel, to_rel):
499
This can change the directory or the filename or both.
501
raise NotImplementedError(self.rename_one)
503
def move(self, from_paths, to_name):
506
to_name must exist as a versioned directory.
508
If to_name exists and is a directory, the files are moved into
509
it, keeping their old names. If it is a directory,
511
Note that to_name is only the last component of the new name;
512
this doesn't change the directory.
514
This returns a list of (from_path, to_path) pairs for each
517
raise NotImplementedError(self.move)
519
def get_parent(self):
520
"""Return the parent location of the branch.
522
This is the default location for push/pull/missing. The usual
523
pattern is that the user can override it by specifying a
526
raise NotImplementedError(self.get_parent)
528
def _set_config_location(self, name, url, config=None,
529
make_relative=False):
531
config = self.get_config()
535
url = urlutils.relative_url(self.base, url)
536
config.set_user_option(name, url)
538
def _get_config_location(self, name, config=None):
540
config = self.get_config()
541
location = config.get_user_option(name)
546
def get_submit_branch(self):
547
"""Return the submit location of the branch.
549
This is the default location for bundle. The usual
550
pattern is that the user can override it by specifying a
553
return self.get_config().get_user_option('submit_branch')
555
def set_submit_branch(self, location):
556
"""Return the submit location of the branch.
558
This is the default location for bundle. The usual
559
pattern is that the user can override it by specifying a
562
self.get_config().set_user_option('submit_branch', location)
564
def get_public_branch(self):
565
"""Return the public location of the branch.
567
This is is used by merge directives.
569
return self._get_config_location('public_branch')
571
def set_public_branch(self, location):
572
"""Return the submit location of the branch.
574
This is the default location for bundle. The usual
575
pattern is that the user can override it by specifying a
578
self._set_config_location('public_branch', location)
580
def get_push_location(self):
581
"""Return the None or the location to push this branch to."""
582
push_loc = self.get_config().get_user_option('push_location')
585
def set_push_location(self, location):
586
"""Set a new push location for this branch."""
587
raise NotImplementedError(self.set_push_location)
589
def set_parent(self, url):
590
raise NotImplementedError(self.set_parent)
594
"""Synchronise this branch with the master branch if any.
596
:return: None or the last_revision pivoted out during the update.
600
def check_revno(self, revno):
602
Check whether a revno corresponds to any revision.
603
Zero (the NULL revision) is considered valid.
606
self.check_real_revno(revno)
608
def check_real_revno(self, revno):
610
Check whether a revno corresponds to a real revision.
611
Zero (the NULL revision) is considered invalid
613
if revno < 1 or revno > self.revno():
614
raise InvalidRevisionNumber(revno)
617
def clone(self, to_bzrdir, revision_id=None):
618
"""Clone this branch into to_bzrdir preserving all semantic values.
620
revision_id: if not None, the revision history in the new branch will
621
be truncated to end with revision_id.
623
result = self._format.initialize(to_bzrdir)
624
self.copy_content_into(result, revision_id=revision_id)
628
def sprout(self, to_bzrdir, revision_id=None):
629
"""Create a new line of development from the branch, into to_bzrdir.
631
revision_id: if not None, the revision history in the new branch will
632
be truncated to end with revision_id.
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
636
result.set_parent(self.bzrdir.root_transport.base)
639
def _synchronize_history(self, destination, revision_id):
640
"""Synchronize last revision and revision history between branches.
642
This version is most efficient when the destination is also a
643
BzrBranch5, but works for BzrBranch6 as long as the revision
644
history is the true lefthand parent history, and all of the revisions
645
are in the destination's repository. If not, set_revision_history
648
:param destination: The branch to copy the history into
649
:param revision_id: The revision-id to truncate history at. May
650
be None to copy complete history.
652
new_history = self.revision_history()
653
if revision_id is not None:
654
revision_id = osutils.safe_revision_id(revision_id)
656
new_history = new_history[:new_history.index(revision_id) + 1]
658
rev = self.repository.get_revision(revision_id)
659
new_history = rev.get_history(self.repository)[1:]
660
destination.set_revision_history(new_history)
663
def copy_content_into(self, destination, revision_id=None):
664
"""Copy the content of self into destination.
666
revision_id: if not None, the revision history in the new branch will
667
be truncated to end with revision_id.
669
self._synchronize_history(destination, revision_id)
671
parent = self.get_parent()
672
except errors.InaccessibleParent, e:
673
mutter('parent was not accessible to copy: %s', e)
676
destination.set_parent(parent)
677
self.tags.merge_to(destination.tags)
681
"""Check consistency of the branch.
683
In particular this checks that revisions given in the revision-history
684
do actually match up in the revision graph, and that they're all
685
present in the repository.
687
Callers will typically also want to check the repository.
689
:return: A BranchCheckResult.
691
mainline_parent_id = None
692
for revision_id in self.revision_history():
694
revision = self.repository.get_revision(revision_id)
695
except errors.NoSuchRevision, e:
696
raise errors.BzrCheckError("mainline revision {%s} not in repository"
698
# In general the first entry on the revision history has no parents.
699
# But it's not illegal for it to have parents listed; this can happen
700
# in imports from Arch when the parents weren't reachable.
701
if mainline_parent_id is not None:
702
if mainline_parent_id not in revision.parent_ids:
703
raise errors.BzrCheckError("previous revision {%s} not listed among "
705
% (mainline_parent_id, revision_id))
706
mainline_parent_id = revision_id
707
return BranchCheckResult(self)
709
def _get_checkout_format(self):
710
"""Return the most suitable metadir for a checkout of this branch.
711
Weaves are used if this branch's repository uses weaves.
713
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
714
from bzrlib.repofmt import weaverepo
715
format = bzrdir.BzrDirMetaFormat1()
716
format.repository_format = weaverepo.RepositoryFormat7()
718
format = self.repository.bzrdir.checkout_metadir()
719
format.set_branch_format(self._format)
722
def create_checkout(self, to_location, revision_id=None,
724
"""Create a checkout of a branch.
726
:param to_location: The url to produce the checkout at
727
:param revision_id: The revision to check out
728
:param lightweight: If True, produce a lightweight checkout, otherwise,
729
produce a bound branch (heavyweight checkout)
730
:return: The tree of the created checkout
732
t = transport.get_transport(to_location)
735
except errors.FileExists:
738
format = self._get_checkout_format()
739
checkout = format.initialize_on_transport(t)
740
BranchReferenceFormat().initialize(checkout, self)
742
format = self._get_checkout_format()
743
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
744
to_location, force_new_tree=False, format=format)
745
checkout = checkout_branch.bzrdir
746
checkout_branch.bind(self)
747
# pull up to the specified revision_id to set the initial
748
# branch tip correctly, and seed it with history.
749
checkout_branch.pull(self, stop_revision=revision_id)
750
tree = checkout.create_workingtree(revision_id)
751
basis_tree = tree.basis_tree()
752
basis_tree.lock_read()
754
for path, file_id in basis_tree.iter_references():
755
reference_parent = self.reference_parent(file_id, path)
756
reference_parent.create_checkout(tree.abspath(path),
757
basis_tree.get_reference_revision(file_id, path),
763
def reference_parent(self, file_id, path):
764
"""Return the parent branch for a tree-reference file_id
765
:param file_id: The file_id of the tree reference
766
:param path: The path of the file_id in the tree
767
:return: A branch associated with the file_id
769
# FIXME should provide multiple branches, based on config
770
return Branch.open(self.bzrdir.root_transport.clone(path).base)
772
def supports_tags(self):
773
return self._format.supports_tags()
776
class BranchFormat(object):
777
"""An encapsulation of the initialization and open routines for a format.
779
Formats provide three things:
780
* An initialization routine,
784
Formats are placed in an dict by their format string for reference
785
during branch opening. Its not required that these be instances, they
786
can be classes themselves with class methods - it simply depends on
787
whether state is needed for a given format or not.
789
Once a format is deprecated, just deprecate the initialize and open
790
methods on the format class. Do not deprecate the object, as the
791
object will be created every time regardless.
794
_default_format = None
795
"""The default format used for new branches."""
798
"""The known formats."""
801
def find_format(klass, a_bzrdir):
802
"""Return the format for the branch object in a_bzrdir."""
804
transport = a_bzrdir.get_branch_transport(None)
805
format_string = transport.get("format").read()
806
return klass._formats[format_string]
808
raise NotBranchError(path=transport.base)
810
raise errors.UnknownFormatError(format=format_string)
813
def get_default_format(klass):
814
"""Return the current default format."""
815
return klass._default_format
817
def get_reference(self, a_bzrdir):
818
"""Get the target reference of the branch in a_bzrdir.
820
format probing must have been completed before calling
821
this method - it is assumed that the format of the branch
822
in a_bzrdir is correct.
824
:param a_bzrdir: The bzrdir to get the branch data from.
825
:return: None if the branch is not a reference branch.
829
def get_format_string(self):
830
"""Return the ASCII format string that identifies this format."""
831
raise NotImplementedError(self.get_format_string)
833
def get_format_description(self):
834
"""Return the short format description for this format."""
835
raise NotImplementedError(self.get_format_description)
837
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
839
"""Initialize a branch in a bzrdir, with specified files
841
:param a_bzrdir: The bzrdir to initialize the branch in
842
:param utf8_files: The files to create as a list of
843
(filename, content) tuples
844
:param set_format: If True, set the format with
845
self.get_format_string. (BzrBranch4 has its format set
847
:return: a branch in this format
849
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
850
branch_transport = a_bzrdir.get_branch_transport(self)
852
'metadir': ('lock', lockdir.LockDir),
853
'branch4': ('branch-lock', lockable_files.TransportLock),
855
lock_name, lock_class = lock_map[lock_type]
856
control_files = lockable_files.LockableFiles(branch_transport,
857
lock_name, lock_class)
858
control_files.create_lock()
859
control_files.lock_write()
861
control_files.put_utf8('format', self.get_format_string())
863
for file, content in utf8_files:
864
control_files.put_utf8(file, content)
866
control_files.unlock()
867
return self.open(a_bzrdir, _found=True)
869
def initialize(self, a_bzrdir):
870
"""Create a branch of this format in a_bzrdir."""
871
raise NotImplementedError(self.initialize)
873
def is_supported(self):
874
"""Is this format supported?
876
Supported formats can be initialized and opened.
877
Unsupported formats may not support initialization or committing or
878
some other features depending on the reason for not being supported.
882
def open(self, a_bzrdir, _found=False):
883
"""Return the branch object for a_bzrdir
885
_found is a private parameter, do not use it. It is used to indicate
886
if format probing has already be done.
888
raise NotImplementedError(self.open)
891
def register_format(klass, format):
892
klass._formats[format.get_format_string()] = format
895
def set_default_format(klass, format):
896
klass._default_format = format
899
def unregister_format(klass, format):
900
assert klass._formats[format.get_format_string()] is format
901
del klass._formats[format.get_format_string()]
904
return self.get_format_string().rstrip()
906
def supports_tags(self):
907
"""True if this format supports tags stored in the branch"""
908
return False # by default
910
# XXX: Probably doesn't really belong here -- mbp 20070212
911
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
913
branch_transport = a_bzrdir.get_branch_transport(self)
914
control_files = lockable_files.LockableFiles(branch_transport,
915
lock_filename, lock_class)
916
control_files.create_lock()
917
control_files.lock_write()
919
for filename, content in utf8_files:
920
control_files.put_utf8(filename, content)
922
control_files.unlock()
925
class BranchHooks(Hooks):
926
"""A dictionary mapping hook name to a list of callables for branch hooks.
928
e.g. ['set_rh'] Is the list of items to be called when the
929
set_revision_history function is invoked.
933
"""Create the default hooks.
935
These are all empty initially, because by default nothing should get
939
# Introduced in 0.15:
940
# invoked whenever the revision history has been set
941
# with set_revision_history. The api signature is
942
# (branch, revision_history), and the branch will
945
# invoked after a push operation completes.
946
# the api signature is
948
# containing the members
949
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
950
# where local is the local branch or None, master is the target
951
# master branch, and the rest should be self explanatory. The source
952
# is read locked and the target branches write locked. Source will
953
# be the local low-latency branch.
954
self['post_push'] = []
955
# invoked after a pull operation completes.
956
# the api signature is
958
# containing the members
959
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
960
# where local is the local branch or None, master is the target
961
# master branch, and the rest should be self explanatory. The source
962
# is read locked and the target branches write locked. The local
963
# branch is the low-latency branch.
964
self['post_pull'] = []
965
# invoked after a commit operation completes.
966
# the api signature is
967
# (local, master, old_revno, old_revid, new_revno, new_revid)
968
# old_revid is NULL_REVISION for the first commit to a branch.
969
self['post_commit'] = []
970
# invoked after a uncommit operation completes.
971
# the api signature is
972
# (local, master, old_revno, old_revid, new_revno, new_revid) where
973
# local is the local branch or None, master is the target branch,
974
# and an empty branch recieves new_revno of 0, new_revid of None.
975
self['post_uncommit'] = []
978
# install the default hooks into the Branch class.
979
Branch.hooks = BranchHooks()
982
class BzrBranchFormat4(BranchFormat):
983
"""Bzr branch format 4.
986
- a revision-history file.
987
- a branch-lock lock file [ to be shared with the bzrdir ]
990
def get_format_description(self):
991
"""See BranchFormat.get_format_description()."""
992
return "Branch format 4"
994
def initialize(self, a_bzrdir):
995
"""Create a branch of this format in a_bzrdir."""
996
utf8_files = [('revision-history', ''),
999
return self._initialize_helper(a_bzrdir, utf8_files,
1000
lock_type='branch4', set_format=False)
1003
super(BzrBranchFormat4, self).__init__()
1004
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1006
def open(self, a_bzrdir, _found=False):
1007
"""Return the branch object for a_bzrdir
1009
_found is a private parameter, do not use it. It is used to indicate
1010
if format probing has already be done.
1013
# we are being called directly and must probe.
1014
raise NotImplementedError
1015
return BzrBranch(_format=self,
1016
_control_files=a_bzrdir._control_files,
1018
_repository=a_bzrdir.open_repository())
1021
return "Bazaar-NG branch format 4"
1024
class BzrBranchFormat5(BranchFormat):
1025
"""Bzr branch format 5.
1028
- a revision-history file.
1030
- a lock dir guarding the branch itself
1031
- all of this stored in a branch/ subdirectory
1032
- works with shared repositories.
1034
This format is new in bzr 0.8.
1037
def get_format_string(self):
1038
"""See BranchFormat.get_format_string()."""
1039
return "Bazaar-NG branch format 5\n"
1041
def get_format_description(self):
1042
"""See BranchFormat.get_format_description()."""
1043
return "Branch format 5"
1045
def initialize(self, a_bzrdir):
1046
"""Create a branch of this format in a_bzrdir."""
1047
utf8_files = [('revision-history', ''),
1048
('branch-name', ''),
1050
return self._initialize_helper(a_bzrdir, utf8_files)
1053
super(BzrBranchFormat5, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1059
_found is a private parameter, do not use it. It is used to indicate
1060
if format probing has already be done.
1063
format = BranchFormat.find_format(a_bzrdir)
1064
assert format.__class__ == self.__class__
1066
transport = a_bzrdir.get_branch_transport(None)
1067
control_files = lockable_files.LockableFiles(transport, 'lock',
1069
return BzrBranch5(_format=self,
1070
_control_files=control_files,
1072
_repository=a_bzrdir.find_repository())
1074
raise NotBranchError(path=transport.base)
1077
class BzrBranchFormat6(BzrBranchFormat5):
1078
"""Branch format with last-revision
1080
Unlike previous formats, this has no explicit revision history. Instead,
1081
this just stores the last-revision, and the left-hand history leading
1082
up to there is the history.
1084
This format was introduced in bzr 0.15
1087
def get_format_string(self):
1088
"""See BranchFormat.get_format_string()."""
1089
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1091
def get_format_description(self):
1092
"""See BranchFormat.get_format_description()."""
1093
return "Branch format 6"
1095
def initialize(self, a_bzrdir):
1096
"""Create a branch of this format in a_bzrdir."""
1097
utf8_files = [('last-revision', '0 null:\n'),
1098
('branch-name', ''),
1099
('branch.conf', ''),
1102
return self._initialize_helper(a_bzrdir, utf8_files)
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__
1113
transport = a_bzrdir.get_branch_transport(None)
1114
control_files = lockable_files.LockableFiles(transport, 'lock',
1116
return BzrBranch6(_format=self,
1117
_control_files=control_files,
1119
_repository=a_bzrdir.find_repository())
1121
def supports_tags(self):
1125
class BranchReferenceFormat(BranchFormat):
1126
"""Bzr branch reference format.
1128
Branch references are used in implementing checkouts, they
1129
act as an alias to the real branch which is at some other url.
1136
def get_format_string(self):
1137
"""See BranchFormat.get_format_string()."""
1138
return "Bazaar-NG Branch Reference Format 1\n"
1140
def get_format_description(self):
1141
"""See BranchFormat.get_format_description()."""
1142
return "Checkout reference format 1"
1144
def get_reference(self, a_bzrdir):
1145
"""See BranchFormat.get_reference()."""
1146
transport = a_bzrdir.get_branch_transport(None)
1147
return transport.get('location').read()
1149
def initialize(self, a_bzrdir, target_branch=None):
1150
"""Create a branch of this format in a_bzrdir."""
1151
if target_branch is None:
1152
# this format does not implement branch itself, thus the implicit
1153
# creation contract must see it as uninitializable
1154
raise errors.UninitializableFormat(self)
1155
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1156
branch_transport = a_bzrdir.get_branch_transport(self)
1157
branch_transport.put_bytes('location',
1158
target_branch.bzrdir.root_transport.base)
1159
branch_transport.put_bytes('format', self.get_format_string())
1160
return self.open(a_bzrdir, _found=True)
1163
super(BranchReferenceFormat, self).__init__()
1164
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1166
def _make_reference_clone_function(format, a_branch):
1167
"""Create a clone() routine for a branch dynamically."""
1168
def clone(to_bzrdir, revision_id=None):
1169
"""See Branch.clone()."""
1170
return format.initialize(to_bzrdir, a_branch)
1171
# cannot obey revision_id limits when cloning a reference ...
1172
# FIXME RBC 20060210 either nuke revision_id for clone, or
1173
# emit some sort of warning/error to the caller ?!
1176
def open(self, a_bzrdir, _found=False, location=None):
1177
"""Return the branch that the branch reference in a_bzrdir points at.
1179
_found is a private parameter, do not use it. It is used to indicate
1180
if format probing has already be done.
1183
format = BranchFormat.find_format(a_bzrdir)
1184
assert format.__class__ == self.__class__
1185
if location is None:
1186
location = self.get_reference(a_bzrdir)
1187
real_bzrdir = bzrdir.BzrDir.open(location)
1188
result = real_bzrdir.open_branch()
1189
# this changes the behaviour of result.clone to create a new reference
1190
# rather than a copy of the content of the branch.
1191
# I did not use a proxy object because that needs much more extensive
1192
# testing, and we are only changing one behaviour at the moment.
1193
# If we decide to alter more behaviours - i.e. the implicit nickname
1194
# then this should be refactored to introduce a tested proxy branch
1195
# and a subclass of that for use in overriding clone() and ....
1197
result.clone = self._make_reference_clone_function(result)
1201
# formats which have no format string are not discoverable
1202
# and not independently creatable, so are not registered.
1203
__default_format = BzrBranchFormat5()
1204
BranchFormat.register_format(__default_format)
1205
BranchFormat.register_format(BranchReferenceFormat())
1206
BranchFormat.register_format(BzrBranchFormat6())
1207
BranchFormat.set_default_format(__default_format)
1208
_legacy_formats = [BzrBranchFormat4(),
1211
class BzrBranch(Branch):
1212
"""A branch stored in the actual filesystem.
1214
Note that it's "local" in the context of the filesystem; it doesn't
1215
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1216
it's writable, and can be accessed via the normal filesystem API.
1219
def __init__(self, _format=None,
1220
_control_files=None, a_bzrdir=None, _repository=None):
1221
"""Create new branch object at a particular location."""
1222
Branch.__init__(self)
1223
if a_bzrdir is None:
1224
raise ValueError('a_bzrdir must be supplied')
1226
self.bzrdir = a_bzrdir
1227
# self._transport used to point to the directory containing the
1228
# control directory, but was not used - now it's just the transport
1229
# for the branch control files. mbp 20070212
1230
self._base = self.bzrdir.transport.clone('..').base
1231
self._format = _format
1232
if _control_files is None:
1233
raise ValueError('BzrBranch _control_files is None')
1234
self.control_files = _control_files
1235
self._transport = _control_files._transport
1236
self.repository = _repository
1239
return '%s(%r)' % (self.__class__.__name__, self.base)
1243
def _get_base(self):
1244
"""Returns the directory containing the control directory."""
1247
base = property(_get_base, doc="The URL for the root of this branch.")
1249
def abspath(self, name):
1250
"""See Branch.abspath."""
1251
return self.control_files._transport.abspath(name)
1254
@deprecated_method(zero_sixteen)
1256
def get_root_id(self):
1257
"""See Branch.get_root_id."""
1258
tree = self.repository.revision_tree(self.last_revision())
1259
return tree.inventory.root.file_id
1261
def is_locked(self):
1262
return self.control_files.is_locked()
1264
def lock_write(self, token=None):
1265
repo_token = self.repository.lock_write()
1267
token = self.control_files.lock_write(token=token)
1269
self.repository.unlock()
1273
def lock_read(self):
1274
self.repository.lock_read()
1276
self.control_files.lock_read()
1278
self.repository.unlock()
1282
# TODO: test for failed two phase locks. This is known broken.
1284
self.control_files.unlock()
1286
self.repository.unlock()
1287
if not self.control_files.is_locked():
1288
# we just released the lock
1289
self._clear_cached_state()
1291
def peek_lock_mode(self):
1292
if self.control_files._lock_count == 0:
1295
return self.control_files._lock_mode
1297
def get_physical_lock_status(self):
1298
return self.control_files.get_physical_lock_status()
1301
def print_file(self, file, revision_id):
1302
"""See Branch.print_file."""
1303
return self.repository.print_file(file, revision_id)
1306
def append_revision(self, *revision_ids):
1307
"""See Branch.append_revision."""
1308
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1309
for revision_id in revision_ids:
1310
_mod_revision.check_not_reserved_id(revision_id)
1311
mutter("add {%s} to revision-history" % revision_id)
1312
rev_history = self.revision_history()
1313
rev_history.extend(revision_ids)
1314
self.set_revision_history(rev_history)
1316
def _write_revision_history(self, history):
1317
"""Factored out of set_revision_history.
1319
This performs the actual writing to disk.
1320
It is intended to be called by BzrBranch5.set_revision_history."""
1321
self.control_files.put_bytes(
1322
'revision-history', '\n'.join(history))
1325
def set_revision_history(self, rev_history):
1326
"""See Branch.set_revision_history."""
1327
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1328
self._write_revision_history(rev_history)
1329
self._cache_revision_history(rev_history)
1330
for hook in Branch.hooks['set_rh']:
1331
hook(self, rev_history)
1334
def set_last_revision_info(self, revno, revision_id):
1335
revision_id = osutils.safe_revision_id(revision_id)
1336
history = self._lefthand_history(revision_id)
1337
assert len(history) == revno, '%d != %d' % (len(history), revno)
1338
self.set_revision_history(history)
1340
def _gen_revision_history(self):
1341
history = self.control_files.get('revision-history').read().split('\n')
1342
if history[-1:] == ['']:
1343
# There shouldn't be a trailing newline, but just in case.
1347
def _lefthand_history(self, revision_id, last_rev=None,
1349
# stop_revision must be a descendant of last_revision
1350
stop_graph = self.repository.get_revision_graph(revision_id)
1351
if last_rev is not None and last_rev not in stop_graph:
1352
# our previous tip is not merged into stop_revision
1353
raise errors.DivergedBranches(self, other_branch)
1354
# make a new revision history from the graph
1355
current_rev_id = revision_id
1357
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1358
new_history.append(current_rev_id)
1359
current_rev_id_parents = stop_graph[current_rev_id]
1361
current_rev_id = current_rev_id_parents[0]
1363
current_rev_id = None
1364
new_history.reverse()
1368
def generate_revision_history(self, revision_id, last_rev=None,
1370
"""Create a new revision history that will finish with revision_id.
1372
:param revision_id: the new tip to use.
1373
:param last_rev: The previous last_revision. If not None, then this
1374
must be a ancestory of revision_id, or DivergedBranches is raised.
1375
:param other_branch: The other branch that DivergedBranches should
1376
raise with respect to.
1378
revision_id = osutils.safe_revision_id(revision_id)
1379
self.set_revision_history(self._lefthand_history(revision_id,
1380
last_rev, other_branch))
1383
def update_revisions(self, other, stop_revision=None):
1384
"""See Branch.update_revisions."""
1387
if stop_revision is None:
1388
stop_revision = other.last_revision()
1389
if stop_revision is None:
1390
# if there are no commits, we're done.
1393
stop_revision = osutils.safe_revision_id(stop_revision)
1394
# whats the current last revision, before we fetch [and change it
1396
last_rev = self.last_revision()
1397
# we fetch here regardless of whether we need to so that we pickup
1399
self.fetch(other, stop_revision)
1400
my_ancestry = self.repository.get_ancestry(last_rev)
1401
if stop_revision in my_ancestry:
1402
# last_revision is a descendant of stop_revision
1404
self.generate_revision_history(stop_revision, last_rev=last_rev,
1409
def basis_tree(self):
1410
"""See Branch.basis_tree."""
1411
return self.repository.revision_tree(self.last_revision())
1413
@deprecated_method(zero_eight)
1414
def working_tree(self):
1415
"""Create a Working tree object for this branch."""
1417
from bzrlib.transport.local import LocalTransport
1418
if (self.base.find('://') != -1 or
1419
not isinstance(self._transport, LocalTransport)):
1420
raise NoWorkingTree(self.base)
1421
return self.bzrdir.open_workingtree()
1424
def pull(self, source, overwrite=False, stop_revision=None,
1425
_hook_master=None, _run_hooks=True):
1428
:param _hook_master: Private parameter - set the branch to
1429
be supplied as the master to push hooks.
1430
:param _run_hooks: Private parameter - allow disabling of
1431
hooks, used when pushing to a master branch.
1433
result = PullResult()
1434
result.source_branch = source
1435
result.target_branch = self
1438
result.old_revno, result.old_revid = self.last_revision_info()
1440
self.update_revisions(source, stop_revision)
1441
except DivergedBranches:
1445
if stop_revision is None:
1446
stop_revision = source.last_revision()
1447
self.generate_revision_history(stop_revision)
1448
result.tag_conflicts = source.tags.merge_to(self.tags)
1449
result.new_revno, result.new_revid = self.last_revision_info()
1451
result.master_branch = _hook_master
1452
result.local_branch = self
1454
result.master_branch = self
1455
result.local_branch = None
1457
for hook in Branch.hooks['post_pull']:
1463
def _get_parent_location(self):
1464
_locs = ['parent', 'pull', 'x-pull']
1467
return self.control_files.get(l).read().strip('\n')
1473
def push(self, target, overwrite=False, stop_revision=None,
1474
_hook_master=None, _run_hooks=True):
1477
:param _hook_master: Private parameter - set the branch to
1478
be supplied as the master to push hooks.
1479
:param _run_hooks: Private parameter - allow disabling of
1480
hooks, used when pushing to a master branch.
1482
result = PushResult()
1483
result.source_branch = self
1484
result.target_branch = target
1487
result.old_revno, result.old_revid = target.last_revision_info()
1489
target.update_revisions(self, stop_revision)
1490
except DivergedBranches:
1494
target.set_revision_history(self.revision_history())
1495
result.tag_conflicts = self.tags.merge_to(target.tags)
1496
result.new_revno, result.new_revid = target.last_revision_info()
1498
result.master_branch = _hook_master
1499
result.local_branch = target
1501
result.master_branch = target
1502
result.local_branch = None
1504
for hook in Branch.hooks['post_push']:
1510
def get_parent(self):
1511
"""See Branch.get_parent."""
1513
assert self.base[-1] == '/'
1514
parent = self._get_parent_location()
1517
# This is an old-format absolute path to a local branch
1518
# turn it into a url
1519
if parent.startswith('/'):
1520
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1522
return urlutils.join(self.base[:-1], parent)
1523
except errors.InvalidURLJoin, e:
1524
raise errors.InaccessibleParent(parent, self.base)
1526
def set_push_location(self, location):
1527
"""See Branch.set_push_location."""
1528
self.get_config().set_user_option(
1529
'push_location', location,
1530
store=_mod_config.STORE_LOCATION_NORECURSE)
1533
def set_parent(self, url):
1534
"""See Branch.set_parent."""
1535
# TODO: Maybe delete old location files?
1536
# URLs should never be unicode, even on the local fs,
1537
# FIXUP this and get_parent in a future branch format bump:
1538
# read and rewrite the file, and have the new format code read
1539
# using .get not .get_utf8. RBC 20060125
1541
if isinstance(url, unicode):
1543
url = url.encode('ascii')
1544
except UnicodeEncodeError:
1545
raise bzrlib.errors.InvalidURL(url,
1546
"Urls must be 7-bit ascii, "
1547
"use bzrlib.urlutils.escape")
1548
url = urlutils.relative_url(self.base, url)
1549
self._set_parent_location(url)
1551
def _set_parent_location(self, url):
1553
self.control_files._transport.delete('parent')
1555
assert isinstance(url, str)
1556
self.control_files.put_bytes('parent', url + '\n')
1558
@deprecated_function(zero_nine)
1559
def tree_config(self):
1560
"""DEPRECATED; call get_config instead.
1561
TreeConfig has become part of BranchConfig."""
1562
return TreeConfig(self)
1565
class BzrBranch5(BzrBranch):
1566
"""A format 5 branch. This supports new features over plan branches.
1568
It has support for a master_branch which is the data for bound branches.
1576
super(BzrBranch5, self).__init__(_format=_format,
1577
_control_files=_control_files,
1579
_repository=_repository)
1582
def pull(self, source, overwrite=False, stop_revision=None,
1584
"""Extends branch.pull to be bound branch aware.
1586
:param _run_hooks: Private parameter used to force hook running
1587
off during bound branch double-pushing.
1589
bound_location = self.get_bound_location()
1590
master_branch = None
1591
if bound_location and source.base != bound_location:
1592
# not pulling from master, so we need to update master.
1593
master_branch = self.get_master_branch()
1594
master_branch.lock_write()
1597
# pull from source into master.
1598
master_branch.pull(source, overwrite, stop_revision,
1600
return super(BzrBranch5, self).pull(source, overwrite,
1601
stop_revision, _hook_master=master_branch,
1602
_run_hooks=_run_hooks)
1605
master_branch.unlock()
1608
def push(self, target, overwrite=False, stop_revision=None):
1609
"""Updates branch.push to be bound branch aware."""
1610
bound_location = target.get_bound_location()
1611
master_branch = None
1612
if bound_location and target.base != bound_location:
1613
# not pushing to master, so we need to update master.
1614
master_branch = target.get_master_branch()
1615
master_branch.lock_write()
1618
# push into the master from this branch.
1619
super(BzrBranch5, self).push(master_branch, overwrite,
1620
stop_revision, _run_hooks=False)
1621
# and push into the target branch from this. Note that we push from
1622
# this branch again, because its considered the highest bandwidth
1624
return super(BzrBranch5, self).push(target, overwrite,
1625
stop_revision, _hook_master=master_branch)
1628
master_branch.unlock()
1630
def get_bound_location(self):
1632
return self.control_files.get_utf8('bound').read()[:-1]
1633
except errors.NoSuchFile:
1637
def get_master_branch(self):
1638
"""Return the branch we are bound to.
1640
:return: Either a Branch, or None
1642
This could memoise the branch, but if thats done
1643
it must be revalidated on each new lock.
1644
So for now we just don't memoise it.
1645
# RBC 20060304 review this decision.
1647
bound_loc = self.get_bound_location()
1651
return Branch.open(bound_loc)
1652
except (errors.NotBranchError, errors.ConnectionError), e:
1653
raise errors.BoundBranchConnectionFailure(
1657
def set_bound_location(self, location):
1658
"""Set the target where this branch is bound to.
1660
:param location: URL to the target branch
1663
self.control_files.put_utf8('bound', location+'\n')
1666
self.control_files._transport.delete('bound')
1672
def bind(self, other):
1673
"""Bind this branch to the branch other.
1675
This does not push or pull data between the branches, though it does
1676
check for divergence to raise an error when the branches are not
1677
either the same, or one a prefix of the other. That behaviour may not
1678
be useful, so that check may be removed in future.
1680
:param other: The branch to bind to
1683
# TODO: jam 20051230 Consider checking if the target is bound
1684
# It is debatable whether you should be able to bind to
1685
# a branch which is itself bound.
1686
# Committing is obviously forbidden,
1687
# but binding itself may not be.
1688
# Since we *have* to check at commit time, we don't
1689
# *need* to check here
1691
# we want to raise diverged if:
1692
# last_rev is not in the other_last_rev history, AND
1693
# other_last_rev is not in our history, and do it without pulling
1695
last_rev = self.last_revision()
1696
if last_rev is not None:
1699
other_last_rev = other.last_revision()
1700
if other_last_rev is not None:
1701
# neither branch is new, we have to do some work to
1702
# ascertain diversion.
1703
remote_graph = other.repository.get_revision_graph(
1705
local_graph = self.repository.get_revision_graph(last_rev)
1706
if (last_rev not in remote_graph and
1707
other_last_rev not in local_graph):
1708
raise errors.DivergedBranches(self, other)
1711
self.set_bound_location(other.base)
1715
"""If bound, unbind"""
1716
return self.set_bound_location(None)
1720
"""Synchronise this branch with the master branch if any.
1722
:return: None or the last_revision that was pivoted out during the
1725
master = self.get_master_branch()
1726
if master is not None:
1727
old_tip = self.last_revision()
1728
self.pull(master, overwrite=True)
1729
if old_tip in self.repository.get_ancestry(self.last_revision()):
1735
class BzrBranchExperimental(BzrBranch5):
1736
"""Bzr experimental branch format
1739
- a revision-history file.
1741
- a lock dir guarding the branch itself
1742
- all of this stored in a branch/ subdirectory
1743
- works with shared repositories.
1744
- a tag dictionary in the branch
1746
This format is new in bzr 0.15, but shouldn't be used for real data,
1749
This class acts as it's own BranchFormat.
1752
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1755
def get_format_string(cls):
1756
"""See BranchFormat.get_format_string()."""
1757
return "Bazaar-NG branch format experimental\n"
1760
def get_format_description(cls):
1761
"""See BranchFormat.get_format_description()."""
1762
return "Experimental branch format"
1765
def get_reference(cls, a_bzrdir):
1766
"""Get the target reference of the branch in a_bzrdir.
1768
format probing must have been completed before calling
1769
this method - it is assumed that the format of the branch
1770
in a_bzrdir is correct.
1772
:param a_bzrdir: The bzrdir to get the branch data from.
1773
:return: None if the branch is not a reference branch.
1778
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1780
branch_transport = a_bzrdir.get_branch_transport(cls)
1781
control_files = lockable_files.LockableFiles(branch_transport,
1782
lock_filename, lock_class)
1783
control_files.create_lock()
1784
control_files.lock_write()
1786
for filename, content in utf8_files:
1787
control_files.put_utf8(filename, content)
1789
control_files.unlock()
1792
def initialize(cls, a_bzrdir):
1793
"""Create a branch of this format in a_bzrdir."""
1794
utf8_files = [('format', cls.get_format_string()),
1795
('revision-history', ''),
1796
('branch-name', ''),
1799
cls._initialize_control_files(a_bzrdir, utf8_files,
1800
'lock', lockdir.LockDir)
1801
return cls.open(a_bzrdir, _found=True)
1804
def open(cls, a_bzrdir, _found=False):
1805
"""Return the branch object for a_bzrdir
1807
_found is a private parameter, do not use it. It is used to indicate
1808
if format probing has already be done.
1811
format = BranchFormat.find_format(a_bzrdir)
1812
assert format.__class__ == cls
1813
transport = a_bzrdir.get_branch_transport(None)
1814
control_files = lockable_files.LockableFiles(transport, 'lock',
1816
return cls(_format=cls,
1817
_control_files=control_files,
1819
_repository=a_bzrdir.find_repository())
1822
def is_supported(cls):
1825
def _make_tags(self):
1826
return BasicTags(self)
1829
def supports_tags(cls):
1833
BranchFormat.register_format(BzrBranchExperimental)
1836
class BzrBranch6(BzrBranch5):
1839
def last_revision_info(self):
1840
revision_string = self.control_files.get('last-revision').read()
1841
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1842
revision_id = cache_utf8.get_cached_utf8(revision_id)
1844
return revno, revision_id
1846
def last_revision(self):
1847
"""Return last revision id, or None"""
1848
revision_id = self.last_revision_info()[1]
1849
if revision_id == _mod_revision.NULL_REVISION:
1853
def _write_last_revision_info(self, revno, revision_id):
1854
"""Simply write out the revision id, with no checks.
1856
Use set_last_revision_info to perform this safely.
1858
Does not update the revision_history cache.
1859
Intended to be called by set_last_revision_info and
1860
_write_revision_history.
1862
if revision_id is None:
1863
revision_id = 'null:'
1864
out_string = '%d %s\n' % (revno, revision_id)
1865
self.control_files.put_bytes('last-revision', out_string)
1868
def set_last_revision_info(self, revno, revision_id):
1869
revision_id = osutils.safe_revision_id(revision_id)
1870
if self._get_append_revisions_only():
1871
self._check_history_violation(revision_id)
1872
self._write_last_revision_info(revno, revision_id)
1873
self._clear_cached_state()
1875
def _check_history_violation(self, revision_id):
1876
last_revision = self.last_revision()
1877
if last_revision is None:
1879
if last_revision not in self._lefthand_history(revision_id):
1880
raise errors.AppendRevisionsOnlyViolation(self.base)
1882
def _gen_revision_history(self):
1883
"""Generate the revision history from last revision
1885
history = list(self.repository.iter_reverse_revision_history(
1886
self.last_revision()))
1890
def _write_revision_history(self, history):
1891
"""Factored out of set_revision_history.
1893
This performs the actual writing to disk, with format-specific checks.
1894
It is intended to be called by BzrBranch5.set_revision_history.
1896
if len(history) == 0:
1897
last_revision = 'null:'
1899
if history != self._lefthand_history(history[-1]):
1900
raise errors.NotLefthandHistory(history)
1901
last_revision = history[-1]
1902
if self._get_append_revisions_only():
1903
self._check_history_violation(last_revision)
1904
self._write_last_revision_info(len(history), last_revision)
1907
def append_revision(self, *revision_ids):
1908
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1909
if len(revision_ids) == 0:
1911
prev_revno, prev_revision = self.last_revision_info()
1912
for revision in self.repository.get_revisions(revision_ids):
1913
if prev_revision == _mod_revision.NULL_REVISION:
1914
if revision.parent_ids != []:
1915
raise errors.NotLeftParentDescendant(self, prev_revision,
1916
revision.revision_id)
1918
if revision.parent_ids[0] != prev_revision:
1919
raise errors.NotLeftParentDescendant(self, prev_revision,
1920
revision.revision_id)
1921
prev_revision = revision.revision_id
1922
self.set_last_revision_info(prev_revno + len(revision_ids),
1926
def _set_parent_location(self, url):
1927
"""Set the parent branch"""
1928
self._set_config_location('parent_location', url, make_relative=True)
1931
def _get_parent_location(self):
1932
"""Set the parent branch"""
1933
return self._get_config_location('parent_location')
1935
def set_push_location(self, location):
1936
"""See Branch.set_push_location."""
1937
self._set_config_location('push_location', location)
1939
def set_bound_location(self, location):
1940
"""See Branch.set_push_location."""
1942
config = self.get_config()
1943
if location is None:
1944
if config.get_user_option('bound') != 'True':
1947
config.set_user_option('bound', 'False')
1950
self._set_config_location('bound_location', location,
1952
config.set_user_option('bound', 'True')
1955
def _get_bound_location(self, bound):
1956
"""Return the bound location in the config file.
1958
Return None if the bound parameter does not match"""
1959
config = self.get_config()
1960
config_bound = (config.get_user_option('bound') == 'True')
1961
if config_bound != bound:
1963
return self._get_config_location('bound_location', config=config)
1965
def get_bound_location(self):
1966
"""See Branch.set_push_location."""
1967
return self._get_bound_location(True)
1969
def get_old_bound_location(self):
1970
"""See Branch.get_old_bound_location"""
1971
return self._get_bound_location(False)
1973
def set_append_revisions_only(self, enabled):
1978
self.get_config().set_user_option('append_revisions_only', value)
1980
def _get_append_revisions_only(self):
1981
value = self.get_config().get_user_option('append_revisions_only')
1982
return value == 'True'
1984
def _synchronize_history(self, destination, revision_id):
1985
"""Synchronize last revision and revision history between branches.
1987
This version is most efficient when the destination is also a
1988
BzrBranch6, but works for BzrBranch5, as long as the destination's
1989
repository contains all the lefthand ancestors of the intended
1990
last_revision. If not, set_last_revision_info will fail.
1992
:param destination: The branch to copy the history into
1993
:param revision_id: The revision-id to truncate history at. May
1994
be None to copy complete history.
1996
if revision_id is None:
1997
revno, revision_id = self.last_revision_info()
1999
revno = self.revision_id_to_revno(revision_id)
2000
destination.set_last_revision_info(revno, revision_id)
2002
def _make_tags(self):
2003
return BasicTags(self)
2006
class BranchTestProviderAdapter(object):
2007
"""A tool to generate a suite testing multiple branch formats at once.
2009
This is done by copying the test once for each transport and injecting
2010
the transport_server, transport_readonly_server, and branch_format
2011
classes into each copy. Each copy is also given a new id() to make it
2015
def __init__(self, transport_server, transport_readonly_server, formats,
2016
vfs_transport_factory=None):
2017
self._transport_server = transport_server
2018
self._transport_readonly_server = transport_readonly_server
2019
self._formats = formats
2021
def adapt(self, test):
2022
result = TestSuite()
2023
for branch_format, bzrdir_format in self._formats:
2024
new_test = deepcopy(test)
2025
new_test.transport_server = self._transport_server
2026
new_test.transport_readonly_server = self._transport_readonly_server
2027
new_test.bzrdir_format = bzrdir_format
2028
new_test.branch_format = branch_format
2029
def make_new_test_id():
2030
# the format can be either a class or an instance
2031
name = getattr(branch_format, '__name__',
2032
branch_format.__class__.__name__)
2033
new_id = "%s(%s)" % (new_test.id(), name)
2034
return lambda: new_id
2035
new_test.id = make_new_test_id()
2036
result.addTest(new_test)
2040
######################################################################
2041
# results of operations
2044
class _Result(object):
2046
def _show_tag_conficts(self, to_file):
2047
if not getattr(self, 'tag_conflicts', None):
2049
to_file.write('Conflicting tags:\n')
2050
for name, value1, value2 in self.tag_conflicts:
2051
to_file.write(' %s\n' % (name, ))
2054
class PullResult(_Result):
2055
"""Result of a Branch.pull operation.
2057
:ivar old_revno: Revision number before pull.
2058
:ivar new_revno: Revision number after pull.
2059
:ivar old_revid: Tip revision id before pull.
2060
:ivar new_revid: Tip revision id after pull.
2061
:ivar source_branch: Source (local) branch object.
2062
:ivar master_branch: Master branch of the target, or None.
2063
:ivar target_branch: Target/destination branch object.
2067
# DEPRECATED: pull used to return the change in revno
2068
return self.new_revno - self.old_revno
2070
def report(self, to_file):
2071
if self.old_revid == self.new_revid:
2072
to_file.write('No revisions to pull.\n')
2074
to_file.write('Now on revision %d.\n' % self.new_revno)
2075
self._show_tag_conficts(to_file)
2078
class PushResult(_Result):
2079
"""Result of a Branch.push operation.
2081
:ivar old_revno: Revision number before push.
2082
:ivar new_revno: Revision number after push.
2083
:ivar old_revid: Tip revision id before push.
2084
:ivar new_revid: Tip revision id after push.
2085
:ivar source_branch: Source branch object.
2086
:ivar master_branch: Master branch of the target, or None.
2087
:ivar target_branch: Target/destination branch object.
2091
# DEPRECATED: push used to return the change in revno
2092
return self.new_revno - self.old_revno
2094
def report(self, to_file):
2095
"""Write a human-readable description of the result."""
2096
if self.old_revid == self.new_revid:
2097
to_file.write('No new revisions to push.\n')
2099
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2100
self._show_tag_conficts(to_file)
2103
class BranchCheckResult(object):
2104
"""Results of checking branch consistency.
2109
def __init__(self, branch):
2110
self.branch = branch
2112
def report_results(self, verbose):
2113
"""Report the check results via trace.note.
2115
:param verbose: Requests more detailed display of what was checked,
2118
note('checked branch %s format %s',
2120
self.branch._format)
2123
class Converter5to6(object):
2124
"""Perform an in-place upgrade of format 5 to format 6"""
2126
def convert(self, branch):
2127
# Data for 5 and 6 can peacefully coexist.
2128
format = BzrBranchFormat6()
2129
new_branch = format.open(branch.bzrdir, _found=True)
2131
# Copy source data into target
2132
new_branch.set_last_revision_info(*branch.last_revision_info())
2133
new_branch.set_parent(branch.get_parent())
2134
new_branch.set_bound_location(branch.get_bound_location())
2135
new_branch.set_push_location(branch.get_push_location())
2137
# New branch has no tags by default
2138
new_branch.tags._set_tag_dict({})
2140
# Copying done; now update target format
2141
new_branch.control_files.put_utf8('format',
2142
format.get_format_string())
2144
# Clean up old files
2145
new_branch.control_files._transport.delete('revision-history')
2147
branch.set_parent(None)
2150
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
