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
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 (Revision, is_ancestor, get_intervening_revisions)
61
from bzrlib.store import copy_all
62
from bzrlib.symbol_versioning import *
63
import bzrlib.transactions as transactions
64
from bzrlib.transport import Transport, get_transport
65
from bzrlib.tree import EmptyTree, RevisionTree
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
71
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
72
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
75
# TODO: Maybe include checks for common corruption of newlines, etc?
77
# TODO: Some operations like log might retrieve the same revisions
78
# repeatedly to calculate deltas. We could perhaps have a weakref
79
# cache in memory to make this faster. In general anything can be
80
# cached in memory between lock and unlock operations. .. nb thats
81
# what the transaction identity map provides
84
######################################################################
88
"""Branch holding a history of revisions.
91
Base directory/url of the branch.
93
# this is really an instance variable - FIXME move it there
99
"""Construct the current default format branch in a_bzrdir.
101
This creates the current default BzrDir format, and if that
102
supports multiple Branch formats, then the default Branch format
105
print "not usable until we have repositories"
106
raise NotImplementedError("not usable right now")
107
return bzrdir.BzrDir.create(base)
109
def __init__(self, *ignored, **ignored_too):
110
raise NotImplementedError('The Branch class is abstract')
113
@deprecated_method(zero_eight)
114
def open_downlevel(base):
115
"""Open a branch which may be of an old format."""
116
return Branch.open(base, _unsupported=True)
119
def open(base, _unsupported=False):
120
"""Open the repository rooted at base.
122
For instance, if the repository is at URL/.bzr/repository,
123
Repository.open(URL) -> a Repository instance.
125
control = bzrdir.BzrDir.open(base, _unsupported)
126
return control.open_branch(_unsupported)
129
def open_containing(url):
130
"""Open an existing branch which contains url.
132
This probes for a branch at url, and searches upwards from there.
134
Basically we keep looking up until we find the control directory or
135
run into the root. If there isn't one, raises NotBranchError.
136
If there is one and it is either an unrecognised format or an unsupported
137
format, UnknownFormatError or UnsupportedFormatError are raised.
138
If there is one, it is returned, along with the unused portion of url.
140
control, relpath = bzrdir.BzrDir.open_containing(url)
141
return control.open_branch(), relpath
144
@deprecated_function(zero_eight)
145
def initialize(base):
146
"""Create a new working tree and branch, rooted at 'base' (url)
148
NOTE: This will soon be deprecated in favour of creation
151
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
153
def setup_caching(self, cache_root):
154
"""Subclasses that care about caching should override this, and set
155
up cached stores located under cache_root.
157
# seems to be unused, 2006-01-13 mbp
158
warn('%s is deprecated' % self.setup_caching)
159
self.cache_root = cache_root
162
cfg = self.tree_config()
163
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
165
def _set_nick(self, nick):
166
cfg = self.tree_config()
167
cfg.set_option(nick, "nickname")
168
assert cfg.get_option("nickname") == nick
170
nick = property(_get_nick, _set_nick)
172
def lock_write(self):
173
raise NotImplementedError('lock_write is abstract')
176
raise NotImplementedError('lock_read is abstract')
179
raise NotImplementedError('unlock is abstract')
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def abspath(self, name):
186
"""Return absolute filename for something in the branch
188
XXX: Robert Collins 20051017 what is this used for? why is it a branch
189
method and not a tree method.
191
raise NotImplementedError('abspath is abstract')
193
def get_root_id(self):
194
"""Return the id of this branches root"""
195
raise NotImplementedError('get_root_id is abstract')
197
def print_file(self, file, revision_id):
198
"""Print `file` to stdout."""
199
raise NotImplementedError('print_file is abstract')
201
def append_revision(self, *revision_ids):
202
raise NotImplementedError('append_revision is abstract')
204
def set_revision_history(self, rev_history):
205
raise NotImplementedError('set_revision_history is abstract')
207
def revision_history(self):
208
"""Return sequence of revision hashes on to this branch."""
209
raise NotImplementedError('revision_history is abstract')
212
"""Return current revision number for this branch.
214
That is equivalent to the number of revisions committed to
217
return len(self.revision_history())
219
def last_revision(self):
220
"""Return last patch hash, or None if no history."""
221
ph = self.revision_history()
227
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
228
"""Return a list of new revisions that would perfectly fit.
230
If self and other have not diverged, return a list of the revisions
231
present in other, but missing from self.
233
>>> from bzrlib.workingtree import WorkingTree
234
>>> bzrlib.trace.silent = True
235
>>> d1 = bzrdir.ScratchDir()
236
>>> br1 = d1.open_branch()
237
>>> wt1 = WorkingTree(br1.base, br1)
238
>>> d2 = bzrdir.ScratchDir()
239
>>> br2 = d2.open_branch()
240
>>> wt2 = WorkingTree(br2.base, br2)
241
>>> br1.missing_revisions(br2)
243
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
244
>>> br1.missing_revisions(br2)
246
>>> br2.missing_revisions(br1)
248
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
249
>>> br1.missing_revisions(br2)
251
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
252
>>> br1.missing_revisions(br2)
254
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
255
>>> br1.missing_revisions(br2)
256
Traceback (most recent call last):
257
DivergedBranches: These branches have diverged. Try merge.
259
self_history = self.revision_history()
260
self_len = len(self_history)
261
other_history = other.revision_history()
262
other_len = len(other_history)
263
common_index = min(self_len, other_len) -1
264
if common_index >= 0 and \
265
self_history[common_index] != other_history[common_index]:
266
raise DivergedBranches(self, other)
268
if stop_revision is None:
269
stop_revision = other_len
271
assert isinstance(stop_revision, int)
272
if stop_revision > other_len:
273
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
274
return other_history[self_len:stop_revision]
276
def update_revisions(self, other, stop_revision=None):
277
"""Pull in new perfect-fit revisions."""
278
raise NotImplementedError('update_revisions is abstract')
280
def pullable_revisions(self, other, stop_revision):
281
raise NotImplementedError('pullable_revisions is abstract')
283
def revision_id_to_revno(self, revision_id):
284
"""Given a revision id, return its revno"""
285
if revision_id is None:
287
history = self.revision_history()
289
return history.index(revision_id) + 1
291
raise bzrlib.errors.NoSuchRevision(self, revision_id)
293
def get_rev_id(self, revno, history=None):
294
"""Find the revision id of the specified revno."""
298
history = self.revision_history()
299
elif revno <= 0 or revno > len(history):
300
raise bzrlib.errors.NoSuchRevision(self, revno)
301
return history[revno - 1]
303
def pull(self, source, overwrite=False):
304
raise NotImplementedError('pull is abstract')
306
def basis_tree(self):
307
"""Return `Tree` object for last revision.
309
If there are no revisions yet, return an `EmptyTree`.
311
return self.repository.revision_tree(self.last_revision())
313
def rename_one(self, from_rel, to_rel):
316
This can change the directory or the filename or both.
318
raise NotImplementedError('rename_one is abstract')
320
def move(self, from_paths, to_name):
323
to_name must exist as a versioned directory.
325
If to_name exists and is a directory, the files are moved into
326
it, keeping their old names. If it is a directory,
328
Note that to_name is only the last component of the new name;
329
this doesn't change the directory.
331
This returns a list of (from_path, to_path) pairs for each
334
raise NotImplementedError('move is abstract')
336
def get_parent(self):
337
"""Return the parent location of the branch.
339
This is the default location for push/pull/missing. The usual
340
pattern is that the user can override it by specifying a
343
raise NotImplementedError('get_parent is abstract')
345
def get_push_location(self):
346
"""Return the None or the location to push this branch to."""
347
raise NotImplementedError('get_push_location is abstract')
349
def set_push_location(self, location):
350
"""Set a new push location for this branch."""
351
raise NotImplementedError('set_push_location is abstract')
353
def set_parent(self, url):
354
raise NotImplementedError('set_parent is abstract')
356
def check_revno(self, revno):
358
Check whether a revno corresponds to any revision.
359
Zero (the NULL revision) is considered valid.
362
self.check_real_revno(revno)
364
def check_real_revno(self, revno):
366
Check whether a revno corresponds to a real revision.
367
Zero (the NULL revision) is considered invalid
369
if revno < 1 or revno > self.revno():
370
raise InvalidRevisionNumber(revno)
373
def clone(self, *args, **kwargs):
374
"""Clone this branch into to_bzrdir preserving all semantic values.
376
revision_id: if not None, the revision history in the new branch will
377
be truncated to end with revision_id.
379
# for API compatability, until 0.8 releases we provide the old api:
380
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
381
# after 0.8 releases, the *args and **kwargs should be changed:
382
# def clone(self, to_bzrdir, revision_id=None):
383
if (kwargs.get('to_location', None) or
384
kwargs.get('revision', None) or
385
kwargs.get('basis_branch', None) or
386
(len(args) and isinstance(args[0], basestring))):
387
# backwards compatability api:
388
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
389
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
392
basis_branch = args[2]
394
basis_branch = kwargs.get('basis_branch', None)
396
basis = basis_branch.bzrdir
401
revision_id = args[1]
403
revision_id = kwargs.get('revision', None)
408
# no default to raise if not provided.
409
url = kwargs.get('to_location')
410
return self.bzrdir.clone(url,
411
revision_id=revision_id,
412
basis=basis).open_branch()
414
# generate args by hand
416
revision_id = args[1]
418
revision_id = kwargs.get('revision_id', None)
422
# no default to raise if not provided.
423
to_bzrdir = kwargs.get('to_bzrdir')
424
result = self._format.initialize(to_bzrdir)
425
self.copy_content_into(result, revision_id=revision_id)
429
def sprout(self, to_bzrdir, revision_id=None):
430
"""Create a new line of development from the branch, into to_bzrdir.
432
revision_id: if not None, the revision history in the new branch will
433
be truncated to end with revision_id.
435
result = self._format.initialize(to_bzrdir)
436
self.copy_content_into(result, revision_id=revision_id)
437
result.set_parent(self.bzrdir.root_transport.base)
441
def copy_content_into(self, destination, revision_id=None):
442
"""Copy the content of self into destination.
444
revision_id: if not None, the revision history in the new branch will
445
be truncated to end with revision_id.
447
new_history = self.revision_history()
448
if revision_id is not None:
450
new_history = new_history[:new_history.index(revision_id) + 1]
452
rev = self.repository.get_revision(revision_id)
453
new_history = rev.get_history(self.repository)[1:]
454
destination.set_revision_history(new_history)
455
parent = self.get_parent()
457
destination.set_parent(parent)
460
class BranchFormat(object):
461
"""An encapsulation of the initialization and open routines for a format.
463
Formats provide three things:
464
* An initialization routine,
468
Formats are placed in an dict by their format string for reference
469
during branch opening. Its not required that these be instances, they
470
can be classes themselves with class methods - it simply depends on
471
whether state is needed for a given format or not.
473
Once a format is deprecated, just deprecate the initialize and open
474
methods on the format class. Do not deprecate the object, as the
475
object will be created every time regardless.
478
_default_format = None
479
"""The default format used for new branches."""
482
"""The known formats."""
485
def find_format(klass, a_bzrdir):
486
"""Return the format for the branch object in a_bzrdir."""
488
transport = a_bzrdir.get_branch_transport(None)
489
format_string = transport.get("format").read()
490
return klass._formats[format_string]
492
raise NotBranchError(path=transport.base)
494
raise errors.UnknownFormatError(format_string)
497
def get_default_format(klass):
498
"""Return the current default format."""
499
return klass._default_format
501
def get_format_string(self):
502
"""Return the ASCII format string that identifies this format."""
503
raise NotImplementedError(self.get_format_string)
505
def _find_modes(self, t):
506
"""Determine the appropriate modes for files and directories.
508
FIXME: When this merges into, or from storage,
509
this code becomes delgatable to a LockableFiles instance.
511
For now its cribbed and returns (dir_mode, file_mode)
515
except errors.TransportNotPossible:
519
dir_mode = st.st_mode & 07777
520
# Remove the sticky and execute bits for files
521
file_mode = dir_mode & ~07111
522
if not BzrBranch._set_dir_mode:
524
if not BzrBranch._set_file_mode:
526
return dir_mode, file_mode
528
def initialize(self, a_bzrdir):
529
"""Create a branch of this format in a_bzrdir."""
530
raise NotImplementedError(self.initialized)
532
def is_supported(self):
533
"""Is this format supported?
535
Supported formats can be initialized and opened.
536
Unsupported formats may not support initialization or committing or
537
some other features depending on the reason for not being supported.
541
def open(self, a_bzrdir, _found=False):
542
"""Return the branch object for a_bzrdir
544
_found is a private parameter, do not use it. It is used to indicate
545
if format probing has already be done.
547
raise NotImplementedError(self.open)
550
def register_format(klass, format):
551
klass._formats[format.get_format_string()] = format
554
def set_default_format(klass, format):
555
klass._default_format = format
558
def unregister_format(klass, format):
559
assert klass._formats[format.get_format_string()] is format
560
del klass._formats[format.get_format_string()]
563
class BzrBranchFormat4(BranchFormat):
564
"""Bzr branch format 4.
567
- a revision-history file.
568
- a branch-lock lock file [ to be shared with the bzrdir ]
571
def initialize(self, a_bzrdir):
572
"""Create a branch of this format in a_bzrdir."""
573
mutter('creating branch in %s', a_bzrdir.transport.base)
574
branch_transport = a_bzrdir.get_branch_transport(self)
575
utf8_files = [('revision-history', ''),
578
control_files = LockableFiles(branch_transport, 'branch-lock')
579
control_files.lock_write()
581
for file, content in utf8_files:
582
control_files.put_utf8(file, content)
584
control_files.unlock()
585
return self.open(a_bzrdir, _found=True)
588
super(BzrBranchFormat4, self).__init__()
589
self._matchingbzrdir = bzrdir.BzrDirFormat6()
591
def open(self, a_bzrdir, _found=False):
592
"""Return the branch object for a_bzrdir
594
_found is a private parameter, do not use it. It is used to indicate
595
if format probing has already be done.
598
# we are being called directly and must probe.
599
raise NotImplementedError
600
transport = a_bzrdir.get_branch_transport(self)
601
control_files = LockableFiles(transport, 'branch-lock')
602
return BzrBranch(_format=self,
603
_control_files=control_files,
607
class BzrBranchFormat5(BranchFormat):
608
"""Bzr branch format 5.
611
- a revision-history file.
616
def get_format_string(self):
617
"""See BranchFormat.get_format_string()."""
618
return "Bazaar-NG branch format 5\n"
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)
625
utf8_files = [('revision-history', ''),
629
branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
630
control_files = LockableFiles(branch_transport, 'lock')
631
control_files.lock_write()
632
control_files.put_utf8('format', self.get_format_string())
634
for file, content in utf8_files:
635
control_files.put_utf8(file, content)
637
control_files.unlock()
638
return self.open(a_bzrdir, _found=True, )
641
super(BzrBranchFormat5, self).__init__()
642
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
644
def open(self, a_bzrdir, _found=False):
645
"""Return the branch object for a_bzrdir
647
_found is a private parameter, do not use it. It is used to indicate
648
if format probing has already be done.
651
format = BranchFormat.find_format(a_bzrdir)
652
assert format.__class__ == self.__class__
653
transport = a_bzrdir.get_branch_transport(None)
654
control_files = LockableFiles(transport, 'lock')
655
return BzrBranch(_format=self,
656
_control_files=control_files,
660
class BranchReferenceFormat(BranchFormat):
661
"""Bzr branch reference format.
663
Branch references are used in implementing checkouts, they
664
act as an alias to the real branch which is at some other url.
671
def get_format_string(self):
672
"""See BranchFormat.get_format_string()."""
673
return "Bazaar-NG Branch Reference Format 1\n"
675
def initialize(self, a_bzrdir, target_branch=None):
676
"""Create a branch of this format in a_bzrdir."""
677
if target_branch is None:
678
# this format does not implement branch itself, thus the implicit
679
# creation contract must see it as uninitializable
680
raise errors.UninitializableFormat(self)
681
mutter('creating branch reference in %s', a_bzrdir.transport.base)
682
branch_transport = a_bzrdir.get_branch_transport(self)
683
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
684
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
685
branch_transport.put('format', StringIO(self.get_format_string()))
686
return self.open(a_bzrdir, _found=True)
689
super(BranchReferenceFormat, self).__init__()
690
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
692
def _make_reference_clone_function(format, a_branch):
693
"""Create a clone() routine for a branch dynamically."""
694
def clone(to_bzrdir, revision_id=None):
695
"""See Branch.clone()."""
696
return format.initialize(to_bzrdir, a_branch)
697
# cannot obey revision_id limits when cloning a reference ...
698
# FIXME RBC 20060210 either nuke revision_id for clone, or
699
# emit some sort of warning/error to the caller ?!
702
def open(self, a_bzrdir, _found=False):
703
"""Return the branch that the branch reference in a_bzrdir points at.
705
_found is a private parameter, do not use it. It is used to indicate
706
if format probing has already be done.
709
format = BranchFormat.find_format(a_bzrdir)
710
assert format.__class__ == self.__class__
711
transport = a_bzrdir.get_branch_transport(None)
712
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
713
result = real_bzrdir.open_branch()
714
# this changes the behaviour of result.clone to create a new reference
715
# rather than a copy of the content of the branch.
716
# I did not use a proxy object because that needs much more extensive
717
# testing, and we are only changing one behaviour at the moment.
718
# If we decide to alter more behaviours - i.e. the implicit nickname
719
# then this should be refactored to introduce a tested proxy branch
720
# and a subclass of that for use in overriding clone() and ....
722
result.clone = self._make_reference_clone_function(result)
726
# formats which have no format string are not discoverable
727
# and not independently creatable, so are not registered.
728
__default_format = BzrBranchFormat5()
729
BranchFormat.register_format(__default_format)
730
BranchFormat.register_format(BranchReferenceFormat())
731
BranchFormat.set_default_format(__default_format)
732
_legacy_formats = [BzrBranchFormat4(),
735
class BzrBranch(Branch):
736
"""A branch stored in the actual filesystem.
738
Note that it's "local" in the context of the filesystem; it doesn't
739
really matter if it's on an nfs/smb/afs/coda/... share, as long as
740
it's writable, and can be accessed via the normal filesystem API.
742
# We actually expect this class to be somewhat short-lived; part of its
743
# purpose is to try to isolate what bits of the branch logic are tied to
744
# filesystem access, so that in a later step, we can extricate them to
745
# a separarte ("storage") class.
746
_inventory_weave = None
748
# Map some sort of prefix into a namespace
749
# stuff like "revno:10", "revid:", etc.
750
# This should match a prefix with a function which accepts
751
REVISION_NAMESPACES = {}
753
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
754
relax_version_check=DEPRECATED_PARAMETER, _format=None,
755
_control_files=None, a_bzrdir=None):
756
"""Create new branch object at a particular location.
758
transport -- A Transport object, defining how to access files.
760
init -- If True, create new control files in a previously
761
unversioned directory. If False, the branch must already
764
relax_version_check -- If true, the usual check for the branch
765
version is not applied. This is intended only for
766
upgrade/recovery type use; it's not guaranteed that
767
all operations will work on old format branches.
770
self.bzrdir = bzrdir.BzrDir.open(transport.base)
772
self.bzrdir = a_bzrdir
773
self._transport = self.bzrdir.transport.clone('..')
774
self._base = self._transport.base
775
self._format = _format
776
if _control_files is None:
777
raise BzrBadParameterMissing('_control_files')
778
self.control_files = _control_files
779
if deprecated_passed(init):
780
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
781
"deprecated as of bzr 0.8. Please use Branch.create().",
785
# this is slower than before deprecation, oh well never mind.
787
self._initialize(transport.base)
788
self._check_format(_format)
789
if deprecated_passed(relax_version_check):
790
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
791
"relax_version_check parameter is deprecated as of bzr 0.8. "
792
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
796
if (not relax_version_check
797
and not self._format.is_supported()):
798
raise errors.UnsupportedFormatError(
799
'sorry, branch format %r not supported' % fmt,
800
['use a different bzr version',
801
'or remove the .bzr directory'
802
' and "bzr init" again'])
803
if deprecated_passed(transport):
804
warn("BzrBranch.__init__(transport=XXX...): The transport "
805
"parameter is deprecated as of bzr 0.8. "
806
"Please use Branch.open, or bzrdir.open_branch().",
809
# TODO change this to search upwards if needed.
810
self.repository = self.bzrdir.open_repository()
813
return '%s(%r)' % (self.__class__.__name__, self.base)
818
# TODO: It might be best to do this somewhere else,
819
# but it is nice for a Branch object to automatically
820
# cache it's information.
821
# Alternatively, we could have the Transport objects cache requests
822
# See the earlier discussion about how major objects (like Branch)
823
# should never expect their __del__ function to run.
824
# XXX: cache_root seems to be unused, 2006-01-13 mbp
825
if hasattr(self, 'cache_root') and self.cache_root is not None:
827
shutil.rmtree(self.cache_root)
830
self.cache_root = None
835
base = property(_get_base, doc="The URL for the root of this branch.")
837
def _finish_transaction(self):
838
"""Exit the current transaction."""
839
return self.control_files._finish_transaction()
841
def get_transaction(self):
842
"""Return the current active transaction.
844
If no transaction is active, this returns a passthrough object
845
for which all data is immediately flushed and no caching happens.
847
# this is an explicit function so that we can do tricky stuff
848
# when the storage in rev_storage is elsewhere.
849
# we probably need to hook the two 'lock a location' and
850
# 'have a transaction' together more delicately, so that
851
# we can have two locks (branch and storage) and one transaction
852
# ... and finishing the transaction unlocks both, but unlocking
853
# does not. - RBC 20051121
854
return self.control_files.get_transaction()
856
def _set_transaction(self, transaction):
857
"""Set a new active transaction."""
858
return self.control_files._set_transaction(transaction)
860
def abspath(self, name):
861
"""See Branch.abspath."""
862
return self.control_files._transport.abspath(name)
864
def _check_format(self, format):
865
"""Identify the branch format if needed.
867
The format is stored as a reference to the format object in
868
self._format for code that needs to check it later.
870
The format parameter is either None or the branch format class
871
used to open this branch.
873
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
876
format = BzrBranchFormat.find_format(self.bzrdir)
877
self._format = format
878
mutter("got branch format %s", self._format)
881
def get_root_id(self):
882
"""See Branch.get_root_id."""
883
tree = self.repository.revision_tree(self.last_revision())
884
return tree.inventory.root.file_id
886
def lock_write(self):
887
# TODO: test for failed two phase locks. This is known broken.
888
self.control_files.lock_write()
889
self.repository.lock_write()
892
# TODO: test for failed two phase locks. This is known broken.
893
self.control_files.lock_read()
894
self.repository.lock_read()
897
# TODO: test for failed two phase locks. This is known broken.
898
self.repository.unlock()
899
self.control_files.unlock()
901
def peek_lock_mode(self):
902
if self.control_files._lock_count == 0:
905
return self.control_files._lock_mode
908
def print_file(self, file, revision_id):
909
"""See Branch.print_file."""
910
return self.repository.print_file(file, revision_id)
913
def append_revision(self, *revision_ids):
914
"""See Branch.append_revision."""
915
for revision_id in revision_ids:
916
mutter("add {%s} to revision-history" % revision_id)
917
rev_history = self.revision_history()
918
rev_history.extend(revision_ids)
919
self.set_revision_history(rev_history)
922
def set_revision_history(self, rev_history):
923
"""See Branch.set_revision_history."""
924
self.control_files.put_utf8(
925
'revision-history', '\n'.join(rev_history))
927
def get_revision_delta(self, revno):
928
"""Return the delta for one revision.
930
The delta is relative to its mainline predecessor, or the
931
empty tree for revision 1.
933
assert isinstance(revno, int)
934
rh = self.revision_history()
935
if not (1 <= revno <= len(rh)):
936
raise InvalidRevisionNumber(revno)
938
# revno is 1-based; list is 0-based
940
new_tree = self.repository.revision_tree(rh[revno-1])
942
old_tree = EmptyTree()
944
old_tree = self.repository.revision_tree(rh[revno-2])
945
return compare_trees(old_tree, new_tree)
948
def revision_history(self):
949
"""See Branch.revision_history."""
950
# FIXME are transactions bound to control files ? RBC 20051121
951
transaction = self.get_transaction()
952
history = transaction.map.find_revision_history()
953
if history is not None:
954
mutter("cache hit for revision-history in %s", self)
956
history = [l.rstrip('\r\n') for l in
957
self.control_files.get_utf8('revision-history').readlines()]
958
transaction.map.add_revision_history(history)
959
# this call is disabled because revision_history is
960
# not really an object yet, and the transaction is for objects.
961
# transaction.register_clean(history, precious=True)
964
def update_revisions(self, other, stop_revision=None):
965
"""See Branch.update_revisions."""
966
from bzrlib.fetch import greedy_fetch
967
if stop_revision is None:
968
stop_revision = other.last_revision()
969
### Should this be checking is_ancestor instead of revision_history?
970
if (stop_revision is not None and
971
stop_revision in self.revision_history()):
973
greedy_fetch(to_branch=self, from_branch=other,
974
revision=stop_revision)
975
pullable_revs = self.pullable_revisions(other, stop_revision)
976
if len(pullable_revs) > 0:
977
self.append_revision(*pullable_revs)
979
def pullable_revisions(self, other, stop_revision):
980
"""See Branch.pullable_revisions."""
981
other_revno = other.revision_id_to_revno(stop_revision)
983
return self.missing_revisions(other, other_revno)
984
except DivergedBranches, e:
986
pullable_revs = get_intervening_revisions(self.last_revision(),
989
assert self.last_revision() not in pullable_revs
991
except bzrlib.errors.NotAncestor:
992
if is_ancestor(self.last_revision(), stop_revision, self):
997
def basis_tree(self):
998
"""See Branch.basis_tree."""
999
return self.repository.revision_tree(self.last_revision())
1001
@deprecated_method(zero_eight)
1002
def working_tree(self):
1003
"""Create a Working tree object for this branch."""
1004
from bzrlib.workingtree import WorkingTree
1005
from bzrlib.transport.local import LocalTransport
1006
if (self.base.find('://') != -1 or
1007
not isinstance(self._transport, LocalTransport)):
1008
raise NoWorkingTree(self.base)
1009
return WorkingTree(self.base, branch=self)
1012
def pull(self, source, overwrite=False):
1013
"""See Branch.pull."""
1016
old_count = len(self.revision_history())
1018
self.update_revisions(source)
1019
except DivergedBranches:
1023
self.set_revision_history(source.revision_history())
1024
new_count = len(self.revision_history())
1025
return new_count - old_count
1029
def get_parent(self):
1030
"""See Branch.get_parent."""
1032
_locs = ['parent', 'pull', 'x-pull']
1035
return self.control_files.get_utf8(l).read().strip('\n')
1040
def get_push_location(self):
1041
"""See Branch.get_push_location."""
1042
config = bzrlib.config.BranchConfig(self)
1043
push_loc = config.get_user_option('push_location')
1046
def set_push_location(self, location):
1047
"""See Branch.set_push_location."""
1048
config = bzrlib.config.LocationConfig(self.base)
1049
config.set_user_option('push_location', location)
1052
def set_parent(self, url):
1053
"""See Branch.set_parent."""
1054
# TODO: Maybe delete old location files?
1055
# URLs should never be unicode, even on the local fs,
1056
# FIXUP this and get_parent in a future branch format bump:
1057
# read and rewrite the file, and have the new format code read
1058
# using .get not .get_utf8. RBC 20060125
1059
self.control_files.put_utf8('parent', url + '\n')
1061
def tree_config(self):
1062
return TreeConfig(self)
1064
def _get_truncated_history(self, revision_id):
1065
history = self.revision_history()
1066
if revision_id is None:
1069
idx = history.index(revision_id)
1071
raise InvalidRevisionId(revision_id=revision, branch=self)
1072
return history[:idx+1]
1075
def _clone_weave(self, to_location, revision=None, basis_branch=None):
1077
from bzrlib.workingtree import WorkingTree
1078
assert isinstance(to_location, basestring)
1079
if basis_branch is not None:
1080
note("basis_branch is not supported for fast weave copy yet.")
1082
history = self._get_truncated_history(revision)
1083
if not bzrlib.osutils.lexists(to_location):
1084
os.mkdir(to_location)
1085
bzrdir_to = self.bzrdir._format.initialize(to_location)
1086
self.repository.clone(bzrdir_to)
1087
branch_to = bzrdir_to.create_branch()
1088
mutter("copy branch from %s to %s", self, branch_to)
1090
# FIXME duplicate code with base .clone().
1091
# .. would template method be useful here? RBC 20051207
1092
branch_to.set_parent(self.base)
1093
branch_to.append_revision(*history)
1094
WorkingTree.create(branch_to, branch_to.base)
1099
class BranchTestProviderAdapter(object):
1100
"""A tool to generate a suite testing multiple branch formats at once.
1102
This is done by copying the test once for each transport and injecting
1103
the transport_server, transport_readonly_server, and branch_format
1104
classes into each copy. Each copy is also given a new id() to make it
1108
def __init__(self, transport_server, transport_readonly_server, formats):
1109
self._transport_server = transport_server
1110
self._transport_readonly_server = transport_readonly_server
1111
self._formats = formats
1113
def adapt(self, test):
1114
result = TestSuite()
1115
for branch_format, bzrdir_format in self._formats:
1116
new_test = deepcopy(test)
1117
new_test.transport_server = self._transport_server
1118
new_test.transport_readonly_server = self._transport_readonly_server
1119
new_test.bzrdir_format = bzrdir_format
1120
new_test.branch_format = branch_format
1121
def make_new_test_id():
1122
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1123
return lambda: new_id
1124
new_test.id = make_new_test_id()
1125
result.addTest(new_test)
1129
######################################################################
1133
@deprecated_function(zero_eight)
1134
def ScratchBranch(*args, **kwargs):
1135
"""See bzrlib.bzrdir.ScratchDir."""
1136
d = ScratchDir(*args, **kwargs)
1137
return d.open_branch()
1140
@deprecated_function(zero_eight)
1141
def is_control_file(*args, **kwargs):
1142
"""See bzrlib.workingtree.is_control_file."""
1143
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
