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
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
49
from bzrlib.textui import show_status
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
# this is really an instance variable - FIXME move it there
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
115
def open_containing(url):
116
"""Open an existing branch which contains url.
118
This probes for a branch at url, and searches upwards from there.
120
Basically we keep looking up until we find the control directory or
121
run into the root. If there isn't one, raises NotBranchError.
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
134
NOTE: This will soon be deprecated in favour of creation
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
151
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
156
nick = property(_get_nick, _set_nick)
158
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
162
raise NotImplementedError('lock_read is abstract')
165
raise NotImplementedError('unlock is abstract')
167
def peek_lock_mode(self):
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
169
raise NotImplementedError(self.peek_lock_mode)
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
179
def bind(self, other):
180
"""Bind the local branch the other branch.
182
:param other: The branch to bind to
185
raise errors.UpgradeRequired(self.base)
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
194
:param pb: An optional progress bar to use.
196
Returns the copied revision count and the failed revisions in a tuple:
199
if self.base == from_branch.base:
202
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
207
from_branch.lock_read()
209
if last_revision is None:
210
pb.update('get source history')
211
from_history = from_branch.revision_history()
213
last_revision = from_history[-1]
215
# no history in the source branch
216
last_revision = NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
221
if nested_pb is not None:
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
228
Older format branches cannot bind, please be sure to use a metadir
233
def get_master_branch(self):
234
"""Return the branch we are bound to.
236
:return: Either a Branch, or None
240
def get_root_id(self):
241
"""Return the id of this branches root"""
242
raise NotImplementedError('get_root_id is abstract')
244
def print_file(self, file, revision_id):
245
"""Print `file` to stdout."""
246
raise NotImplementedError('print_file is abstract')
248
def append_revision(self, *revision_ids):
249
raise NotImplementedError('append_revision is abstract')
251
def set_revision_history(self, rev_history):
252
raise NotImplementedError('set_revision_history is abstract')
254
def revision_history(self):
255
"""Return sequence of revision hashes on to this branch."""
256
raise NotImplementedError('revision_history is abstract')
259
"""Return current revision number for this branch.
261
That is equivalent to the number of revisions committed to
264
return len(self.revision_history())
267
"""Older format branches cannot bind or unbind."""
268
raise errors.UpgradeRequired(self.base)
270
def last_revision(self):
271
"""Return last patch hash, or None if no history."""
272
ph = self.revision_history()
278
def missing_revisions(self, other, stop_revision=None):
279
"""Return a list of new revisions that would perfectly fit.
281
If self and other have not diverged, return a list of the revisions
282
present in other, but missing from self.
284
>>> from bzrlib.workingtree import WorkingTree
285
>>> bzrlib.trace.silent = True
286
>>> d1 = bzrdir.ScratchDir()
287
>>> br1 = d1.open_branch()
288
>>> wt1 = d1.open_workingtree()
289
>>> d2 = bzrdir.ScratchDir()
290
>>> br2 = d2.open_branch()
291
>>> wt2 = d2.open_workingtree()
292
>>> br1.missing_revisions(br2)
294
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
295
>>> br1.missing_revisions(br2)
297
>>> br2.missing_revisions(br1)
299
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
300
>>> br1.missing_revisions(br2)
302
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
303
>>> br1.missing_revisions(br2)
305
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
306
>>> br1.missing_revisions(br2)
307
Traceback (most recent call last):
308
DivergedBranches: These branches have diverged. Try merge.
310
self_history = self.revision_history()
311
self_len = len(self_history)
312
other_history = other.revision_history()
313
other_len = len(other_history)
314
common_index = min(self_len, other_len) -1
315
if common_index >= 0 and \
316
self_history[common_index] != other_history[common_index]:
317
raise DivergedBranches(self, other)
319
if stop_revision is None:
320
stop_revision = other_len
322
assert isinstance(stop_revision, int)
323
if stop_revision > other_len:
324
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
325
return other_history[self_len:stop_revision]
327
def update_revisions(self, other, stop_revision=None):
328
"""Pull in new perfect-fit revisions.
330
:param other: Another Branch to pull from
331
:param stop_revision: Updated until the given revision
334
raise NotImplementedError('update_revisions is abstract')
336
def revision_id_to_revno(self, revision_id):
337
"""Given a revision id, return its revno"""
338
if revision_id is None:
340
history = self.revision_history()
342
return history.index(revision_id) + 1
344
raise bzrlib.errors.NoSuchRevision(self, revision_id)
346
def get_rev_id(self, revno, history=None):
347
"""Find the revision id of the specified revno."""
351
history = self.revision_history()
352
elif revno <= 0 or revno > len(history):
353
raise bzrlib.errors.NoSuchRevision(self, revno)
354
return history[revno - 1]
356
def pull(self, source, overwrite=False, stop_revision=None):
357
raise NotImplementedError('pull is abstract')
359
def basis_tree(self):
360
"""Return `Tree` object for last revision.
362
If there are no revisions yet, return an `EmptyTree`.
364
return self.repository.revision_tree(self.last_revision())
366
def rename_one(self, from_rel, to_rel):
369
This can change the directory or the filename or both.
371
raise NotImplementedError('rename_one is abstract')
373
def move(self, from_paths, to_name):
376
to_name must exist as a versioned directory.
378
If to_name exists and is a directory, the files are moved into
379
it, keeping their old names. If it is a directory,
381
Note that to_name is only the last component of the new name;
382
this doesn't change the directory.
384
This returns a list of (from_path, to_path) pairs for each
387
raise NotImplementedError('move is abstract')
389
def get_parent(self):
390
"""Return the parent location of the branch.
392
This is the default location for push/pull/missing. The usual
393
pattern is that the user can override it by specifying a
396
raise NotImplementedError('get_parent is abstract')
398
def get_push_location(self):
399
"""Return the None or the location to push this branch to."""
400
raise NotImplementedError('get_push_location is abstract')
402
def set_push_location(self, location):
403
"""Set a new push location for this branch."""
404
raise NotImplementedError('set_push_location is abstract')
406
def set_parent(self, url):
407
raise NotImplementedError('set_parent is abstract')
411
"""Synchronise this branch with the master branch if any.
413
:return: None or the last_revision pivoted out during the update.
417
def check_revno(self, revno):
419
Check whether a revno corresponds to any revision.
420
Zero (the NULL revision) is considered valid.
423
self.check_real_revno(revno)
425
def check_real_revno(self, revno):
427
Check whether a revno corresponds to a real revision.
428
Zero (the NULL revision) is considered invalid
430
if revno < 1 or revno > self.revno():
431
raise InvalidRevisionNumber(revno)
434
def clone(self, *args, **kwargs):
435
"""Clone this branch into to_bzrdir preserving all semantic values.
437
revision_id: if not None, the revision history in the new branch will
438
be truncated to end with revision_id.
440
# for API compatability, until 0.8 releases we provide the old api:
441
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
442
# after 0.8 releases, the *args and **kwargs should be changed:
443
# def clone(self, to_bzrdir, revision_id=None):
444
if (kwargs.get('to_location', None) or
445
kwargs.get('revision', None) or
446
kwargs.get('basis_branch', None) or
447
(len(args) and isinstance(args[0], basestring))):
448
# backwards compatability api:
449
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
450
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
453
basis_branch = args[2]
455
basis_branch = kwargs.get('basis_branch', None)
457
basis = basis_branch.bzrdir
462
revision_id = args[1]
464
revision_id = kwargs.get('revision', None)
469
# no default to raise if not provided.
470
url = kwargs.get('to_location')
471
return self.bzrdir.clone(url,
472
revision_id=revision_id,
473
basis=basis).open_branch()
475
# generate args by hand
477
revision_id = args[1]
479
revision_id = kwargs.get('revision_id', None)
483
# no default to raise if not provided.
484
to_bzrdir = kwargs.get('to_bzrdir')
485
result = self._format.initialize(to_bzrdir)
486
self.copy_content_into(result, revision_id=revision_id)
490
def sprout(self, to_bzrdir, revision_id=None):
491
"""Create a new line of development from the branch, into to_bzrdir.
493
revision_id: if not None, the revision history in the new branch will
494
be truncated to end with revision_id.
496
result = self._format.initialize(to_bzrdir)
497
self.copy_content_into(result, revision_id=revision_id)
498
result.set_parent(self.bzrdir.root_transport.base)
502
def copy_content_into(self, destination, revision_id=None):
503
"""Copy the content of self into destination.
505
revision_id: if not None, the revision history in the new branch will
506
be truncated to end with revision_id.
508
new_history = self.revision_history()
509
if revision_id is not None:
511
new_history = new_history[:new_history.index(revision_id) + 1]
513
rev = self.repository.get_revision(revision_id)
514
new_history = rev.get_history(self.repository)[1:]
515
destination.set_revision_history(new_history)
516
parent = self.get_parent()
518
destination.set_parent(parent)
521
class BranchFormat(object):
522
"""An encapsulation of the initialization and open routines for a format.
524
Formats provide three things:
525
* An initialization routine,
529
Formats are placed in an dict by their format string for reference
530
during branch opening. Its not required that these be instances, they
531
can be classes themselves with class methods - it simply depends on
532
whether state is needed for a given format or not.
534
Once a format is deprecated, just deprecate the initialize and open
535
methods on the format class. Do not deprecate the object, as the
536
object will be created every time regardless.
539
_default_format = None
540
"""The default format used for new branches."""
543
"""The known formats."""
546
def find_format(klass, a_bzrdir):
547
"""Return the format for the branch object in a_bzrdir."""
549
transport = a_bzrdir.get_branch_transport(None)
550
format_string = transport.get("format").read()
551
return klass._formats[format_string]
553
raise NotBranchError(path=transport.base)
555
raise errors.UnknownFormatError(format_string)
558
def get_default_format(klass):
559
"""Return the current default format."""
560
return klass._default_format
562
def get_format_string(self):
563
"""Return the ASCII format string that identifies this format."""
564
raise NotImplementedError(self.get_format_string)
566
def initialize(self, a_bzrdir):
567
"""Create a branch of this format in a_bzrdir."""
568
raise NotImplementedError(self.initialized)
570
def is_supported(self):
571
"""Is this format supported?
573
Supported formats can be initialized and opened.
574
Unsupported formats may not support initialization or committing or
575
some other features depending on the reason for not being supported.
579
def open(self, a_bzrdir, _found=False):
580
"""Return the branch object for a_bzrdir
582
_found is a private parameter, do not use it. It is used to indicate
583
if format probing has already be done.
585
raise NotImplementedError(self.open)
588
def register_format(klass, format):
589
klass._formats[format.get_format_string()] = format
592
def set_default_format(klass, format):
593
klass._default_format = format
596
def unregister_format(klass, format):
597
assert klass._formats[format.get_format_string()] is format
598
del klass._formats[format.get_format_string()]
601
return self.get_format_string().rstrip()
604
class BzrBranchFormat4(BranchFormat):
605
"""Bzr branch format 4.
608
- a revision-history file.
609
- a branch-lock lock file [ to be shared with the bzrdir ]
612
def initialize(self, a_bzrdir):
613
"""Create a branch of this format in a_bzrdir."""
614
mutter('creating branch in %s', a_bzrdir.transport.base)
615
branch_transport = a_bzrdir.get_branch_transport(self)
616
utf8_files = [('revision-history', ''),
619
control_files = LockableFiles(branch_transport, 'branch-lock',
621
control_files.create_lock()
622
control_files.lock_write()
624
for file, content in utf8_files:
625
control_files.put_utf8(file, content)
627
control_files.unlock()
628
return self.open(a_bzrdir, _found=True)
631
super(BzrBranchFormat4, self).__init__()
632
self._matchingbzrdir = bzrdir.BzrDirFormat6()
634
def open(self, a_bzrdir, _found=False):
635
"""Return the branch object for a_bzrdir
637
_found is a private parameter, do not use it. It is used to indicate
638
if format probing has already be done.
641
# we are being called directly and must probe.
642
raise NotImplementedError
643
return BzrBranch(_format=self,
644
_control_files=a_bzrdir._control_files,
646
_repository=a_bzrdir.open_repository())
649
return "Bazaar-NG branch format 4"
652
class BzrBranchFormat5(BranchFormat):
653
"""Bzr branch format 5.
656
- a revision-history file.
658
- a lock dir guarding the branch itself
659
- all of this stored in a branch/ subdirectory
660
- works with shared repositories.
662
This format is new in bzr 0.8.
665
def get_format_string(self):
666
"""See BranchFormat.get_format_string()."""
667
return "Bazaar-NG branch format 5\n"
669
def initialize(self, a_bzrdir):
670
"""Create a branch of this format in a_bzrdir."""
671
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
672
branch_transport = a_bzrdir.get_branch_transport(self)
673
utf8_files = [('revision-history', ''),
676
control_files = LockableFiles(branch_transport, 'lock', LockDir)
677
control_files.create_lock()
678
control_files.lock_write()
679
control_files.put_utf8('format', self.get_format_string())
681
for file, content in utf8_files:
682
control_files.put_utf8(file, content)
684
control_files.unlock()
685
return self.open(a_bzrdir, _found=True, )
688
super(BzrBranchFormat5, self).__init__()
689
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
691
def open(self, a_bzrdir, _found=False):
692
"""Return the branch object for a_bzrdir
694
_found is a private parameter, do not use it. It is used to indicate
695
if format probing has already be done.
698
format = BranchFormat.find_format(a_bzrdir)
699
assert format.__class__ == self.__class__
700
transport = a_bzrdir.get_branch_transport(None)
701
control_files = LockableFiles(transport, 'lock', LockDir)
702
return BzrBranch5(_format=self,
703
_control_files=control_files,
705
_repository=a_bzrdir.find_repository())
708
return "Bazaar-NG Metadir branch format 5"
711
class BranchReferenceFormat(BranchFormat):
712
"""Bzr branch reference format.
714
Branch references are used in implementing checkouts, they
715
act as an alias to the real branch which is at some other url.
722
def get_format_string(self):
723
"""See BranchFormat.get_format_string()."""
724
return "Bazaar-NG Branch Reference Format 1\n"
726
def initialize(self, a_bzrdir, target_branch=None):
727
"""Create a branch of this format in a_bzrdir."""
728
if target_branch is None:
729
# this format does not implement branch itself, thus the implicit
730
# creation contract must see it as uninitializable
731
raise errors.UninitializableFormat(self)
732
mutter('creating branch reference in %s', a_bzrdir.transport.base)
733
branch_transport = a_bzrdir.get_branch_transport(self)
734
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
735
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
736
branch_transport.put('format', StringIO(self.get_format_string()))
737
return self.open(a_bzrdir, _found=True)
740
super(BranchReferenceFormat, self).__init__()
741
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
743
def _make_reference_clone_function(format, a_branch):
744
"""Create a clone() routine for a branch dynamically."""
745
def clone(to_bzrdir, revision_id=None):
746
"""See Branch.clone()."""
747
return format.initialize(to_bzrdir, a_branch)
748
# cannot obey revision_id limits when cloning a reference ...
749
# FIXME RBC 20060210 either nuke revision_id for clone, or
750
# emit some sort of warning/error to the caller ?!
753
def open(self, a_bzrdir, _found=False):
754
"""Return the branch that the branch reference in a_bzrdir points at.
756
_found is a private parameter, do not use it. It is used to indicate
757
if format probing has already be done.
760
format = BranchFormat.find_format(a_bzrdir)
761
assert format.__class__ == self.__class__
762
transport = a_bzrdir.get_branch_transport(None)
763
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
764
result = real_bzrdir.open_branch()
765
# this changes the behaviour of result.clone to create a new reference
766
# rather than a copy of the content of the branch.
767
# I did not use a proxy object because that needs much more extensive
768
# testing, and we are only changing one behaviour at the moment.
769
# If we decide to alter more behaviours - i.e. the implicit nickname
770
# then this should be refactored to introduce a tested proxy branch
771
# and a subclass of that for use in overriding clone() and ....
773
result.clone = self._make_reference_clone_function(result)
777
# formats which have no format string are not discoverable
778
# and not independently creatable, so are not registered.
779
__default_format = BzrBranchFormat5()
780
BranchFormat.register_format(__default_format)
781
BranchFormat.register_format(BranchReferenceFormat())
782
BranchFormat.set_default_format(__default_format)
783
_legacy_formats = [BzrBranchFormat4(),
786
class BzrBranch(Branch):
787
"""A branch stored in the actual filesystem.
789
Note that it's "local" in the context of the filesystem; it doesn't
790
really matter if it's on an nfs/smb/afs/coda/... share, as long as
791
it's writable, and can be accessed via the normal filesystem API.
794
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
795
relax_version_check=DEPRECATED_PARAMETER, _format=None,
796
_control_files=None, a_bzrdir=None, _repository=None):
797
"""Create new branch object at a particular location.
799
transport -- A Transport object, defining how to access files.
801
init -- If True, create new control files in a previously
802
unversioned directory. If False, the branch must already
805
relax_version_check -- If true, the usual check for the branch
806
version is not applied. This is intended only for
807
upgrade/recovery type use; it's not guaranteed that
808
all operations will work on old format branches.
811
self.bzrdir = bzrdir.BzrDir.open(transport.base)
813
self.bzrdir = a_bzrdir
814
self._transport = self.bzrdir.transport.clone('..')
815
self._base = self._transport.base
816
self._format = _format
817
if _control_files is None:
818
raise BzrBadParameterMissing('_control_files')
819
self.control_files = _control_files
820
if deprecated_passed(init):
821
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
822
"deprecated as of bzr 0.8. Please use Branch.create().",
826
# this is slower than before deprecation, oh well never mind.
828
self._initialize(transport.base)
829
self._check_format(_format)
830
if deprecated_passed(relax_version_check):
831
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
832
"relax_version_check parameter is deprecated as of bzr 0.8. "
833
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
837
if (not relax_version_check
838
and not self._format.is_supported()):
839
raise errors.UnsupportedFormatError(
840
'sorry, branch format %r not supported' % fmt,
841
['use a different bzr version',
842
'or remove the .bzr directory'
843
' and "bzr init" again'])
844
if deprecated_passed(transport):
845
warn("BzrBranch.__init__(transport=XXX...): The transport "
846
"parameter is deprecated as of bzr 0.8. "
847
"Please use Branch.open, or bzrdir.open_branch().",
850
self.repository = _repository
853
return '%s(%r)' % (self.__class__.__name__, self.base)
858
# TODO: It might be best to do this somewhere else,
859
# but it is nice for a Branch object to automatically
860
# cache it's information.
861
# Alternatively, we could have the Transport objects cache requests
862
# See the earlier discussion about how major objects (like Branch)
863
# should never expect their __del__ function to run.
864
# XXX: cache_root seems to be unused, 2006-01-13 mbp
865
if hasattr(self, 'cache_root') and self.cache_root is not None:
867
shutil.rmtree(self.cache_root)
870
self.cache_root = None
875
base = property(_get_base, doc="The URL for the root of this branch.")
877
def _finish_transaction(self):
878
"""Exit the current transaction."""
879
return self.control_files._finish_transaction()
881
def get_transaction(self):
882
"""Return the current active transaction.
884
If no transaction is active, this returns a passthrough object
885
for which all data is immediately flushed and no caching happens.
887
# this is an explicit function so that we can do tricky stuff
888
# when the storage in rev_storage is elsewhere.
889
# we probably need to hook the two 'lock a location' and
890
# 'have a transaction' together more delicately, so that
891
# we can have two locks (branch and storage) and one transaction
892
# ... and finishing the transaction unlocks both, but unlocking
893
# does not. - RBC 20051121
894
return self.control_files.get_transaction()
896
def _set_transaction(self, transaction):
897
"""Set a new active transaction."""
898
return self.control_files._set_transaction(transaction)
900
def abspath(self, name):
901
"""See Branch.abspath."""
902
return self.control_files._transport.abspath(name)
904
def _check_format(self, format):
905
"""Identify the branch format if needed.
907
The format is stored as a reference to the format object in
908
self._format for code that needs to check it later.
910
The format parameter is either None or the branch format class
911
used to open this branch.
913
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
916
format = BzrBranchFormat.find_format(self.bzrdir)
917
self._format = format
918
mutter("got branch format %s", self._format)
921
def get_root_id(self):
922
"""See Branch.get_root_id."""
923
tree = self.repository.revision_tree(self.last_revision())
924
return tree.inventory.root.file_id
926
def lock_write(self):
927
# TODO: test for failed two phase locks. This is known broken.
928
self.control_files.lock_write()
929
self.repository.lock_write()
932
# TODO: test for failed two phase locks. This is known broken.
933
self.control_files.lock_read()
934
self.repository.lock_read()
937
# TODO: test for failed two phase locks. This is known broken.
938
self.repository.unlock()
939
self.control_files.unlock()
941
def peek_lock_mode(self):
942
if self.control_files._lock_count == 0:
945
return self.control_files._lock_mode
948
def print_file(self, file, revision_id):
949
"""See Branch.print_file."""
950
return self.repository.print_file(file, revision_id)
953
def append_revision(self, *revision_ids):
954
"""See Branch.append_revision."""
955
for revision_id in revision_ids:
956
mutter("add {%s} to revision-history" % revision_id)
957
rev_history = self.revision_history()
958
rev_history.extend(revision_ids)
959
self.set_revision_history(rev_history)
962
def set_revision_history(self, rev_history):
963
"""See Branch.set_revision_history."""
964
self.control_files.put_utf8(
965
'revision-history', '\n'.join(rev_history))
966
transaction = self.get_transaction()
967
history = transaction.map.find_revision_history()
968
if history is not None:
969
# update the revision history in the identity map.
970
history[:] = list(rev_history)
971
# this call is disabled because revision_history is
972
# not really an object yet, and the transaction is for objects.
973
# transaction.register_dirty(history)
975
transaction.map.add_revision_history(rev_history)
976
# this call is disabled because revision_history is
977
# not really an object yet, and the transaction is for objects.
978
# transaction.register_clean(history)
980
def get_revision_delta(self, revno):
981
"""Return the delta for one revision.
983
The delta is relative to its mainline predecessor, or the
984
empty tree for revision 1.
986
assert isinstance(revno, int)
987
rh = self.revision_history()
988
if not (1 <= revno <= len(rh)):
989
raise InvalidRevisionNumber(revno)
991
# revno is 1-based; list is 0-based
993
new_tree = self.repository.revision_tree(rh[revno-1])
995
old_tree = EmptyTree()
997
old_tree = self.repository.revision_tree(rh[revno-2])
998
return compare_trees(old_tree, new_tree)
1001
def revision_history(self):
1002
"""See Branch.revision_history."""
1003
transaction = self.get_transaction()
1004
history = transaction.map.find_revision_history()
1005
if history is not None:
1006
mutter("cache hit for revision-history in %s", self)
1007
return list(history)
1008
history = [l.rstrip('\r\n') for l in
1009
self.control_files.get_utf8('revision-history').readlines()]
1010
transaction.map.add_revision_history(history)
1011
# this call is disabled because revision_history is
1012
# not really an object yet, and the transaction is for objects.
1013
# transaction.register_clean(history, precious=True)
1014
return list(history)
1017
def update_revisions(self, other, stop_revision=None):
1018
"""See Branch.update_revisions."""
1021
if stop_revision is None:
1022
stop_revision = other.last_revision()
1023
if stop_revision is None:
1024
# if there are no commits, we're done.
1026
# whats the current last revision, before we fetch [and change it
1028
last_rev = self.last_revision()
1029
# we fetch here regardless of whether we need to so that we pickup
1031
self.fetch(other, stop_revision)
1032
my_ancestry = self.repository.get_ancestry(last_rev)
1033
if stop_revision in my_ancestry:
1034
# last_revision is a descendant of stop_revision
1036
# stop_revision must be a descendant of last_revision
1037
stop_graph = self.repository.get_revision_graph(stop_revision)
1038
if last_rev is not None and last_rev not in stop_graph:
1039
# our previous tip is not merged into stop_revision
1040
raise errors.DivergedBranches(self, other)
1041
# make a new revision history from the graph
1042
current_rev_id = stop_revision
1044
while current_rev_id not in (None, NULL_REVISION):
1045
new_history.append(current_rev_id)
1046
current_rev_id_parents = stop_graph[current_rev_id]
1048
current_rev_id = current_rev_id_parents[0]
1050
current_rev_id = None
1051
new_history.reverse()
1052
self.set_revision_history(new_history)
1056
@deprecated_method(zero_eight)
1057
def pullable_revisions(self, other, stop_revision):
1058
"""Please use bzrlib.missing instead."""
1059
other_revno = other.revision_id_to_revno(stop_revision)
1061
return self.missing_revisions(other, other_revno)
1062
except DivergedBranches, e:
1064
pullable_revs = get_intervening_revisions(self.last_revision(),
1067
assert self.last_revision() not in pullable_revs
1068
return pullable_revs
1069
except bzrlib.errors.NotAncestor:
1070
if is_ancestor(self.last_revision(), stop_revision, self):
1075
def basis_tree(self):
1076
"""See Branch.basis_tree."""
1077
return self.repository.revision_tree(self.last_revision())
1079
@deprecated_method(zero_eight)
1080
def working_tree(self):
1081
"""Create a Working tree object for this branch."""
1082
from bzrlib.workingtree import WorkingTree
1083
from bzrlib.transport.local import LocalTransport
1084
if (self.base.find('://') != -1 or
1085
not isinstance(self._transport, LocalTransport)):
1086
raise NoWorkingTree(self.base)
1087
return self.bzrdir.open_workingtree()
1090
def pull(self, source, overwrite=False, stop_revision=None):
1091
"""See Branch.pull."""
1094
old_count = len(self.revision_history())
1096
self.update_revisions(source,stop_revision)
1097
except DivergedBranches:
1101
self.set_revision_history(source.revision_history())
1102
new_count = len(self.revision_history())
1103
return new_count - old_count
1107
def get_parent(self):
1108
"""See Branch.get_parent."""
1110
_locs = ['parent', 'pull', 'x-pull']
1113
return self.control_files.get_utf8(l).read().strip('\n')
1118
def get_push_location(self):
1119
"""See Branch.get_push_location."""
1120
config = bzrlib.config.BranchConfig(self)
1121
push_loc = config.get_user_option('push_location')
1124
def set_push_location(self, location):
1125
"""See Branch.set_push_location."""
1126
config = bzrlib.config.LocationConfig(self.base)
1127
config.set_user_option('push_location', location)
1130
def set_parent(self, url):
1131
"""See Branch.set_parent."""
1132
# TODO: Maybe delete old location files?
1133
# URLs should never be unicode, even on the local fs,
1134
# FIXUP this and get_parent in a future branch format bump:
1135
# read and rewrite the file, and have the new format code read
1136
# using .get not .get_utf8. RBC 20060125
1137
self.control_files.put_utf8('parent', url + '\n')
1139
def tree_config(self):
1140
return TreeConfig(self)
1143
class BzrBranch5(BzrBranch):
1144
"""A format 5 branch. This supports new features over plan branches.
1146
It has support for a master_branch which is the data for bound branches.
1154
super(BzrBranch5, self).__init__(_format=_format,
1155
_control_files=_control_files,
1157
_repository=_repository)
1160
def pull(self, source, overwrite=False, stop_revision=None):
1161
"""Updates branch.pull to be bound branch aware."""
1162
bound_location = self.get_bound_location()
1163
if source.base != bound_location:
1164
# not pulling from master, so we need to update master.
1165
master_branch = self.get_master_branch()
1167
master_branch.pull(source)
1168
source = master_branch
1169
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1171
def get_bound_location(self):
1173
return self.control_files.get_utf8('bound').read()[:-1]
1174
except errors.NoSuchFile:
1178
def get_master_branch(self):
1179
"""Return the branch we are bound to.
1181
:return: Either a Branch, or None
1183
This could memoise the branch, but if thats done
1184
it must be revalidated on each new lock.
1185
So for now we just dont memoise it.
1186
# RBC 20060304 review this decision.
1188
bound_loc = self.get_bound_location()
1192
return Branch.open(bound_loc)
1193
except (errors.NotBranchError, errors.ConnectionError), e:
1194
raise errors.BoundBranchConnectionFailure(
1198
def set_bound_location(self, location):
1199
"""Set the target where this branch is bound to.
1201
:param location: URL to the target branch
1204
self.control_files.put_utf8('bound', location+'\n')
1207
self.control_files._transport.delete('bound')
1213
def bind(self, other):
1214
"""Bind the local branch the other branch.
1216
:param other: The branch to bind to
1219
# TODO: jam 20051230 Consider checking if the target is bound
1220
# It is debatable whether you should be able to bind to
1221
# a branch which is itself bound.
1222
# Committing is obviously forbidden,
1223
# but binding itself may not be.
1224
# Since we *have* to check at commit time, we don't
1225
# *need* to check here
1228
# we are now equal to or a suffix of other.
1230
# Since we have 'pulled' from the remote location,
1231
# now we should try to pull in the opposite direction
1232
# in case the local tree has more revisions than the
1234
# There may be a different check you could do here
1235
# rather than actually trying to install revisions remotely.
1236
# TODO: capture an exception which indicates the remote branch
1238
# If it is up-to-date, this probably should not be a failure
1240
# lock other for write so the revision-history syncing cannot race
1244
# if this does not error, other now has the same last rev we do
1245
# it can only error if the pull from other was concurrent with
1246
# a commit to other from someone else.
1248
# until we ditch revision-history, we need to sync them up:
1249
self.set_revision_history(other.revision_history())
1250
# now other and self are up to date with each other and have the
1251
# same revision-history.
1255
self.set_bound_location(other.base)
1259
"""If bound, unbind"""
1260
return self.set_bound_location(None)
1264
"""Synchronise this branch with the master branch if any.
1266
:return: None or the last_revision that was pivoted out during the
1269
master = self.get_master_branch()
1270
if master is not None:
1271
old_tip = self.last_revision()
1272
self.pull(master, overwrite=True)
1273
if old_tip in self.repository.get_ancestry(self.last_revision()):
1279
class BranchTestProviderAdapter(object):
1280
"""A tool to generate a suite testing multiple branch formats at once.
1282
This is done by copying the test once for each transport and injecting
1283
the transport_server, transport_readonly_server, and branch_format
1284
classes into each copy. Each copy is also given a new id() to make it
1288
def __init__(self, transport_server, transport_readonly_server, formats):
1289
self._transport_server = transport_server
1290
self._transport_readonly_server = transport_readonly_server
1291
self._formats = formats
1293
def adapt(self, test):
1294
result = TestSuite()
1295
for branch_format, bzrdir_format in self._formats:
1296
new_test = deepcopy(test)
1297
new_test.transport_server = self._transport_server
1298
new_test.transport_readonly_server = self._transport_readonly_server
1299
new_test.bzrdir_format = bzrdir_format
1300
new_test.branch_format = branch_format
1301
def make_new_test_id():
1302
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1303
return lambda: new_id
1304
new_test.id = make_new_test_id()
1305
result.addTest(new_test)
1309
######################################################################
1313
@deprecated_function(zero_eight)
1314
def ScratchBranch(*args, **kwargs):
1315
"""See bzrlib.bzrdir.ScratchDir."""
1316
d = ScratchDir(*args, **kwargs)
1317
return d.open_branch()
1320
@deprecated_function(zero_eight)
1321
def is_control_file(*args, **kwargs):
1322
"""See bzrlib.workingtree.is_control_file."""
1323
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
