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.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
84
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
123
def open(base, _unsupported=False):
124
"""Open the branch rooted at base.
126
For instance, if the branch is at URL/.bzr/branch,
127
Branch.open(URL) -> a Branch instance.
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url):
134
"""Open an existing branch which contains url.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
152
NOTE: This will soon be deprecated in favour of creation
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
162
NOTE: This is unused.
166
def get_config(self):
167
return BranchConfig(self)
170
return self.get_config().get_nickname()
172
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
175
nick = property(_get_nick, _set_nick)
178
raise NotImplementedError(self.is_locked)
180
def lock_write(self):
181
raise NotImplementedError(self.lock_write)
184
raise NotImplementedError(self.lock_read)
187
raise NotImplementedError(self.unlock)
189
def peek_lock_mode(self):
190
"""Return lock mode for the Branch: 'r', 'w' or None"""
191
raise NotImplementedError(self.peek_lock_mode)
193
def get_physical_lock_status(self):
194
raise NotImplementedError(self.get_physical_lock_status)
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
202
raise NotImplementedError(self.abspath)
204
def bind(self, other):
205
"""Bind the local branch the other branch.
207
:param other: The branch to bind to
210
raise errors.UpgradeRequired(self.base)
213
def fetch(self, from_branch, last_revision=None, pb=None):
214
"""Copy revisions from from_branch into this branch.
216
:param from_branch: Where to copy from.
217
:param last_revision: What revision to stop at (None for at the end
219
:param pb: An optional progress bar to use.
221
Returns the copied revision count and the failed revisions in a tuple:
224
if self.base == from_branch.base:
227
nested_pb = ui.ui_factory.nested_progress_bar()
232
from_branch.lock_read()
234
if last_revision is None:
235
pb.update('get source history')
236
last_revision = from_branch.last_revision()
237
if last_revision is None:
238
last_revision = _mod_revision.NULL_REVISION
239
return self.repository.fetch(from_branch.repository,
240
revision_id=last_revision,
243
if nested_pb is not None:
247
def get_bound_location(self):
248
"""Return the URL of the branch we are bound to.
250
Older format branches cannot bind, please be sure to use a metadir
255
def get_old_bound_location(self):
256
"""Return the URL of the branch we used to be bound to
258
raise errors.UpgradeRequired(self.base)
260
def get_commit_builder(self, parents, config=None, timestamp=None,
261
timezone=None, committer=None, revprops=None,
263
"""Obtain a CommitBuilder for this branch.
265
:param parents: Revision ids of the parents of the new revision.
266
:param config: Optional configuration to use.
267
:param timestamp: Optional timestamp recorded for commit.
268
:param timezone: Optional timezone for timestamp.
269
:param committer: Optional committer to set for commit.
270
:param revprops: Optional dictionary of revision properties.
271
:param revision_id: Optional revision id.
275
config = self.get_config()
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
280
def get_master_branch(self):
281
"""Return the branch we are bound to.
283
:return: Either a Branch, or None
287
def get_revision_delta(self, revno):
288
"""Return the delta for one revision.
290
The delta is relative to its mainline predecessor, or the
291
empty tree for revision 1.
293
assert isinstance(revno, int)
294
rh = self.revision_history()
295
if not (1 <= revno <= len(rh)):
296
raise InvalidRevisionNumber(revno)
297
return self.repository.get_revision_delta(rh[revno-1])
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
303
def print_file(self, file, revision_id):
304
"""Print `file` to stdout."""
305
raise NotImplementedError(self.print_file)
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
313
def revision_history(self):
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
318
"""Return current revision number for this branch.
320
That is equivalent to the number of revisions committed to
323
return len(self.revision_history())
326
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
333
def last_revision(self):
334
"""Return last revision id, or None"""
335
ph = self.revision_history()
341
def last_revision_info(self):
342
"""Return information about the last revision.
344
:return: A tuple (revno, last_revision_id).
346
rh = self.revision_history()
349
return (revno, rh[-1])
351
return (0, _mod_revision.NULL_REVISION)
353
def missing_revisions(self, other, stop_revision=None):
354
"""Return a list of new revisions that would perfectly fit.
356
If self and other have not diverged, return a list of the revisions
357
present in other, but missing from self.
359
self_history = self.revision_history()
360
self_len = len(self_history)
361
other_history = other.revision_history()
362
other_len = len(other_history)
363
common_index = min(self_len, other_len) -1
364
if common_index >= 0 and \
365
self_history[common_index] != other_history[common_index]:
366
raise DivergedBranches(self, other)
368
if stop_revision is None:
369
stop_revision = other_len
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
374
return other_history[self_len:stop_revision]
376
def update_revisions(self, other, stop_revision=None):
377
"""Pull in new perfect-fit revisions.
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
383
raise NotImplementedError(self.update_revisions)
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
392
return history.index(revision_id) + 1
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
396
def get_rev_id(self, revno, history=None):
397
"""Find the revision id of the specified revno."""
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
406
def pull(self, source, overwrite=False, stop_revision=None):
407
"""Mirror source into this branch.
409
This branch is considered to be 'local', having low latency.
411
:returns: PullResult instance
413
raise NotImplementedError(self.pull)
415
def push(self, target, overwrite=False, stop_revision=None):
416
"""Mirror this branch into target.
418
This branch is considered to be 'local', having low latency.
420
raise NotImplementedError(self.push)
422
def basis_tree(self):
423
"""Return `Tree` object for last revision."""
424
return self.repository.revision_tree(self.last_revision())
426
def rename_one(self, from_rel, to_rel):
429
This can change the directory or the filename or both.
431
raise NotImplementedError(self.rename_one)
433
def move(self, from_paths, to_name):
436
to_name must exist as a versioned directory.
438
If to_name exists and is a directory, the files are moved into
439
it, keeping their old names. If it is a directory,
441
Note that to_name is only the last component of the new name;
442
this doesn't change the directory.
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError(self.move)
449
def get_parent(self):
450
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
456
raise NotImplementedError(self.get_parent)
458
def _set_config_location(self, name, url, config=None,
459
make_relative=False):
461
config = self.get_config()
465
url = urlutils.relative_url(self.base, url)
466
config.set_user_option(name, url)
468
def _get_config_location(self, name, config=None):
470
config = self.get_config()
471
location = config.get_user_option(name)
476
def get_submit_branch(self):
477
"""Return the submit location of the branch.
479
This is the default location for bundle. The usual
480
pattern is that the user can override it by specifying a
483
return self.get_config().get_user_option('submit_branch')
485
def set_submit_branch(self, location):
486
"""Return the submit location of the branch.
488
This is the default location for bundle. The usual
489
pattern is that the user can override it by specifying a
492
self.get_config().set_user_option('submit_branch', location)
494
def get_public_branch(self):
495
"""Return the public location of the branch.
497
This is is used by merge directives.
499
return self._get_config_location('public_branch')
501
def set_public_branch(self, location):
502
"""Return the submit location of the branch.
504
This is the default location for bundle. The usual
505
pattern is that the user can override it by specifying a
508
self._set_config_location('public_branch', location)
510
def get_push_location(self):
511
"""Return the None or the location to push this branch to."""
512
raise NotImplementedError(self.get_push_location)
514
def set_push_location(self, location):
515
"""Set a new push location for this branch."""
516
raise NotImplementedError(self.set_push_location)
518
def set_parent(self, url):
519
raise NotImplementedError(self.set_parent)
523
"""Synchronise this branch with the master branch if any.
525
:return: None or the last_revision pivoted out during the update.
529
def check_revno(self, revno):
531
Check whether a revno corresponds to any revision.
532
Zero (the NULL revision) is considered valid.
535
self.check_real_revno(revno)
537
def check_real_revno(self, revno):
539
Check whether a revno corresponds to a real revision.
540
Zero (the NULL revision) is considered invalid
542
if revno < 1 or revno > self.revno():
543
raise InvalidRevisionNumber(revno)
546
def clone(self, to_bzrdir, revision_id=None):
547
"""Clone this branch into to_bzrdir preserving all semantic values.
549
revision_id: if not None, the revision history in the new branch will
550
be truncated to end with revision_id.
552
result = self._format.initialize(to_bzrdir)
553
self.copy_content_into(result, revision_id=revision_id)
557
def sprout(self, to_bzrdir, revision_id=None):
558
"""Create a new line of development from the branch, into to_bzrdir.
560
revision_id: if not None, the revision history in the new branch will
561
be truncated to end with revision_id.
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
565
result.set_parent(self.bzrdir.root_transport.base)
568
def _synchronize_history(self, destination, revision_id):
569
"""Synchronize last revision and revision history between branches.
571
This version is most efficient when the destination is also a
572
BzrBranch5, but works for BzrBranch6 as long as the revision
573
history is the true lefthand parent history, and all of the revisions
574
are in the destination's repository. If not, set_revision_history
577
:param destination: The branch to copy the history into
578
:param revision_id: The revision-id to truncate history at. May
579
be None to copy complete history.
581
new_history = self.revision_history()
582
if revision_id is not None:
583
revision_id = osutils.safe_revision_id(revision_id)
585
new_history = new_history[:new_history.index(revision_id) + 1]
587
rev = self.repository.get_revision(revision_id)
588
new_history = rev.get_history(self.repository)[1:]
589
destination.set_revision_history(new_history)
592
def copy_content_into(self, destination, revision_id=None):
593
"""Copy the content of self into destination.
595
revision_id: if not None, the revision history in the new branch will
596
be truncated to end with revision_id.
598
self._synchronize_history(destination, revision_id)
600
parent = self.get_parent()
601
except errors.InaccessibleParent, e:
602
mutter('parent was not accessible to copy: %s', e)
605
destination.set_parent(parent)
606
self.tags.merge_to(destination.tags)
610
"""Check consistency of the branch.
612
In particular this checks that revisions given in the revision-history
613
do actually match up in the revision graph, and that they're all
614
present in the repository.
616
Callers will typically also want to check the repository.
618
:return: A BranchCheckResult.
620
mainline_parent_id = None
621
for revision_id in self.revision_history():
623
revision = self.repository.get_revision(revision_id)
624
except errors.NoSuchRevision, e:
625
raise errors.BzrCheckError("mainline revision {%s} not in repository"
627
# In general the first entry on the revision history has no parents.
628
# But it's not illegal for it to have parents listed; this can happen
629
# in imports from Arch when the parents weren't reachable.
630
if mainline_parent_id is not None:
631
if mainline_parent_id not in revision.parent_ids:
632
raise errors.BzrCheckError("previous revision {%s} not listed among "
634
% (mainline_parent_id, revision_id))
635
mainline_parent_id = revision_id
636
return BranchCheckResult(self)
638
def _get_checkout_format(self):
639
"""Return the most suitable metadir for a checkout of this branch.
640
Weaves are used if this branch's repostory uses weaves.
642
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
643
from bzrlib.repofmt import weaverepo
644
format = bzrdir.BzrDirMetaFormat1()
645
format.repository_format = weaverepo.RepositoryFormat7()
647
format = self.repository.bzrdir.checkout_metadir()
648
format.branch_format = self._format
651
def create_checkout(self, to_location, revision_id=None,
653
"""Create a checkout of a branch.
655
:param to_location: The url to produce the checkout at
656
:param revision_id: The revision to check out
657
:param lightweight: If True, produce a lightweight checkout, otherwise,
658
produce a bound branch (heavyweight checkout)
659
:return: The tree of the created checkout
661
t = transport.get_transport(to_location)
664
except errors.FileExists:
667
format = self._get_checkout_format()
668
checkout = format.initialize_on_transport(t)
669
BranchReferenceFormat().initialize(checkout, self)
671
format = self._get_checkout_format()
672
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
673
to_location, force_new_tree=False, format=format)
674
checkout = checkout_branch.bzrdir
675
checkout_branch.bind(self)
676
# pull up to the specified revision_id to set the initial
677
# branch tip correctly, and seed it with history.
678
checkout_branch.pull(self, stop_revision=revision_id)
679
tree = checkout.create_workingtree(revision_id)
680
basis_tree = tree.basis_tree()
681
basis_tree.lock_read()
683
for path, file_id in basis_tree.iter_references():
684
reference_parent = self.reference_parent(file_id, path)
685
reference_parent.create_checkout(tree.abspath(path),
686
basis_tree.get_reference_revision(file_id, path),
692
def reference_parent(self, file_id, path):
693
"""Return the parent branch for a tree-reference file_id
694
:param file_id: The file_id of the tree reference
695
:param path: The path of the file_id in the tree
696
:return: A branch associated with the file_id
698
# FIXME should provide multiple branches, based on config
699
return Branch.open(self.bzrdir.root_transport.clone(path).base)
701
def supports_tags(self):
702
return self._format.supports_tags()
705
class BranchFormat(object):
706
"""An encapsulation of the initialization and open routines for a format.
708
Formats provide three things:
709
* An initialization routine,
713
Formats are placed in an dict by their format string for reference
714
during branch opening. Its not required that these be instances, they
715
can be classes themselves with class methods - it simply depends on
716
whether state is needed for a given format or not.
718
Once a format is deprecated, just deprecate the initialize and open
719
methods on the format class. Do not deprecate the object, as the
720
object will be created every time regardless.
723
_default_format = None
724
"""The default format used for new branches."""
727
"""The known formats."""
730
def find_format(klass, a_bzrdir):
731
"""Return the format for the branch object in a_bzrdir."""
733
transport = a_bzrdir.get_branch_transport(None)
734
format_string = transport.get("format").read()
735
return klass._formats[format_string]
737
raise NotBranchError(path=transport.base)
739
raise errors.UnknownFormatError(format=format_string)
742
def get_default_format(klass):
743
"""Return the current default format."""
744
return klass._default_format
746
def get_format_string(self):
747
"""Return the ASCII format string that identifies this format."""
748
raise NotImplementedError(self.get_format_string)
750
def get_format_description(self):
751
"""Return the short format description for this format."""
752
raise NotImplementedError(self.get_format_description)
754
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
756
"""Initialize a branch in a bzrdir, with specified files
758
:param a_bzrdir: The bzrdir to initialize the branch in
759
:param utf8_files: The files to create as a list of
760
(filename, content) tuples
761
:param set_format: If True, set the format with
762
self.get_format_string. (BzrBranch4 has its format set
764
:return: a branch in this format
766
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
767
branch_transport = a_bzrdir.get_branch_transport(self)
769
'metadir': ('lock', lockdir.LockDir),
770
'branch4': ('branch-lock', lockable_files.TransportLock),
772
lock_name, lock_class = lock_map[lock_type]
773
control_files = lockable_files.LockableFiles(branch_transport,
774
lock_name, lock_class)
775
control_files.create_lock()
776
control_files.lock_write()
778
control_files.put_utf8('format', self.get_format_string())
780
for file, content in utf8_files:
781
control_files.put_utf8(file, content)
783
control_files.unlock()
784
return self.open(a_bzrdir, _found=True)
786
def initialize(self, a_bzrdir):
787
"""Create a branch of this format in a_bzrdir."""
788
raise NotImplementedError(self.initialize)
790
def is_supported(self):
791
"""Is this format supported?
793
Supported formats can be initialized and opened.
794
Unsupported formats may not support initialization or committing or
795
some other features depending on the reason for not being supported.
799
def open(self, a_bzrdir, _found=False):
800
"""Return the branch object for a_bzrdir
802
_found is a private parameter, do not use it. It is used to indicate
803
if format probing has already be done.
805
raise NotImplementedError(self.open)
808
def register_format(klass, format):
809
klass._formats[format.get_format_string()] = format
812
def set_default_format(klass, format):
813
klass._default_format = format
816
def unregister_format(klass, format):
817
assert klass._formats[format.get_format_string()] is format
818
del klass._formats[format.get_format_string()]
821
return self.get_format_string().rstrip()
823
def supports_tags(self):
824
"""True if this format supports tags stored in the branch"""
825
return False # by default
827
# XXX: Probably doesn't really belong here -- mbp 20070212
828
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
830
branch_transport = a_bzrdir.get_branch_transport(self)
831
control_files = lockable_files.LockableFiles(branch_transport,
832
lock_filename, lock_class)
833
control_files.create_lock()
834
control_files.lock_write()
836
for filename, content in utf8_files:
837
control_files.put_utf8(filename, content)
839
control_files.unlock()
842
class BranchHooks(dict):
843
"""A dictionary mapping hook name to a list of callables for branch hooks.
845
e.g. ['set_rh'] Is the list of items to be called when the
846
set_revision_history function is invoked.
850
"""Create the default hooks.
852
These are all empty initially, because by default nothing should get
856
# Introduced in 0.15:
857
# invoked whenever the revision history has been set
858
# with set_revision_history. The api signature is
859
# (branch, revision_history), and the branch will
862
# invoked after a push operation completes.
863
# the api signature is
865
# containing the members
866
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
867
# where local is the local branch or None, master is the target
868
# master branch, and the rest should be self explanatory. The source
869
# is read locked and the target branches write locked. Source will
870
# be the local low-latency branch.
871
self['post_push'] = []
872
# invoked after a pull operation completes.
873
# the api signature is
875
# containing the members
876
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
877
# where local is the local branch or None, master is the target
878
# master branch, and the rest should be self explanatory. The source
879
# is read locked and the target branches write locked. The local
880
# branch is the low-latency branch.
881
self['post_pull'] = []
882
# invoked after a commit operation completes.
883
# the api signature is
884
# (local, master, old_revno, old_revid, new_revno, new_revid)
885
# old_revid is NULL_REVISION for the first commit to a branch.
886
self['post_commit'] = []
887
# invoked after a uncommit operation completes.
888
# the api signature is
889
# (local, master, old_revno, old_revid, new_revno, new_revid) where
890
# local is the local branch or None, master is the target branch,
891
# and an empty branch recieves new_revno of 0, new_revid of None.
892
self['post_uncommit'] = []
894
def install_hook(self, hook_name, a_callable):
895
"""Install a_callable in to the hook hook_name.
897
:param hook_name: A hook name. See the __init__ method of BranchHooks
898
for the complete list of hooks.
899
:param a_callable: The callable to be invoked when the hook triggers.
900
The exact signature will depend on the hook - see the __init__
901
method of BranchHooks for details on each hook.
904
self[hook_name].append(a_callable)
906
raise errors.UnknownHook('branch', hook_name)
909
# install the default hooks into the Branch class.
910
Branch.hooks = BranchHooks()
913
class BzrBranchFormat4(BranchFormat):
914
"""Bzr branch format 4.
917
- a revision-history file.
918
- a branch-lock lock file [ to be shared with the bzrdir ]
921
def get_format_description(self):
922
"""See BranchFormat.get_format_description()."""
923
return "Branch format 4"
925
def initialize(self, a_bzrdir):
926
"""Create a branch of this format in a_bzrdir."""
927
utf8_files = [('revision-history', ''),
930
return self._initialize_helper(a_bzrdir, utf8_files,
931
lock_type='branch4', set_format=False)
934
super(BzrBranchFormat4, self).__init__()
935
self._matchingbzrdir = bzrdir.BzrDirFormat6()
937
def open(self, a_bzrdir, _found=False):
938
"""Return the branch object for a_bzrdir
940
_found is a private parameter, do not use it. It is used to indicate
941
if format probing has already be done.
944
# we are being called directly and must probe.
945
raise NotImplementedError
946
return BzrBranch(_format=self,
947
_control_files=a_bzrdir._control_files,
949
_repository=a_bzrdir.open_repository())
952
return "Bazaar-NG branch format 4"
955
class BzrBranchFormat5(BranchFormat):
956
"""Bzr branch format 5.
959
- a revision-history file.
961
- a lock dir guarding the branch itself
962
- all of this stored in a branch/ subdirectory
963
- works with shared repositories.
965
This format is new in bzr 0.8.
968
def get_format_string(self):
969
"""See BranchFormat.get_format_string()."""
970
return "Bazaar-NG branch format 5\n"
972
def get_format_description(self):
973
"""See BranchFormat.get_format_description()."""
974
return "Branch format 5"
976
def initialize(self, a_bzrdir):
977
"""Create a branch of this format in a_bzrdir."""
978
utf8_files = [('revision-history', ''),
981
return self._initialize_helper(a_bzrdir, utf8_files)
984
super(BzrBranchFormat5, self).__init__()
985
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
987
def open(self, a_bzrdir, _found=False):
988
"""Return the branch object for a_bzrdir
990
_found is a private parameter, do not use it. It is used to indicate
991
if format probing has already be done.
994
format = BranchFormat.find_format(a_bzrdir)
995
assert format.__class__ == self.__class__
996
transport = a_bzrdir.get_branch_transport(None)
997
control_files = lockable_files.LockableFiles(transport, 'lock',
999
return BzrBranch5(_format=self,
1000
_control_files=control_files,
1002
_repository=a_bzrdir.find_repository())
1005
class BzrBranchFormat6(BzrBranchFormat5):
1006
"""Branch format with last-revision
1008
Unlike previous formats, this has no explicit revision history. Instead,
1009
this just stores the last-revision, and the left-hand history leading
1010
up to there is the history.
1012
This format was introduced in bzr 0.15
1015
def get_format_string(self):
1016
"""See BranchFormat.get_format_string()."""
1017
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1019
def get_format_description(self):
1020
"""See BranchFormat.get_format_description()."""
1021
return "Branch format 6"
1023
def initialize(self, a_bzrdir):
1024
"""Create a branch of this format in a_bzrdir."""
1025
utf8_files = [('last-revision', '0 null:\n'),
1026
('branch-name', ''),
1027
('branch.conf', ''),
1030
return self._initialize_helper(a_bzrdir, utf8_files)
1032
def open(self, a_bzrdir, _found=False):
1033
"""Return the branch object for a_bzrdir
1035
_found is a private parameter, do not use it. It is used to indicate
1036
if format probing has already be done.
1039
format = BranchFormat.find_format(a_bzrdir)
1040
assert format.__class__ == self.__class__
1041
transport = a_bzrdir.get_branch_transport(None)
1042
control_files = lockable_files.LockableFiles(transport, 'lock',
1044
return BzrBranch6(_format=self,
1045
_control_files=control_files,
1047
_repository=a_bzrdir.find_repository())
1049
def supports_tags(self):
1053
class BranchReferenceFormat(BranchFormat):
1054
"""Bzr branch reference format.
1056
Branch references are used in implementing checkouts, they
1057
act as an alias to the real branch which is at some other url.
1064
def get_format_string(self):
1065
"""See BranchFormat.get_format_string()."""
1066
return "Bazaar-NG Branch Reference Format 1\n"
1068
def get_format_description(self):
1069
"""See BranchFormat.get_format_description()."""
1070
return "Checkout reference format 1"
1072
def initialize(self, a_bzrdir, target_branch=None):
1073
"""Create a branch of this format in a_bzrdir."""
1074
if target_branch is None:
1075
# this format does not implement branch itself, thus the implicit
1076
# creation contract must see it as uninitializable
1077
raise errors.UninitializableFormat(self)
1078
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1079
branch_transport = a_bzrdir.get_branch_transport(self)
1080
branch_transport.put_bytes('location',
1081
target_branch.bzrdir.root_transport.base)
1082
branch_transport.put_bytes('format', self.get_format_string())
1083
return self.open(a_bzrdir, _found=True)
1086
super(BranchReferenceFormat, self).__init__()
1087
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1089
def _make_reference_clone_function(format, a_branch):
1090
"""Create a clone() routine for a branch dynamically."""
1091
def clone(to_bzrdir, revision_id=None):
1092
"""See Branch.clone()."""
1093
return format.initialize(to_bzrdir, a_branch)
1094
# cannot obey revision_id limits when cloning a reference ...
1095
# FIXME RBC 20060210 either nuke revision_id for clone, or
1096
# emit some sort of warning/error to the caller ?!
1099
def open(self, a_bzrdir, _found=False):
1100
"""Return the branch that the branch reference in a_bzrdir points at.
1102
_found is a private parameter, do not use it. It is used to indicate
1103
if format probing has already be done.
1106
format = BranchFormat.find_format(a_bzrdir)
1107
assert format.__class__ == self.__class__
1108
transport = a_bzrdir.get_branch_transport(None)
1109
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1110
result = real_bzrdir.open_branch()
1111
# this changes the behaviour of result.clone to create a new reference
1112
# rather than a copy of the content of the branch.
1113
# I did not use a proxy object because that needs much more extensive
1114
# testing, and we are only changing one behaviour at the moment.
1115
# If we decide to alter more behaviours - i.e. the implicit nickname
1116
# then this should be refactored to introduce a tested proxy branch
1117
# and a subclass of that for use in overriding clone() and ....
1119
result.clone = self._make_reference_clone_function(result)
1123
# formats which have no format string are not discoverable
1124
# and not independently creatable, so are not registered.
1125
__default_format = BzrBranchFormat5()
1126
BranchFormat.register_format(__default_format)
1127
BranchFormat.register_format(BranchReferenceFormat())
1128
BranchFormat.register_format(BzrBranchFormat6())
1129
BranchFormat.set_default_format(__default_format)
1130
_legacy_formats = [BzrBranchFormat4(),
1133
class BzrBranch(Branch):
1134
"""A branch stored in the actual filesystem.
1136
Note that it's "local" in the context of the filesystem; it doesn't
1137
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1138
it's writable, and can be accessed via the normal filesystem API.
1141
def __init__(self, _format=None,
1142
_control_files=None, a_bzrdir=None, _repository=None):
1143
"""Create new branch object at a particular location."""
1144
Branch.__init__(self)
1145
if a_bzrdir is None:
1146
raise ValueError('a_bzrdir must be supplied')
1148
self.bzrdir = a_bzrdir
1149
# self._transport used to point to the directory containing the
1150
# control directory, but was not used - now it's just the transport
1151
# for the branch control files. mbp 20070212
1152
self._base = self.bzrdir.transport.clone('..').base
1153
self._format = _format
1154
if _control_files is None:
1155
raise ValueError('BzrBranch _control_files is None')
1156
self.control_files = _control_files
1157
self._transport = _control_files._transport
1158
self.repository = _repository
1161
return '%s(%r)' % (self.__class__.__name__, self.base)
1165
def _get_base(self):
1166
"""Returns the directory containing the control directory."""
1169
base = property(_get_base, doc="The URL for the root of this branch.")
1171
def _finish_transaction(self):
1172
"""Exit the current transaction."""
1173
return self.control_files._finish_transaction()
1175
def get_transaction(self):
1176
"""Return the current active transaction.
1178
If no transaction is active, this returns a passthrough object
1179
for which all data is immediately flushed and no caching happens.
1181
# this is an explicit function so that we can do tricky stuff
1182
# when the storage in rev_storage is elsewhere.
1183
# we probably need to hook the two 'lock a location' and
1184
# 'have a transaction' together more delicately, so that
1185
# we can have two locks (branch and storage) and one transaction
1186
# ... and finishing the transaction unlocks both, but unlocking
1187
# does not. - RBC 20051121
1188
return self.control_files.get_transaction()
1190
def _set_transaction(self, transaction):
1191
"""Set a new active transaction."""
1192
return self.control_files._set_transaction(transaction)
1194
def abspath(self, name):
1195
"""See Branch.abspath."""
1196
return self.control_files._transport.abspath(name)
1199
def get_root_id(self):
1200
"""See Branch.get_root_id."""
1201
tree = self.repository.revision_tree(self.last_revision())
1202
return tree.inventory.root.file_id
1204
def is_locked(self):
1205
return self.control_files.is_locked()
1207
def lock_write(self):
1208
self.repository.lock_write()
1210
self.control_files.lock_write()
1212
self.repository.unlock()
1215
def lock_read(self):
1216
self.repository.lock_read()
1218
self.control_files.lock_read()
1220
self.repository.unlock()
1224
# TODO: test for failed two phase locks. This is known broken.
1226
self.control_files.unlock()
1228
self.repository.unlock()
1230
def peek_lock_mode(self):
1231
if self.control_files._lock_count == 0:
1234
return self.control_files._lock_mode
1236
def get_physical_lock_status(self):
1237
return self.control_files.get_physical_lock_status()
1240
def print_file(self, file, revision_id):
1241
"""See Branch.print_file."""
1242
return self.repository.print_file(file, revision_id)
1245
def append_revision(self, *revision_ids):
1246
"""See Branch.append_revision."""
1247
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1248
for revision_id in revision_ids:
1249
_mod_revision.check_not_reserved_id(revision_id)
1250
mutter("add {%s} to revision-history" % revision_id)
1251
rev_history = self.revision_history()
1252
rev_history.extend(revision_ids)
1253
self.set_revision_history(rev_history)
1255
def _write_revision_history(self, history):
1256
"""Factored out of set_revision_history.
1258
This performs the actual writing to disk.
1259
It is intended to be called by BzrBranch5.set_revision_history."""
1260
self.control_files.put_bytes(
1261
'revision-history', '\n'.join(history))
1264
def set_revision_history(self, rev_history):
1265
"""See Branch.set_revision_history."""
1266
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1267
self._write_revision_history(rev_history)
1268
transaction = self.get_transaction()
1269
history = transaction.map.find_revision_history()
1270
if history is not None:
1271
# update the revision history in the identity map.
1272
history[:] = list(rev_history)
1273
# this call is disabled because revision_history is
1274
# not really an object yet, and the transaction is for objects.
1275
# transaction.register_dirty(history)
1277
transaction.map.add_revision_history(rev_history)
1278
# this call is disabled because revision_history is
1279
# not really an object yet, and the transaction is for objects.
1280
# transaction.register_clean(history)
1281
for hook in Branch.hooks['set_rh']:
1282
hook(self, rev_history)
1285
def set_last_revision_info(self, revno, revision_id):
1286
revision_id = osutils.safe_revision_id(revision_id)
1287
history = self._lefthand_history(revision_id)
1288
assert len(history) == revno, '%d != %d' % (len(history), revno)
1289
self.set_revision_history(history)
1291
def _gen_revision_history(self):
1292
history = self.control_files.get('revision-history').read().split('\n')
1293
if history[-1:] == ['']:
1294
# There shouldn't be a trailing newline, but just in case.
1299
def revision_history(self):
1300
"""See Branch.revision_history."""
1301
transaction = self.get_transaction()
1302
history = transaction.map.find_revision_history()
1303
if history is not None:
1304
# mutter("cache hit for revision-history in %s", self)
1305
return list(history)
1306
history = self._gen_revision_history()
1307
transaction.map.add_revision_history(history)
1308
# this call is disabled because revision_history is
1309
# not really an object yet, and the transaction is for objects.
1310
# transaction.register_clean(history, precious=True)
1311
return list(history)
1313
def _lefthand_history(self, revision_id, last_rev=None,
1315
# stop_revision must be a descendant of last_revision
1316
stop_graph = self.repository.get_revision_graph(revision_id)
1317
if last_rev is not None and last_rev not in stop_graph:
1318
# our previous tip is not merged into stop_revision
1319
raise errors.DivergedBranches(self, other_branch)
1320
# make a new revision history from the graph
1321
current_rev_id = revision_id
1323
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1324
new_history.append(current_rev_id)
1325
current_rev_id_parents = stop_graph[current_rev_id]
1327
current_rev_id = current_rev_id_parents[0]
1329
current_rev_id = None
1330
new_history.reverse()
1334
def generate_revision_history(self, revision_id, last_rev=None,
1336
"""Create a new revision history that will finish with revision_id.
1338
:param revision_id: the new tip to use.
1339
:param last_rev: The previous last_revision. If not None, then this
1340
must be a ancestory of revision_id, or DivergedBranches is raised.
1341
:param other_branch: The other branch that DivergedBranches should
1342
raise with respect to.
1344
revision_id = osutils.safe_revision_id(revision_id)
1345
self.set_revision_history(self._lefthand_history(revision_id,
1346
last_rev, other_branch))
1349
def update_revisions(self, other, stop_revision=None):
1350
"""See Branch.update_revisions."""
1353
if stop_revision is None:
1354
stop_revision = other.last_revision()
1355
if stop_revision is None:
1356
# if there are no commits, we're done.
1359
stop_revision = osutils.safe_revision_id(stop_revision)
1360
# whats the current last revision, before we fetch [and change it
1362
last_rev = self.last_revision()
1363
# we fetch here regardless of whether we need to so that we pickup
1365
self.fetch(other, stop_revision)
1366
my_ancestry = self.repository.get_ancestry(last_rev)
1367
if stop_revision in my_ancestry:
1368
# last_revision is a descendant of stop_revision
1370
self.generate_revision_history(stop_revision, last_rev=last_rev,
1375
def basis_tree(self):
1376
"""See Branch.basis_tree."""
1377
return self.repository.revision_tree(self.last_revision())
1379
@deprecated_method(zero_eight)
1380
def working_tree(self):
1381
"""Create a Working tree object for this branch."""
1383
from bzrlib.transport.local import LocalTransport
1384
if (self.base.find('://') != -1 or
1385
not isinstance(self._transport, LocalTransport)):
1386
raise NoWorkingTree(self.base)
1387
return self.bzrdir.open_workingtree()
1390
def pull(self, source, overwrite=False, stop_revision=None,
1391
_hook_master=None, _run_hooks=True):
1394
:param _hook_master: Private parameter - set the branch to
1395
be supplied as the master to push hooks.
1396
:param _run_hooks: Private parameter - allow disabling of
1397
hooks, used when pushing to a master branch.
1399
result = PullResult()
1400
result.source_branch = source
1401
result.target_branch = self
1404
result.old_revno, result.old_revid = self.last_revision_info()
1406
self.update_revisions(source, stop_revision)
1407
except DivergedBranches:
1411
if stop_revision is None:
1412
stop_revision = source.last_revision()
1413
self.generate_revision_history(stop_revision)
1414
result.tag_conflicts = source.tags.merge_to(self.tags)
1415
result.new_revno, result.new_revid = self.last_revision_info()
1417
result.master_branch = _hook_master
1418
result.local_branch = self
1420
result.master_branch = self
1421
result.local_branch = None
1423
for hook in Branch.hooks['post_pull']:
1429
def _get_parent_location(self):
1430
_locs = ['parent', 'pull', 'x-pull']
1433
return self.control_files.get(l).read().strip('\n')
1439
def push(self, target, overwrite=False, stop_revision=None,
1440
_hook_master=None, _run_hooks=True):
1443
:param _hook_master: Private parameter - set the branch to
1444
be supplied as the master to push hooks.
1445
:param _run_hooks: Private parameter - allow disabling of
1446
hooks, used when pushing to a master branch.
1448
result = PushResult()
1449
result.source_branch = self
1450
result.target_branch = target
1453
result.old_revno, result.old_revid = target.last_revision_info()
1455
target.update_revisions(self, stop_revision)
1456
except DivergedBranches:
1460
target.set_revision_history(self.revision_history())
1461
result.tag_conflicts = self.tags.merge_to(target.tags)
1462
result.new_revno, result.new_revid = target.last_revision_info()
1464
result.master_branch = _hook_master
1465
result.local_branch = target
1467
result.master_branch = target
1468
result.local_branch = None
1470
for hook in Branch.hooks['post_push']:
1476
def get_parent(self):
1477
"""See Branch.get_parent."""
1479
assert self.base[-1] == '/'
1480
parent = self._get_parent_location()
1483
# This is an old-format absolute path to a local branch
1484
# turn it into a url
1485
if parent.startswith('/'):
1486
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1488
return urlutils.join(self.base[:-1], parent)
1489
except errors.InvalidURLJoin, e:
1490
raise errors.InaccessibleParent(parent, self.base)
1492
def get_push_location(self):
1493
"""See Branch.get_push_location."""
1494
push_loc = self.get_config().get_user_option('push_location')
1497
def set_push_location(self, location):
1498
"""See Branch.set_push_location."""
1499
self.get_config().set_user_option(
1500
'push_location', location,
1501
store=_mod_config.STORE_LOCATION_NORECURSE)
1504
def set_parent(self, url):
1505
"""See Branch.set_parent."""
1506
# TODO: Maybe delete old location files?
1507
# URLs should never be unicode, even on the local fs,
1508
# FIXUP this and get_parent in a future branch format bump:
1509
# read and rewrite the file, and have the new format code read
1510
# using .get not .get_utf8. RBC 20060125
1512
if isinstance(url, unicode):
1514
url = url.encode('ascii')
1515
except UnicodeEncodeError:
1516
raise bzrlib.errors.InvalidURL(url,
1517
"Urls must be 7-bit ascii, "
1518
"use bzrlib.urlutils.escape")
1519
url = urlutils.relative_url(self.base, url)
1520
self._set_parent_location(url)
1522
def _set_parent_location(self, url):
1524
self.control_files._transport.delete('parent')
1526
assert isinstance(url, str)
1527
self.control_files.put_bytes('parent', url + '\n')
1529
@deprecated_function(zero_nine)
1530
def tree_config(self):
1531
"""DEPRECATED; call get_config instead.
1532
TreeConfig has become part of BranchConfig."""
1533
return TreeConfig(self)
1536
class BzrBranch5(BzrBranch):
1537
"""A format 5 branch. This supports new features over plan branches.
1539
It has support for a master_branch which is the data for bound branches.
1547
super(BzrBranch5, self).__init__(_format=_format,
1548
_control_files=_control_files,
1550
_repository=_repository)
1553
def pull(self, source, overwrite=False, stop_revision=None,
1555
"""Extends branch.pull to be bound branch aware.
1557
:param _run_hooks: Private parameter used to force hook running
1558
off during bound branch double-pushing.
1560
bound_location = self.get_bound_location()
1561
master_branch = None
1562
if bound_location and source.base != bound_location:
1563
# not pulling from master, so we need to update master.
1564
master_branch = self.get_master_branch()
1565
master_branch.lock_write()
1568
# pull from source into master.
1569
master_branch.pull(source, overwrite, stop_revision,
1571
return super(BzrBranch5, self).pull(source, overwrite,
1572
stop_revision, _hook_master=master_branch,
1573
_run_hooks=_run_hooks)
1576
master_branch.unlock()
1579
def push(self, target, overwrite=False, stop_revision=None):
1580
"""Updates branch.push to be bound branch aware."""
1581
bound_location = target.get_bound_location()
1582
master_branch = None
1583
if bound_location and target.base != bound_location:
1584
# not pushing to master, so we need to update master.
1585
master_branch = target.get_master_branch()
1586
master_branch.lock_write()
1589
# push into the master from this branch.
1590
super(BzrBranch5, self).push(master_branch, overwrite,
1591
stop_revision, _run_hooks=False)
1592
# and push into the target branch from this. Note that we push from
1593
# this branch again, because its considered the highest bandwidth
1595
return super(BzrBranch5, self).push(target, overwrite,
1596
stop_revision, _hook_master=master_branch)
1599
master_branch.unlock()
1601
def get_bound_location(self):
1603
return self.control_files.get_utf8('bound').read()[:-1]
1604
except errors.NoSuchFile:
1608
def get_master_branch(self):
1609
"""Return the branch we are bound to.
1611
:return: Either a Branch, or None
1613
This could memoise the branch, but if thats done
1614
it must be revalidated on each new lock.
1615
So for now we just don't memoise it.
1616
# RBC 20060304 review this decision.
1618
bound_loc = self.get_bound_location()
1622
return Branch.open(bound_loc)
1623
except (errors.NotBranchError, errors.ConnectionError), e:
1624
raise errors.BoundBranchConnectionFailure(
1628
def set_bound_location(self, location):
1629
"""Set the target where this branch is bound to.
1631
:param location: URL to the target branch
1634
self.control_files.put_utf8('bound', location+'\n')
1637
self.control_files._transport.delete('bound')
1643
def bind(self, other):
1644
"""Bind this branch to the branch other.
1646
This does not push or pull data between the branches, though it does
1647
check for divergence to raise an error when the branches are not
1648
either the same, or one a prefix of the other. That behaviour may not
1649
be useful, so that check may be removed in future.
1651
:param other: The branch to bind to
1654
# TODO: jam 20051230 Consider checking if the target is bound
1655
# It is debatable whether you should be able to bind to
1656
# a branch which is itself bound.
1657
# Committing is obviously forbidden,
1658
# but binding itself may not be.
1659
# Since we *have* to check at commit time, we don't
1660
# *need* to check here
1662
# we want to raise diverged if:
1663
# last_rev is not in the other_last_rev history, AND
1664
# other_last_rev is not in our history, and do it without pulling
1666
last_rev = self.last_revision()
1667
if last_rev is not None:
1670
other_last_rev = other.last_revision()
1671
if other_last_rev is not None:
1672
# neither branch is new, we have to do some work to
1673
# ascertain diversion.
1674
remote_graph = other.repository.get_revision_graph(
1676
local_graph = self.repository.get_revision_graph(last_rev)
1677
if (last_rev not in remote_graph and
1678
other_last_rev not in local_graph):
1679
raise errors.DivergedBranches(self, other)
1682
self.set_bound_location(other.base)
1686
"""If bound, unbind"""
1687
return self.set_bound_location(None)
1691
"""Synchronise this branch with the master branch if any.
1693
:return: None or the last_revision that was pivoted out during the
1696
master = self.get_master_branch()
1697
if master is not None:
1698
old_tip = self.last_revision()
1699
self.pull(master, overwrite=True)
1700
if old_tip in self.repository.get_ancestry(self.last_revision()):
1706
class BzrBranchExperimental(BzrBranch5):
1707
"""Bzr experimental branch format
1710
- a revision-history file.
1712
- a lock dir guarding the branch itself
1713
- all of this stored in a branch/ subdirectory
1714
- works with shared repositories.
1715
- a tag dictionary in the branch
1717
This format is new in bzr 0.15, but shouldn't be used for real data,
1720
This class acts as it's own BranchFormat.
1723
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1726
def get_format_string(cls):
1727
"""See BranchFormat.get_format_string()."""
1728
return "Bazaar-NG branch format experimental\n"
1731
def get_format_description(cls):
1732
"""See BranchFormat.get_format_description()."""
1733
return "Experimental branch format"
1736
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1738
branch_transport = a_bzrdir.get_branch_transport(cls)
1739
control_files = lockable_files.LockableFiles(branch_transport,
1740
lock_filename, lock_class)
1741
control_files.create_lock()
1742
control_files.lock_write()
1744
for filename, content in utf8_files:
1745
control_files.put_utf8(filename, content)
1747
control_files.unlock()
1750
def initialize(cls, a_bzrdir):
1751
"""Create a branch of this format in a_bzrdir."""
1752
utf8_files = [('format', cls.get_format_string()),
1753
('revision-history', ''),
1754
('branch-name', ''),
1757
cls._initialize_control_files(a_bzrdir, utf8_files,
1758
'lock', lockdir.LockDir)
1759
return cls.open(a_bzrdir, _found=True)
1762
def open(cls, a_bzrdir, _found=False):
1763
"""Return the branch object for a_bzrdir
1765
_found is a private parameter, do not use it. It is used to indicate
1766
if format probing has already be done.
1769
format = BranchFormat.find_format(a_bzrdir)
1770
assert format.__class__ == cls
1771
transport = a_bzrdir.get_branch_transport(None)
1772
control_files = lockable_files.LockableFiles(transport, 'lock',
1774
return cls(_format=cls,
1775
_control_files=control_files,
1777
_repository=a_bzrdir.find_repository())
1780
def is_supported(cls):
1783
def _make_tags(self):
1784
return BasicTags(self)
1787
def supports_tags(cls):
1791
BranchFormat.register_format(BzrBranchExperimental)
1794
class BzrBranch6(BzrBranch5):
1797
def last_revision_info(self):
1798
revision_string = self.control_files.get('last-revision').read()
1799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1800
revision_id = cache_utf8.get_cached_utf8(revision_id)
1802
return revno, revision_id
1804
def last_revision(self):
1805
"""Return last revision id, or None"""
1806
revision_id = self.last_revision_info()[1]
1807
if revision_id == _mod_revision.NULL_REVISION:
1811
def _write_last_revision_info(self, revno, revision_id):
1812
"""Simply write out the revision id, with no checks.
1814
Use set_last_revision_info to perform this safely.
1816
Does not update the revision_history cache.
1817
Intended to be called by set_last_revision_info and
1818
_write_revision_history.
1820
if revision_id is None:
1821
revision_id = 'null:'
1822
out_string = '%d %s\n' % (revno, revision_id)
1823
self.control_files.put_bytes('last-revision', out_string)
1826
def set_last_revision_info(self, revno, revision_id):
1827
revision_id = osutils.safe_revision_id(revision_id)
1828
if self._get_append_revisions_only():
1829
self._check_history_violation(revision_id)
1830
self._write_last_revision_info(revno, revision_id)
1831
transaction = self.get_transaction()
1832
cached_history = transaction.map.find_revision_history()
1833
if cached_history is not None:
1834
transaction.map.remove_object(cached_history)
1836
def _check_history_violation(self, revision_id):
1837
last_revision = self.last_revision()
1838
if last_revision is None:
1840
if last_revision not in self._lefthand_history(revision_id):
1841
raise errors.AppendRevisionsOnlyViolation(self.base)
1843
def _gen_revision_history(self):
1844
"""Generate the revision history from last revision
1846
history = list(self.repository.iter_reverse_revision_history(
1847
self.last_revision()))
1851
def _write_revision_history(self, history):
1852
"""Factored out of set_revision_history.
1854
This performs the actual writing to disk, with format-specific checks.
1855
It is intended to be called by BzrBranch5.set_revision_history.
1857
if len(history) == 0:
1858
last_revision = 'null:'
1860
if history != self._lefthand_history(history[-1]):
1861
raise errors.NotLefthandHistory(history)
1862
last_revision = history[-1]
1863
if self._get_append_revisions_only():
1864
self._check_history_violation(last_revision)
1865
self._write_last_revision_info(len(history), last_revision)
1868
def append_revision(self, *revision_ids):
1869
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1870
if len(revision_ids) == 0:
1872
prev_revno, prev_revision = self.last_revision_info()
1873
for revision in self.repository.get_revisions(revision_ids):
1874
if prev_revision == _mod_revision.NULL_REVISION:
1875
if revision.parent_ids != []:
1876
raise errors.NotLeftParentDescendant(self, prev_revision,
1877
revision.revision_id)
1879
if revision.parent_ids[0] != prev_revision:
1880
raise errors.NotLeftParentDescendant(self, prev_revision,
1881
revision.revision_id)
1882
prev_revision = revision.revision_id
1883
self.set_last_revision_info(prev_revno + len(revision_ids),
1887
def _set_parent_location(self, url):
1888
"""Set the parent branch"""
1889
self._set_config_location('parent_location', url, make_relative=True)
1892
def _get_parent_location(self):
1893
"""Set the parent branch"""
1894
return self._get_config_location('parent_location')
1896
def set_push_location(self, location):
1897
"""See Branch.set_push_location."""
1898
self._set_config_location('push_location', location)
1900
def set_bound_location(self, location):
1901
"""See Branch.set_push_location."""
1903
config = self.get_config()
1904
if location is None:
1905
if config.get_user_option('bound') != 'True':
1908
config.set_user_option('bound', 'False')
1911
self._set_config_location('bound_location', location,
1913
config.set_user_option('bound', 'True')
1916
def _get_bound_location(self, bound):
1917
"""Return the bound location in the config file.
1919
Return None if the bound parameter does not match"""
1920
config = self.get_config()
1921
config_bound = (config.get_user_option('bound') == 'True')
1922
if config_bound != bound:
1924
return self._get_config_location('bound_location', config=config)
1926
def get_bound_location(self):
1927
"""See Branch.set_push_location."""
1928
return self._get_bound_location(True)
1930
def get_old_bound_location(self):
1931
"""See Branch.get_old_bound_location"""
1932
return self._get_bound_location(False)
1934
def set_append_revisions_only(self, enabled):
1939
self.get_config().set_user_option('append_revisions_only', value)
1941
def _get_append_revisions_only(self):
1942
value = self.get_config().get_user_option('append_revisions_only')
1943
return value == 'True'
1945
def _synchronize_history(self, destination, revision_id):
1946
"""Synchronize last revision and revision history between branches.
1948
This version is most efficient when the destination is also a
1949
BzrBranch6, but works for BzrBranch5, as long as the destination's
1950
repository contains all the lefthand ancestors of the intended
1951
last_revision. If not, set_last_revision_info will fail.
1953
:param destination: The branch to copy the history into
1954
:param revision_id: The revision-id to truncate history at. May
1955
be None to copy complete history.
1957
if revision_id is None:
1958
revno, revision_id = self.last_revision_info()
1960
revno = self.revision_id_to_revno(revision_id)
1961
destination.set_last_revision_info(revno, revision_id)
1963
def _make_tags(self):
1964
return BasicTags(self)
1967
class BranchTestProviderAdapter(object):
1968
"""A tool to generate a suite testing multiple branch formats at once.
1970
This is done by copying the test once for each transport and injecting
1971
the transport_server, transport_readonly_server, and branch_format
1972
classes into each copy. Each copy is also given a new id() to make it
1976
def __init__(self, transport_server, transport_readonly_server, formats):
1977
self._transport_server = transport_server
1978
self._transport_readonly_server = transport_readonly_server
1979
self._formats = formats
1981
def adapt(self, test):
1982
result = TestSuite()
1983
for branch_format, bzrdir_format in self._formats:
1984
new_test = deepcopy(test)
1985
new_test.transport_server = self._transport_server
1986
new_test.transport_readonly_server = self._transport_readonly_server
1987
new_test.bzrdir_format = bzrdir_format
1988
new_test.branch_format = branch_format
1989
def make_new_test_id():
1990
# the format can be either a class or an instance
1991
name = getattr(branch_format, '__name__',
1992
branch_format.__class__.__name__)
1993
new_id = "%s(%s)" % (new_test.id(), name)
1994
return lambda: new_id
1995
new_test.id = make_new_test_id()
1996
result.addTest(new_test)
2000
######################################################################
2001
# results of operations
2004
class _Result(object):
2006
def _show_tag_conficts(self, to_file):
2007
if not getattr(self, 'tag_conflicts', None):
2009
to_file.write('Conflicting tags:\n')
2010
for name, value1, value2 in self.tag_conflicts:
2011
to_file.write(' %s\n' % (name, ))
2014
class PullResult(_Result):
2015
"""Result of a Branch.pull operation.
2017
:ivar old_revno: Revision number before pull.
2018
:ivar new_revno: Revision number after pull.
2019
:ivar old_revid: Tip revision id before pull.
2020
:ivar new_revid: Tip revision id after pull.
2021
:ivar source_branch: Source (local) branch object.
2022
:ivar master_branch: Master branch of the target, or None.
2023
:ivar target_branch: Target/destination branch object.
2027
# DEPRECATED: pull used to return the change in revno
2028
return self.new_revno - self.old_revno
2030
def report(self, to_file):
2031
if self.old_revid == self.new_revid:
2032
to_file.write('No revisions to pull.\n')
2034
to_file.write('Now on revision %d.\n' % self.new_revno)
2035
self._show_tag_conficts(to_file)
2038
class PushResult(_Result):
2039
"""Result of a Branch.push operation.
2041
:ivar old_revno: Revision number before push.
2042
:ivar new_revno: Revision number after push.
2043
:ivar old_revid: Tip revision id before push.
2044
:ivar new_revid: Tip revision id after push.
2045
:ivar source_branch: Source branch object.
2046
:ivar master_branch: Master branch of the target, or None.
2047
:ivar target_branch: Target/destination branch object.
2051
# DEPRECATED: push used to return the change in revno
2052
return self.new_revno - self.old_revno
2054
def report(self, to_file):
2055
"""Write a human-readable description of the result."""
2056
if self.old_revid == self.new_revid:
2057
to_file.write('No new revisions to push.\n')
2059
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2060
self._show_tag_conficts(to_file)
2063
class BranchCheckResult(object):
2064
"""Results of checking branch consistency.
2069
def __init__(self, branch):
2070
self.branch = branch
2072
def report_results(self, verbose):
2073
"""Report the check results via trace.note.
2075
:param verbose: Requests more detailed display of what was checked,
2078
note('checked branch %s format %s',
2080
self.branch._format)
2083
class Converter5to6(object):
2084
"""Perform an in-place upgrade of format 5 to format 6"""
2086
def convert(self, branch):
2087
# Data for 5 and 6 can peacefully coexist.
2088
format = BzrBranchFormat6()
2089
new_branch = format.open(branch.bzrdir, _found=True)
2091
# Copy source data into target
2092
new_branch.set_last_revision_info(*branch.last_revision_info())
2093
new_branch.set_parent(branch.get_parent())
2094
new_branch.set_bound_location(branch.get_bound_location())
2095
new_branch.set_push_location(branch.get_push_location())
2097
# New branch has no tags by default
2098
new_branch.tags._set_tag_dict({})
2100
# Copying done; now update target format
2101
new_branch.control_files.put_utf8('format',
2102
format.get_format_string())
2104
# Clean up old files
2105
new_branch.control_files._transport.delete('revision-history')
2107
branch.set_parent(None)
2110
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
