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 copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
import bzrlib.errors as errors
32
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
33
HistoryMissing, InvalidRevisionId,
34
InvalidRevisionNumber, LockError, NoSuchFile,
35
NoSuchRevision, NoWorkingTree, NotVersionedError,
36
NotBranchError, UninitializableFormat,
37
UnlistableStore, UnlistableBranch,
39
import bzrlib.inventory as inventory
40
from bzrlib.inventory import Inventory
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.lockdir import LockDir
43
from bzrlib.osutils import (isdir, quotefn,
44
rename, splitpath, sha_file,
45
file_kind, abspath, normpath, pathjoin,
49
from bzrlib.repository import Repository
50
from bzrlib.revision import (
55
from bzrlib.store import copy_all
56
from bzrlib.symbol_versioning import *
57
from bzrlib.textui import show_status
58
from bzrlib.trace import mutter, note
59
import bzrlib.transactions as transactions
60
from bzrlib.transport import Transport, get_transport
62
import bzrlib.urlutils as urlutils
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-NG branch, format 6\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
# this is really an instance variable - FIXME move it there
93
def __init__(self, *ignored, **ignored_too):
94
raise NotImplementedError('The Branch class is abstract')
97
"""Break a lock if one is present from another instance.
99
Uses the ui factory to ask for confirmation if the lock may be from
102
This will probe the repository for its lock as well.
104
self.control_files.break_lock()
105
self.repository.break_lock()
106
master = self.get_master_branch()
107
if master is not None:
111
@deprecated_method(zero_eight)
112
def open_downlevel(base):
113
"""Open a branch which may be of an old format."""
114
return Branch.open(base, _unsupported=True)
117
def open(base, _unsupported=False):
118
"""Open the repository rooted at base.
120
For instance, if the repository is at URL/.bzr/repository,
121
Repository.open(URL) -> a Repository instance.
123
control = bzrdir.BzrDir.open(base, _unsupported)
124
return control.open_branch(_unsupported)
127
def open_containing(url):
128
"""Open an existing branch which contains url.
130
This probes for a branch at url, and searches upwards from there.
132
Basically we keep looking up until we find the control directory or
133
run into the root. If there isn't one, raises NotBranchError.
134
If there is one and it is either an unrecognised format or an unsupported
135
format, UnknownFormatError or UnsupportedFormatError are raised.
136
If there is one, it is returned, along with the unused portion of url.
138
control, relpath = bzrdir.BzrDir.open_containing(url)
139
return control.open_branch(), relpath
142
@deprecated_function(zero_eight)
143
def initialize(base):
144
"""Create a new working tree and branch, rooted at 'base' (url)
146
NOTE: This will soon be deprecated in favour of creation
149
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
155
# seems to be unused, 2006-01-13 mbp
156
warn('%s is deprecated' % self.setup_caching)
157
self.cache_root = cache_root
160
cfg = self.tree_config()
161
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
163
def _set_nick(self, nick):
164
cfg = self.tree_config()
165
cfg.set_option(nick, "nickname")
166
assert cfg.get_option("nickname") == nick
168
nick = property(_get_nick, _set_nick)
171
raise NotImplementedError('is_locked is abstract')
173
def lock_write(self):
174
raise NotImplementedError('lock_write is abstract')
177
raise NotImplementedError('lock_read is abstract')
180
raise NotImplementedError('unlock is abstract')
182
def peek_lock_mode(self):
183
"""Return lock mode for the Branch: 'r', 'w' or None"""
184
raise NotImplementedError(self.peek_lock_mode)
186
def get_physical_lock_status(self):
187
raise NotImplementedError('get_physical_lock_status is abstract')
189
def abspath(self, name):
190
"""Return absolute filename for something in the branch
192
XXX: Robert Collins 20051017 what is this used for? why is it a branch
193
method and not a tree method.
195
raise NotImplementedError('abspath is abstract')
197
def bind(self, other):
198
"""Bind the local branch the other branch.
200
:param other: The branch to bind to
203
raise errors.UpgradeRequired(self.base)
206
def fetch(self, from_branch, last_revision=None, pb=None):
207
"""Copy revisions from from_branch into this branch.
209
:param from_branch: Where to copy from.
210
:param last_revision: What revision to stop at (None for at the end
212
:param pb: An optional progress bar to use.
214
Returns the copied revision count and the failed revisions in a tuple:
217
if self.base == from_branch.base:
220
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
225
from_branch.lock_read()
227
if last_revision is None:
228
pb.update('get source history')
229
from_history = from_branch.revision_history()
231
last_revision = from_history[-1]
233
# no history in the source branch
234
last_revision = NULL_REVISION
235
return self.repository.fetch(from_branch.repository,
236
revision_id=last_revision,
239
if nested_pb is not None:
243
def get_bound_location(self):
244
"""Return the URL of the branch we are bound to.
246
Older format branches cannot bind, please be sure to use a metadir
251
def get_commit_builder(self, parents, config=None, timestamp=None,
252
timezone=None, committer=None, revprops=None,
254
"""Obtain a CommitBuilder for this branch.
256
:param parents: Revision ids of the parents of the new revision.
257
:param config: Optional configuration to use.
258
:param timestamp: Optional timestamp recorded for commit.
259
:param timezone: Optional timezone for timestamp.
260
:param committer: Optional committer to set for commit.
261
:param revprops: Optional dictionary of revision properties.
262
:param revision_id: Optional revision id.
266
config = bzrlib.config.BranchConfig(self)
268
return self.repository.get_commit_builder(self, parents, config,
269
timestamp, timezone, committer, revprops, revision_id)
271
def get_master_branch(self):
272
"""Return the branch we are bound to.
274
:return: Either a Branch, or None
278
def get_revision_delta(self, revno):
279
"""Return the delta for one revision.
281
The delta is relative to its mainline predecessor, or the
282
empty tree for revision 1.
284
assert isinstance(revno, int)
285
rh = self.revision_history()
286
if not (1 <= revno <= len(rh)):
287
raise InvalidRevisionNumber(revno)
288
return self.repository.get_revision_delta(rh[revno-1])
290
def get_root_id(self):
291
"""Return the id of this branches root"""
292
raise NotImplementedError('get_root_id is abstract')
294
def print_file(self, file, revision_id):
295
"""Print `file` to stdout."""
296
raise NotImplementedError('print_file is abstract')
298
def append_revision(self, *revision_ids):
299
raise NotImplementedError('append_revision is abstract')
301
def set_revision_history(self, rev_history):
302
raise NotImplementedError('set_revision_history is abstract')
304
def revision_history(self):
305
"""Return sequence of revision hashes on to this branch."""
306
raise NotImplementedError('revision_history is abstract')
309
"""Return current revision number for this branch.
311
That is equivalent to the number of revisions committed to
314
return len(self.revision_history())
317
"""Older format branches cannot bind or unbind."""
318
raise errors.UpgradeRequired(self.base)
320
def last_revision(self):
321
"""Return last patch hash, or None if no history."""
322
ph = self.revision_history()
328
def missing_revisions(self, other, stop_revision=None):
329
"""Return a list of new revisions that would perfectly fit.
331
If self and other have not diverged, return a list of the revisions
332
present in other, but missing from self.
334
>>> from bzrlib.workingtree import WorkingTree
335
>>> bzrlib.trace.silent = True
336
>>> d1 = bzrdir.ScratchDir()
337
>>> br1 = d1.open_branch()
338
>>> wt1 = d1.open_workingtree()
339
>>> d2 = bzrdir.ScratchDir()
340
>>> br2 = d2.open_branch()
341
>>> wt2 = d2.open_workingtree()
342
>>> br1.missing_revisions(br2)
344
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
346
>>> br1.missing_revisions(br2)
348
>>> br2.missing_revisions(br1)
350
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
352
>>> br1.missing_revisions(br2)
354
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
356
>>> br1.missing_revisions(br2)
358
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
360
>>> br1.missing_revisions(br2)
361
Traceback (most recent call last):
362
DivergedBranches: These branches have diverged. Try merge.
364
self_history = self.revision_history()
365
self_len = len(self_history)
366
other_history = other.revision_history()
367
other_len = len(other_history)
368
common_index = min(self_len, other_len) -1
369
if common_index >= 0 and \
370
self_history[common_index] != other_history[common_index]:
371
raise DivergedBranches(self, other)
373
if stop_revision is None:
374
stop_revision = other_len
376
assert isinstance(stop_revision, int)
377
if stop_revision > other_len:
378
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
379
return other_history[self_len:stop_revision]
381
def update_revisions(self, other, stop_revision=None):
382
"""Pull in new perfect-fit revisions.
384
:param other: Another Branch to pull from
385
:param stop_revision: Updated until the given revision
388
raise NotImplementedError('update_revisions is abstract')
390
def revision_id_to_revno(self, revision_id):
391
"""Given a revision id, return its revno"""
392
if revision_id is None:
394
history = self.revision_history()
396
return history.index(revision_id) + 1
398
raise bzrlib.errors.NoSuchRevision(self, revision_id)
400
def get_rev_id(self, revno, history=None):
401
"""Find the revision id of the specified revno."""
405
history = self.revision_history()
406
elif revno <= 0 or revno > len(history):
407
raise bzrlib.errors.NoSuchRevision(self, revno)
408
return history[revno - 1]
410
def pull(self, source, overwrite=False, stop_revision=None):
411
raise NotImplementedError('pull is abstract')
413
def basis_tree(self):
414
"""Return `Tree` object for last revision.
416
If there are no revisions yet, return an `EmptyTree`.
418
return self.repository.revision_tree(self.last_revision())
420
def rename_one(self, from_rel, to_rel):
423
This can change the directory or the filename or both.
425
raise NotImplementedError('rename_one is abstract')
427
def move(self, from_paths, to_name):
430
to_name must exist as a versioned directory.
432
If to_name exists and is a directory, the files are moved into
433
it, keeping their old names. If it is a directory,
435
Note that to_name is only the last component of the new name;
436
this doesn't change the directory.
438
This returns a list of (from_path, to_path) pairs for each
441
raise NotImplementedError('move is abstract')
443
def get_parent(self):
444
"""Return the parent location of the branch.
446
This is the default location for push/pull/missing. The usual
447
pattern is that the user can override it by specifying a
450
raise NotImplementedError('get_parent is abstract')
452
def get_push_location(self):
453
"""Return the None or the location to push this branch to."""
454
raise NotImplementedError('get_push_location is abstract')
456
def set_push_location(self, location):
457
"""Set a new push location for this branch."""
458
raise NotImplementedError('set_push_location is abstract')
460
def set_parent(self, url):
461
raise NotImplementedError('set_parent is abstract')
465
"""Synchronise this branch with the master branch if any.
467
:return: None or the last_revision pivoted out during the update.
471
def check_revno(self, revno):
473
Check whether a revno corresponds to any revision.
474
Zero (the NULL revision) is considered valid.
477
self.check_real_revno(revno)
479
def check_real_revno(self, revno):
481
Check whether a revno corresponds to a real revision.
482
Zero (the NULL revision) is considered invalid
484
if revno < 1 or revno > self.revno():
485
raise InvalidRevisionNumber(revno)
488
def clone(self, *args, **kwargs):
489
"""Clone this branch into to_bzrdir preserving all semantic values.
491
revision_id: if not None, the revision history in the new branch will
492
be truncated to end with revision_id.
494
# for API compatibility, until 0.8 releases we provide the old api:
495
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
496
# after 0.8 releases, the *args and **kwargs should be changed:
497
# def clone(self, to_bzrdir, revision_id=None):
498
if (kwargs.get('to_location', None) or
499
kwargs.get('revision', None) or
500
kwargs.get('basis_branch', None) or
501
(len(args) and isinstance(args[0], basestring))):
502
# backwards compatibility api:
503
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
504
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
507
basis_branch = args[2]
509
basis_branch = kwargs.get('basis_branch', None)
511
basis = basis_branch.bzrdir
516
revision_id = args[1]
518
revision_id = kwargs.get('revision', None)
523
# no default to raise if not provided.
524
url = kwargs.get('to_location')
525
return self.bzrdir.clone(url,
526
revision_id=revision_id,
527
basis=basis).open_branch()
529
# generate args by hand
531
revision_id = args[1]
533
revision_id = kwargs.get('revision_id', None)
537
# no default to raise if not provided.
538
to_bzrdir = kwargs.get('to_bzrdir')
539
result = self._format.initialize(to_bzrdir)
540
self.copy_content_into(result, revision_id=revision_id)
544
def sprout(self, to_bzrdir, revision_id=None):
545
"""Create a new line of development from the branch, into to_bzrdir.
547
revision_id: if not None, the revision history in the new branch will
548
be truncated to end with revision_id.
550
result = self._format.initialize(to_bzrdir)
551
self.copy_content_into(result, revision_id=revision_id)
552
result.set_parent(self.bzrdir.root_transport.base)
556
def copy_content_into(self, destination, revision_id=None):
557
"""Copy the content of self into destination.
559
revision_id: if not None, the revision history in the new branch will
560
be truncated to end with revision_id.
562
new_history = self.revision_history()
563
if revision_id is not None:
565
new_history = new_history[:new_history.index(revision_id) + 1]
567
rev = self.repository.get_revision(revision_id)
568
new_history = rev.get_history(self.repository)[1:]
569
destination.set_revision_history(new_history)
570
parent = self.get_parent()
572
destination.set_parent(parent)
576
"""Check consistency of the branch.
578
In particular this checks that revisions given in the revision-history
579
do actually match up in the revision graph, and that they're all
580
present in the repository.
582
:return: A BranchCheckResult.
584
mainline_parent_id = None
585
for revision_id in self.revision_history():
587
revision = self.repository.get_revision(revision_id)
588
except errors.NoSuchRevision, e:
589
raise BzrCheckError("mainline revision {%s} not in repository"
591
# In general the first entry on the revision history has no parents.
592
# But it's not illegal for it to have parents listed; this can happen
593
# in imports from Arch when the parents weren't reachable.
594
if mainline_parent_id is not None:
595
if mainline_parent_id not in revision.parent_ids:
596
raise BzrCheckError("previous revision {%s} not listed among "
598
% (mainline_parent_id, revision_id))
599
mainline_parent_id = revision_id
600
return BranchCheckResult(self)
603
class BranchFormat(object):
604
"""An encapsulation of the initialization and open routines for a format.
606
Formats provide three things:
607
* An initialization routine,
611
Formats are placed in an dict by their format string for reference
612
during branch opening. Its not required that these be instances, they
613
can be classes themselves with class methods - it simply depends on
614
whether state is needed for a given format or not.
616
Once a format is deprecated, just deprecate the initialize and open
617
methods on the format class. Do not deprecate the object, as the
618
object will be created every time regardless.
621
_default_format = None
622
"""The default format used for new branches."""
625
"""The known formats."""
628
def find_format(klass, a_bzrdir):
629
"""Return the format for the branch object in a_bzrdir."""
631
transport = a_bzrdir.get_branch_transport(None)
632
format_string = transport.get("format").read()
633
return klass._formats[format_string]
635
raise NotBranchError(path=transport.base)
637
raise errors.UnknownFormatError(format_string)
640
def get_default_format(klass):
641
"""Return the current default format."""
642
return klass._default_format
644
def get_format_string(self):
645
"""Return the ASCII format string that identifies this format."""
646
raise NotImplementedError(self.get_format_string)
648
def get_format_description(self):
649
"""Return the short format description for this format."""
650
raise NotImplementedError(self.get_format_string)
652
def initialize(self, a_bzrdir):
653
"""Create a branch of this format in a_bzrdir."""
654
raise NotImplementedError(self.initialize)
656
def is_supported(self):
657
"""Is this format supported?
659
Supported formats can be initialized and opened.
660
Unsupported formats may not support initialization or committing or
661
some other features depending on the reason for not being supported.
665
def open(self, a_bzrdir, _found=False):
666
"""Return the branch object for a_bzrdir
668
_found is a private parameter, do not use it. It is used to indicate
669
if format probing has already be done.
671
raise NotImplementedError(self.open)
674
def register_format(klass, format):
675
klass._formats[format.get_format_string()] = format
678
def set_default_format(klass, format):
679
klass._default_format = format
682
def unregister_format(klass, format):
683
assert klass._formats[format.get_format_string()] is format
684
del klass._formats[format.get_format_string()]
687
return self.get_format_string().rstrip()
690
class BzrBranchFormat4(BranchFormat):
691
"""Bzr branch format 4.
694
- a revision-history file.
695
- a branch-lock lock file [ to be shared with the bzrdir ]
698
def get_format_description(self):
699
"""See BranchFormat.get_format_description()."""
700
return "Branch format 4"
702
def initialize(self, a_bzrdir):
703
"""Create a branch of this format in a_bzrdir."""
704
mutter('creating branch in %s', a_bzrdir.transport.base)
705
branch_transport = a_bzrdir.get_branch_transport(self)
706
utf8_files = [('revision-history', ''),
709
control_files = LockableFiles(branch_transport, 'branch-lock',
711
control_files.create_lock()
712
control_files.lock_write()
714
for file, content in utf8_files:
715
control_files.put_utf8(file, content)
717
control_files.unlock()
718
return self.open(a_bzrdir, _found=True)
721
super(BzrBranchFormat4, self).__init__()
722
self._matchingbzrdir = bzrdir.BzrDirFormat6()
724
def open(self, a_bzrdir, _found=False):
725
"""Return the branch object for a_bzrdir
727
_found is a private parameter, do not use it. It is used to indicate
728
if format probing has already be done.
731
# we are being called directly and must probe.
732
raise NotImplementedError
733
return BzrBranch(_format=self,
734
_control_files=a_bzrdir._control_files,
736
_repository=a_bzrdir.open_repository())
739
return "Bazaar-NG branch format 4"
742
class BzrBranchFormat5(BranchFormat):
743
"""Bzr branch format 5.
746
- a revision-history file.
748
- a lock dir guarding the branch itself
749
- all of this stored in a branch/ subdirectory
750
- works with shared repositories.
752
This format is new in bzr 0.8.
755
def get_format_string(self):
756
"""See BranchFormat.get_format_string()."""
757
return "Bazaar-NG branch format 5\n"
759
def get_format_description(self):
760
"""See BranchFormat.get_format_description()."""
761
return "Branch format 5"
763
def initialize(self, a_bzrdir):
764
"""Create a branch of this format in a_bzrdir."""
765
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
766
branch_transport = a_bzrdir.get_branch_transport(self)
767
utf8_files = [('revision-history', ''),
770
control_files = LockableFiles(branch_transport, 'lock', LockDir)
771
control_files.create_lock()
772
control_files.lock_write()
773
control_files.put_utf8('format', self.get_format_string())
775
for file, content in utf8_files:
776
control_files.put_utf8(file, content)
778
control_files.unlock()
779
return self.open(a_bzrdir, _found=True, )
782
super(BzrBranchFormat5, self).__init__()
783
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
785
def open(self, a_bzrdir, _found=False):
786
"""Return the branch object for a_bzrdir
788
_found is a private parameter, do not use it. It is used to indicate
789
if format probing has already be done.
792
format = BranchFormat.find_format(a_bzrdir)
793
assert format.__class__ == self.__class__
794
transport = a_bzrdir.get_branch_transport(None)
795
control_files = LockableFiles(transport, 'lock', LockDir)
796
return BzrBranch5(_format=self,
797
_control_files=control_files,
799
_repository=a_bzrdir.find_repository())
802
return "Bazaar-NG Metadir branch format 5"
805
class BranchReferenceFormat(BranchFormat):
806
"""Bzr branch reference format.
808
Branch references are used in implementing checkouts, they
809
act as an alias to the real branch which is at some other url.
816
def get_format_string(self):
817
"""See BranchFormat.get_format_string()."""
818
return "Bazaar-NG Branch Reference Format 1\n"
820
def get_format_description(self):
821
"""See BranchFormat.get_format_description()."""
822
return "Checkout reference format 1"
824
def initialize(self, a_bzrdir, target_branch=None):
825
"""Create a branch of this format in a_bzrdir."""
826
if target_branch is None:
827
# this format does not implement branch itself, thus the implicit
828
# creation contract must see it as uninitializable
829
raise errors.UninitializableFormat(self)
830
mutter('creating branch reference in %s', a_bzrdir.transport.base)
831
branch_transport = a_bzrdir.get_branch_transport(self)
832
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
833
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
834
branch_transport.put('format', StringIO(self.get_format_string()))
835
return self.open(a_bzrdir, _found=True)
838
super(BranchReferenceFormat, self).__init__()
839
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
841
def _make_reference_clone_function(format, a_branch):
842
"""Create a clone() routine for a branch dynamically."""
843
def clone(to_bzrdir, revision_id=None):
844
"""See Branch.clone()."""
845
return format.initialize(to_bzrdir, a_branch)
846
# cannot obey revision_id limits when cloning a reference ...
847
# FIXME RBC 20060210 either nuke revision_id for clone, or
848
# emit some sort of warning/error to the caller ?!
851
def open(self, a_bzrdir, _found=False):
852
"""Return the branch that the branch reference in a_bzrdir points at.
854
_found is a private parameter, do not use it. It is used to indicate
855
if format probing has already be done.
858
format = BranchFormat.find_format(a_bzrdir)
859
assert format.__class__ == self.__class__
860
transport = a_bzrdir.get_branch_transport(None)
861
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
862
result = real_bzrdir.open_branch()
863
# this changes the behaviour of result.clone to create a new reference
864
# rather than a copy of the content of the branch.
865
# I did not use a proxy object because that needs much more extensive
866
# testing, and we are only changing one behaviour at the moment.
867
# If we decide to alter more behaviours - i.e. the implicit nickname
868
# then this should be refactored to introduce a tested proxy branch
869
# and a subclass of that for use in overriding clone() and ....
871
result.clone = self._make_reference_clone_function(result)
875
# formats which have no format string are not discoverable
876
# and not independently creatable, so are not registered.
877
__default_format = BzrBranchFormat5()
878
BranchFormat.register_format(__default_format)
879
BranchFormat.register_format(BranchReferenceFormat())
880
BranchFormat.set_default_format(__default_format)
881
_legacy_formats = [BzrBranchFormat4(),
884
class BzrBranch(Branch):
885
"""A branch stored in the actual filesystem.
887
Note that it's "local" in the context of the filesystem; it doesn't
888
really matter if it's on an nfs/smb/afs/coda/... share, as long as
889
it's writable, and can be accessed via the normal filesystem API.
892
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
893
relax_version_check=DEPRECATED_PARAMETER, _format=None,
894
_control_files=None, a_bzrdir=None, _repository=None):
895
"""Create new branch object at a particular location.
897
transport -- A Transport object, defining how to access files.
899
init -- If True, create new control files in a previously
900
unversioned directory. If False, the branch must already
903
relax_version_check -- If true, the usual check for the branch
904
version is not applied. This is intended only for
905
upgrade/recovery type use; it's not guaranteed that
906
all operations will work on old format branches.
909
self.bzrdir = bzrdir.BzrDir.open(transport.base)
911
self.bzrdir = a_bzrdir
912
self._transport = self.bzrdir.transport.clone('..')
913
self._base = self._transport.base
914
self._format = _format
915
if _control_files is None:
916
raise BzrBadParameterMissing('_control_files')
917
self.control_files = _control_files
918
if deprecated_passed(init):
919
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
920
"deprecated as of bzr 0.8. Please use Branch.create().",
924
# this is slower than before deprecation, oh well never mind.
926
self._initialize(transport.base)
927
self._check_format(_format)
928
if deprecated_passed(relax_version_check):
929
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
930
"relax_version_check parameter is deprecated as of bzr 0.8. "
931
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
935
if (not relax_version_check
936
and not self._format.is_supported()):
937
raise errors.UnsupportedFormatError(
938
'sorry, branch format %r not supported' % fmt,
939
['use a different bzr version',
940
'or remove the .bzr directory'
941
' and "bzr init" again'])
942
if deprecated_passed(transport):
943
warn("BzrBranch.__init__(transport=XXX...): The transport "
944
"parameter is deprecated as of bzr 0.8. "
945
"Please use Branch.open, or bzrdir.open_branch().",
948
self.repository = _repository
951
return '%s(%r)' % (self.__class__.__name__, self.base)
956
# TODO: It might be best to do this somewhere else,
957
# but it is nice for a Branch object to automatically
958
# cache it's information.
959
# Alternatively, we could have the Transport objects cache requests
960
# See the earlier discussion about how major objects (like Branch)
961
# should never expect their __del__ function to run.
962
# XXX: cache_root seems to be unused, 2006-01-13 mbp
963
if hasattr(self, 'cache_root') and self.cache_root is not None:
965
rmtree(self.cache_root)
968
self.cache_root = None
973
base = property(_get_base, doc="The URL for the root of this branch.")
975
def _finish_transaction(self):
976
"""Exit the current transaction."""
977
return self.control_files._finish_transaction()
979
def get_transaction(self):
980
"""Return the current active transaction.
982
If no transaction is active, this returns a passthrough object
983
for which all data is immediately flushed and no caching happens.
985
# this is an explicit function so that we can do tricky stuff
986
# when the storage in rev_storage is elsewhere.
987
# we probably need to hook the two 'lock a location' and
988
# 'have a transaction' together more delicately, so that
989
# we can have two locks (branch and storage) and one transaction
990
# ... and finishing the transaction unlocks both, but unlocking
991
# does not. - RBC 20051121
992
return self.control_files.get_transaction()
994
def _set_transaction(self, transaction):
995
"""Set a new active transaction."""
996
return self.control_files._set_transaction(transaction)
998
def abspath(self, name):
999
"""See Branch.abspath."""
1000
return self.control_files._transport.abspath(name)
1002
def _check_format(self, format):
1003
"""Identify the branch format if needed.
1005
The format is stored as a reference to the format object in
1006
self._format for code that needs to check it later.
1008
The format parameter is either None or the branch format class
1009
used to open this branch.
1011
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1014
format = BzrBranchFormat.find_format(self.bzrdir)
1015
self._format = format
1016
mutter("got branch format %s", self._format)
1019
def get_root_id(self):
1020
"""See Branch.get_root_id."""
1021
tree = self.repository.revision_tree(self.last_revision())
1022
return tree.inventory.root.file_id
1024
def is_locked(self):
1025
return self.control_files.is_locked()
1027
def lock_write(self):
1028
# TODO: test for failed two phase locks. This is known broken.
1029
self.control_files.lock_write()
1030
self.repository.lock_write()
1032
def lock_read(self):
1033
# TODO: test for failed two phase locks. This is known broken.
1034
self.control_files.lock_read()
1035
self.repository.lock_read()
1038
# TODO: test for failed two phase locks. This is known broken.
1040
self.repository.unlock()
1042
self.control_files.unlock()
1044
def peek_lock_mode(self):
1045
if self.control_files._lock_count == 0:
1048
return self.control_files._lock_mode
1050
def get_physical_lock_status(self):
1051
return self.control_files.get_physical_lock_status()
1054
def print_file(self, file, revision_id):
1055
"""See Branch.print_file."""
1056
return self.repository.print_file(file, revision_id)
1059
def append_revision(self, *revision_ids):
1060
"""See Branch.append_revision."""
1061
for revision_id in revision_ids:
1062
mutter("add {%s} to revision-history" % revision_id)
1063
rev_history = self.revision_history()
1064
rev_history.extend(revision_ids)
1065
self.set_revision_history(rev_history)
1068
def set_revision_history(self, rev_history):
1069
"""See Branch.set_revision_history."""
1070
self.control_files.put_utf8(
1071
'revision-history', '\n'.join(rev_history))
1072
transaction = self.get_transaction()
1073
history = transaction.map.find_revision_history()
1074
if history is not None:
1075
# update the revision history in the identity map.
1076
history[:] = list(rev_history)
1077
# this call is disabled because revision_history is
1078
# not really an object yet, and the transaction is for objects.
1079
# transaction.register_dirty(history)
1081
transaction.map.add_revision_history(rev_history)
1082
# this call is disabled because revision_history is
1083
# not really an object yet, and the transaction is for objects.
1084
# transaction.register_clean(history)
1087
def revision_history(self):
1088
"""See Branch.revision_history."""
1089
transaction = self.get_transaction()
1090
history = transaction.map.find_revision_history()
1091
if history is not None:
1092
mutter("cache hit for revision-history in %s", self)
1093
return list(history)
1094
history = [l.rstrip('\r\n') for l in
1095
self.control_files.get_utf8('revision-history').readlines()]
1096
transaction.map.add_revision_history(history)
1097
# this call is disabled because revision_history is
1098
# not really an object yet, and the transaction is for objects.
1099
# transaction.register_clean(history, precious=True)
1100
return list(history)
1103
def update_revisions(self, other, stop_revision=None):
1104
"""See Branch.update_revisions."""
1107
if stop_revision is None:
1108
stop_revision = other.last_revision()
1109
if stop_revision is None:
1110
# if there are no commits, we're done.
1112
# whats the current last revision, before we fetch [and change it
1114
last_rev = self.last_revision()
1115
# we fetch here regardless of whether we need to so that we pickup
1117
self.fetch(other, stop_revision)
1118
my_ancestry = self.repository.get_ancestry(last_rev)
1119
if stop_revision in my_ancestry:
1120
# last_revision is a descendant of stop_revision
1122
# stop_revision must be a descendant of last_revision
1123
stop_graph = self.repository.get_revision_graph(stop_revision)
1124
if last_rev is not None and last_rev not in stop_graph:
1125
# our previous tip is not merged into stop_revision
1126
raise errors.DivergedBranches(self, other)
1127
# make a new revision history from the graph
1128
current_rev_id = stop_revision
1130
while current_rev_id not in (None, NULL_REVISION):
1131
new_history.append(current_rev_id)
1132
current_rev_id_parents = stop_graph[current_rev_id]
1134
current_rev_id = current_rev_id_parents[0]
1136
current_rev_id = None
1137
new_history.reverse()
1138
self.set_revision_history(new_history)
1142
def basis_tree(self):
1143
"""See Branch.basis_tree."""
1144
return self.repository.revision_tree(self.last_revision())
1146
@deprecated_method(zero_eight)
1147
def working_tree(self):
1148
"""Create a Working tree object for this branch."""
1149
from bzrlib.workingtree import WorkingTree
1150
from bzrlib.transport.local import LocalTransport
1151
if (self.base.find('://') != -1 or
1152
not isinstance(self._transport, LocalTransport)):
1153
raise NoWorkingTree(self.base)
1154
return self.bzrdir.open_workingtree()
1157
def pull(self, source, overwrite=False, stop_revision=None):
1158
"""See Branch.pull."""
1161
old_count = len(self.revision_history())
1163
self.update_revisions(source,stop_revision)
1164
except DivergedBranches:
1168
self.set_revision_history(source.revision_history())
1169
new_count = len(self.revision_history())
1170
return new_count - old_count
1174
def get_parent(self):
1175
"""See Branch.get_parent."""
1177
_locs = ['parent', 'pull', 'x-pull']
1178
assert self.base[-1] == '/'
1181
parent = self.control_files.get(l).read().strip('\n')
1184
# This is an old-format absolute path to a local branch
1185
# turn it into a url
1186
if parent.startswith('/'):
1187
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1188
return urlutils.join(self.base[:-1], parent)
1191
def get_push_location(self):
1192
"""See Branch.get_push_location."""
1193
config = bzrlib.config.BranchConfig(self)
1194
push_loc = config.get_user_option('push_location')
1197
def set_push_location(self, location):
1198
"""See Branch.set_push_location."""
1199
config = bzrlib.config.LocationConfig(self.base)
1200
config.set_user_option('push_location', location)
1203
def set_parent(self, url):
1204
"""See Branch.set_parent."""
1205
# TODO: Maybe delete old location files?
1206
# URLs should never be unicode, even on the local fs,
1207
# FIXUP this and get_parent in a future branch format bump:
1208
# read and rewrite the file, and have the new format code read
1209
# using .get not .get_utf8. RBC 20060125
1211
self.control_files._transport.delete('parent')
1213
if isinstance(url, unicode):
1215
url = url.encode('ascii')
1216
except UnicodeEncodeError:
1217
raise bzrlib.errors.InvalidURL(url,
1218
"Urls must be 7-bit ascii, "
1219
"use bzrlib.urlutils.escape")
1221
url = urlutils.relative_url(self.base, url)
1222
self.control_files.put('parent', url + '\n')
1224
def tree_config(self):
1225
return TreeConfig(self)
1228
class BzrBranch5(BzrBranch):
1229
"""A format 5 branch. This supports new features over plan branches.
1231
It has support for a master_branch which is the data for bound branches.
1239
super(BzrBranch5, self).__init__(_format=_format,
1240
_control_files=_control_files,
1242
_repository=_repository)
1245
def pull(self, source, overwrite=False, stop_revision=None):
1246
"""Updates branch.pull to be bound branch aware."""
1247
bound_location = self.get_bound_location()
1248
if source.base != bound_location:
1249
# not pulling from master, so we need to update master.
1250
master_branch = self.get_master_branch()
1252
master_branch.pull(source)
1253
source = master_branch
1254
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1256
def get_bound_location(self):
1258
return self.control_files.get_utf8('bound').read()[:-1]
1259
except errors.NoSuchFile:
1263
def get_master_branch(self):
1264
"""Return the branch we are bound to.
1266
:return: Either a Branch, or None
1268
This could memoise the branch, but if thats done
1269
it must be revalidated on each new lock.
1270
So for now we just don't memoise it.
1271
# RBC 20060304 review this decision.
1273
bound_loc = self.get_bound_location()
1277
return Branch.open(bound_loc)
1278
except (errors.NotBranchError, errors.ConnectionError), e:
1279
raise errors.BoundBranchConnectionFailure(
1283
def set_bound_location(self, location):
1284
"""Set the target where this branch is bound to.
1286
:param location: URL to the target branch
1289
self.control_files.put_utf8('bound', location+'\n')
1292
self.control_files._transport.delete('bound')
1298
def bind(self, other):
1299
"""Bind the local branch the other branch.
1301
:param other: The branch to bind to
1304
# TODO: jam 20051230 Consider checking if the target is bound
1305
# It is debatable whether you should be able to bind to
1306
# a branch which is itself bound.
1307
# Committing is obviously forbidden,
1308
# but binding itself may not be.
1309
# Since we *have* to check at commit time, we don't
1310
# *need* to check here
1313
# we are now equal to or a suffix of other.
1315
# Since we have 'pulled' from the remote location,
1316
# now we should try to pull in the opposite direction
1317
# in case the local tree has more revisions than the
1319
# There may be a different check you could do here
1320
# rather than actually trying to install revisions remotely.
1321
# TODO: capture an exception which indicates the remote branch
1323
# If it is up-to-date, this probably should not be a failure
1325
# lock other for write so the revision-history syncing cannot race
1329
# if this does not error, other now has the same last rev we do
1330
# it can only error if the pull from other was concurrent with
1331
# a commit to other from someone else.
1333
# until we ditch revision-history, we need to sync them up:
1334
self.set_revision_history(other.revision_history())
1335
# now other and self are up to date with each other and have the
1336
# same revision-history.
1340
self.set_bound_location(other.base)
1344
"""If bound, unbind"""
1345
return self.set_bound_location(None)
1349
"""Synchronise this branch with the master branch if any.
1351
:return: None or the last_revision that was pivoted out during the
1354
master = self.get_master_branch()
1355
if master is not None:
1356
old_tip = self.last_revision()
1357
self.pull(master, overwrite=True)
1358
if old_tip in self.repository.get_ancestry(self.last_revision()):
1364
class BranchTestProviderAdapter(object):
1365
"""A tool to generate a suite testing multiple branch formats at once.
1367
This is done by copying the test once for each transport and injecting
1368
the transport_server, transport_readonly_server, and branch_format
1369
classes into each copy. Each copy is also given a new id() to make it
1373
def __init__(self, transport_server, transport_readonly_server, formats):
1374
self._transport_server = transport_server
1375
self._transport_readonly_server = transport_readonly_server
1376
self._formats = formats
1378
def adapt(self, test):
1379
result = TestSuite()
1380
for branch_format, bzrdir_format in self._formats:
1381
new_test = deepcopy(test)
1382
new_test.transport_server = self._transport_server
1383
new_test.transport_readonly_server = self._transport_readonly_server
1384
new_test.bzrdir_format = bzrdir_format
1385
new_test.branch_format = branch_format
1386
def make_new_test_id():
1387
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1388
return lambda: new_id
1389
new_test.id = make_new_test_id()
1390
result.addTest(new_test)
1394
class BranchCheckResult(object):
1395
"""Results of checking branch consistency.
1400
def __init__(self, branch):
1401
self.branch = branch
1403
def report_results(self, verbose):
1404
"""Report the check results via trace.note.
1406
:param verbose: Requests more detailed display of what was checked,
1409
note('checked branch %s format %s',
1411
self.branch._format)
1414
######################################################################
1418
@deprecated_function(zero_eight)
1419
def ScratchBranch(*args, **kwargs):
1420
"""See bzrlib.bzrdir.ScratchDir."""
1421
d = ScratchDir(*args, **kwargs)
1422
return d.open_branch()
1425
@deprecated_function(zero_eight)
1426
def is_control_file(*args, **kwargs):
1427
"""See bzrlib.workingtree.is_control_file."""
1428
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
