1
# Copyright (C) 2005, 2006 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
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
80
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
raise NotImplementedError('The Branch class is abstract')
93
"""Break a lock if one is present from another instance.
95
Uses the ui factory to ask for confirmation if the lock may be from
98
This will probe the repository for its lock as well.
100
self.control_files.break_lock()
101
self.repository.break_lock()
102
master = self.get_master_branch()
103
if master is not None:
107
@deprecated_method(zero_eight)
108
def open_downlevel(base):
109
"""Open a branch which may be of an old format."""
110
return Branch.open(base, _unsupported=True)
113
def open(base, _unsupported=False):
114
"""Open the branch rooted at base.
116
For instance, if the branch is at URL/.bzr/branch,
117
Branch.open(URL) -> a Branch instance.
119
control = bzrdir.BzrDir.open(base, _unsupported)
120
return control.open_branch(_unsupported)
123
def open_containing(url):
124
"""Open an existing branch which contains url.
126
This probes for a branch at url, and searches upwards from there.
128
Basically we keep looking up until we find the control directory or
129
run into the root. If there isn't one, raises NotBranchError.
130
If there is one and it is either an unrecognised format or an unsupported
131
format, UnknownFormatError or UnsupportedFormatError are raised.
132
If there is one, it is returned, along with the unused portion of url.
134
control, relpath = bzrdir.BzrDir.open_containing(url)
135
return control.open_branch(), relpath
138
@deprecated_function(zero_eight)
139
def initialize(base):
140
"""Create a new working tree and branch, rooted at 'base' (url)
142
NOTE: This will soon be deprecated in favour of creation
145
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
147
@deprecated_function(zero_eight)
148
def setup_caching(self, cache_root):
149
"""Subclasses that care about caching should override this, and set
150
up cached stores located under cache_root.
152
NOTE: This is unused.
156
def get_config(self):
157
return BranchConfig(self)
160
return self.get_config().get_nickname()
162
def _set_nick(self, nick):
163
self.get_config().set_user_option('nickname', nick)
165
nick = property(_get_nick, _set_nick)
168
raise NotImplementedError(self.is_locked)
170
def lock_write(self):
171
raise NotImplementedError(self.lock_write)
174
raise NotImplementedError(self.lock_read)
177
raise NotImplementedError(self.unlock)
179
def peek_lock_mode(self):
180
"""Return lock mode for the Branch: 'r', 'w' or None"""
181
raise NotImplementedError(self.peek_lock_mode)
183
def get_physical_lock_status(self):
184
raise NotImplementedError(self.get_physical_lock_status)
186
def abspath(self, name):
187
"""Return absolute filename for something in the branch
189
XXX: Robert Collins 20051017 what is this used for? why is it a branch
190
method and not a tree method.
192
raise NotImplementedError(self.abspath)
194
def bind(self, other):
195
"""Bind the local branch the other branch.
197
:param other: The branch to bind to
200
raise errors.UpgradeRequired(self.base)
203
def fetch(self, from_branch, last_revision=None, pb=None):
204
"""Copy revisions from from_branch into this branch.
206
:param from_branch: Where to copy from.
207
:param last_revision: What revision to stop at (None for at the end
209
:param pb: An optional progress bar to use.
211
Returns the copied revision count and the failed revisions in a tuple:
214
if self.base == from_branch.base:
217
nested_pb = ui.ui_factory.nested_progress_bar()
222
from_branch.lock_read()
224
if last_revision is None:
225
pb.update('get source history')
226
from_history = from_branch.revision_history()
228
last_revision = from_history[-1]
230
# no history in the source branch
231
last_revision = _mod_revision.NULL_REVISION
232
return self.repository.fetch(from_branch.repository,
233
revision_id=last_revision,
236
if nested_pb is not None:
240
def get_bound_location(self):
241
"""Return the URL of the branch we are bound to.
243
Older format branches cannot bind, please be sure to use a metadir
248
def get_commit_builder(self, parents, config=None, timestamp=None,
249
timezone=None, committer=None, revprops=None,
251
"""Obtain a CommitBuilder for this branch.
253
:param parents: Revision ids of the parents of the new revision.
254
:param config: Optional configuration to use.
255
:param timestamp: Optional timestamp recorded for commit.
256
:param timezone: Optional timezone for timestamp.
257
:param committer: Optional committer to set for commit.
258
:param revprops: Optional dictionary of revision properties.
259
:param revision_id: Optional revision id.
263
config = self.get_config()
265
return self.repository.get_commit_builder(self, parents, config,
266
timestamp, timezone, committer, revprops, revision_id)
268
def get_master_branch(self):
269
"""Return the branch we are bound to.
271
:return: Either a Branch, or None
275
def get_revision_delta(self, revno):
276
"""Return the delta for one revision.
278
The delta is relative to its mainline predecessor, or the
279
empty tree for revision 1.
281
assert isinstance(revno, int)
282
rh = self.revision_history()
283
if not (1 <= revno <= len(rh)):
284
raise InvalidRevisionNumber(revno)
285
return self.repository.get_revision_delta(rh[revno-1])
287
def get_root_id(self):
288
"""Return the id of this branches root"""
289
raise NotImplementedError(self.get_root_id)
291
def print_file(self, file, revision_id):
292
"""Print `file` to stdout."""
293
raise NotImplementedError(self.print_file)
295
def append_revision(self, *revision_ids):
296
raise NotImplementedError(self.append_revision)
298
def set_revision_history(self, rev_history):
299
raise NotImplementedError(self.set_revision_history)
301
def revision_history(self):
302
"""Return sequence of revision hashes on to this branch."""
303
raise NotImplementedError(self.revision_history)
306
"""Return current revision number for this branch.
308
That is equivalent to the number of revisions committed to
311
return len(self.revision_history())
314
"""Older format branches cannot bind or unbind."""
315
raise errors.UpgradeRequired(self.base)
317
def last_revision(self):
318
"""Return last revision id, or None"""
319
ph = self.revision_history()
325
def missing_revisions(self, other, stop_revision=None):
326
"""Return a list of new revisions that would perfectly fit.
328
If self and other have not diverged, return a list of the revisions
329
present in other, but missing from self.
331
self_history = self.revision_history()
332
self_len = len(self_history)
333
other_history = other.revision_history()
334
other_len = len(other_history)
335
common_index = min(self_len, other_len) -1
336
if common_index >= 0 and \
337
self_history[common_index] != other_history[common_index]:
338
raise DivergedBranches(self, other)
340
if stop_revision is None:
341
stop_revision = other_len
343
assert isinstance(stop_revision, int)
344
if stop_revision > other_len:
345
raise errors.NoSuchRevision(self, stop_revision)
346
return other_history[self_len:stop_revision]
348
def update_revisions(self, other, stop_revision=None):
349
"""Pull in new perfect-fit revisions.
351
:param other: Another Branch to pull from
352
:param stop_revision: Updated until the given revision
355
raise NotImplementedError(self.update_revisions)
357
def revision_id_to_revno(self, revision_id):
358
"""Given a revision id, return its revno"""
359
if revision_id is None:
361
history = self.revision_history()
363
return history.index(revision_id) + 1
365
raise bzrlib.errors.NoSuchRevision(self, revision_id)
367
def get_rev_id(self, revno, history=None):
368
"""Find the revision id of the specified revno."""
372
history = self.revision_history()
373
if revno <= 0 or revno > len(history):
374
raise bzrlib.errors.NoSuchRevision(self, revno)
375
return history[revno - 1]
377
def pull(self, source, overwrite=False, stop_revision=None):
378
raise NotImplementedError(self.pull)
380
def basis_tree(self):
381
"""Return `Tree` object for last revision."""
382
return self.repository.revision_tree(self.last_revision())
384
def rename_one(self, from_rel, to_rel):
387
This can change the directory or the filename or both.
389
raise NotImplementedError(self.rename_one)
391
def move(self, from_paths, to_name):
394
to_name must exist as a versioned directory.
396
If to_name exists and is a directory, the files are moved into
397
it, keeping their old names. If it is a directory,
399
Note that to_name is only the last component of the new name;
400
this doesn't change the directory.
402
This returns a list of (from_path, to_path) pairs for each
405
raise NotImplementedError(self.move)
407
def get_parent(self):
408
"""Return the parent location of the branch.
410
This is the default location for push/pull/missing. The usual
411
pattern is that the user can override it by specifying a
414
raise NotImplementedError(self.get_parent)
416
def get_submit_branch(self):
417
"""Return the submit location of the branch.
419
This is the default location for bundle. The usual
420
pattern is that the user can override it by specifying a
423
return self.get_config().get_user_option('submit_branch')
425
def set_submit_branch(self, location):
426
"""Return the submit location of the branch.
428
This is the default location for bundle. The usual
429
pattern is that the user can override it by specifying a
432
self.get_config().set_user_option('submit_branch', location)
434
def get_push_location(self):
435
"""Return the None or the location to push this branch to."""
436
raise NotImplementedError(self.get_push_location)
438
def set_push_location(self, location):
439
"""Set a new push location for this branch."""
440
raise NotImplementedError(self.set_push_location)
442
def set_parent(self, url):
443
raise NotImplementedError(self.set_parent)
447
"""Synchronise this branch with the master branch if any.
449
:return: None or the last_revision pivoted out during the update.
453
def check_revno(self, revno):
455
Check whether a revno corresponds to any revision.
456
Zero (the NULL revision) is considered valid.
459
self.check_real_revno(revno)
461
def check_real_revno(self, revno):
463
Check whether a revno corresponds to a real revision.
464
Zero (the NULL revision) is considered invalid
466
if revno < 1 or revno > self.revno():
467
raise InvalidRevisionNumber(revno)
470
def clone(self, *args, **kwargs):
471
"""Clone this branch into to_bzrdir preserving all semantic values.
473
revision_id: if not None, the revision history in the new branch will
474
be truncated to end with revision_id.
476
# for API compatibility, until 0.8 releases we provide the old api:
477
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
478
# after 0.8 releases, the *args and **kwargs should be changed:
479
# def clone(self, to_bzrdir, revision_id=None):
480
if (kwargs.get('to_location', None) or
481
kwargs.get('revision', None) or
482
kwargs.get('basis_branch', None) or
483
(len(args) and isinstance(args[0], basestring))):
484
# backwards compatibility api:
485
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
486
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
489
basis_branch = args[2]
491
basis_branch = kwargs.get('basis_branch', None)
493
basis = basis_branch.bzrdir
498
revision_id = args[1]
500
revision_id = kwargs.get('revision', None)
505
# no default to raise if not provided.
506
url = kwargs.get('to_location')
507
return self.bzrdir.clone(url,
508
revision_id=revision_id,
509
basis=basis).open_branch()
511
# generate args by hand
513
revision_id = args[1]
515
revision_id = kwargs.get('revision_id', None)
519
# no default to raise if not provided.
520
to_bzrdir = kwargs.get('to_bzrdir')
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id=revision_id)
526
def sprout(self, to_bzrdir, revision_id=None):
527
"""Create a new line of development from the branch, into to_bzrdir.
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
532
result = self._format.initialize(to_bzrdir)
533
self.copy_content_into(result, revision_id=revision_id)
534
result.set_parent(self.bzrdir.root_transport.base)
538
def copy_content_into(self, destination, revision_id=None):
539
"""Copy the content of self into destination.
541
revision_id: if not None, the revision history in the new branch will
542
be truncated to end with revision_id.
544
if revision_id is None:
545
revision_id = self.last_revision()
546
destination.set_last_revision(revision_id)
548
parent = self.get_parent()
549
except errors.InaccessibleParent, e:
550
mutter('parent was not accessible to copy: %s', e)
553
destination.set_parent(parent)
557
"""Check consistency of the branch.
559
In particular this checks that revisions given in the revision-history
560
do actually match up in the revision graph, and that they're all
561
present in the repository.
563
Callers will typically also want to check the repository.
565
:return: A BranchCheckResult.
567
mainline_parent_id = None
568
for revision_id in self.revision_history():
570
revision = self.repository.get_revision(revision_id)
571
except errors.NoSuchRevision, e:
572
raise errors.BzrCheckError("mainline revision {%s} not in repository"
574
# In general the first entry on the revision history has no parents.
575
# But it's not illegal for it to have parents listed; this can happen
576
# in imports from Arch when the parents weren't reachable.
577
if mainline_parent_id is not None:
578
if mainline_parent_id not in revision.parent_ids:
579
raise errors.BzrCheckError("previous revision {%s} not listed among "
581
% (mainline_parent_id, revision_id))
582
mainline_parent_id = revision_id
583
return BranchCheckResult(self)
585
def _get_checkout_format(self):
586
"""Return the most suitable metadir for a checkout of this branch.
587
Weaves are used if this branch's repostory uses weaves.
589
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
590
from bzrlib import repository
591
format = bzrdir.BzrDirMetaFormat1()
592
format.repository_format = repository.RepositoryFormat7()
594
format = self.repository.bzrdir.cloning_metadir()
597
def create_checkout(self, to_location, revision_id=None,
599
"""Create a checkout of a branch.
601
:param to_location: The url to produce the checkout at
602
:param revision_id: The revision to check out
603
:param lightweight: If True, produce a lightweight checkout, otherwise,
604
produce a bound branch (heavyweight checkout)
605
:return: The tree of the created checkout
607
t = transport.get_transport(to_location)
610
except errors.FileExists:
613
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
614
BranchReferenceFormat().initialize(checkout, self)
616
format = self._get_checkout_format()
617
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
618
to_location, force_new_tree=False, format=format)
619
checkout = checkout_branch.bzrdir
620
checkout_branch.bind(self)
621
# pull up to the specified revision_id to set the initial
622
# branch tip correctly, and seed it with history.
623
checkout_branch.pull(self, stop_revision=revision_id)
624
return checkout.create_workingtree(revision_id)
627
class BranchFormat(object):
628
"""An encapsulation of the initialization and open routines for a format.
630
Formats provide three things:
631
* An initialization routine,
635
Formats are placed in an dict by their format string for reference
636
during branch opening. Its not required that these be instances, they
637
can be classes themselves with class methods - it simply depends on
638
whether state is needed for a given format or not.
640
Once a format is deprecated, just deprecate the initialize and open
641
methods on the format class. Do not deprecate the object, as the
642
object will be created every time regardless.
645
_default_format = None
646
"""The default format used for new branches."""
649
"""The known formats."""
652
def find_format(klass, a_bzrdir):
653
"""Return the format for the branch object in a_bzrdir."""
655
transport = a_bzrdir.get_branch_transport(None)
656
format_string = transport.get("format").read()
657
return klass._formats[format_string]
659
raise NotBranchError(path=transport.base)
661
raise errors.UnknownFormatError(format=format_string)
664
def get_default_format(klass):
665
"""Return the current default format."""
666
return klass._default_format
668
def get_format_string(self):
669
"""Return the ASCII format string that identifies this format."""
670
raise NotImplementedError(self.get_format_string)
672
def get_format_description(self):
673
"""Return the short format description for this format."""
674
raise NotImplementedError(self.get_format_string)
676
def initialize(self, a_bzrdir):
677
"""Create a branch of this format in a_bzrdir."""
678
raise NotImplementedError(self.initialize)
680
def is_supported(self):
681
"""Is this format supported?
683
Supported formats can be initialized and opened.
684
Unsupported formats may not support initialization or committing or
685
some other features depending on the reason for not being supported.
689
def open(self, a_bzrdir, _found=False):
690
"""Return the branch object for a_bzrdir
692
_found is a private parameter, do not use it. It is used to indicate
693
if format probing has already be done.
695
raise NotImplementedError(self.open)
698
def register_format(klass, format):
699
klass._formats[format.get_format_string()] = format
702
def set_default_format(klass, format):
703
klass._default_format = format
706
def unregister_format(klass, format):
707
assert klass._formats[format.get_format_string()] is format
708
del klass._formats[format.get_format_string()]
711
return self.get_format_string().rstrip()
714
class BzrBranchFormat4(BranchFormat):
715
"""Bzr branch format 4.
718
- a revision-history file.
719
- a branch-lock lock file [ to be shared with the bzrdir ]
722
def get_format_description(self):
723
"""See BranchFormat.get_format_description()."""
724
return "Branch format 4"
726
def initialize(self, a_bzrdir):
727
"""Create a branch of this format in a_bzrdir."""
728
mutter('creating branch in %s', a_bzrdir.transport.base)
729
branch_transport = a_bzrdir.get_branch_transport(self)
730
utf8_files = [('revision-history', ''),
733
control_files = lockable_files.LockableFiles(branch_transport,
734
'branch-lock', lockable_files.TransportLock)
735
control_files.create_lock()
736
control_files.lock_write()
738
for file, content in utf8_files:
739
control_files.put_utf8(file, content)
741
control_files.unlock()
742
return self.open(a_bzrdir, _found=True)
745
super(BzrBranchFormat4, self).__init__()
746
self._matchingbzrdir = bzrdir.BzrDirFormat6()
748
def open(self, a_bzrdir, _found=False):
749
"""Return the branch object for a_bzrdir
751
_found is a private parameter, do not use it. It is used to indicate
752
if format probing has already be done.
755
# we are being called directly and must probe.
756
raise NotImplementedError
757
return BzrBranch(_format=self,
758
_control_files=a_bzrdir._control_files,
760
_repository=a_bzrdir.open_repository())
763
return "Bazaar-NG branch format 4"
766
class BzrBranchFormat5(BranchFormat):
767
"""Bzr branch format 5.
770
- a revision-history file.
772
- a lock dir guarding the branch itself
773
- all of this stored in a branch/ subdirectory
774
- works with shared repositories.
776
This format is new in bzr 0.8.
779
def get_format_string(self):
780
"""See BranchFormat.get_format_string()."""
781
return "Bazaar-NG branch format 5\n"
783
def get_format_description(self):
784
"""See BranchFormat.get_format_description()."""
785
return "Branch format 5"
787
def initialize(self, a_bzrdir):
788
"""Create a branch of this format in a_bzrdir."""
789
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
790
branch_transport = a_bzrdir.get_branch_transport(self)
791
utf8_files = [('revision-history', ''),
794
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
796
control_files.create_lock()
797
control_files.lock_write()
798
control_files.put_utf8('format', self.get_format_string())
800
for file, content in utf8_files:
801
control_files.put_utf8(file, content)
803
control_files.unlock()
804
return self.open(a_bzrdir, _found=True, )
807
super(BzrBranchFormat5, self).__init__()
808
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
810
def open(self, a_bzrdir, _found=False):
811
"""Return the branch object for a_bzrdir
813
_found is a private parameter, do not use it. It is used to indicate
814
if format probing has already be done.
817
format = BranchFormat.find_format(a_bzrdir)
818
assert format.__class__ == self.__class__
819
transport = a_bzrdir.get_branch_transport(None)
820
control_files = lockable_files.LockableFiles(transport, 'lock',
822
return BzrBranch5(_format=self,
823
_control_files=control_files,
825
_repository=a_bzrdir.find_repository())
828
return "Bazaar-NG Metadir branch format 5"
831
class BzrBranchFormat6(BzrBranchFormat5):
832
"""Branch format with last-revision
834
Unlike previous formats, this has no explicit revision history, instead
835
the left-parent revision history is used.
838
def get_format_string(self):
839
"""See BranchFormat.get_format_string()."""
840
return "Bazaar-NG branch format 6\n"
842
def get_format_description(self):
843
"""See BranchFormat.get_format_description()."""
844
return "Branch format 6"
846
def initialize(self, a_bzrdir):
847
"""Create a branch of this format in a_bzrdir."""
848
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
849
branch_transport = a_bzrdir.get_branch_transport(self)
850
utf8_files = [('last-revision', 'null:\n'),
854
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
856
control_files.create_lock()
857
control_files.lock_write()
858
control_files.put_utf8('format', self.get_format_string())
860
for file, content in utf8_files:
861
control_files.put_utf8(file, content)
863
control_files.unlock()
864
return self.open(a_bzrdir, _found=True, )
866
def open(self, a_bzrdir, _found=False):
867
"""Return the branch object for a_bzrdir
869
_found is a private parameter, do not use it. It is used to indicate
870
if format probing has already be done.
873
format = BranchFormat.find_format(a_bzrdir)
874
assert format.__class__ == self.__class__
875
transport = a_bzrdir.get_branch_transport(None)
876
control_files = lockable_files.LockableFiles(transport, 'lock',
878
return BzrBranch6(_format=self,
879
_control_files=control_files,
881
_repository=a_bzrdir.find_repository())
884
class BranchReferenceFormat(BranchFormat):
885
"""Bzr branch reference format.
887
Branch references are used in implementing checkouts, they
888
act as an alias to the real branch which is at some other url.
895
def get_format_string(self):
896
"""See BranchFormat.get_format_string()."""
897
return "Bazaar-NG Branch Reference Format 1\n"
899
def get_format_description(self):
900
"""See BranchFormat.get_format_description()."""
901
return "Checkout reference format 1"
903
def initialize(self, a_bzrdir, target_branch=None):
904
"""Create a branch of this format in a_bzrdir."""
905
if target_branch is None:
906
# this format does not implement branch itself, thus the implicit
907
# creation contract must see it as uninitializable
908
raise errors.UninitializableFormat(self)
909
mutter('creating branch reference in %s', a_bzrdir.transport.base)
910
branch_transport = a_bzrdir.get_branch_transport(self)
911
branch_transport.put_bytes('location',
912
target_branch.bzrdir.root_transport.base)
913
branch_transport.put_bytes('format', self.get_format_string())
914
return self.open(a_bzrdir, _found=True)
917
super(BranchReferenceFormat, self).__init__()
918
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
920
def _make_reference_clone_function(format, a_branch):
921
"""Create a clone() routine for a branch dynamically."""
922
def clone(to_bzrdir, revision_id=None):
923
"""See Branch.clone()."""
924
return format.initialize(to_bzrdir, a_branch)
925
# cannot obey revision_id limits when cloning a reference ...
926
# FIXME RBC 20060210 either nuke revision_id for clone, or
927
# emit some sort of warning/error to the caller ?!
930
def open(self, a_bzrdir, _found=False):
931
"""Return the branch that the branch reference in a_bzrdir points at.
933
_found is a private parameter, do not use it. It is used to indicate
934
if format probing has already be done.
937
format = BranchFormat.find_format(a_bzrdir)
938
assert format.__class__ == self.__class__
939
transport = a_bzrdir.get_branch_transport(None)
940
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
941
result = real_bzrdir.open_branch()
942
# this changes the behaviour of result.clone to create a new reference
943
# rather than a copy of the content of the branch.
944
# I did not use a proxy object because that needs much more extensive
945
# testing, and we are only changing one behaviour at the moment.
946
# If we decide to alter more behaviours - i.e. the implicit nickname
947
# then this should be refactored to introduce a tested proxy branch
948
# and a subclass of that for use in overriding clone() and ....
950
result.clone = self._make_reference_clone_function(result)
954
# formats which have no format string are not discoverable
955
# and not independently creatable, so are not registered.
956
__default_format = BzrBranchFormat5()
957
BranchFormat.register_format(__default_format)
958
BranchFormat.register_format(BranchReferenceFormat())
959
BranchFormat.register_format(BzrBranchFormat6())
960
BranchFormat.set_default_format(BzrBranchFormat6())
961
_legacy_formats = [BzrBranchFormat4(),
964
class BzrBranch(Branch):
965
"""A branch stored in the actual filesystem.
967
Note that it's "local" in the context of the filesystem; it doesn't
968
really matter if it's on an nfs/smb/afs/coda/... share, as long as
969
it's writable, and can be accessed via the normal filesystem API.
972
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
973
relax_version_check=DEPRECATED_PARAMETER, _format=None,
974
_control_files=None, a_bzrdir=None, _repository=None):
975
"""Create new branch object at a particular location.
977
transport -- A Transport object, defining how to access files.
979
init -- If True, create new control files in a previously
980
unversioned directory. If False, the branch must already
983
relax_version_check -- If true, the usual check for the branch
984
version is not applied. This is intended only for
985
upgrade/recovery type use; it's not guaranteed that
986
all operations will work on old format branches.
989
self.bzrdir = bzrdir.BzrDir.open(transport.base)
991
self.bzrdir = a_bzrdir
992
self._transport = self.bzrdir.transport.clone('..')
993
self._base = self._transport.base
994
self._format = _format
995
if _control_files is None:
996
raise ValueError('BzrBranch _control_files is None')
997
self.control_files = _control_files
998
if deprecated_passed(init):
999
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1000
"deprecated as of bzr 0.8. Please use Branch.create().",
1004
# this is slower than before deprecation, oh well never mind.
1005
# -> its deprecated.
1006
self._initialize(transport.base)
1007
self._check_format(_format)
1008
if deprecated_passed(relax_version_check):
1009
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1010
"relax_version_check parameter is deprecated as of bzr 0.8. "
1011
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1015
if (not relax_version_check
1016
and not self._format.is_supported()):
1017
raise errors.UnsupportedFormatError(format=fmt)
1018
if deprecated_passed(transport):
1019
warn("BzrBranch.__init__(transport=XXX...): The transport "
1020
"parameter is deprecated as of bzr 0.8. "
1021
"Please use Branch.open, or bzrdir.open_branch().",
1024
self.repository = _repository
1027
return '%s(%r)' % (self.__class__.__name__, self.base)
1031
def _get_base(self):
1034
base = property(_get_base, doc="The URL for the root of this branch.")
1036
def _finish_transaction(self):
1037
"""Exit the current transaction."""
1038
return self.control_files._finish_transaction()
1040
def get_transaction(self):
1041
"""Return the current active transaction.
1043
If no transaction is active, this returns a passthrough object
1044
for which all data is immediately flushed and no caching happens.
1046
# this is an explicit function so that we can do tricky stuff
1047
# when the storage in rev_storage is elsewhere.
1048
# we probably need to hook the two 'lock a location' and
1049
# 'have a transaction' together more delicately, so that
1050
# we can have two locks (branch and storage) and one transaction
1051
# ... and finishing the transaction unlocks both, but unlocking
1052
# does not. - RBC 20051121
1053
return self.control_files.get_transaction()
1055
def _set_transaction(self, transaction):
1056
"""Set a new active transaction."""
1057
return self.control_files._set_transaction(transaction)
1059
def abspath(self, name):
1060
"""See Branch.abspath."""
1061
return self.control_files._transport.abspath(name)
1063
def _check_format(self, format):
1064
"""Identify the branch format if needed.
1066
The format is stored as a reference to the format object in
1067
self._format for code that needs to check it later.
1069
The format parameter is either None or the branch format class
1070
used to open this branch.
1072
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1075
format = BranchFormat.find_format(self.bzrdir)
1076
self._format = format
1077
mutter("got branch format %s", self._format)
1080
def get_root_id(self):
1081
"""See Branch.get_root_id."""
1082
tree = self.repository.revision_tree(self.last_revision())
1083
return tree.inventory.root.file_id
1085
def is_locked(self):
1086
return self.control_files.is_locked()
1088
def lock_write(self):
1089
self.repository.lock_write()
1091
self.control_files.lock_write()
1093
self.repository.unlock()
1096
def lock_read(self):
1097
self.repository.lock_read()
1099
self.control_files.lock_read()
1101
self.repository.unlock()
1105
# TODO: test for failed two phase locks. This is known broken.
1107
self.control_files.unlock()
1109
self.repository.unlock()
1111
def peek_lock_mode(self):
1112
if self.control_files._lock_count == 0:
1115
return self.control_files._lock_mode
1117
def get_physical_lock_status(self):
1118
return self.control_files.get_physical_lock_status()
1121
def print_file(self, file, revision_id):
1122
"""See Branch.print_file."""
1123
return self.repository.print_file(file, revision_id)
1126
def append_revision(self, *revision_ids):
1127
"""See Branch.append_revision."""
1128
for revision_id in revision_ids:
1129
mutter("add {%s} to revision-history" % revision_id)
1130
rev_history = self.revision_history()
1131
rev_history.extend(revision_ids)
1132
self.set_revision_history(rev_history)
1135
def set_revision_history(self, rev_history):
1136
"""See Branch.set_revision_history."""
1137
self.control_files.put_utf8(
1138
'revision-history', '\n'.join(rev_history))
1139
transaction = self.get_transaction()
1140
history = transaction.map.find_revision_history()
1141
if history is not None:
1142
# update the revision history in the identity map.
1143
history[:] = list(rev_history)
1144
# this call is disabled because revision_history is
1145
# not really an object yet, and the transaction is for objects.
1146
# transaction.register_dirty(history)
1148
transaction.map.add_revision_history(rev_history)
1149
# this call is disabled because revision_history is
1150
# not really an object yet, and the transaction is for objects.
1151
# transaction.register_clean(history)
1154
def set_last_revision(self, revision_id):
1155
self.set_revision_history(self._lefthand_history(revision_id))
1158
def revision_history(self):
1159
"""See Branch.revision_history."""
1160
transaction = self.get_transaction()
1161
history = transaction.map.find_revision_history()
1162
if history is not None:
1163
# mutter("cache hit for revision-history in %s", self)
1164
return list(history)
1165
decode_utf8 = cache_utf8.decode
1166
history = [decode_utf8(l.rstrip('\r\n')) for l in
1167
self.control_files.get('revision-history').readlines()]
1168
transaction.map.add_revision_history(history)
1169
# this call is disabled because revision_history is
1170
# not really an object yet, and the transaction is for objects.
1171
# transaction.register_clean(history, precious=True)
1172
return list(history)
1174
def _lefthand_history(self, revision_id, last_rev=None,
1176
# stop_revision must be a descendant of last_revision
1177
stop_graph = self.repository.get_revision_graph(revision_id)
1178
if last_rev is not None and last_rev not in stop_graph:
1179
# our previous tip is not merged into stop_revision
1180
raise errors.DivergedBranches(self, other_branch)
1181
# make a new revision history from the graph
1182
current_rev_id = revision_id
1184
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1185
new_history.append(current_rev_id)
1186
current_rev_id_parents = stop_graph[current_rev_id]
1188
current_rev_id = current_rev_id_parents[0]
1190
current_rev_id = None
1191
new_history.reverse()
1195
def generate_revision_history(self, revision_id, last_rev=None,
1197
"""Create a new revision history that will finish with revision_id.
1199
:param revision_id: the new tip to use.
1200
:param last_rev: The previous last_revision. If not None, then this
1201
must be a ancestory of revision_id, or DivergedBranches is raised.
1202
:param other_branch: The other branch that DivergedBranches should
1203
raise with respect to.
1205
self.set_revision_history(self._lefthand_history(revision_id,
1206
last_rev, other_branch))
1209
def update_revisions(self, other, stop_revision=None):
1210
"""See Branch.update_revisions."""
1213
if stop_revision is None:
1214
stop_revision = other.last_revision()
1215
if stop_revision is None:
1216
# if there are no commits, we're done.
1218
# whats the current last revision, before we fetch [and change it
1220
last_rev = self.last_revision()
1221
# we fetch here regardless of whether we need to so that we pickup
1223
self.fetch(other, stop_revision)
1224
my_ancestry = self.repository.get_ancestry(last_rev)
1225
if stop_revision in my_ancestry:
1226
# last_revision is a descendant of stop_revision
1228
self.generate_revision_history(stop_revision, last_rev=last_rev,
1233
def basis_tree(self):
1234
"""See Branch.basis_tree."""
1235
return self.repository.revision_tree(self.last_revision())
1237
@deprecated_method(zero_eight)
1238
def working_tree(self):
1239
"""Create a Working tree object for this branch."""
1241
from bzrlib.transport.local import LocalTransport
1242
if (self.base.find('://') != -1 or
1243
not isinstance(self._transport, LocalTransport)):
1244
raise NoWorkingTree(self.base)
1245
return self.bzrdir.open_workingtree()
1248
def pull(self, source, overwrite=False, stop_revision=None):
1249
"""See Branch.pull."""
1252
old_count = len(self.revision_history())
1254
self.update_revisions(source, stop_revision)
1255
except DivergedBranches:
1259
self.set_revision_history(source.revision_history())
1260
new_count = len(self.revision_history())
1261
return new_count - old_count
1265
def get_parent(self):
1266
"""See Branch.get_parent."""
1268
_locs = ['parent', 'pull', 'x-pull']
1269
assert self.base[-1] == '/'
1272
parent = self.control_files.get(l).read().strip('\n')
1275
# This is an old-format absolute path to a local branch
1276
# turn it into a url
1277
if parent.startswith('/'):
1278
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1280
return urlutils.join(self.base[:-1], parent)
1281
except errors.InvalidURLJoin, e:
1282
raise errors.InaccessibleParent(parent, self.base)
1285
def get_push_location(self):
1286
"""See Branch.get_push_location."""
1287
push_loc = self.get_config().get_user_option('push_location')
1290
def set_push_location(self, location):
1291
"""See Branch.set_push_location."""
1292
self.get_config().set_user_option(
1293
'push_location', location,
1294
store=_mod_config.STORE_LOCATION_NORECURSE)
1297
def set_parent(self, url):
1298
"""See Branch.set_parent."""
1299
# TODO: Maybe delete old location files?
1300
# URLs should never be unicode, even on the local fs,
1301
# FIXUP this and get_parent in a future branch format bump:
1302
# read and rewrite the file, and have the new format code read
1303
# using .get not .get_utf8. RBC 20060125
1305
self.control_files._transport.delete('parent')
1307
if isinstance(url, unicode):
1309
url = url.encode('ascii')
1310
except UnicodeEncodeError:
1311
raise bzrlib.errors.InvalidURL(url,
1312
"Urls must be 7-bit ascii, "
1313
"use bzrlib.urlutils.escape")
1315
url = urlutils.relative_url(self.base, url)
1316
self.control_files.put('parent', StringIO(url + '\n'))
1318
@deprecated_function(zero_nine)
1319
def tree_config(self):
1320
"""DEPRECATED; call get_config instead.
1321
TreeConfig has become part of BranchConfig."""
1322
return TreeConfig(self)
1325
class BzrBranch5(BzrBranch):
1326
"""A format 5 branch. This supports new features over plan branches.
1328
It has support for a master_branch which is the data for bound branches.
1336
super(BzrBranch5, self).__init__(_format=_format,
1337
_control_files=_control_files,
1339
_repository=_repository)
1342
def pull(self, source, overwrite=False, stop_revision=None):
1343
"""Updates branch.pull to be bound branch aware."""
1344
bound_location = self.get_bound_location()
1345
if source.base != bound_location:
1346
# not pulling from master, so we need to update master.
1347
master_branch = self.get_master_branch()
1349
master_branch.pull(source)
1350
source = master_branch
1351
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1353
def get_bound_location(self):
1355
return self.control_files.get_utf8('bound').read()[:-1]
1356
except errors.NoSuchFile:
1360
def get_master_branch(self):
1361
"""Return the branch we are bound to.
1363
:return: Either a Branch, or None
1365
This could memoise the branch, but if thats done
1366
it must be revalidated on each new lock.
1367
So for now we just don't memoise it.
1368
# RBC 20060304 review this decision.
1370
bound_loc = self.get_bound_location()
1374
return Branch.open(bound_loc)
1375
except (errors.NotBranchError, errors.ConnectionError), e:
1376
raise errors.BoundBranchConnectionFailure(
1380
def set_bound_location(self, location):
1381
"""Set the target where this branch is bound to.
1383
:param location: URL to the target branch
1386
self.control_files.put_utf8('bound', location+'\n')
1389
self.control_files._transport.delete('bound')
1395
def bind(self, other):
1396
"""Bind this branch to the branch other.
1398
This does not push or pull data between the branches, though it does
1399
check for divergence to raise an error when the branches are not
1400
either the same, or one a prefix of the other. That behaviour may not
1401
be useful, so that check may be removed in future.
1403
:param other: The branch to bind to
1406
# TODO: jam 20051230 Consider checking if the target is bound
1407
# It is debatable whether you should be able to bind to
1408
# a branch which is itself bound.
1409
# Committing is obviously forbidden,
1410
# but binding itself may not be.
1411
# Since we *have* to check at commit time, we don't
1412
# *need* to check here
1414
# we want to raise diverged if:
1415
# last_rev is not in the other_last_rev history, AND
1416
# other_last_rev is not in our history, and do it without pulling
1418
last_rev = self.last_revision()
1419
if last_rev is not None:
1422
other_last_rev = other.last_revision()
1423
if other_last_rev is not None:
1424
# neither branch is new, we have to do some work to
1425
# ascertain diversion.
1426
remote_graph = other.repository.get_revision_graph(
1428
local_graph = self.repository.get_revision_graph(last_rev)
1429
if (last_rev not in remote_graph and
1430
other_last_rev not in local_graph):
1431
raise errors.DivergedBranches(self, other)
1434
self.set_bound_location(other.base)
1438
"""If bound, unbind"""
1439
return self.set_bound_location(None)
1443
"""Synchronise this branch with the master branch if any.
1445
:return: None or the last_revision that was pivoted out during the
1448
master = self.get_master_branch()
1449
if master is not None:
1450
old_tip = self.last_revision()
1451
self.pull(master, overwrite=True)
1452
if old_tip in self.repository.get_ancestry(self.last_revision()):
1458
class BzrBranch6(BzrBranch5):
1461
def last_revision(self):
1462
"""Return last revision id, or None"""
1463
revision_id = self.control_files.get_utf8('last-revision').read()
1464
revision_id = revision_id.rstrip('\n')
1465
if revision_id == _mod_revision.NULL_REVISION:
1470
def set_last_revision(self, revision_id):
1471
if revision_id is None:
1472
revision_id = 'null:'
1473
self.control_files.put_utf8('last-revision', revision_id + '\n')
1476
def revision_history(self):
1477
"""Generate the revision history from last revision
1479
return self._lefthand_history(self.last_revision())
1482
def set_revision_history(self, history):
1483
"""Set the last_revision, not revision history"""
1484
if len(history) == 0:
1485
self.set_last_revision('null:')
1487
assert history == self._lefthand_history(history[-1])
1488
self.set_last_revision(history[-1])
1491
def set_parent(self, url):
1492
"""Set the parent branch"""
1493
if isinstance(url, unicode):
1495
url = url.encode('ascii')
1496
except UnicodeEncodeError:
1497
raise bzrlib.errors.InvalidURL(url,
1498
"Urls must be 7-bit ascii, "
1499
"use bzrlib.urlutils.escape")
1501
url = urlutils.relative_url(self.base, url)
1502
self.get_config().set_user_option('parent_location', url)
1505
def get_parent(self):
1506
"""Set the parent branch"""
1507
parent = self.get_config().get_user_option('parent_location')
1511
return urlutils.join(self.base[:-1], parent)
1512
except errors.InvalidURLJoin, e:
1513
raise errors.InaccessibleParent(parent, self.base)
1515
def set_push_location(self, location):
1516
"""See Branch.set_push_location."""
1517
self.get_config().set_user_option('push_location', location)
1519
def set_bound_location(self, location):
1520
"""See Branch.set_push_location."""
1521
if location is None:
1523
self.get_config().set_user_option('bound_location', location)
1525
def get_bound_location(self):
1526
"""See Branch.set_push_location."""
1527
location = self.get_config().get_user_option('bound_location')
1533
class BranchTestProviderAdapter(object):
1534
"""A tool to generate a suite testing multiple branch formats at once.
1536
This is done by copying the test once for each transport and injecting
1537
the transport_server, transport_readonly_server, and branch_format
1538
classes into each copy. Each copy is also given a new id() to make it
1542
def __init__(self, transport_server, transport_readonly_server, formats):
1543
self._transport_server = transport_server
1544
self._transport_readonly_server = transport_readonly_server
1545
self._formats = formats
1547
def adapt(self, test):
1548
result = TestSuite()
1549
for branch_format, bzrdir_format in self._formats:
1550
new_test = deepcopy(test)
1551
new_test.transport_server = self._transport_server
1552
new_test.transport_readonly_server = self._transport_readonly_server
1553
new_test.bzrdir_format = bzrdir_format
1554
new_test.branch_format = branch_format
1555
def make_new_test_id():
1556
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1557
return lambda: new_id
1558
new_test.id = make_new_test_id()
1559
result.addTest(new_test)
1563
class BranchCheckResult(object):
1564
"""Results of checking branch consistency.
1569
def __init__(self, branch):
1570
self.branch = branch
1572
def report_results(self, verbose):
1573
"""Report the check results via trace.note.
1575
:param verbose: Requests more detailed display of what was checked,
1578
note('checked branch %s format %s',
1580
self.branch._format)
1583
######################################################################
1587
@deprecated_function(zero_eight)
1588
def is_control_file(*args, **kwargs):
1589
"""See bzrlib.workingtree.is_control_file."""
1590
from bzrlib import workingtree
1591
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
