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
raise NotImplementedError(self.get_push_location)
584
def set_push_location(self, location):
585
"""Set a new push location for this branch."""
586
raise NotImplementedError(self.set_push_location)
588
def set_parent(self, url):
589
raise NotImplementedError(self.set_parent)
593
"""Synchronise this branch with the master branch if any.
595
:return: None or the last_revision pivoted out during the update.
599
def check_revno(self, revno):
601
Check whether a revno corresponds to any revision.
602
Zero (the NULL revision) is considered valid.
605
self.check_real_revno(revno)
607
def check_real_revno(self, revno):
609
Check whether a revno corresponds to a real revision.
610
Zero (the NULL revision) is considered invalid
612
if revno < 1 or revno > self.revno():
613
raise InvalidRevisionNumber(revno)
616
def clone(self, to_bzrdir, revision_id=None):
617
"""Clone this branch into to_bzrdir preserving all semantic values.
619
revision_id: if not None, the revision history in the new branch will
620
be truncated to end with revision_id.
622
result = self._format.initialize(to_bzrdir)
623
self.copy_content_into(result, revision_id=revision_id)
627
def sprout(self, to_bzrdir, revision_id=None):
628
"""Create a new line of development from the branch, into to_bzrdir.
630
revision_id: if not None, the revision history in the new branch will
631
be truncated to end with revision_id.
633
result = self._format.initialize(to_bzrdir)
634
self.copy_content_into(result, revision_id=revision_id)
635
result.set_parent(self.bzrdir.root_transport.base)
638
def _synchronize_history(self, destination, revision_id):
639
"""Synchronize last revision and revision history between branches.
641
This version is most efficient when the destination is also a
642
BzrBranch5, but works for BzrBranch6 as long as the revision
643
history is the true lefthand parent history, and all of the revisions
644
are in the destination's repository. If not, set_revision_history
647
:param destination: The branch to copy the history into
648
:param revision_id: The revision-id to truncate history at. May
649
be None to copy complete history.
651
new_history = self.revision_history()
652
if revision_id is not None:
653
revision_id = osutils.safe_revision_id(revision_id)
655
new_history = new_history[:new_history.index(revision_id) + 1]
657
rev = self.repository.get_revision(revision_id)
658
new_history = rev.get_history(self.repository)[1:]
659
destination.set_revision_history(new_history)
662
def copy_content_into(self, destination, revision_id=None):
663
"""Copy the content of self into destination.
665
revision_id: if not None, the revision history in the new branch will
666
be truncated to end with revision_id.
668
self._synchronize_history(destination, revision_id)
670
parent = self.get_parent()
671
except errors.InaccessibleParent, e:
672
mutter('parent was not accessible to copy: %s', e)
675
destination.set_parent(parent)
676
self.tags.merge_to(destination.tags)
680
"""Check consistency of the branch.
682
In particular this checks that revisions given in the revision-history
683
do actually match up in the revision graph, and that they're all
684
present in the repository.
686
Callers will typically also want to check the repository.
688
:return: A BranchCheckResult.
690
mainline_parent_id = None
691
for revision_id in self.revision_history():
693
revision = self.repository.get_revision(revision_id)
694
except errors.NoSuchRevision, e:
695
raise errors.BzrCheckError("mainline revision {%s} not in repository"
697
# In general the first entry on the revision history has no parents.
698
# But it's not illegal for it to have parents listed; this can happen
699
# in imports from Arch when the parents weren't reachable.
700
if mainline_parent_id is not None:
701
if mainline_parent_id not in revision.parent_ids:
702
raise errors.BzrCheckError("previous revision {%s} not listed among "
704
% (mainline_parent_id, revision_id))
705
mainline_parent_id = revision_id
706
return BranchCheckResult(self)
708
def _get_checkout_format(self):
709
"""Return the most suitable metadir for a checkout of this branch.
710
Weaves are used if this branch's repostory uses weaves.
712
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
713
from bzrlib.repofmt import weaverepo
714
format = bzrdir.BzrDirMetaFormat1()
715
format.repository_format = weaverepo.RepositoryFormat7()
717
format = self.repository.bzrdir.checkout_metadir()
718
format.set_branch_format(self._format)
721
def create_checkout(self, to_location, revision_id=None,
723
"""Create a checkout of a branch.
725
:param to_location: The url to produce the checkout at
726
:param revision_id: The revision to check out
727
:param lightweight: If True, produce a lightweight checkout, otherwise,
728
produce a bound branch (heavyweight checkout)
729
:return: The tree of the created checkout
731
t = transport.get_transport(to_location)
734
except errors.FileExists:
737
format = self._get_checkout_format()
738
checkout = format.initialize_on_transport(t)
739
BranchReferenceFormat().initialize(checkout, self)
741
format = self._get_checkout_format()
742
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
743
to_location, force_new_tree=False, format=format)
744
checkout = checkout_branch.bzrdir
745
checkout_branch.bind(self)
746
# pull up to the specified revision_id to set the initial
747
# branch tip correctly, and seed it with history.
748
checkout_branch.pull(self, stop_revision=revision_id)
749
tree = checkout.create_workingtree(revision_id)
750
basis_tree = tree.basis_tree()
751
basis_tree.lock_read()
753
for path, file_id in basis_tree.iter_references():
754
reference_parent = self.reference_parent(file_id, path)
755
reference_parent.create_checkout(tree.abspath(path),
756
basis_tree.get_reference_revision(file_id, path),
762
def reference_parent(self, file_id, path):
763
"""Return the parent branch for a tree-reference file_id
764
:param file_id: The file_id of the tree reference
765
:param path: The path of the file_id in the tree
766
:return: A branch associated with the file_id
768
# FIXME should provide multiple branches, based on config
769
return Branch.open(self.bzrdir.root_transport.clone(path).base)
771
def supports_tags(self):
772
return self._format.supports_tags()
775
class BranchFormat(object):
776
"""An encapsulation of the initialization and open routines for a format.
778
Formats provide three things:
779
* An initialization routine,
783
Formats are placed in an dict by their format string for reference
784
during branch opening. Its not required that these be instances, they
785
can be classes themselves with class methods - it simply depends on
786
whether state is needed for a given format or not.
788
Once a format is deprecated, just deprecate the initialize and open
789
methods on the format class. Do not deprecate the object, as the
790
object will be created every time regardless.
793
_default_format = None
794
"""The default format used for new branches."""
797
"""The known formats."""
800
def find_format(klass, a_bzrdir):
801
"""Return the format for the branch object in a_bzrdir."""
803
transport = a_bzrdir.get_branch_transport(None)
804
format_string = transport.get("format").read()
805
return klass._formats[format_string]
807
raise NotBranchError(path=transport.base)
809
raise errors.UnknownFormatError(format=format_string)
812
def get_default_format(klass):
813
"""Return the current default format."""
814
return klass._default_format
816
def get_format_string(self):
817
"""Return the ASCII format string that identifies this format."""
818
raise NotImplementedError(self.get_format_string)
820
def get_format_description(self):
821
"""Return the short format description for this format."""
822
raise NotImplementedError(self.get_format_description)
824
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
826
"""Initialize a branch in a bzrdir, with specified files
828
:param a_bzrdir: The bzrdir to initialize the branch in
829
:param utf8_files: The files to create as a list of
830
(filename, content) tuples
831
:param set_format: If True, set the format with
832
self.get_format_string. (BzrBranch4 has its format set
834
:return: a branch in this format
836
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
837
branch_transport = a_bzrdir.get_branch_transport(self)
839
'metadir': ('lock', lockdir.LockDir),
840
'branch4': ('branch-lock', lockable_files.TransportLock),
842
lock_name, lock_class = lock_map[lock_type]
843
control_files = lockable_files.LockableFiles(branch_transport,
844
lock_name, lock_class)
845
control_files.create_lock()
846
control_files.lock_write()
848
control_files.put_utf8('format', self.get_format_string())
850
for file, content in utf8_files:
851
control_files.put_utf8(file, content)
853
control_files.unlock()
854
return self.open(a_bzrdir, _found=True)
856
def initialize(self, a_bzrdir):
857
"""Create a branch of this format in a_bzrdir."""
858
raise NotImplementedError(self.initialize)
860
def is_supported(self):
861
"""Is this format supported?
863
Supported formats can be initialized and opened.
864
Unsupported formats may not support initialization or committing or
865
some other features depending on the reason for not being supported.
869
def open(self, a_bzrdir, _found=False):
870
"""Return the branch object for a_bzrdir
872
_found is a private parameter, do not use it. It is used to indicate
873
if format probing has already be done.
875
raise NotImplementedError(self.open)
878
def register_format(klass, format):
879
klass._formats[format.get_format_string()] = format
882
def set_default_format(klass, format):
883
klass._default_format = format
886
def unregister_format(klass, format):
887
assert klass._formats[format.get_format_string()] is format
888
del klass._formats[format.get_format_string()]
891
return self.get_format_string().rstrip()
893
def supports_tags(self):
894
"""True if this format supports tags stored in the branch"""
895
return False # by default
897
# XXX: Probably doesn't really belong here -- mbp 20070212
898
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
900
branch_transport = a_bzrdir.get_branch_transport(self)
901
control_files = lockable_files.LockableFiles(branch_transport,
902
lock_filename, lock_class)
903
control_files.create_lock()
904
control_files.lock_write()
906
for filename, content in utf8_files:
907
control_files.put_utf8(filename, content)
909
control_files.unlock()
912
class BranchHooks(Hooks):
913
"""A dictionary mapping hook name to a list of callables for branch hooks.
915
e.g. ['set_rh'] Is the list of items to be called when the
916
set_revision_history function is invoked.
920
"""Create the default hooks.
922
These are all empty initially, because by default nothing should get
926
# Introduced in 0.15:
927
# invoked whenever the revision history has been set
928
# with set_revision_history. The api signature is
929
# (branch, revision_history), and the branch will
932
# invoked after a push operation completes.
933
# the api signature is
935
# containing the members
936
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
937
# where local is the local branch or None, master is the target
938
# master branch, and the rest should be self explanatory. The source
939
# is read locked and the target branches write locked. Source will
940
# be the local low-latency branch.
941
self['post_push'] = []
942
# invoked after a pull operation completes.
943
# the api signature is
945
# containing the members
946
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
947
# where local is the local branch or None, master is the target
948
# master branch, and the rest should be self explanatory. The source
949
# is read locked and the target branches write locked. The local
950
# branch is the low-latency branch.
951
self['post_pull'] = []
952
# invoked after a commit operation completes.
953
# the api signature is
954
# (local, master, old_revno, old_revid, new_revno, new_revid)
955
# old_revid is NULL_REVISION for the first commit to a branch.
956
self['post_commit'] = []
957
# invoked after a uncommit operation completes.
958
# the api signature is
959
# (local, master, old_revno, old_revid, new_revno, new_revid) where
960
# local is the local branch or None, master is the target branch,
961
# and an empty branch recieves new_revno of 0, new_revid of None.
962
self['post_uncommit'] = []
965
# install the default hooks into the Branch class.
966
Branch.hooks = BranchHooks()
969
class BzrBranchFormat4(BranchFormat):
970
"""Bzr branch format 4.
973
- a revision-history file.
974
- a branch-lock lock file [ to be shared with the bzrdir ]
977
def get_format_description(self):
978
"""See BranchFormat.get_format_description()."""
979
return "Branch format 4"
981
def initialize(self, a_bzrdir):
982
"""Create a branch of this format in a_bzrdir."""
983
utf8_files = [('revision-history', ''),
986
return self._initialize_helper(a_bzrdir, utf8_files,
987
lock_type='branch4', set_format=False)
990
super(BzrBranchFormat4, self).__init__()
991
self._matchingbzrdir = bzrdir.BzrDirFormat6()
993
def open(self, a_bzrdir, _found=False):
994
"""Return the branch object for a_bzrdir
996
_found is a private parameter, do not use it. It is used to indicate
997
if format probing has already be done.
1000
# we are being called directly and must probe.
1001
raise NotImplementedError
1002
return BzrBranch(_format=self,
1003
_control_files=a_bzrdir._control_files,
1005
_repository=a_bzrdir.open_repository())
1008
return "Bazaar-NG branch format 4"
1011
class BzrBranchFormat5(BranchFormat):
1012
"""Bzr branch format 5.
1015
- a revision-history file.
1017
- a lock dir guarding the branch itself
1018
- all of this stored in a branch/ subdirectory
1019
- works with shared repositories.
1021
This format is new in bzr 0.8.
1024
def get_format_string(self):
1025
"""See BranchFormat.get_format_string()."""
1026
return "Bazaar-NG branch format 5\n"
1028
def get_format_description(self):
1029
"""See BranchFormat.get_format_description()."""
1030
return "Branch format 5"
1032
def initialize(self, a_bzrdir):
1033
"""Create a branch of this format in a_bzrdir."""
1034
utf8_files = [('revision-history', ''),
1035
('branch-name', ''),
1037
return self._initialize_helper(a_bzrdir, utf8_files)
1040
super(BzrBranchFormat5, self).__init__()
1041
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1043
def open(self, a_bzrdir, _found=False):
1044
"""Return the branch object for a_bzrdir
1046
_found is a private parameter, do not use it. It is used to indicate
1047
if format probing has already be done.
1050
format = BranchFormat.find_format(a_bzrdir)
1051
assert format.__class__ == self.__class__
1052
transport = a_bzrdir.get_branch_transport(None)
1053
control_files = lockable_files.LockableFiles(transport, 'lock',
1055
return BzrBranch5(_format=self,
1056
_control_files=control_files,
1058
_repository=a_bzrdir.find_repository())
1061
class BzrBranchFormat6(BzrBranchFormat5):
1062
"""Branch format with last-revision
1064
Unlike previous formats, this has no explicit revision history. Instead,
1065
this just stores the last-revision, and the left-hand history leading
1066
up to there is the history.
1068
This format was introduced in bzr 0.15
1071
def get_format_string(self):
1072
"""See BranchFormat.get_format_string()."""
1073
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1075
def get_format_description(self):
1076
"""See BranchFormat.get_format_description()."""
1077
return "Branch format 6"
1079
def initialize(self, a_bzrdir):
1080
"""Create a branch of this format in a_bzrdir."""
1081
utf8_files = [('last-revision', '0 null:\n'),
1082
('branch-name', ''),
1083
('branch.conf', ''),
1086
return self._initialize_helper(a_bzrdir, utf8_files)
1088
def open(self, a_bzrdir, _found=False):
1089
"""Return the branch object for a_bzrdir
1091
_found is a private parameter, do not use it. It is used to indicate
1092
if format probing has already be done.
1095
format = BranchFormat.find_format(a_bzrdir)
1096
assert format.__class__ == self.__class__
1097
transport = a_bzrdir.get_branch_transport(None)
1098
control_files = lockable_files.LockableFiles(transport, 'lock',
1100
return BzrBranch6(_format=self,
1101
_control_files=control_files,
1103
_repository=a_bzrdir.find_repository())
1105
def supports_tags(self):
1109
class BranchReferenceFormat(BranchFormat):
1110
"""Bzr branch reference format.
1112
Branch references are used in implementing checkouts, they
1113
act as an alias to the real branch which is at some other url.
1120
def get_format_string(self):
1121
"""See BranchFormat.get_format_string()."""
1122
return "Bazaar-NG Branch Reference Format 1\n"
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Checkout reference format 1"
1128
def initialize(self, a_bzrdir, target_branch=None):
1129
"""Create a branch of this format in a_bzrdir."""
1130
if target_branch is None:
1131
# this format does not implement branch itself, thus the implicit
1132
# creation contract must see it as uninitializable
1133
raise errors.UninitializableFormat(self)
1134
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1135
branch_transport = a_bzrdir.get_branch_transport(self)
1136
branch_transport.put_bytes('location',
1137
target_branch.bzrdir.root_transport.base)
1138
branch_transport.put_bytes('format', self.get_format_string())
1139
return self.open(a_bzrdir, _found=True)
1142
super(BranchReferenceFormat, self).__init__()
1143
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1145
def _make_reference_clone_function(format, a_branch):
1146
"""Create a clone() routine for a branch dynamically."""
1147
def clone(to_bzrdir, revision_id=None):
1148
"""See Branch.clone()."""
1149
return format.initialize(to_bzrdir, a_branch)
1150
# cannot obey revision_id limits when cloning a reference ...
1151
# FIXME RBC 20060210 either nuke revision_id for clone, or
1152
# emit some sort of warning/error to the caller ?!
1155
def open(self, a_bzrdir, _found=False):
1156
"""Return the branch that the branch reference in a_bzrdir points at.
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1166
result = real_bzrdir.open_branch()
1167
# this changes the behaviour of result.clone to create a new reference
1168
# rather than a copy of the content of the branch.
1169
# I did not use a proxy object because that needs much more extensive
1170
# testing, and we are only changing one behaviour at the moment.
1171
# If we decide to alter more behaviours - i.e. the implicit nickname
1172
# then this should be refactored to introduce a tested proxy branch
1173
# and a subclass of that for use in overriding clone() and ....
1175
result.clone = self._make_reference_clone_function(result)
1179
# formats which have no format string are not discoverable
1180
# and not independently creatable, so are not registered.
1181
__default_format = BzrBranchFormat5()
1182
BranchFormat.register_format(__default_format)
1183
BranchFormat.register_format(BranchReferenceFormat())
1184
BranchFormat.register_format(BzrBranchFormat6())
1185
BranchFormat.set_default_format(__default_format)
1186
_legacy_formats = [BzrBranchFormat4(),
1189
class BzrBranch(Branch):
1190
"""A branch stored in the actual filesystem.
1192
Note that it's "local" in the context of the filesystem; it doesn't
1193
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1194
it's writable, and can be accessed via the normal filesystem API.
1197
def __init__(self, _format=None,
1198
_control_files=None, a_bzrdir=None, _repository=None):
1199
"""Create new branch object at a particular location."""
1200
Branch.__init__(self)
1201
if a_bzrdir is None:
1202
raise ValueError('a_bzrdir must be supplied')
1204
self.bzrdir = a_bzrdir
1205
# self._transport used to point to the directory containing the
1206
# control directory, but was not used - now it's just the transport
1207
# for the branch control files. mbp 20070212
1208
self._base = self.bzrdir.transport.clone('..').base
1209
self._format = _format
1210
if _control_files is None:
1211
raise ValueError('BzrBranch _control_files is None')
1212
self.control_files = _control_files
1213
self._transport = _control_files._transport
1214
self.repository = _repository
1217
return '%s(%r)' % (self.__class__.__name__, self.base)
1221
def _get_base(self):
1222
"""Returns the directory containing the control directory."""
1225
base = property(_get_base, doc="The URL for the root of this branch.")
1227
def abspath(self, name):
1228
"""See Branch.abspath."""
1229
return self.control_files._transport.abspath(name)
1232
@deprecated_method(zero_sixteen)
1234
def get_root_id(self):
1235
"""See Branch.get_root_id."""
1236
tree = self.repository.revision_tree(self.last_revision())
1237
return tree.inventory.root.file_id
1239
def is_locked(self):
1240
return self.control_files.is_locked()
1242
def lock_write(self, tokens=None):
1243
if tokens is not None:
1244
branch_token, repo_token = tokens
1246
branch_token = repo_token = None
1247
repo_token = self.repository.lock_write(token=repo_token)
1249
branch_token = self.control_files.lock_write(token=branch_token)
1251
self.repository.unlock()
1254
tokens = (branch_token, repo_token)
1255
assert tokens == (None, None) or None not in tokens, (
1256
'Both branch and repository locks must return tokens, or else '
1257
'neither must return tokens. Got %r.' % (tokens,))
1258
if tokens == (None, None):
1263
def lock_read(self):
1264
self.repository.lock_read()
1266
self.control_files.lock_read()
1268
self.repository.unlock()
1272
# TODO: test for failed two phase locks. This is known broken.
1274
self.control_files.unlock()
1276
self.repository.unlock()
1277
if not self.control_files.is_locked():
1278
# we just released the lock
1279
self._clear_cached_state()
1281
def peek_lock_mode(self):
1282
if self.control_files._lock_count == 0:
1285
return self.control_files._lock_mode
1287
def get_physical_lock_status(self):
1288
return self.control_files.get_physical_lock_status()
1291
def print_file(self, file, revision_id):
1292
"""See Branch.print_file."""
1293
return self.repository.print_file(file, revision_id)
1296
def append_revision(self, *revision_ids):
1297
"""See Branch.append_revision."""
1298
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1299
for revision_id in revision_ids:
1300
_mod_revision.check_not_reserved_id(revision_id)
1301
mutter("add {%s} to revision-history" % revision_id)
1302
rev_history = self.revision_history()
1303
rev_history.extend(revision_ids)
1304
self.set_revision_history(rev_history)
1306
def _write_revision_history(self, history):
1307
"""Factored out of set_revision_history.
1309
This performs the actual writing to disk.
1310
It is intended to be called by BzrBranch5.set_revision_history."""
1311
self.control_files.put_bytes(
1312
'revision-history', '\n'.join(history))
1315
def set_revision_history(self, rev_history):
1316
"""See Branch.set_revision_history."""
1317
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1318
self._write_revision_history(rev_history)
1319
self._cache_revision_history(rev_history)
1320
for hook in Branch.hooks['set_rh']:
1321
hook(self, rev_history)
1324
def set_last_revision_info(self, revno, revision_id):
1325
revision_id = osutils.safe_revision_id(revision_id)
1326
history = self._lefthand_history(revision_id)
1327
assert len(history) == revno, '%d != %d' % (len(history), revno)
1328
self.set_revision_history(history)
1330
def _gen_revision_history(self):
1331
history = self.control_files.get('revision-history').read().split('\n')
1332
if history[-1:] == ['']:
1333
# There shouldn't be a trailing newline, but just in case.
1337
def _lefthand_history(self, revision_id, last_rev=None,
1339
# stop_revision must be a descendant of last_revision
1340
stop_graph = self.repository.get_revision_graph(revision_id)
1341
if last_rev is not None and last_rev not in stop_graph:
1342
# our previous tip is not merged into stop_revision
1343
raise errors.DivergedBranches(self, other_branch)
1344
# make a new revision history from the graph
1345
current_rev_id = revision_id
1347
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1348
new_history.append(current_rev_id)
1349
current_rev_id_parents = stop_graph[current_rev_id]
1351
current_rev_id = current_rev_id_parents[0]
1353
current_rev_id = None
1354
new_history.reverse()
1358
def generate_revision_history(self, revision_id, last_rev=None,
1360
"""Create a new revision history that will finish with revision_id.
1362
:param revision_id: the new tip to use.
1363
:param last_rev: The previous last_revision. If not None, then this
1364
must be a ancestory of revision_id, or DivergedBranches is raised.
1365
:param other_branch: The other branch that DivergedBranches should
1366
raise with respect to.
1368
revision_id = osutils.safe_revision_id(revision_id)
1369
self.set_revision_history(self._lefthand_history(revision_id,
1370
last_rev, other_branch))
1373
def update_revisions(self, other, stop_revision=None):
1374
"""See Branch.update_revisions."""
1377
if stop_revision is None:
1378
stop_revision = other.last_revision()
1379
if stop_revision is None:
1380
# if there are no commits, we're done.
1383
stop_revision = osutils.safe_revision_id(stop_revision)
1384
# whats the current last revision, before we fetch [and change it
1386
last_rev = self.last_revision()
1387
# we fetch here regardless of whether we need to so that we pickup
1389
self.fetch(other, stop_revision)
1390
my_ancestry = self.repository.get_ancestry(last_rev)
1391
if stop_revision in my_ancestry:
1392
# last_revision is a descendant of stop_revision
1394
self.generate_revision_history(stop_revision, last_rev=last_rev,
1399
def basis_tree(self):
1400
"""See Branch.basis_tree."""
1401
return self.repository.revision_tree(self.last_revision())
1403
@deprecated_method(zero_eight)
1404
def working_tree(self):
1405
"""Create a Working tree object for this branch."""
1407
from bzrlib.transport.local import LocalTransport
1408
if (self.base.find('://') != -1 or
1409
not isinstance(self._transport, LocalTransport)):
1410
raise NoWorkingTree(self.base)
1411
return self.bzrdir.open_workingtree()
1414
def pull(self, source, overwrite=False, stop_revision=None,
1415
_hook_master=None, _run_hooks=True):
1418
:param _hook_master: Private parameter - set the branch to
1419
be supplied as the master to push hooks.
1420
:param _run_hooks: Private parameter - allow disabling of
1421
hooks, used when pushing to a master branch.
1423
result = PullResult()
1424
result.source_branch = source
1425
result.target_branch = self
1428
result.old_revno, result.old_revid = self.last_revision_info()
1430
self.update_revisions(source, stop_revision)
1431
except DivergedBranches:
1435
if stop_revision is None:
1436
stop_revision = source.last_revision()
1437
self.generate_revision_history(stop_revision)
1438
result.tag_conflicts = source.tags.merge_to(self.tags)
1439
result.new_revno, result.new_revid = self.last_revision_info()
1441
result.master_branch = _hook_master
1442
result.local_branch = self
1444
result.master_branch = self
1445
result.local_branch = None
1447
for hook in Branch.hooks['post_pull']:
1453
def _get_parent_location(self):
1454
_locs = ['parent', 'pull', 'x-pull']
1457
return self.control_files.get(l).read().strip('\n')
1463
def push(self, target, 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 - allow disabling of
1470
hooks, used when pushing to a master branch.
1472
result = PushResult()
1473
result.source_branch = self
1474
result.target_branch = target
1477
result.old_revno, result.old_revid = target.last_revision_info()
1479
target.update_revisions(self, stop_revision)
1480
except DivergedBranches:
1484
target.set_revision_history(self.revision_history())
1485
result.tag_conflicts = self.tags.merge_to(target.tags)
1486
result.new_revno, result.new_revid = target.last_revision_info()
1488
result.master_branch = _hook_master
1489
result.local_branch = target
1491
result.master_branch = target
1492
result.local_branch = None
1494
for hook in Branch.hooks['post_push']:
1500
def get_parent(self):
1501
"""See Branch.get_parent."""
1503
assert self.base[-1] == '/'
1504
parent = self._get_parent_location()
1507
# This is an old-format absolute path to a local branch
1508
# turn it into a url
1509
if parent.startswith('/'):
1510
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1512
return urlutils.join(self.base[:-1], parent)
1513
except errors.InvalidURLJoin, e:
1514
raise errors.InaccessibleParent(parent, self.base)
1516
def get_push_location(self):
1517
"""See Branch.get_push_location."""
1518
push_loc = self.get_config().get_user_option('push_location')
1521
def set_push_location(self, location):
1522
"""See Branch.set_push_location."""
1523
self.get_config().set_user_option(
1524
'push_location', location,
1525
store=_mod_config.STORE_LOCATION_NORECURSE)
1528
def set_parent(self, url):
1529
"""See Branch.set_parent."""
1530
# TODO: Maybe delete old location files?
1531
# URLs should never be unicode, even on the local fs,
1532
# FIXUP this and get_parent in a future branch format bump:
1533
# read and rewrite the file, and have the new format code read
1534
# using .get not .get_utf8. RBC 20060125
1536
if isinstance(url, unicode):
1538
url = url.encode('ascii')
1539
except UnicodeEncodeError:
1540
raise bzrlib.errors.InvalidURL(url,
1541
"Urls must be 7-bit ascii, "
1542
"use bzrlib.urlutils.escape")
1543
url = urlutils.relative_url(self.base, url)
1544
self._set_parent_location(url)
1546
def _set_parent_location(self, url):
1548
self.control_files._transport.delete('parent')
1550
assert isinstance(url, str)
1551
self.control_files.put_bytes('parent', url + '\n')
1553
@deprecated_function(zero_nine)
1554
def tree_config(self):
1555
"""DEPRECATED; call get_config instead.
1556
TreeConfig has become part of BranchConfig."""
1557
return TreeConfig(self)
1560
class BzrBranch5(BzrBranch):
1561
"""A format 5 branch. This supports new features over plan branches.
1563
It has support for a master_branch which is the data for bound branches.
1571
super(BzrBranch5, self).__init__(_format=_format,
1572
_control_files=_control_files,
1574
_repository=_repository)
1577
def pull(self, source, overwrite=False, stop_revision=None,
1579
"""Extends branch.pull to be bound branch aware.
1581
:param _run_hooks: Private parameter used to force hook running
1582
off during bound branch double-pushing.
1584
bound_location = self.get_bound_location()
1585
master_branch = None
1586
if bound_location and source.base != bound_location:
1587
# not pulling from master, so we need to update master.
1588
master_branch = self.get_master_branch()
1589
master_branch.lock_write()
1592
# pull from source into master.
1593
master_branch.pull(source, overwrite, stop_revision,
1595
return super(BzrBranch5, self).pull(source, overwrite,
1596
stop_revision, _hook_master=master_branch,
1597
_run_hooks=_run_hooks)
1600
master_branch.unlock()
1603
def push(self, target, overwrite=False, stop_revision=None):
1604
"""Updates branch.push to be bound branch aware."""
1605
bound_location = target.get_bound_location()
1606
master_branch = None
1607
if bound_location and target.base != bound_location:
1608
# not pushing to master, so we need to update master.
1609
master_branch = target.get_master_branch()
1610
master_branch.lock_write()
1613
# push into the master from this branch.
1614
super(BzrBranch5, self).push(master_branch, overwrite,
1615
stop_revision, _run_hooks=False)
1616
# and push into the target branch from this. Note that we push from
1617
# this branch again, because its considered the highest bandwidth
1619
return super(BzrBranch5, self).push(target, overwrite,
1620
stop_revision, _hook_master=master_branch)
1623
master_branch.unlock()
1625
def get_bound_location(self):
1627
return self.control_files.get_utf8('bound').read()[:-1]
1628
except errors.NoSuchFile:
1632
def get_master_branch(self):
1633
"""Return the branch we are bound to.
1635
:return: Either a Branch, or None
1637
This could memoise the branch, but if thats done
1638
it must be revalidated on each new lock.
1639
So for now we just don't memoise it.
1640
# RBC 20060304 review this decision.
1642
bound_loc = self.get_bound_location()
1646
return Branch.open(bound_loc)
1647
except (errors.NotBranchError, errors.ConnectionError), e:
1648
raise errors.BoundBranchConnectionFailure(
1652
def set_bound_location(self, location):
1653
"""Set the target where this branch is bound to.
1655
:param location: URL to the target branch
1658
self.control_files.put_utf8('bound', location+'\n')
1661
self.control_files._transport.delete('bound')
1667
def bind(self, other):
1668
"""Bind this branch to the branch other.
1670
This does not push or pull data between the branches, though it does
1671
check for divergence to raise an error when the branches are not
1672
either the same, or one a prefix of the other. That behaviour may not
1673
be useful, so that check may be removed in future.
1675
:param other: The branch to bind to
1678
# TODO: jam 20051230 Consider checking if the target is bound
1679
# It is debatable whether you should be able to bind to
1680
# a branch which is itself bound.
1681
# Committing is obviously forbidden,
1682
# but binding itself may not be.
1683
# Since we *have* to check at commit time, we don't
1684
# *need* to check here
1686
# we want to raise diverged if:
1687
# last_rev is not in the other_last_rev history, AND
1688
# other_last_rev is not in our history, and do it without pulling
1690
last_rev = self.last_revision()
1691
if last_rev is not None:
1694
other_last_rev = other.last_revision()
1695
if other_last_rev is not None:
1696
# neither branch is new, we have to do some work to
1697
# ascertain diversion.
1698
remote_graph = other.repository.get_revision_graph(
1700
local_graph = self.repository.get_revision_graph(last_rev)
1701
if (last_rev not in remote_graph and
1702
other_last_rev not in local_graph):
1703
raise errors.DivergedBranches(self, other)
1706
self.set_bound_location(other.base)
1710
"""If bound, unbind"""
1711
return self.set_bound_location(None)
1715
"""Synchronise this branch with the master branch if any.
1717
:return: None or the last_revision that was pivoted out during the
1720
master = self.get_master_branch()
1721
if master is not None:
1722
old_tip = self.last_revision()
1723
self.pull(master, overwrite=True)
1724
if old_tip in self.repository.get_ancestry(self.last_revision()):
1730
class BzrBranchExperimental(BzrBranch5):
1731
"""Bzr experimental branch format
1734
- a revision-history file.
1736
- a lock dir guarding the branch itself
1737
- all of this stored in a branch/ subdirectory
1738
- works with shared repositories.
1739
- a tag dictionary in the branch
1741
This format is new in bzr 0.15, but shouldn't be used for real data,
1744
This class acts as it's own BranchFormat.
1747
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1750
def get_format_string(cls):
1751
"""See BranchFormat.get_format_string()."""
1752
return "Bazaar-NG branch format experimental\n"
1755
def get_format_description(cls):
1756
"""See BranchFormat.get_format_description()."""
1757
return "Experimental branch format"
1760
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1762
branch_transport = a_bzrdir.get_branch_transport(cls)
1763
control_files = lockable_files.LockableFiles(branch_transport,
1764
lock_filename, lock_class)
1765
control_files.create_lock()
1766
control_files.lock_write()
1768
for filename, content in utf8_files:
1769
control_files.put_utf8(filename, content)
1771
control_files.unlock()
1774
def initialize(cls, a_bzrdir):
1775
"""Create a branch of this format in a_bzrdir."""
1776
utf8_files = [('format', cls.get_format_string()),
1777
('revision-history', ''),
1778
('branch-name', ''),
1781
cls._initialize_control_files(a_bzrdir, utf8_files,
1782
'lock', lockdir.LockDir)
1783
return cls.open(a_bzrdir, _found=True)
1786
def open(cls, a_bzrdir, _found=False):
1787
"""Return the branch object for a_bzrdir
1789
_found is a private parameter, do not use it. It is used to indicate
1790
if format probing has already be done.
1793
format = BranchFormat.find_format(a_bzrdir)
1794
assert format.__class__ == cls
1795
transport = a_bzrdir.get_branch_transport(None)
1796
control_files = lockable_files.LockableFiles(transport, 'lock',
1798
return cls(_format=cls,
1799
_control_files=control_files,
1801
_repository=a_bzrdir.find_repository())
1804
def is_supported(cls):
1807
def _make_tags(self):
1808
return BasicTags(self)
1811
def supports_tags(cls):
1815
BranchFormat.register_format(BzrBranchExperimental)
1818
class BzrBranch6(BzrBranch5):
1821
def last_revision_info(self):
1822
revision_string = self.control_files.get('last-revision').read()
1823
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1824
revision_id = cache_utf8.get_cached_utf8(revision_id)
1826
return revno, revision_id
1828
def last_revision(self):
1829
"""Return last revision id, or None"""
1830
revision_id = self.last_revision_info()[1]
1831
if revision_id == _mod_revision.NULL_REVISION:
1835
def _write_last_revision_info(self, revno, revision_id):
1836
"""Simply write out the revision id, with no checks.
1838
Use set_last_revision_info to perform this safely.
1840
Does not update the revision_history cache.
1841
Intended to be called by set_last_revision_info and
1842
_write_revision_history.
1844
if revision_id is None:
1845
revision_id = 'null:'
1846
out_string = '%d %s\n' % (revno, revision_id)
1847
self.control_files.put_bytes('last-revision', out_string)
1850
def set_last_revision_info(self, revno, revision_id):
1851
revision_id = osutils.safe_revision_id(revision_id)
1852
if self._get_append_revisions_only():
1853
self._check_history_violation(revision_id)
1854
self._write_last_revision_info(revno, revision_id)
1855
self._clear_cached_state()
1857
def _check_history_violation(self, revision_id):
1858
last_revision = self.last_revision()
1859
if last_revision is None:
1861
if last_revision not in self._lefthand_history(revision_id):
1862
raise errors.AppendRevisionsOnlyViolation(self.base)
1864
def _gen_revision_history(self):
1865
"""Generate the revision history from last revision
1867
history = list(self.repository.iter_reverse_revision_history(
1868
self.last_revision()))
1872
def _write_revision_history(self, history):
1873
"""Factored out of set_revision_history.
1875
This performs the actual writing to disk, with format-specific checks.
1876
It is intended to be called by BzrBranch5.set_revision_history.
1878
if len(history) == 0:
1879
last_revision = 'null:'
1881
if history != self._lefthand_history(history[-1]):
1882
raise errors.NotLefthandHistory(history)
1883
last_revision = history[-1]
1884
if self._get_append_revisions_only():
1885
self._check_history_violation(last_revision)
1886
self._write_last_revision_info(len(history), last_revision)
1889
def append_revision(self, *revision_ids):
1890
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1891
if len(revision_ids) == 0:
1893
prev_revno, prev_revision = self.last_revision_info()
1894
for revision in self.repository.get_revisions(revision_ids):
1895
if prev_revision == _mod_revision.NULL_REVISION:
1896
if revision.parent_ids != []:
1897
raise errors.NotLeftParentDescendant(self, prev_revision,
1898
revision.revision_id)
1900
if revision.parent_ids[0] != prev_revision:
1901
raise errors.NotLeftParentDescendant(self, prev_revision,
1902
revision.revision_id)
1903
prev_revision = revision.revision_id
1904
self.set_last_revision_info(prev_revno + len(revision_ids),
1908
def _set_parent_location(self, url):
1909
"""Set the parent branch"""
1910
self._set_config_location('parent_location', url, make_relative=True)
1913
def _get_parent_location(self):
1914
"""Set the parent branch"""
1915
return self._get_config_location('parent_location')
1917
def set_push_location(self, location):
1918
"""See Branch.set_push_location."""
1919
self._set_config_location('push_location', location)
1921
def set_bound_location(self, location):
1922
"""See Branch.set_push_location."""
1924
config = self.get_config()
1925
if location is None:
1926
if config.get_user_option('bound') != 'True':
1929
config.set_user_option('bound', 'False')
1932
self._set_config_location('bound_location', location,
1934
config.set_user_option('bound', 'True')
1937
def _get_bound_location(self, bound):
1938
"""Return the bound location in the config file.
1940
Return None if the bound parameter does not match"""
1941
config = self.get_config()
1942
config_bound = (config.get_user_option('bound') == 'True')
1943
if config_bound != bound:
1945
return self._get_config_location('bound_location', config=config)
1947
def get_bound_location(self):
1948
"""See Branch.set_push_location."""
1949
return self._get_bound_location(True)
1951
def get_old_bound_location(self):
1952
"""See Branch.get_old_bound_location"""
1953
return self._get_bound_location(False)
1955
def set_append_revisions_only(self, enabled):
1960
self.get_config().set_user_option('append_revisions_only', value)
1962
def _get_append_revisions_only(self):
1963
value = self.get_config().get_user_option('append_revisions_only')
1964
return value == 'True'
1966
def _synchronize_history(self, destination, revision_id):
1967
"""Synchronize last revision and revision history between branches.
1969
This version is most efficient when the destination is also a
1970
BzrBranch6, but works for BzrBranch5, as long as the destination's
1971
repository contains all the lefthand ancestors of the intended
1972
last_revision. If not, set_last_revision_info will fail.
1974
:param destination: The branch to copy the history into
1975
:param revision_id: The revision-id to truncate history at. May
1976
be None to copy complete history.
1978
if revision_id is None:
1979
revno, revision_id = self.last_revision_info()
1981
revno = self.revision_id_to_revno(revision_id)
1982
destination.set_last_revision_info(revno, revision_id)
1984
def _make_tags(self):
1985
return BasicTags(self)
1988
class BranchTestProviderAdapter(object):
1989
"""A tool to generate a suite testing multiple branch formats at once.
1991
This is done by copying the test once for each transport and injecting
1992
the transport_server, transport_readonly_server, and branch_format
1993
classes into each copy. Each copy is also given a new id() to make it
1997
def __init__(self, transport_server, transport_readonly_server, formats):
1998
self._transport_server = transport_server
1999
self._transport_readonly_server = transport_readonly_server
2000
self._formats = formats
2002
def adapt(self, test):
2003
result = TestSuite()
2004
for branch_format, bzrdir_format in self._formats:
2005
new_test = deepcopy(test)
2006
new_test.transport_server = self._transport_server
2007
new_test.transport_readonly_server = self._transport_readonly_server
2008
new_test.bzrdir_format = bzrdir_format
2009
new_test.branch_format = branch_format
2010
def make_new_test_id():
2011
# the format can be either a class or an instance
2012
name = getattr(branch_format, '__name__',
2013
branch_format.__class__.__name__)
2014
new_id = "%s(%s)" % (new_test.id(), name)
2015
return lambda: new_id
2016
new_test.id = make_new_test_id()
2017
result.addTest(new_test)
2021
######################################################################
2022
# results of operations
2025
class _Result(object):
2027
def _show_tag_conficts(self, to_file):
2028
if not getattr(self, 'tag_conflicts', None):
2030
to_file.write('Conflicting tags:\n')
2031
for name, value1, value2 in self.tag_conflicts:
2032
to_file.write(' %s\n' % (name, ))
2035
class PullResult(_Result):
2036
"""Result of a Branch.pull operation.
2038
:ivar old_revno: Revision number before pull.
2039
:ivar new_revno: Revision number after pull.
2040
:ivar old_revid: Tip revision id before pull.
2041
:ivar new_revid: Tip revision id after pull.
2042
:ivar source_branch: Source (local) branch object.
2043
:ivar master_branch: Master branch of the target, or None.
2044
:ivar target_branch: Target/destination branch object.
2048
# DEPRECATED: pull used to return the change in revno
2049
return self.new_revno - self.old_revno
2051
def report(self, to_file):
2052
if self.old_revid == self.new_revid:
2053
to_file.write('No revisions to pull.\n')
2055
to_file.write('Now on revision %d.\n' % self.new_revno)
2056
self._show_tag_conficts(to_file)
2059
class PushResult(_Result):
2060
"""Result of a Branch.push operation.
2062
:ivar old_revno: Revision number before push.
2063
:ivar new_revno: Revision number after push.
2064
:ivar old_revid: Tip revision id before push.
2065
:ivar new_revid: Tip revision id after push.
2066
:ivar source_branch: Source branch object.
2067
:ivar master_branch: Master branch of the target, or None.
2068
:ivar target_branch: Target/destination branch object.
2072
# DEPRECATED: push used to return the change in revno
2073
return self.new_revno - self.old_revno
2075
def report(self, to_file):
2076
"""Write a human-readable description of the result."""
2077
if self.old_revid == self.new_revid:
2078
to_file.write('No new revisions to push.\n')
2080
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2081
self._show_tag_conficts(to_file)
2084
class BranchCheckResult(object):
2085
"""Results of checking branch consistency.
2090
def __init__(self, branch):
2091
self.branch = branch
2093
def report_results(self, verbose):
2094
"""Report the check results via trace.note.
2096
:param verbose: Requests more detailed display of what was checked,
2099
note('checked branch %s format %s',
2101
self.branch._format)
2104
class Converter5to6(object):
2105
"""Perform an in-place upgrade of format 5 to format 6"""
2107
def convert(self, branch):
2108
# Data for 5 and 6 can peacefully coexist.
2109
format = BzrBranchFormat6()
2110
new_branch = format.open(branch.bzrdir, _found=True)
2112
# Copy source data into target
2113
new_branch.set_last_revision_info(*branch.last_revision_info())
2114
new_branch.set_parent(branch.get_parent())
2115
new_branch.set_bound_location(branch.get_bound_location())
2116
new_branch.set_push_location(branch.get_push_location())
2118
# New branch has no tags by default
2119
new_branch.tags._set_tag_dict({})
2121
# Copying done; now update target format
2122
new_branch.control_files.put_utf8('format',
2123
format.get_format_string())
2125
# Clean up old files
2126
new_branch.control_files._transport.delete('revision-history')
2128
branch.set_parent(None)
2131
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
