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
new_history = self.revision_history()
545
if revision_id is not None:
547
new_history = new_history[:new_history.index(revision_id) + 1]
549
rev = self.repository.get_revision(revision_id)
550
new_history = rev.get_history(self.repository)[1:]
551
destination.set_revision_history(new_history)
553
parent = self.get_parent()
554
except errors.InaccessibleParent, e:
555
mutter('parent was not accessible to copy: %s', e)
558
destination.set_parent(parent)
562
"""Check consistency of the branch.
564
In particular this checks that revisions given in the revision-history
565
do actually match up in the revision graph, and that they're all
566
present in the repository.
568
Callers will typically also want to check the repository.
570
:return: A BranchCheckResult.
572
mainline_parent_id = None
573
for revision_id in self.revision_history():
575
revision = self.repository.get_revision(revision_id)
576
except errors.NoSuchRevision, e:
577
raise errors.BzrCheckError("mainline revision {%s} not in repository"
579
# In general the first entry on the revision history has no parents.
580
# But it's not illegal for it to have parents listed; this can happen
581
# in imports from Arch when the parents weren't reachable.
582
if mainline_parent_id is not None:
583
if mainline_parent_id not in revision.parent_ids:
584
raise errors.BzrCheckError("previous revision {%s} not listed among "
586
% (mainline_parent_id, revision_id))
587
mainline_parent_id = revision_id
588
return BranchCheckResult(self)
590
def _get_checkout_format(self):
591
"""Return the most suitable metadir for a checkout of this branch.
592
Weaves are used if this branch's repostory uses weaves.
594
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
595
from bzrlib import repository
596
format = bzrdir.BzrDirMetaFormat1()
597
format.repository_format = repository.RepositoryFormat7()
599
format = self.repository.bzrdir.cloning_metadir()
602
def create_checkout(self, to_location, revision_id=None,
604
"""Create a checkout of a branch.
606
:param to_location: The url to produce the checkout at
607
:param revision_id: The revision to check out
608
:param lightweight: If True, produce a lightweight checkout, otherwise,
609
produce a bound branch (heavyweight checkout)
610
:return: The tree of the created checkout
612
t = transport.get_transport(to_location)
615
except errors.FileExists:
618
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
619
BranchReferenceFormat().initialize(checkout, self)
621
format = self._get_checkout_format()
622
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
623
to_location, force_new_tree=False, format=format)
624
checkout = checkout_branch.bzrdir
625
checkout_branch.bind(self)
626
# pull up to the specified revision_id to set the initial
627
# branch tip correctly, and seed it with history.
628
checkout_branch.pull(self, stop_revision=revision_id)
629
return checkout.create_workingtree(revision_id)
632
class BranchFormat(object):
633
"""An encapsulation of the initialization and open routines for a format.
635
Formats provide three things:
636
* An initialization routine,
640
Formats are placed in an dict by their format string for reference
641
during branch opening. Its not required that these be instances, they
642
can be classes themselves with class methods - it simply depends on
643
whether state is needed for a given format or not.
645
Once a format is deprecated, just deprecate the initialize and open
646
methods on the format class. Do not deprecate the object, as the
647
object will be created every time regardless.
650
_default_format = None
651
"""The default format used for new branches."""
654
"""The known formats."""
657
def find_format(klass, a_bzrdir):
658
"""Return the format for the branch object in a_bzrdir."""
660
transport = a_bzrdir.get_branch_transport(None)
661
format_string = transport.get("format").read()
662
return klass._formats[format_string]
664
raise NotBranchError(path=transport.base)
666
raise errors.UnknownFormatError(format=format_string)
669
def get_default_format(klass):
670
"""Return the current default format."""
671
return klass._default_format
673
def get_format_string(self):
674
"""Return the ASCII format string that identifies this format."""
675
raise NotImplementedError(self.get_format_string)
677
def get_format_description(self):
678
"""Return the short format description for this format."""
679
raise NotImplementedError(self.get_format_string)
681
def get_reference(self, a_bzrdir):
682
"""Get the target reference of the branch in a_bzrdir.
684
format probing must have been completed before calling
685
this method - it is assumed that the format of the branch
686
in a_bzrdir is correct.
688
:param a_bzrdir: The bzrdir to get the branch data from.
689
:return: None if the branch is not a reference branch.
693
def initialize(self, a_bzrdir):
694
"""Create a branch of this format in a_bzrdir."""
695
raise NotImplementedError(self.initialize)
697
def is_supported(self):
698
"""Is this format supported?
700
Supported formats can be initialized and opened.
701
Unsupported formats may not support initialization or committing or
702
some other features depending on the reason for not being supported.
706
def open(self, a_bzrdir, _found=False):
707
"""Return the branch object for a_bzrdir
709
_found is a private parameter, do not use it. It is used to indicate
710
if format probing has already be done.
712
raise NotImplementedError(self.open)
715
def register_format(klass, format):
716
klass._formats[format.get_format_string()] = format
719
def set_default_format(klass, format):
720
klass._default_format = format
723
def unregister_format(klass, format):
724
assert klass._formats[format.get_format_string()] is format
725
del klass._formats[format.get_format_string()]
728
return self.get_format_string().rstrip()
731
class BzrBranchFormat4(BranchFormat):
732
"""Bzr branch format 4.
735
- a revision-history file.
736
- a branch-lock lock file [ to be shared with the bzrdir ]
739
def get_format_description(self):
740
"""See BranchFormat.get_format_description()."""
741
return "Branch format 4"
743
def initialize(self, a_bzrdir):
744
"""Create a branch of this format in a_bzrdir."""
745
mutter('creating branch in %s', a_bzrdir.transport.base)
746
branch_transport = a_bzrdir.get_branch_transport(self)
747
utf8_files = [('revision-history', ''),
750
control_files = lockable_files.LockableFiles(branch_transport,
751
'branch-lock', lockable_files.TransportLock)
752
control_files.create_lock()
753
control_files.lock_write()
755
for file, content in utf8_files:
756
control_files.put_utf8(file, content)
758
control_files.unlock()
759
return self.open(a_bzrdir, _found=True)
762
super(BzrBranchFormat4, self).__init__()
763
self._matchingbzrdir = bzrdir.BzrDirFormat6()
765
def open(self, a_bzrdir, _found=False):
766
"""Return the branch object for a_bzrdir
768
_found is a private parameter, do not use it. It is used to indicate
769
if format probing has already be done.
772
# we are being called directly and must probe.
773
raise NotImplementedError
774
return BzrBranch(_format=self,
775
_control_files=a_bzrdir._control_files,
777
_repository=a_bzrdir.open_repository())
780
return "Bazaar-NG branch format 4"
783
class BzrBranchFormat5(BranchFormat):
784
"""Bzr branch format 5.
787
- a revision-history file.
789
- a lock dir guarding the branch itself
790
- all of this stored in a branch/ subdirectory
791
- works with shared repositories.
793
This format is new in bzr 0.8.
796
def get_format_string(self):
797
"""See BranchFormat.get_format_string()."""
798
return "Bazaar-NG branch format 5\n"
800
def get_format_description(self):
801
"""See BranchFormat.get_format_description()."""
802
return "Branch format 5"
804
def initialize(self, a_bzrdir):
805
"""Create a branch of this format in a_bzrdir."""
806
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
807
branch_transport = a_bzrdir.get_branch_transport(self)
808
utf8_files = [('revision-history', ''),
811
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
813
control_files.create_lock()
814
control_files.lock_write()
815
control_files.put_utf8('format', self.get_format_string())
817
for file, content in utf8_files:
818
control_files.put_utf8(file, content)
820
control_files.unlock()
821
return self.open(a_bzrdir, _found=True, )
824
super(BzrBranchFormat5, self).__init__()
825
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
827
def open(self, a_bzrdir, _found=False):
828
"""Return the branch object for a_bzrdir
830
_found is a private parameter, do not use it. It is used to indicate
831
if format probing has already be done.
834
format = BranchFormat.find_format(a_bzrdir)
835
assert format.__class__ == self.__class__
837
transport = a_bzrdir.get_branch_transport(None)
838
control_files = lockable_files.LockableFiles(transport, 'lock',
840
return BzrBranch5(_format=self,
841
_control_files=control_files,
843
_repository=a_bzrdir.find_repository())
845
raise NotBranchError(path=transport.base)
848
return "Bazaar-NG Metadir branch format 5"
851
class BranchReferenceFormat(BranchFormat):
852
"""Bzr branch reference format.
854
Branch references are used in implementing checkouts, they
855
act as an alias to the real branch which is at some other url.
862
def get_format_string(self):
863
"""See BranchFormat.get_format_string()."""
864
return "Bazaar-NG Branch Reference Format 1\n"
866
def get_format_description(self):
867
"""See BranchFormat.get_format_description()."""
868
return "Checkout reference format 1"
870
def get_reference(self, a_bzrdir):
871
"""See BranchFormat.get_reference()."""
872
transport = a_bzrdir.get_branch_transport(None)
873
return transport.get('location').read()
875
def initialize(self, a_bzrdir, target_branch=None):
876
"""Create a branch of this format in a_bzrdir."""
877
if target_branch is None:
878
# this format does not implement branch itself, thus the implicit
879
# creation contract must see it as uninitializable
880
raise errors.UninitializableFormat(self)
881
mutter('creating branch reference in %s', a_bzrdir.transport.base)
882
branch_transport = a_bzrdir.get_branch_transport(self)
883
branch_transport.put_bytes('location',
884
target_branch.bzrdir.root_transport.base)
885
branch_transport.put_bytes('format', self.get_format_string())
886
return self.open(a_bzrdir, _found=True)
889
super(BranchReferenceFormat, self).__init__()
890
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
892
def _make_reference_clone_function(format, a_branch):
893
"""Create a clone() routine for a branch dynamically."""
894
def clone(to_bzrdir, revision_id=None):
895
"""See Branch.clone()."""
896
return format.initialize(to_bzrdir, a_branch)
897
# cannot obey revision_id limits when cloning a reference ...
898
# FIXME RBC 20060210 either nuke revision_id for clone, or
899
# emit some sort of warning/error to the caller ?!
902
def open(self, a_bzrdir, _found=False, location=None):
903
"""Return the branch that the branch reference in a_bzrdir points at.
905
_found is a private parameter, do not use it. It is used to indicate
906
if format probing has already be done.
909
format = BranchFormat.find_format(a_bzrdir)
910
assert format.__class__ == self.__class__
912
location = self.get_reference(a_bzrdir)
913
real_bzrdir = bzrdir.BzrDir.open(location)
914
result = real_bzrdir.open_branch()
915
# this changes the behaviour of result.clone to create a new reference
916
# rather than a copy of the content of the branch.
917
# I did not use a proxy object because that needs much more extensive
918
# testing, and we are only changing one behaviour at the moment.
919
# If we decide to alter more behaviours - i.e. the implicit nickname
920
# then this should be refactored to introduce a tested proxy branch
921
# and a subclass of that for use in overriding clone() and ....
923
result.clone = self._make_reference_clone_function(result)
927
# formats which have no format string are not discoverable
928
# and not independently creatable, so are not registered.
929
__default_format = BzrBranchFormat5()
930
BranchFormat.register_format(__default_format)
931
BranchFormat.register_format(BranchReferenceFormat())
932
BranchFormat.set_default_format(__default_format)
933
_legacy_formats = [BzrBranchFormat4(),
936
class BzrBranch(Branch):
937
"""A branch stored in the actual filesystem.
939
Note that it's "local" in the context of the filesystem; it doesn't
940
really matter if it's on an nfs/smb/afs/coda/... share, as long as
941
it's writable, and can be accessed via the normal filesystem API.
944
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
945
relax_version_check=DEPRECATED_PARAMETER, _format=None,
946
_control_files=None, a_bzrdir=None, _repository=None):
947
"""Create new branch object at a particular location.
949
transport -- A Transport object, defining how to access files.
951
init -- If True, create new control files in a previously
952
unversioned directory. If False, the branch must already
955
relax_version_check -- If true, the usual check for the branch
956
version is not applied. This is intended only for
957
upgrade/recovery type use; it's not guaranteed that
958
all operations will work on old format branches.
961
self.bzrdir = bzrdir.BzrDir.open(transport.base)
963
self.bzrdir = a_bzrdir
964
self._transport = self.bzrdir.transport.clone('..')
965
self._base = self._transport.base
966
self._format = _format
967
if _control_files is None:
968
raise ValueError('BzrBranch _control_files is None')
969
self.control_files = _control_files
970
if deprecated_passed(init):
971
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
972
"deprecated as of bzr 0.8. Please use Branch.create().",
976
# this is slower than before deprecation, oh well never mind.
978
self._initialize(transport.base)
979
self._check_format(_format)
980
if deprecated_passed(relax_version_check):
981
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
982
"relax_version_check parameter is deprecated as of bzr 0.8. "
983
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
987
if (not relax_version_check
988
and not self._format.is_supported()):
989
raise errors.UnsupportedFormatError(format=fmt)
990
if deprecated_passed(transport):
991
warn("BzrBranch.__init__(transport=XXX...): The transport "
992
"parameter is deprecated as of bzr 0.8. "
993
"Please use Branch.open, or bzrdir.open_branch().",
996
self.repository = _repository
999
return '%s(%r)' % (self.__class__.__name__, self.base)
1003
def _get_base(self):
1006
base = property(_get_base, doc="The URL for the root of this branch.")
1008
def _finish_transaction(self):
1009
"""Exit the current transaction."""
1010
return self.control_files._finish_transaction()
1012
def get_transaction(self):
1013
"""Return the current active transaction.
1015
If no transaction is active, this returns a passthrough object
1016
for which all data is immediately flushed and no caching happens.
1018
# this is an explicit function so that we can do tricky stuff
1019
# when the storage in rev_storage is elsewhere.
1020
# we probably need to hook the two 'lock a location' and
1021
# 'have a transaction' together more delicately, so that
1022
# we can have two locks (branch and storage) and one transaction
1023
# ... and finishing the transaction unlocks both, but unlocking
1024
# does not. - RBC 20051121
1025
return self.control_files.get_transaction()
1027
def _set_transaction(self, transaction):
1028
"""Set a new active transaction."""
1029
return self.control_files._set_transaction(transaction)
1031
def abspath(self, name):
1032
"""See Branch.abspath."""
1033
return self.control_files._transport.abspath(name)
1035
def _check_format(self, format):
1036
"""Identify the branch format if needed.
1038
The format is stored as a reference to the format object in
1039
self._format for code that needs to check it later.
1041
The format parameter is either None or the branch format class
1042
used to open this branch.
1044
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1047
format = BranchFormat.find_format(self.bzrdir)
1048
self._format = format
1049
mutter("got branch format %s", self._format)
1052
def get_root_id(self):
1053
"""See Branch.get_root_id."""
1054
tree = self.repository.revision_tree(self.last_revision())
1055
return tree.inventory.root.file_id
1057
def is_locked(self):
1058
return self.control_files.is_locked()
1060
def lock_write(self):
1061
self.repository.lock_write()
1063
self.control_files.lock_write()
1065
self.repository.unlock()
1068
def lock_read(self):
1069
self.repository.lock_read()
1071
self.control_files.lock_read()
1073
self.repository.unlock()
1077
# TODO: test for failed two phase locks. This is known broken.
1079
self.control_files.unlock()
1081
self.repository.unlock()
1083
def peek_lock_mode(self):
1084
if self.control_files._lock_count == 0:
1087
return self.control_files._lock_mode
1089
def get_physical_lock_status(self):
1090
return self.control_files.get_physical_lock_status()
1093
def print_file(self, file, revision_id):
1094
"""See Branch.print_file."""
1095
return self.repository.print_file(file, revision_id)
1098
def append_revision(self, *revision_ids):
1099
"""See Branch.append_revision."""
1100
for revision_id in revision_ids:
1101
mutter("add {%s} to revision-history" % revision_id)
1102
rev_history = self.revision_history()
1103
rev_history.extend(revision_ids)
1104
self.set_revision_history(rev_history)
1107
def set_revision_history(self, rev_history):
1108
"""See Branch.set_revision_history."""
1109
self.control_files.put_utf8(
1110
'revision-history', '\n'.join(rev_history))
1111
transaction = self.get_transaction()
1112
history = transaction.map.find_revision_history()
1113
if history is not None:
1114
# update the revision history in the identity map.
1115
history[:] = list(rev_history)
1116
# this call is disabled because revision_history is
1117
# not really an object yet, and the transaction is for objects.
1118
# transaction.register_dirty(history)
1120
transaction.map.add_revision_history(rev_history)
1121
# this call is disabled because revision_history is
1122
# not really an object yet, and the transaction is for objects.
1123
# transaction.register_clean(history)
1126
def revision_history(self):
1127
"""See Branch.revision_history."""
1128
transaction = self.get_transaction()
1129
history = transaction.map.find_revision_history()
1130
if history is not None:
1131
# mutter("cache hit for revision-history in %s", self)
1132
return list(history)
1133
decode_utf8 = cache_utf8.decode
1134
history = [decode_utf8(l.rstrip('\r\n')) for l in
1135
self.control_files.get('revision-history').readlines()]
1136
transaction.map.add_revision_history(history)
1137
# this call is disabled because revision_history is
1138
# not really an object yet, and the transaction is for objects.
1139
# transaction.register_clean(history, precious=True)
1140
return list(history)
1143
def generate_revision_history(self, revision_id, last_rev=None,
1145
"""Create a new revision history that will finish with revision_id.
1147
:param revision_id: the new tip to use.
1148
:param last_rev: The previous last_revision. If not None, then this
1149
must be a ancestory of revision_id, or DivergedBranches is raised.
1150
:param other_branch: The other branch that DivergedBranches should
1151
raise with respect to.
1153
# stop_revision must be a descendant of last_revision
1154
stop_graph = self.repository.get_revision_graph(revision_id)
1155
if last_rev is not None and last_rev not in stop_graph:
1156
# our previous tip is not merged into stop_revision
1157
raise errors.DivergedBranches(self, other_branch)
1158
# make a new revision history from the graph
1159
current_rev_id = revision_id
1161
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1162
new_history.append(current_rev_id)
1163
current_rev_id_parents = stop_graph[current_rev_id]
1165
current_rev_id = current_rev_id_parents[0]
1167
current_rev_id = None
1168
new_history.reverse()
1169
self.set_revision_history(new_history)
1172
def update_revisions(self, other, stop_revision=None):
1173
"""See Branch.update_revisions."""
1176
if stop_revision is None:
1177
stop_revision = other.last_revision()
1178
if stop_revision is None:
1179
# if there are no commits, we're done.
1181
# whats the current last revision, before we fetch [and change it
1183
last_rev = self.last_revision()
1184
# we fetch here regardless of whether we need to so that we pickup
1186
self.fetch(other, stop_revision)
1187
my_ancestry = self.repository.get_ancestry(last_rev)
1188
if stop_revision in my_ancestry:
1189
# last_revision is a descendant of stop_revision
1191
self.generate_revision_history(stop_revision, last_rev=last_rev,
1196
def basis_tree(self):
1197
"""See Branch.basis_tree."""
1198
return self.repository.revision_tree(self.last_revision())
1200
@deprecated_method(zero_eight)
1201
def working_tree(self):
1202
"""Create a Working tree object for this branch."""
1204
from bzrlib.transport.local import LocalTransport
1205
if (self.base.find('://') != -1 or
1206
not isinstance(self._transport, LocalTransport)):
1207
raise NoWorkingTree(self.base)
1208
return self.bzrdir.open_workingtree()
1211
def pull(self, source, overwrite=False, stop_revision=None):
1212
"""See Branch.pull."""
1215
old_count = len(self.revision_history())
1217
self.update_revisions(source, stop_revision)
1218
except DivergedBranches:
1222
self.set_revision_history(source.revision_history())
1223
new_count = len(self.revision_history())
1224
return new_count - old_count
1228
def get_parent(self):
1229
"""See Branch.get_parent."""
1231
_locs = ['parent', 'pull', 'x-pull']
1232
assert self.base[-1] == '/'
1235
parent = self.control_files.get(l).read().strip('\n')
1238
# This is an old-format absolute path to a local branch
1239
# turn it into a url
1240
if parent.startswith('/'):
1241
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1243
return urlutils.join(self.base[:-1], parent)
1244
except errors.InvalidURLJoin, e:
1245
raise errors.InaccessibleParent(parent, self.base)
1248
def get_push_location(self):
1249
"""See Branch.get_push_location."""
1250
push_loc = self.get_config().get_user_option('push_location')
1253
def set_push_location(self, location):
1254
"""See Branch.set_push_location."""
1255
self.get_config().set_user_option(
1256
'push_location', location,
1257
store=_mod_config.STORE_LOCATION_NORECURSE)
1260
def set_parent(self, url):
1261
"""See Branch.set_parent."""
1262
# TODO: Maybe delete old location files?
1263
# URLs should never be unicode, even on the local fs,
1264
# FIXUP this and get_parent in a future branch format bump:
1265
# read and rewrite the file, and have the new format code read
1266
# using .get not .get_utf8. RBC 20060125
1268
self.control_files._transport.delete('parent')
1270
if isinstance(url, unicode):
1272
url = url.encode('ascii')
1273
except UnicodeEncodeError:
1274
raise bzrlib.errors.InvalidURL(url,
1275
"Urls must be 7-bit ascii, "
1276
"use bzrlib.urlutils.escape")
1278
url = urlutils.relative_url(self.base, url)
1279
self.control_files.put('parent', StringIO(url + '\n'))
1281
@deprecated_function(zero_nine)
1282
def tree_config(self):
1283
"""DEPRECATED; call get_config instead.
1284
TreeConfig has become part of BranchConfig."""
1285
return TreeConfig(self)
1288
class BzrBranch5(BzrBranch):
1289
"""A format 5 branch. This supports new features over plan branches.
1291
It has support for a master_branch which is the data for bound branches.
1299
super(BzrBranch5, self).__init__(_format=_format,
1300
_control_files=_control_files,
1302
_repository=_repository)
1305
def pull(self, source, overwrite=False, stop_revision=None):
1306
"""Updates branch.pull to be bound branch aware."""
1307
bound_location = self.get_bound_location()
1308
if source.base != bound_location:
1309
# not pulling from master, so we need to update master.
1310
master_branch = self.get_master_branch()
1312
master_branch.pull(source)
1313
source = master_branch
1314
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1316
def get_bound_location(self):
1318
return self.control_files.get_utf8('bound').read()[:-1]
1319
except errors.NoSuchFile:
1323
def get_master_branch(self):
1324
"""Return the branch we are bound to.
1326
:return: Either a Branch, or None
1328
This could memoise the branch, but if thats done
1329
it must be revalidated on each new lock.
1330
So for now we just don't memoise it.
1331
# RBC 20060304 review this decision.
1333
bound_loc = self.get_bound_location()
1337
return Branch.open(bound_loc)
1338
except (errors.NotBranchError, errors.ConnectionError), e:
1339
raise errors.BoundBranchConnectionFailure(
1343
def set_bound_location(self, location):
1344
"""Set the target where this branch is bound to.
1346
:param location: URL to the target branch
1349
self.control_files.put_utf8('bound', location+'\n')
1352
self.control_files._transport.delete('bound')
1358
def bind(self, other):
1359
"""Bind this branch to the branch other.
1361
This does not push or pull data between the branches, though it does
1362
check for divergence to raise an error when the branches are not
1363
either the same, or one a prefix of the other. That behaviour may not
1364
be useful, so that check may be removed in future.
1366
:param other: The branch to bind to
1369
# TODO: jam 20051230 Consider checking if the target is bound
1370
# It is debatable whether you should be able to bind to
1371
# a branch which is itself bound.
1372
# Committing is obviously forbidden,
1373
# but binding itself may not be.
1374
# Since we *have* to check at commit time, we don't
1375
# *need* to check here
1377
# we want to raise diverged if:
1378
# last_rev is not in the other_last_rev history, AND
1379
# other_last_rev is not in our history, and do it without pulling
1381
last_rev = self.last_revision()
1382
if last_rev is not None:
1385
other_last_rev = other.last_revision()
1386
if other_last_rev is not None:
1387
# neither branch is new, we have to do some work to
1388
# ascertain diversion.
1389
remote_graph = other.repository.get_revision_graph(
1391
local_graph = self.repository.get_revision_graph(last_rev)
1392
if (last_rev not in remote_graph and
1393
other_last_rev not in local_graph):
1394
raise errors.DivergedBranches(self, other)
1397
self.set_bound_location(other.base)
1401
"""If bound, unbind"""
1402
return self.set_bound_location(None)
1406
"""Synchronise this branch with the master branch if any.
1408
:return: None or the last_revision that was pivoted out during the
1411
master = self.get_master_branch()
1412
if master is not None:
1413
old_tip = self.last_revision()
1414
self.pull(master, overwrite=True)
1415
if old_tip in self.repository.get_ancestry(self.last_revision()):
1421
class BranchTestProviderAdapter(object):
1422
"""A tool to generate a suite testing multiple branch formats at once.
1424
This is done by copying the test once for each transport and injecting
1425
the transport_server, transport_readonly_server, and branch_format
1426
classes into each copy. Each copy is also given a new id() to make it
1430
def __init__(self, transport_server, transport_readonly_server, formats):
1431
self._transport_server = transport_server
1432
self._transport_readonly_server = transport_readonly_server
1433
self._formats = formats
1435
def adapt(self, test):
1436
result = TestSuite()
1437
for branch_format, bzrdir_format in self._formats:
1438
new_test = deepcopy(test)
1439
new_test.transport_server = self._transport_server
1440
new_test.transport_readonly_server = self._transport_readonly_server
1441
new_test.bzrdir_format = bzrdir_format
1442
new_test.branch_format = branch_format
1443
def make_new_test_id():
1444
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1445
return lambda: new_id
1446
new_test.id = make_new_test_id()
1447
result.addTest(new_test)
1451
class BranchCheckResult(object):
1452
"""Results of checking branch consistency.
1457
def __init__(self, branch):
1458
self.branch = branch
1460
def report_results(self, verbose):
1461
"""Report the check results via trace.note.
1463
:param verbose: Requests more detailed display of what was checked,
1466
note('checked branch %s format %s',
1468
self.branch._format)
1471
######################################################################
1475
@deprecated_function(zero_eight)
1476
def is_control_file(*args, **kwargs):
1477
"""See bzrlib.workingtree.is_control_file."""
1478
from bzrlib import workingtree
1479
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
