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
27
import xml.sax.saxutils
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
36
import bzrlib.bzrdir as bzrdir
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles, TransportLock
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
56
from bzrlib.textui import show_status
57
from bzrlib.trace import mutter, note
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (
61
get_intervening_revisions,
66
from bzrlib.store import copy_all
67
from bzrlib.symbol_versioning import *
68
import bzrlib.transactions as transactions
69
from bzrlib.transport import Transport, get_transport
70
from bzrlib.tree import EmptyTree, RevisionTree
75
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
76
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
77
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
80
# TODO: Maybe include checks for common corruption of newlines, etc?
82
# TODO: Some operations like log might retrieve the same revisions
83
# repeatedly to calculate deltas. We could perhaps have a weakref
84
# cache in memory to make this faster. In general anything can be
85
# cached in memory between lock and unlock operations. .. nb thats
86
# what the transaction identity map provides
89
######################################################################
93
"""Branch holding a history of revisions.
96
Base directory/url of the branch.
98
# this is really an instance variable - FIXME move it there
102
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
112
def open(base, _unsupported=False):
113
"""Open the repository rooted at base.
115
For instance, if the repository is at URL/.bzr/repository,
116
Repository.open(URL) -> a Repository instance.
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
141
NOTE: This will soon be deprecated in favour of creation
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
146
def setup_caching(self, cache_root):
147
"""Subclasses that care about caching should override this, and set
148
up cached stores located under cache_root.
150
# seems to be unused, 2006-01-13 mbp
151
warn('%s is deprecated' % self.setup_caching)
152
self.cache_root = cache_root
155
cfg = self.tree_config()
156
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
158
def _set_nick(self, nick):
159
cfg = self.tree_config()
160
cfg.set_option(nick, "nickname")
161
assert cfg.get_option("nickname") == nick
163
nick = property(_get_nick, _set_nick)
165
def lock_write(self):
166
raise NotImplementedError('lock_write is abstract')
169
raise NotImplementedError('lock_read is abstract')
172
raise NotImplementedError('unlock is abstract')
174
def peek_lock_mode(self):
175
"""Return lock mode for the Branch: 'r', 'w' or None"""
176
raise NotImplementedError(self.peek_lock_mode)
178
def abspath(self, name):
179
"""Return absolute filename for something in the branch
181
XXX: Robert Collins 20051017 what is this used for? why is it a branch
182
method and not a tree method.
184
raise NotImplementedError('abspath is abstract')
186
def bind(self, other):
187
"""Bind the local branch the other branch.
189
:param other: The branch to bind to
192
raise errors.UpgradeRequired(self.base)
195
def fetch(self, from_branch, last_revision=None, pb=None):
196
"""Copy revisions from from_branch into this branch.
198
:param from_branch: Where to copy from.
199
:param last_revision: What revision to stop at (None for at the end
201
:param pb: An optional progress bar to use.
203
Returns the copied revision count and the failed revisions in a tuple:
206
if self.base == from_branch.base:
207
raise Exception("can't fetch from a branch to itself %s, %s" %
208
(self.base, to_branch.base))
210
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
215
from_branch.lock_read()
217
if last_revision is None:
218
pb.update('get source history')
219
from_history = from_branch.revision_history()
221
last_revision = from_history[-1]
223
# no history in the source branch
224
last_revision = NULL_REVISION
225
return self.repository.fetch(from_branch.repository,
226
revision_id=last_revision,
229
if nested_pb is not None:
233
def get_bound_location(self):
234
"""Return the URL of the rbanch we are bound to.
236
Older format branches cannot bind, please be sure to use a metadir
241
def get_master_branch(self):
242
"""Return the branch we are bound to.
244
:return: Either a Branch, or None
248
def get_root_id(self):
249
"""Return the id of this branches root"""
250
raise NotImplementedError('get_root_id is abstract')
252
def print_file(self, file, revision_id):
253
"""Print `file` to stdout."""
254
raise NotImplementedError('print_file is abstract')
256
def append_revision(self, *revision_ids):
257
raise NotImplementedError('append_revision is abstract')
259
def set_revision_history(self, rev_history):
260
raise NotImplementedError('set_revision_history is abstract')
262
def revision_history(self):
263
"""Return sequence of revision hashes on to this branch."""
264
raise NotImplementedError('revision_history is abstract')
267
"""Return current revision number for this branch.
269
That is equivalent to the number of revisions committed to
272
return len(self.revision_history())
275
"""Older format branches cannot bind or unbind."""
276
raise errors.UpgradeRequired(self.base)
278
def last_revision(self):
279
"""Return last patch hash, or None if no history."""
280
ph = self.revision_history()
286
def missing_revisions(self, other, stop_revision=None):
287
"""Return a list of new revisions that would perfectly fit.
289
If self and other have not diverged, return a list of the revisions
290
present in other, but missing from self.
292
>>> from bzrlib.workingtree import WorkingTree
293
>>> bzrlib.trace.silent = True
294
>>> d1 = bzrdir.ScratchDir()
295
>>> br1 = d1.open_branch()
296
>>> wt1 = d1.open_workingtree()
297
>>> d2 = bzrdir.ScratchDir()
298
>>> br2 = d2.open_branch()
299
>>> wt2 = d2.open_workingtree()
300
>>> br1.missing_revisions(br2)
302
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
303
>>> br1.missing_revisions(br2)
305
>>> br2.missing_revisions(br1)
307
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
308
>>> br1.missing_revisions(br2)
310
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
311
>>> br1.missing_revisions(br2)
313
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
314
>>> br1.missing_revisions(br2)
315
Traceback (most recent call last):
316
DivergedBranches: These branches have diverged. Try merge.
318
self_history = self.revision_history()
319
self_len = len(self_history)
320
other_history = other.revision_history()
321
other_len = len(other_history)
322
common_index = min(self_len, other_len) -1
323
if common_index >= 0 and \
324
self_history[common_index] != other_history[common_index]:
325
raise DivergedBranches(self, other)
327
if stop_revision is None:
328
stop_revision = other_len
330
assert isinstance(stop_revision, int)
331
if stop_revision > other_len:
332
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
333
return other_history[self_len:stop_revision]
335
def update_revisions(self, other, stop_revision=None):
336
"""Pull in new perfect-fit revisions.
338
:param other: Another Branch to pull from
339
:param stop_revision: Updated until the given revision
342
raise NotImplementedError('update_revisions is abstract')
344
def pullable_revisions(self, other, stop_revision):
345
raise NotImplementedError('pullable_revisions is abstract')
347
def revision_id_to_revno(self, revision_id):
348
"""Given a revision id, return its revno"""
349
if revision_id is None:
351
history = self.revision_history()
353
return history.index(revision_id) + 1
355
raise bzrlib.errors.NoSuchRevision(self, revision_id)
357
def get_rev_id(self, revno, history=None):
358
"""Find the revision id of the specified revno."""
362
history = self.revision_history()
363
elif revno <= 0 or revno > len(history):
364
raise bzrlib.errors.NoSuchRevision(self, revno)
365
return history[revno - 1]
367
def pull(self, source, overwrite=False, stop_revision=None):
368
raise NotImplementedError('pull is abstract')
370
def basis_tree(self):
371
"""Return `Tree` object for last revision.
373
If there are no revisions yet, return an `EmptyTree`.
375
return self.repository.revision_tree(self.last_revision())
377
def rename_one(self, from_rel, to_rel):
380
This can change the directory or the filename or both.
382
raise NotImplementedError('rename_one is abstract')
384
def move(self, from_paths, to_name):
387
to_name must exist as a versioned directory.
389
If to_name exists and is a directory, the files are moved into
390
it, keeping their old names. If it is a directory,
392
Note that to_name is only the last component of the new name;
393
this doesn't change the directory.
395
This returns a list of (from_path, to_path) pairs for each
398
raise NotImplementedError('move is abstract')
400
def get_parent(self):
401
"""Return the parent location of the branch.
403
This is the default location for push/pull/missing. The usual
404
pattern is that the user can override it by specifying a
407
raise NotImplementedError('get_parent is abstract')
409
def get_push_location(self):
410
"""Return the None or the location to push this branch to."""
411
raise NotImplementedError('get_push_location is abstract')
413
def set_push_location(self, location):
414
"""Set a new push location for this branch."""
415
raise NotImplementedError('set_push_location is abstract')
417
def set_parent(self, url):
418
raise NotImplementedError('set_parent is abstract')
422
"""Synchronise this branch with the master branch if any.
424
:return: None or the last_revision pivoted out during the update.
428
def check_revno(self, revno):
430
Check whether a revno corresponds to any revision.
431
Zero (the NULL revision) is considered valid.
434
self.check_real_revno(revno)
436
def check_real_revno(self, revno):
438
Check whether a revno corresponds to a real revision.
439
Zero (the NULL revision) is considered invalid
441
if revno < 1 or revno > self.revno():
442
raise InvalidRevisionNumber(revno)
445
def clone(self, *args, **kwargs):
446
"""Clone this branch into to_bzrdir preserving all semantic values.
448
revision_id: if not None, the revision history in the new branch will
449
be truncated to end with revision_id.
451
# for API compatability, until 0.8 releases we provide the old api:
452
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
453
# after 0.8 releases, the *args and **kwargs should be changed:
454
# def clone(self, to_bzrdir, revision_id=None):
455
if (kwargs.get('to_location', None) or
456
kwargs.get('revision', None) or
457
kwargs.get('basis_branch', None) or
458
(len(args) and isinstance(args[0], basestring))):
459
# backwards compatability api:
460
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
461
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
464
basis_branch = args[2]
466
basis_branch = kwargs.get('basis_branch', None)
468
basis = basis_branch.bzrdir
473
revision_id = args[1]
475
revision_id = kwargs.get('revision', None)
480
# no default to raise if not provided.
481
url = kwargs.get('to_location')
482
return self.bzrdir.clone(url,
483
revision_id=revision_id,
484
basis=basis).open_branch()
486
# generate args by hand
488
revision_id = args[1]
490
revision_id = kwargs.get('revision_id', None)
494
# no default to raise if not provided.
495
to_bzrdir = kwargs.get('to_bzrdir')
496
result = self._format.initialize(to_bzrdir)
497
self.copy_content_into(result, revision_id=revision_id)
501
def sprout(self, to_bzrdir, revision_id=None):
502
"""Create a new line of development from the branch, into to_bzrdir.
504
revision_id: if not None, the revision history in the new branch will
505
be truncated to end with revision_id.
507
result = self._format.initialize(to_bzrdir)
508
self.copy_content_into(result, revision_id=revision_id)
509
result.set_parent(self.bzrdir.root_transport.base)
513
def copy_content_into(self, destination, revision_id=None):
514
"""Copy the content of self into destination.
516
revision_id: if not None, the revision history in the new branch will
517
be truncated to end with revision_id.
519
new_history = self.revision_history()
520
if revision_id is not None:
522
new_history = new_history[:new_history.index(revision_id) + 1]
524
rev = self.repository.get_revision(revision_id)
525
new_history = rev.get_history(self.repository)[1:]
526
destination.set_revision_history(new_history)
527
parent = self.get_parent()
529
destination.set_parent(parent)
532
class BranchFormat(object):
533
"""An encapsulation of the initialization and open routines for a format.
535
Formats provide three things:
536
* An initialization routine,
540
Formats are placed in an dict by their format string for reference
541
during branch opening. Its not required that these be instances, they
542
can be classes themselves with class methods - it simply depends on
543
whether state is needed for a given format or not.
545
Once a format is deprecated, just deprecate the initialize and open
546
methods on the format class. Do not deprecate the object, as the
547
object will be created every time regardless.
550
_default_format = None
551
"""The default format used for new branches."""
554
"""The known formats."""
557
def find_format(klass, a_bzrdir):
558
"""Return the format for the branch object in a_bzrdir."""
560
transport = a_bzrdir.get_branch_transport(None)
561
format_string = transport.get("format").read()
562
return klass._formats[format_string]
564
raise NotBranchError(path=transport.base)
566
raise errors.UnknownFormatError(format_string)
569
def get_default_format(klass):
570
"""Return the current default format."""
571
return klass._default_format
573
def get_format_string(self):
574
"""Return the ASCII format string that identifies this format."""
575
raise NotImplementedError(self.get_format_string)
577
def initialize(self, a_bzrdir):
578
"""Create a branch of this format in a_bzrdir."""
579
raise NotImplementedError(self.initialized)
581
def is_supported(self):
582
"""Is this format supported?
584
Supported formats can be initialized and opened.
585
Unsupported formats may not support initialization or committing or
586
some other features depending on the reason for not being supported.
590
def open(self, a_bzrdir, _found=False):
591
"""Return the branch object for a_bzrdir
593
_found is a private parameter, do not use it. It is used to indicate
594
if format probing has already be done.
596
raise NotImplementedError(self.open)
599
def register_format(klass, format):
600
klass._formats[format.get_format_string()] = format
603
def set_default_format(klass, format):
604
klass._default_format = format
607
def unregister_format(klass, format):
608
assert klass._formats[format.get_format_string()] is format
609
del klass._formats[format.get_format_string()]
612
class BzrBranchFormat4(BranchFormat):
613
"""Bzr branch format 4.
616
- a revision-history file.
617
- a branch-lock lock file [ to be shared with the bzrdir ]
620
def initialize(self, a_bzrdir):
621
"""Create a branch of this format in a_bzrdir."""
622
mutter('creating branch in %s', a_bzrdir.transport.base)
623
branch_transport = a_bzrdir.get_branch_transport(self)
624
utf8_files = [('revision-history', ''),
627
control_files = LockableFiles(branch_transport, 'branch-lock',
629
control_files.create_lock()
630
control_files.lock_write()
632
for file, content in utf8_files:
633
control_files.put_utf8(file, content)
635
control_files.unlock()
636
return self.open(a_bzrdir, _found=True)
639
super(BzrBranchFormat4, self).__init__()
640
self._matchingbzrdir = bzrdir.BzrDirFormat6()
642
def open(self, a_bzrdir, _found=False):
643
"""Return the branch object for a_bzrdir
645
_found is a private parameter, do not use it. It is used to indicate
646
if format probing has already be done.
649
# we are being called directly and must probe.
650
raise NotImplementedError
651
return BzrBranch(_format=self,
652
_control_files=a_bzrdir._control_files,
654
_repository=a_bzrdir.open_repository())
657
class BzrBranchFormat5(BranchFormat):
658
"""Bzr branch format 5.
661
- a revision-history file.
664
- works with shared repositories.
667
def get_format_string(self):
668
"""See BranchFormat.get_format_string()."""
669
return "Bazaar-NG branch format 5\n"
671
def initialize(self, a_bzrdir):
672
"""Create a branch of this format in a_bzrdir."""
673
mutter('creating branch in %s', a_bzrdir.transport.base)
674
branch_transport = a_bzrdir.get_branch_transport(self)
676
utf8_files = [('revision-history', ''),
679
control_files = LockableFiles(branch_transport, 'lock', TransportLock)
680
control_files.create_lock()
681
control_files.lock_write()
682
control_files.put_utf8('format', self.get_format_string())
684
for file, content in utf8_files:
685
control_files.put_utf8(file, content)
687
control_files.unlock()
688
return self.open(a_bzrdir, _found=True, )
691
super(BzrBranchFormat5, self).__init__()
692
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
694
def open(self, a_bzrdir, _found=False):
695
"""Return the branch object for a_bzrdir
697
_found is a private parameter, do not use it. It is used to indicate
698
if format probing has already be done.
701
format = BranchFormat.find_format(a_bzrdir)
702
assert format.__class__ == self.__class__
703
transport = a_bzrdir.get_branch_transport(None)
704
control_files = LockableFiles(transport, 'lock', TransportLock)
705
return BzrBranch5(_format=self,
706
_control_files=control_files,
708
_repository=a_bzrdir.find_repository())
711
return "Bazaar-NG Metadir branch format 5"
714
class BranchReferenceFormat(BranchFormat):
715
"""Bzr branch reference format.
717
Branch references are used in implementing checkouts, they
718
act as an alias to the real branch which is at some other url.
725
def get_format_string(self):
726
"""See BranchFormat.get_format_string()."""
727
return "Bazaar-NG Branch Reference Format 1\n"
729
def initialize(self, a_bzrdir, target_branch=None):
730
"""Create a branch of this format in a_bzrdir."""
731
if target_branch is None:
732
# this format does not implement branch itself, thus the implicit
733
# creation contract must see it as uninitializable
734
raise errors.UninitializableFormat(self)
735
mutter('creating branch reference in %s', a_bzrdir.transport.base)
736
branch_transport = a_bzrdir.get_branch_transport(self)
737
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
738
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
739
branch_transport.put('format', StringIO(self.get_format_string()))
740
return self.open(a_bzrdir, _found=True)
743
super(BranchReferenceFormat, self).__init__()
744
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
746
def _make_reference_clone_function(format, a_branch):
747
"""Create a clone() routine for a branch dynamically."""
748
def clone(to_bzrdir, revision_id=None):
749
"""See Branch.clone()."""
750
return format.initialize(to_bzrdir, a_branch)
751
# cannot obey revision_id limits when cloning a reference ...
752
# FIXME RBC 20060210 either nuke revision_id for clone, or
753
# emit some sort of warning/error to the caller ?!
756
def open(self, a_bzrdir, _found=False):
757
"""Return the branch that the branch reference in a_bzrdir points at.
759
_found is a private parameter, do not use it. It is used to indicate
760
if format probing has already be done.
763
format = BranchFormat.find_format(a_bzrdir)
764
assert format.__class__ == self.__class__
765
transport = a_bzrdir.get_branch_transport(None)
766
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
767
result = real_bzrdir.open_branch()
768
# this changes the behaviour of result.clone to create a new reference
769
# rather than a copy of the content of the branch.
770
# I did not use a proxy object because that needs much more extensive
771
# testing, and we are only changing one behaviour at the moment.
772
# If we decide to alter more behaviours - i.e. the implicit nickname
773
# then this should be refactored to introduce a tested proxy branch
774
# and a subclass of that for use in overriding clone() and ....
776
result.clone = self._make_reference_clone_function(result)
780
# formats which have no format string are not discoverable
781
# and not independently creatable, so are not registered.
782
__default_format = BzrBranchFormat5()
783
BranchFormat.register_format(__default_format)
784
BranchFormat.register_format(BranchReferenceFormat())
785
BranchFormat.set_default_format(__default_format)
786
_legacy_formats = [BzrBranchFormat4(),
789
class BzrBranch(Branch):
790
"""A branch stored in the actual filesystem.
792
Note that it's "local" in the context of the filesystem; it doesn't
793
really matter if it's on an nfs/smb/afs/coda/... share, as long as
794
it's writable, and can be accessed via the normal filesystem API.
797
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
798
relax_version_check=DEPRECATED_PARAMETER, _format=None,
799
_control_files=None, a_bzrdir=None, _repository=None):
800
"""Create new branch object at a particular location.
802
transport -- A Transport object, defining how to access files.
804
init -- If True, create new control files in a previously
805
unversioned directory. If False, the branch must already
808
relax_version_check -- If true, the usual check for the branch
809
version is not applied. This is intended only for
810
upgrade/recovery type use; it's not guaranteed that
811
all operations will work on old format branches.
814
self.bzrdir = bzrdir.BzrDir.open(transport.base)
816
self.bzrdir = a_bzrdir
817
self._transport = self.bzrdir.transport.clone('..')
818
self._base = self._transport.base
819
self._format = _format
820
if _control_files is None:
821
raise BzrBadParameterMissing('_control_files')
822
self.control_files = _control_files
823
if deprecated_passed(init):
824
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
825
"deprecated as of bzr 0.8. Please use Branch.create().",
829
# this is slower than before deprecation, oh well never mind.
831
self._initialize(transport.base)
832
self._check_format(_format)
833
if deprecated_passed(relax_version_check):
834
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
835
"relax_version_check parameter is deprecated as of bzr 0.8. "
836
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
840
if (not relax_version_check
841
and not self._format.is_supported()):
842
raise errors.UnsupportedFormatError(
843
'sorry, branch format %r not supported' % fmt,
844
['use a different bzr version',
845
'or remove the .bzr directory'
846
' and "bzr init" again'])
847
if deprecated_passed(transport):
848
warn("BzrBranch.__init__(transport=XXX...): The transport "
849
"parameter is deprecated as of bzr 0.8. "
850
"Please use Branch.open, or bzrdir.open_branch().",
853
self.repository = _repository
856
return '%s(%r)' % (self.__class__.__name__, self.base)
861
# TODO: It might be best to do this somewhere else,
862
# but it is nice for a Branch object to automatically
863
# cache it's information.
864
# Alternatively, we could have the Transport objects cache requests
865
# See the earlier discussion about how major objects (like Branch)
866
# should never expect their __del__ function to run.
867
# XXX: cache_root seems to be unused, 2006-01-13 mbp
868
if hasattr(self, 'cache_root') and self.cache_root is not None:
870
shutil.rmtree(self.cache_root)
873
self.cache_root = None
878
base = property(_get_base, doc="The URL for the root of this branch.")
880
def _finish_transaction(self):
881
"""Exit the current transaction."""
882
return self.control_files._finish_transaction()
884
def get_transaction(self):
885
"""Return the current active transaction.
887
If no transaction is active, this returns a passthrough object
888
for which all data is immediately flushed and no caching happens.
890
# this is an explicit function so that we can do tricky stuff
891
# when the storage in rev_storage is elsewhere.
892
# we probably need to hook the two 'lock a location' and
893
# 'have a transaction' together more delicately, so that
894
# we can have two locks (branch and storage) and one transaction
895
# ... and finishing the transaction unlocks both, but unlocking
896
# does not. - RBC 20051121
897
return self.control_files.get_transaction()
899
def _set_transaction(self, transaction):
900
"""Set a new active transaction."""
901
return self.control_files._set_transaction(transaction)
903
def abspath(self, name):
904
"""See Branch.abspath."""
905
return self.control_files._transport.abspath(name)
907
def _check_format(self, format):
908
"""Identify the branch format if needed.
910
The format is stored as a reference to the format object in
911
self._format for code that needs to check it later.
913
The format parameter is either None or the branch format class
914
used to open this branch.
916
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
919
format = BzrBranchFormat.find_format(self.bzrdir)
920
self._format = format
921
mutter("got branch format %s", self._format)
924
def get_root_id(self):
925
"""See Branch.get_root_id."""
926
tree = self.repository.revision_tree(self.last_revision())
927
return tree.inventory.root.file_id
929
def lock_write(self):
930
# TODO: test for failed two phase locks. This is known broken.
931
self.control_files.lock_write()
932
self.repository.lock_write()
935
# TODO: test for failed two phase locks. This is known broken.
936
self.control_files.lock_read()
937
self.repository.lock_read()
940
# TODO: test for failed two phase locks. This is known broken.
941
self.repository.unlock()
942
self.control_files.unlock()
944
def peek_lock_mode(self):
945
if self.control_files._lock_count == 0:
948
return self.control_files._lock_mode
951
def print_file(self, file, revision_id):
952
"""See Branch.print_file."""
953
return self.repository.print_file(file, revision_id)
956
def append_revision(self, *revision_ids):
957
"""See Branch.append_revision."""
958
for revision_id in revision_ids:
959
mutter("add {%s} to revision-history" % revision_id)
960
rev_history = self.revision_history()
961
rev_history.extend(revision_ids)
962
self.set_revision_history(rev_history)
965
def set_revision_history(self, rev_history):
966
"""See Branch.set_revision_history."""
967
self.control_files.put_utf8(
968
'revision-history', '\n'.join(rev_history))
969
transaction = self.get_transaction()
970
history = transaction.map.find_revision_history()
971
if history is not None:
972
# update the revision history in the identity map.
973
history[:] = list(rev_history)
974
# this call is disabled because revision_history is
975
# not really an object yet, and the transaction is for objects.
976
# transaction.register_dirty(history)
978
transaction.map.add_revision_history(rev_history)
979
# this call is disabled because revision_history is
980
# not really an object yet, and the transaction is for objects.
981
# transaction.register_clean(history)
983
def get_revision_delta(self, revno):
984
"""Return the delta for one revision.
986
The delta is relative to its mainline predecessor, or the
987
empty tree for revision 1.
989
assert isinstance(revno, int)
990
rh = self.revision_history()
991
if not (1 <= revno <= len(rh)):
992
raise InvalidRevisionNumber(revno)
994
# revno is 1-based; list is 0-based
996
new_tree = self.repository.revision_tree(rh[revno-1])
998
old_tree = EmptyTree()
1000
old_tree = self.repository.revision_tree(rh[revno-2])
1001
return compare_trees(old_tree, new_tree)
1004
def revision_history(self):
1005
"""See Branch.revision_history."""
1006
transaction = self.get_transaction()
1007
history = transaction.map.find_revision_history()
1008
if history is not None:
1009
mutter("cache hit for revision-history in %s", self)
1010
return list(history)
1011
history = [l.rstrip('\r\n') for l in
1012
self.control_files.get_utf8('revision-history').readlines()]
1013
transaction.map.add_revision_history(history)
1014
# this call is disabled because revision_history is
1015
# not really an object yet, and the transaction is for objects.
1016
# transaction.register_clean(history, precious=True)
1017
return list(history)
1019
def update_revisions(self, other, stop_revision=None):
1020
"""See Branch.update_revisions."""
1021
if stop_revision is None:
1022
stop_revision = other.last_revision()
1023
### Should this be checking is_ancestor instead of revision_history?
1024
if (stop_revision is not None and
1025
stop_revision in self.revision_history()):
1027
self.fetch(other, stop_revision)
1028
pullable_revs = self.pullable_revisions(other, stop_revision)
1029
if len(pullable_revs) > 0:
1030
self.append_revision(*pullable_revs)
1032
def pullable_revisions(self, other, stop_revision):
1033
other_revno = other.revision_id_to_revno(stop_revision)
1035
return self.missing_revisions(other, other_revno)
1036
except DivergedBranches, e:
1038
pullable_revs = get_intervening_revisions(self.last_revision(),
1041
assert self.last_revision() not in pullable_revs
1042
return pullable_revs
1043
except bzrlib.errors.NotAncestor:
1044
if is_ancestor(self.last_revision(), stop_revision, self):
1049
def basis_tree(self):
1050
"""See Branch.basis_tree."""
1051
return self.repository.revision_tree(self.last_revision())
1053
@deprecated_method(zero_eight)
1054
def working_tree(self):
1055
"""Create a Working tree object for this branch."""
1056
from bzrlib.workingtree import WorkingTree
1057
from bzrlib.transport.local import LocalTransport
1058
if (self.base.find('://') != -1 or
1059
not isinstance(self._transport, LocalTransport)):
1060
raise NoWorkingTree(self.base)
1061
return self.bzrdir.open_workingtree()
1064
def pull(self, source, overwrite=False, stop_revision=None):
1065
"""See Branch.pull."""
1068
old_count = len(self.revision_history())
1070
self.update_revisions(source,stop_revision)
1071
except DivergedBranches:
1075
self.set_revision_history(source.revision_history())
1076
new_count = len(self.revision_history())
1077
return new_count - old_count
1081
def get_parent(self):
1082
"""See Branch.get_parent."""
1084
_locs = ['parent', 'pull', 'x-pull']
1087
return self.control_files.get_utf8(l).read().strip('\n')
1092
def get_push_location(self):
1093
"""See Branch.get_push_location."""
1094
config = bzrlib.config.BranchConfig(self)
1095
push_loc = config.get_user_option('push_location')
1098
def set_push_location(self, location):
1099
"""See Branch.set_push_location."""
1100
config = bzrlib.config.LocationConfig(self.base)
1101
config.set_user_option('push_location', location)
1104
def set_parent(self, url):
1105
"""See Branch.set_parent."""
1106
# TODO: Maybe delete old location files?
1107
# URLs should never be unicode, even on the local fs,
1108
# FIXUP this and get_parent in a future branch format bump:
1109
# read and rewrite the file, and have the new format code read
1110
# using .get not .get_utf8. RBC 20060125
1111
self.control_files.put_utf8('parent', url + '\n')
1113
def tree_config(self):
1114
return TreeConfig(self)
1117
class BzrBranch5(BzrBranch):
1118
"""A format 5 branch. This supports new features over plan branches.
1120
It has support for a master_branch which is the data for bound branches.
1128
super(BzrBranch5, self).__init__(_format=_format,
1129
_control_files=_control_files,
1131
_repository=_repository)
1134
def pull(self, source, overwrite=False, stop_revision=None):
1135
"""Updates branch.pull to be bound branch aware."""
1136
bound_location = self.get_bound_location()
1137
if source.base != bound_location:
1138
# not pulling from master, so we need to update master.
1139
master_branch = self.get_master_branch()
1141
master_branch.pull(source)
1142
source = master_branch
1143
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1145
def get_bound_location(self):
1147
return self.control_files.get_utf8('bound').read()[:-1]
1148
except errors.NoSuchFile:
1152
def get_master_branch(self):
1153
"""Return the branch we are bound to.
1155
:return: Either a Branch, or None
1157
This could memoise the branch, but if thats done
1158
it must be revalidated on each new lock.
1159
So for now we just dont memoise it.
1160
# RBC 20060304 review this decision.
1162
bound_loc = self.get_bound_location()
1166
return Branch.open(bound_loc)
1167
except (errors.NotBranchError, errors.ConnectionError), e:
1168
raise errors.BoundBranchConnectionFailure(
1172
def set_bound_location(self, location):
1173
"""Set the target where this branch is bound to.
1175
:param location: URL to the target branch
1178
self.control_files.put_utf8('bound', location+'\n')
1181
self.control_files._transport.delete('bound')
1187
def bind(self, other):
1188
"""Bind the local branch the other branch.
1190
:param other: The branch to bind to
1193
# TODO: jam 20051230 Consider checking if the target is bound
1194
# It is debatable whether you should be able to bind to
1195
# a branch which is itself bound.
1196
# Committing is obviously forbidden,
1197
# but binding itself may not be.
1198
# Since we *have* to check at commit time, we don't
1199
# *need* to check here
1202
# we are now equal to or a suffix of other.
1204
# Since we have 'pulled' from the remote location,
1205
# now we should try to pull in the opposite direction
1206
# in case the local tree has more revisions than the
1208
# There may be a different check you could do here
1209
# rather than actually trying to install revisions remotely.
1210
# TODO: capture an exception which indicates the remote branch
1212
# If it is up-to-date, this probably should not be a failure
1214
# lock other for write so the revision-history syncing cannot race
1218
# if this does not error, other now has the same last rev we do
1219
# it can only error if the pull from other was concurrent with
1220
# a commit to other from someone else.
1222
# until we ditch revision-history, we need to sync them up:
1223
self.set_revision_history(other.revision_history())
1224
# now other and self are up to date with each other and have the
1225
# same revision-history.
1229
self.set_bound_location(other.base)
1233
"""If bound, unbind"""
1234
return self.set_bound_location(None)
1238
"""Synchronise this branch with the master branch if any.
1240
:return: None or the last_revision that was pivoted out during the
1243
master = self.get_master_branch()
1244
if master is not None:
1245
old_tip = self.last_revision()
1246
self.pull(master, overwrite=True)
1247
if old_tip in self.repository.get_ancestry(self.last_revision()):
1253
class BranchTestProviderAdapter(object):
1254
"""A tool to generate a suite testing multiple branch formats at once.
1256
This is done by copying the test once for each transport and injecting
1257
the transport_server, transport_readonly_server, and branch_format
1258
classes into each copy. Each copy is also given a new id() to make it
1262
def __init__(self, transport_server, transport_readonly_server, formats):
1263
self._transport_server = transport_server
1264
self._transport_readonly_server = transport_readonly_server
1265
self._formats = formats
1267
def adapt(self, test):
1268
result = TestSuite()
1269
for branch_format, bzrdir_format in self._formats:
1270
new_test = deepcopy(test)
1271
new_test.transport_server = self._transport_server
1272
new_test.transport_readonly_server = self._transport_readonly_server
1273
new_test.bzrdir_format = bzrdir_format
1274
new_test.branch_format = branch_format
1275
def make_new_test_id():
1276
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1277
return lambda: new_id
1278
new_test.id = make_new_test_id()
1279
result.addTest(new_test)
1283
######################################################################
1287
@deprecated_function(zero_eight)
1288
def ScratchBranch(*args, **kwargs):
1289
"""See bzrlib.bzrdir.ScratchDir."""
1290
d = ScratchDir(*args, **kwargs)
1291
return d.open_branch()
1294
@deprecated_function(zero_eight)
1295
def is_control_file(*args, **kwargs):
1296
"""See bzrlib.workingtree.is_control_file."""
1297
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
