1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
22
21
from warnings import warn
23
from cStringIO import StringIO
27
import bzrlib.inventory as inventory
36
from bzrlib.config import TreeConfig
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
40
HistoryMissing, InvalidRevisionId,
41
InvalidRevisionNumber, LockError, NoSuchFile,
42
NoSuchRevision, NoWorkingTree, NotVersionedError,
43
NotBranchError, UninitializableFormat,
44
UnlistableStore, UnlistableBranch,
46
from bzrlib.lockable_files import LockableFiles, TransportLock
47
from bzrlib.symbol_versioning import (deprecated_function,
51
zero_eight, zero_nine,
28
53
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file,
31
file_kind, abspath, normpath, pathjoin)
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError,
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
42
from bzrlib.delta import compare_trees
43
from bzrlib.tree import EmptyTree, RevisionTree
44
from bzrlib.inventory import Inventory
45
from bzrlib.store import copy_all
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
53
from config import TreeConfig
56
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
59
## TODO: Maybe include checks for common corruption of newlines, etc?
61
# TODO: Maybe include checks for common corruption of newlines, etc?
62
63
# TODO: Some operations like log might retrieve the same revisions
63
64
# repeatedly to calculate deltas. We could perhaps have a weakref
64
65
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations.
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
78
return unbound(self, *args, **kwargs)
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
89
return unbound(self, *args, **kwargs)
66
# cached in memory between lock and unlock operations. .. nb thats
67
# what the transaction identity map provides
94
70
######################################################################
128
122
Basically we keep looking up until we find the control directory or
129
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
130
126
If there is one, it is returned, along with the unused portion of url.
132
t = get_transport(url)
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError, e:
137
mutter('not a branch in: %r %s', t.base, e)
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
128
control, relpath = bzrdir.BzrDir.open_containing(url)
129
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
145
133
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
150
141
def setup_caching(self, cache_root):
151
142
"""Subclasses that care about caching should override this, and set
152
143
up cached stores located under cache_root.
145
# seems to be unused, 2006-01-13 mbp
146
warn('%s is deprecated' % self.setup_caching)
154
147
self.cache_root = cache_root
149
def get_config(self):
150
return bzrlib.config.BranchConfig(self)
156
152
def _get_nick(self):
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
153
return self.get_config().get_nickname()
160
155
def _set_nick(self, nick):
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
156
self.get_config().set_user_option('nickname', nick)
165
158
nick = property(_get_nick, _set_nick)
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
171
def get_transaction(self):
172
"""Return the current active transaction.
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
177
raise NotImplementedError('get_transaction is abstract')
161
raise NotImplementedError(self.is_locked)
179
163
def lock_write(self):
180
raise NotImplementedError('lock_write is abstract')
164
raise NotImplementedError(self.lock_write)
182
166
def lock_read(self):
183
raise NotImplementedError('lock_read is abstract')
167
raise NotImplementedError(self.lock_read)
185
169
def unlock(self):
186
raise NotImplementedError('unlock is abstract')
170
raise NotImplementedError(self.unlock)
172
def peek_lock_mode(self):
173
"""Return lock mode for the Branch: 'r', 'w' or None"""
174
raise NotImplementedError(self.peek_lock_mode)
176
def get_physical_lock_status(self):
177
raise NotImplementedError(self.get_physical_lock_status)
188
179
def abspath(self, name):
189
180
"""Return absolute filename for something in the branch
191
182
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
183
method and not a tree method.
194
raise NotImplementedError('abspath is abstract')
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
211
raise NotImplementedError('controlfile is abstract')
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
216
:param path: The path to put the file, relative to the .bzr control
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
221
raise NotImplementedError('put_controlfile is abstract')
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
230
raise NotImplementedError('put_controlfiles is abstract')
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
239
def print_file(self, file, revision_id):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
185
raise NotImplementedError(self.abspath)
187
def bind(self, other):
188
"""Bind the local branch the other branch.
190
:param other: The branch to bind to
193
raise errors.UpgradeRequired(self.base)
196
def fetch(self, from_branch, last_revision=None, pb=None):
197
"""Copy revisions from from_branch into this branch.
199
:param from_branch: Where to copy from.
200
:param last_revision: What revision to stop at (None for at the end
202
:param pb: An optional progress bar to use.
204
Returns the copied revision count and the failed revisions in a tuple:
207
if self.base == from_branch.base:
210
nested_pb = 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 = 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 branch we are bound to.
236
Older format branches cannot bind, please be sure to use a metadir
241
def get_commit_builder(self, parents, config=None, timestamp=None,
242
timezone=None, committer=None, revprops=None,
244
"""Obtain a CommitBuilder for this branch.
246
:param parents: Revision ids of the parents of the new revision.
247
:param config: Optional configuration to use.
248
:param timestamp: Optional timestamp recorded for commit.
249
:param timezone: Optional timezone for timestamp.
250
:param committer: Optional committer to set for commit.
251
:param revprops: Optional dictionary of revision properties.
252
:param revision_id: Optional revision id.
256
config = self.get_config()
258
return self.repository.get_commit_builder(self, parents, config,
259
timestamp, timezone, committer, revprops, revision_id)
261
def get_master_branch(self):
262
"""Return the branch we are bound to.
264
:return: Either a Branch, or None
263
268
def get_revision_delta(self, revno):
264
269
"""Return the delta for one revision.
481
459
if revno < 1 or revno > self.revno():
482
460
raise InvalidRevisionNumber(revno)
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
463
def clone(self, *args, **kwargs):
464
"""Clone this branch into to_bzrdir preserving all semantic values.
466
revision_id: if not None, the revision history in the new branch will
467
be truncated to end with revision_id.
469
# for API compatibility, until 0.8 releases we provide the old api:
470
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
471
# after 0.8 releases, the *args and **kwargs should be changed:
472
# def clone(self, to_bzrdir, revision_id=None):
473
if (kwargs.get('to_location', None) or
474
kwargs.get('revision', None) or
475
kwargs.get('basis_branch', None) or
476
(len(args) and isinstance(args[0], basestring))):
477
# backwards compatibility api:
478
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
479
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
482
basis_branch = args[2]
484
basis_branch = kwargs.get('basis_branch', None)
486
basis = basis_branch.bzrdir
491
revision_id = args[1]
493
revision_id = kwargs.get('revision', None)
498
# no default to raise if not provided.
499
url = kwargs.get('to_location')
500
return self.bzrdir.clone(url,
501
revision_id=revision_id,
502
basis=basis).open_branch()
504
# generate args by hand
506
revision_id = args[1]
508
revision_id = kwargs.get('revision_id', None)
512
# no default to raise if not provided.
513
to_bzrdir = kwargs.get('to_bzrdir')
514
result = self._format.initialize(to_bzrdir)
515
self.copy_content_into(result, revision_id=revision_id)
519
def sprout(self, to_bzrdir, revision_id=None):
520
"""Create a new line of development from the branch, into to_bzrdir.
522
revision_id: if not None, the revision history in the new branch will
523
be truncated to end with revision_id.
525
result = self._format.initialize(to_bzrdir)
526
self.copy_content_into(result, revision_id=revision_id)
527
result.set_parent(self.bzrdir.root_transport.base)
531
def copy_content_into(self, destination, revision_id=None):
532
"""Copy the content of self into destination.
534
revision_id: if not None, the revision history in the new branch will
535
be truncated to end with revision_id.
537
new_history = self.revision_history()
538
if revision_id is not None:
540
new_history = new_history[:new_history.index(revision_id) + 1]
542
rev = self.repository.get_revision(revision_id)
543
new_history = rev.get_history(self.repository)[1:]
544
destination.set_revision_history(new_history)
546
parent = self.get_parent()
547
except errors.InaccessibleParent, e:
548
mutter('parent was not accessible to copy: %s', e)
551
destination.set_parent(parent)
555
"""Check consistency of the branch.
557
In particular this checks that revisions given in the revision-history
558
do actually match up in the revision graph, and that they're all
559
present in the repository.
561
Callers will typically also want to check the repository.
563
:return: A BranchCheckResult.
565
mainline_parent_id = None
566
for revision_id in self.revision_history():
568
revision = self.repository.get_revision(revision_id)
569
except errors.NoSuchRevision, e:
570
raise errors.BzrCheckError("mainline revision {%s} not in repository"
572
# In general the first entry on the revision history has no parents.
573
# But it's not illegal for it to have parents listed; this can happen
574
# in imports from Arch when the parents weren't reachable.
575
if mainline_parent_id is not None:
576
if mainline_parent_id not in revision.parent_ids:
577
raise errors.BzrCheckError("previous revision {%s} not listed among "
579
% (mainline_parent_id, revision_id))
580
mainline_parent_id = revision_id
581
return BranchCheckResult(self)
583
def create_checkout(self, to_location, revision_id=None,
585
"""Create a checkout of a branch.
587
:param to_location: The url to produce the checkout at
588
:param revision_id: The revision to check out
589
:param lightweight: If True, produce a lightweight checkout, otherwise,
590
produce a bound branch (heavyweight checkout)
591
:return: The tree of the created checkout
594
t = transport.get_transport(to_location)
597
except errors.FileExists:
599
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
600
BranchReferenceFormat().initialize(checkout, self)
602
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
603
to_location, force_new_tree=False)
604
checkout = checkout_branch.bzrdir
605
checkout_branch.bind(self)
606
if revision_id is not None:
607
rh = checkout_branch.revision_history()
608
new_rh = rh[:rh.index(revision_id) + 1]
609
checkout_branch.set_revision_history(new_rh)
610
return checkout.create_workingtree(revision_id)
613
class BranchFormat(object):
614
"""An encapsulation of the initialization and open routines for a format.
616
Formats provide three things:
617
* An initialization routine,
621
Formats are placed in an dict by their format string for reference
622
during branch opening. Its not required that these be instances, they
623
can be classes themselves with class methods - it simply depends on
624
whether state is needed for a given format or not.
626
Once a format is deprecated, just deprecate the initialize and open
627
methods on the format class. Do not deprecate the object, as the
628
object will be created every time regardless.
631
_default_format = None
632
"""The default format used for new branches."""
635
"""The known formats."""
638
def find_format(klass, a_bzrdir):
639
"""Return the format for the branch object in a_bzrdir."""
641
transport = a_bzrdir.get_branch_transport(None)
642
format_string = transport.get("format").read()
643
return klass._formats[format_string]
645
raise NotBranchError(path=transport.base)
647
raise errors.UnknownFormatError(format=format_string)
650
def get_default_format(klass):
651
"""Return the current default format."""
652
return klass._default_format
654
def get_format_string(self):
655
"""Return the ASCII format string that identifies this format."""
656
raise NotImplementedError(self.get_format_string)
658
def get_format_description(self):
659
"""Return the short format description for this format."""
660
raise NotImplementedError(self.get_format_string)
662
def initialize(self, a_bzrdir):
663
"""Create a branch of this format in a_bzrdir."""
664
raise NotImplementedError(self.initialize)
666
def is_supported(self):
667
"""Is this format supported?
669
Supported formats can be initialized and opened.
670
Unsupported formats may not support initialization or committing or
671
some other features depending on the reason for not being supported.
675
def open(self, a_bzrdir, _found=False):
676
"""Return the branch object for a_bzrdir
678
_found is a private parameter, do not use it. It is used to indicate
679
if format probing has already be done.
681
raise NotImplementedError(self.open)
684
def register_format(klass, format):
685
klass._formats[format.get_format_string()] = format
688
def set_default_format(klass, format):
689
klass._default_format = format
692
def unregister_format(klass, format):
693
assert klass._formats[format.get_format_string()] is format
694
del klass._formats[format.get_format_string()]
697
return self.get_format_string().rstrip()
700
class BzrBranchFormat4(BranchFormat):
701
"""Bzr branch format 4.
704
- a revision-history file.
705
- a branch-lock lock file [ to be shared with the bzrdir ]
708
def get_format_description(self):
709
"""See BranchFormat.get_format_description()."""
710
return "Branch format 4"
712
def initialize(self, a_bzrdir):
713
"""Create a branch of this format in a_bzrdir."""
714
mutter('creating branch in %s', a_bzrdir.transport.base)
715
branch_transport = a_bzrdir.get_branch_transport(self)
716
utf8_files = [('revision-history', ''),
719
control_files = LockableFiles(branch_transport, 'branch-lock',
721
control_files.create_lock()
722
control_files.lock_write()
724
for file, content in utf8_files:
725
control_files.put_utf8(file, content)
727
control_files.unlock()
728
return self.open(a_bzrdir, _found=True)
731
super(BzrBranchFormat4, self).__init__()
732
self._matchingbzrdir = bzrdir.BzrDirFormat6()
734
def open(self, a_bzrdir, _found=False):
735
"""Return the branch object for a_bzrdir
737
_found is a private parameter, do not use it. It is used to indicate
738
if format probing has already be done.
741
# we are being called directly and must probe.
742
raise NotImplementedError
743
return BzrBranch(_format=self,
744
_control_files=a_bzrdir._control_files,
746
_repository=a_bzrdir.open_repository())
749
return "Bazaar-NG branch format 4"
752
class BzrBranchFormat5(BranchFormat):
753
"""Bzr branch format 5.
756
- a revision-history file.
758
- a lock dir guarding the branch itself
759
- all of this stored in a branch/ subdirectory
760
- works with shared repositories.
762
This format is new in bzr 0.8.
765
def get_format_string(self):
766
"""See BranchFormat.get_format_string()."""
767
return "Bazaar-NG branch format 5\n"
769
def get_format_description(self):
770
"""See BranchFormat.get_format_description()."""
771
return "Branch format 5"
773
def initialize(self, a_bzrdir):
774
"""Create a branch of this format in a_bzrdir."""
775
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
776
branch_transport = a_bzrdir.get_branch_transport(self)
777
utf8_files = [('revision-history', ''),
780
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
781
control_files.create_lock()
782
control_files.lock_write()
783
control_files.put_utf8('format', self.get_format_string())
785
for file, content in utf8_files:
786
control_files.put_utf8(file, content)
788
control_files.unlock()
789
return self.open(a_bzrdir, _found=True, )
792
super(BzrBranchFormat5, self).__init__()
793
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
795
def open(self, a_bzrdir, _found=False):
796
"""Return the branch object for a_bzrdir
798
_found is a private parameter, do not use it. It is used to indicate
799
if format probing has already be done.
802
format = BranchFormat.find_format(a_bzrdir)
803
assert format.__class__ == self.__class__
804
transport = a_bzrdir.get_branch_transport(None)
805
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
806
return BzrBranch5(_format=self,
807
_control_files=control_files,
809
_repository=a_bzrdir.find_repository())
812
return "Bazaar-NG Metadir branch format 5"
815
class BranchReferenceFormat(BranchFormat):
816
"""Bzr branch reference format.
818
Branch references are used in implementing checkouts, they
819
act as an alias to the real branch which is at some other url.
826
def get_format_string(self):
827
"""See BranchFormat.get_format_string()."""
828
return "Bazaar-NG Branch Reference Format 1\n"
830
def get_format_description(self):
831
"""See BranchFormat.get_format_description()."""
832
return "Checkout reference format 1"
834
def initialize(self, a_bzrdir, target_branch=None):
835
"""Create a branch of this format in a_bzrdir."""
836
if target_branch is None:
837
# this format does not implement branch itself, thus the implicit
838
# creation contract must see it as uninitializable
839
raise errors.UninitializableFormat(self)
840
mutter('creating branch reference in %s', a_bzrdir.transport.base)
841
branch_transport = a_bzrdir.get_branch_transport(self)
842
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
843
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
844
branch_transport.put('format', StringIO(self.get_format_string()))
845
return self.open(a_bzrdir, _found=True)
848
super(BranchReferenceFormat, self).__init__()
849
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
851
def _make_reference_clone_function(format, a_branch):
852
"""Create a clone() routine for a branch dynamically."""
853
def clone(to_bzrdir, revision_id=None):
854
"""See Branch.clone()."""
855
return format.initialize(to_bzrdir, a_branch)
856
# cannot obey revision_id limits when cloning a reference ...
857
# FIXME RBC 20060210 either nuke revision_id for clone, or
858
# emit some sort of warning/error to the caller ?!
861
def open(self, a_bzrdir, _found=False):
862
"""Return the branch that the branch reference in a_bzrdir points at.
864
_found is a private parameter, do not use it. It is used to indicate
865
if format probing has already be done.
868
format = BranchFormat.find_format(a_bzrdir)
869
assert format.__class__ == self.__class__
870
transport = a_bzrdir.get_branch_transport(None)
871
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
872
result = real_bzrdir.open_branch()
873
# this changes the behaviour of result.clone to create a new reference
874
# rather than a copy of the content of the branch.
875
# I did not use a proxy object because that needs much more extensive
876
# testing, and we are only changing one behaviour at the moment.
877
# If we decide to alter more behaviours - i.e. the implicit nickname
878
# then this should be refactored to introduce a tested proxy branch
879
# and a subclass of that for use in overriding clone() and ....
881
result.clone = self._make_reference_clone_function(result)
885
# formats which have no format string are not discoverable
886
# and not independently creatable, so are not registered.
887
__default_format = BzrBranchFormat5()
888
BranchFormat.register_format(__default_format)
889
BranchFormat.register_format(BranchReferenceFormat())
890
BranchFormat.set_default_format(__default_format)
891
_legacy_formats = [BzrBranchFormat4(),
490
894
class BzrBranch(Branch):
491
895
"""A branch stored in the actual filesystem.
556
914
version is not applied. This is intended only for
557
915
upgrade/recovery type use; it's not guaranteed that
558
916
all operations will work on old format branches.
560
In the test suite, creation of new trees is tested using the
561
`ScratchBranch` class.
563
assert isinstance(transport, Transport), \
564
"%r is not a Transport" % transport
565
self._transport = transport
568
self._check_format(relax_version_check)
571
def get_store(name, compressed=True, prefixed=False):
572
relpath = self._rel_controlfilename(unicode(name))
573
store = TextStore(self._transport.clone(relpath),
574
dir_mode=self._dir_mode,
575
file_mode=self._file_mode,
577
compressed=compressed)
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(unicode(name))
582
ws = WeaveStore(self._transport.clone(relpath),
584
dir_mode=self._dir_mode,
585
file_mode=self._file_mode)
586
if self._transport.should_cache():
587
ws.enable_cache = True
590
if self._branch_format == 4:
591
self.inventory_store = get_store('inventory-store')
592
self.text_store = get_store('text-store')
593
self.revision_store = get_store('revision-store')
594
elif self._branch_format == 5:
595
self.control_weaves = get_weave(u'')
596
self.weave_store = get_weave(u'weaves')
597
self.revision_store = get_store(u'revision-store', compressed=False)
598
elif self._branch_format == 6:
599
self.control_weaves = get_weave(u'')
600
self.weave_store = get_weave(u'weaves', prefixed=True)
601
self.revision_store = get_store(u'revision-store', compressed=False,
603
self.revision_store.register_suffix('sig')
604
self._transaction = None
919
self.bzrdir = bzrdir.BzrDir.open(transport.base)
921
self.bzrdir = a_bzrdir
922
self._transport = self.bzrdir.transport.clone('..')
923
self._base = self._transport.base
924
self._format = _format
925
if _control_files is None:
926
raise ValueError('BzrBranch _control_files is None')
927
self.control_files = _control_files
928
if deprecated_passed(init):
929
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
930
"deprecated as of bzr 0.8. Please use Branch.create().",
934
# this is slower than before deprecation, oh well never mind.
936
self._initialize(transport.base)
937
self._check_format(_format)
938
if deprecated_passed(relax_version_check):
939
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
940
"relax_version_check parameter is deprecated as of bzr 0.8. "
941
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
945
if (not relax_version_check
946
and not self._format.is_supported()):
947
raise errors.UnsupportedFormatError(format=fmt)
948
if deprecated_passed(transport):
949
warn("BzrBranch.__init__(transport=XXX...): The transport "
950
"parameter is deprecated as of bzr 0.8. "
951
"Please use Branch.open, or bzrdir.open_branch().",
954
self.repository = _repository
606
956
def __str__(self):
607
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
957
return '%s(%r)' % (self.__class__.__name__, self.base)
609
959
__repr__ = __str__
611
961
def __del__(self):
612
if self._lock_mode or self._lock:
613
# XXX: This should show something every time, and be suitable for
614
# headless operation and embedding
615
warn("branch %r was not explicitly unlocked" % self)
618
962
# TODO: It might be best to do this somewhere else,
619
963
# but it is nice for a Branch object to automatically
620
964
# cache it's information.
621
965
# Alternatively, we could have the Transport objects cache requests
622
966
# See the earlier discussion about how major objects (like Branch)
623
967
# should never expect their __del__ function to run.
968
# XXX: cache_root seems to be unused, 2006-01-13 mbp
624
969
if hasattr(self, 'cache_root') and self.cache_root is not None:
626
shutil.rmtree(self.cache_root)
971
osutils.rmtree(self.cache_root)
629
974
self.cache_root = None
631
976
def _get_base(self):
633
return self._transport.base
636
979
base = property(_get_base, doc="The URL for the root of this branch.")
638
981
def _finish_transaction(self):
639
982
"""Exit the current transaction."""
640
if self._transaction is None:
641
raise errors.LockError('Branch %s is not in a transaction' %
643
transaction = self._transaction
644
self._transaction = None
983
return self.control_files._finish_transaction()
647
985
def get_transaction(self):
648
"""See Branch.get_transaction."""
649
if self._transaction is None:
650
return transactions.PassThroughTransaction()
652
return self._transaction
654
def _set_transaction(self, new_transaction):
986
"""Return the current active transaction.
988
If no transaction is active, this returns a passthrough object
989
for which all data is immediately flushed and no caching happens.
991
# this is an explicit function so that we can do tricky stuff
992
# when the storage in rev_storage is elsewhere.
993
# we probably need to hook the two 'lock a location' and
994
# 'have a transaction' together more delicately, so that
995
# we can have two locks (branch and storage) and one transaction
996
# ... and finishing the transaction unlocks both, but unlocking
997
# does not. - RBC 20051121
998
return self.control_files.get_transaction()
1000
def _set_transaction(self, transaction):
655
1001
"""Set a new active transaction."""
656
if self._transaction is not None:
657
raise errors.LockError('Branch %s is in a transaction already.' %
659
self._transaction = new_transaction
661
def lock_write(self):
662
#mutter("lock write: %s (%s)", self, self._lock_count)
663
# TODO: Upgrade locking to support using a Transport,
664
# and potentially a remote locking protocol
666
if self._lock_mode != 'w':
667
raise LockError("can't upgrade to a write lock from %r" %
669
self._lock_count += 1
671
self._lock = self._transport.lock_write(
672
self._rel_controlfilename('branch-lock'))
673
self._lock_mode = 'w'
675
self._set_transaction(transactions.PassThroughTransaction())
678
#mutter("lock read: %s (%s)", self, self._lock_count)
680
assert self._lock_mode in ('r', 'w'), \
681
"invalid lock mode %r" % self._lock_mode
682
self._lock_count += 1
684
self._lock = self._transport.lock_read(
685
self._rel_controlfilename('branch-lock'))
686
self._lock_mode = 'r'
688
self._set_transaction(transactions.ReadOnlyTransaction())
689
# 5K may be excessive, but hey, its a knob.
690
self.get_transaction().set_cache_size(5000)
693
#mutter("unlock: %s (%s)", self, self._lock_count)
694
if not self._lock_mode:
695
raise LockError('branch %r is not locked' % (self))
697
if self._lock_count > 1:
698
self._lock_count -= 1
700
self._finish_transaction()
703
self._lock_mode = self._lock_count = None
1002
return self.control_files._set_transaction(transaction)
705
1004
def abspath(self, name):
706
1005
"""See Branch.abspath."""
707
return self._transport.abspath(name)
709
def _rel_controlfilename(self, file_or_path):
710
if not isinstance(file_or_path, basestring):
711
file_or_path = u'/'.join(file_or_path)
712
if file_or_path == '':
714
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
716
def controlfilename(self, file_or_path):
717
"""See Branch.controlfilename."""
718
return self._transport.abspath(self._rel_controlfilename(file_or_path))
720
def controlfile(self, file_or_path, mode='r'):
721
"""See Branch.controlfile."""
724
relpath = self._rel_controlfilename(file_or_path)
725
#TODO: codecs.open() buffers linewise, so it was overloaded with
726
# a much larger buffer, do we need to do the same for getreader/getwriter?
728
return self._transport.get(relpath)
730
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
732
# XXX: Do we really want errors='replace'? Perhaps it should be
733
# an error, or at least reported, if there's incorrectly-encoded
734
# data inside a file.
735
# <https://launchpad.net/products/bzr/+bug/3823>
736
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
738
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
740
raise BzrError("invalid controlfile mode %r" % mode)
742
def put_controlfile(self, path, f, encode=True):
743
"""See Branch.put_controlfile."""
744
self.put_controlfiles([(path, f)], encode=encode)
746
def put_controlfiles(self, files, encode=True):
747
"""See Branch.put_controlfiles."""
750
for path, f in files:
752
if isinstance(f, basestring):
753
f = f.encode('utf-8', 'replace')
755
f = codecs.getwriter('utf-8')(f, errors='replace')
756
path = self._rel_controlfilename(path)
757
ctrl_files.append((path, f))
758
self._transport.put_multi(ctrl_files, mode=self._file_mode)
760
def _find_modes(self, path=None):
761
"""Determine the appropriate modes for files and directories."""
764
path = self._rel_controlfilename('')
765
st = self._transport.stat(path)
766
except errors.TransportNotPossible:
767
self._dir_mode = 0755
768
self._file_mode = 0644
770
self._dir_mode = st.st_mode & 07777
771
# Remove the sticky and execute bits for files
772
self._file_mode = self._dir_mode & ~07111
773
if not self._set_dir_mode:
774
self._dir_mode = None
775
if not self._set_file_mode:
776
self._file_mode = None
778
def _make_control(self):
779
from bzrlib.inventory import Inventory
780
from bzrlib.weavefile import write_weave_v5
781
from bzrlib.weave import Weave
783
# Create an empty inventory
785
# if we want per-tree root ids then this is the place to set
786
# them; they're not needed for now and so ommitted for
788
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
789
empty_inv = sio.getvalue()
791
bzrlib.weavefile.write_weave_v5(Weave(), sio)
792
empty_weave = sio.getvalue()
794
cfn = self._rel_controlfilename
795
# Since we don't have a .bzr directory, inherit the
796
# mode from the root directory
797
self._find_modes(u'.')
799
dirs = ['', 'revision-store', 'weaves']
801
"This is a Bazaar-NG control directory.\n"
802
"Do not change any files in this directory.\n"),
803
('branch-format', BZR_BRANCH_FORMAT_6),
804
('revision-history', ''),
807
('pending-merges', ''),
808
('inventory', empty_inv),
809
('inventory.weave', empty_weave),
810
('ancestry.weave', empty_weave)
812
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
813
self.put_controlfiles(files)
814
mutter('created control directory in ' + self._transport.base)
816
def _check_format(self, relax_version_check):
817
"""Check this branch format is supported.
819
The format level is stored, as an integer, in
820
self._branch_format for code that needs to check it later.
822
In the future, we might need different in-memory Branch
823
classes to support downlevel branches. But not yet.
1006
return self.control_files._transport.abspath(name)
1008
def _check_format(self, format):
1009
"""Identify the branch format if needed.
1011
The format is stored as a reference to the format object in
1012
self._format for code that needs to check it later.
1014
The format parameter is either None or the branch format class
1015
used to open this branch.
1017
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
826
fmt = self.controlfile('branch-format', 'r').read()
828
raise NotBranchError(path=self.base)
829
mutter("got branch format %r", fmt)
830
if fmt == BZR_BRANCH_FORMAT_6:
831
self._branch_format = 6
832
elif fmt == BZR_BRANCH_FORMAT_5:
833
self._branch_format = 5
834
elif fmt == BZR_BRANCH_FORMAT_4:
835
self._branch_format = 4
837
if (not relax_version_check
838
and self._branch_format not in (5, 6)):
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'])
1020
format = BranchFormat.find_format(self.bzrdir)
1021
self._format = format
1022
mutter("got branch format %s", self._format)
845
1024
@needs_read_lock
846
1025
def get_root_id(self):
847
1026
"""See Branch.get_root_id."""
848
inv = self.get_inventory(self.last_revision())
849
return inv.root.file_id
1027
tree = self.repository.revision_tree(self.last_revision())
1028
return tree.inventory.root.file_id
1030
def is_locked(self):
1031
return self.control_files.is_locked()
1033
def lock_write(self):
1034
self.repository.lock_write()
1036
self.control_files.lock_write()
1038
self.repository.unlock()
1041
def lock_read(self):
1042
self.repository.lock_read()
1044
self.control_files.lock_read()
1046
self.repository.unlock()
1050
# TODO: test for failed two phase locks. This is known broken.
1052
self.control_files.unlock()
1054
self.repository.unlock()
1056
def peek_lock_mode(self):
1057
if self.control_files._lock_count == 0:
1060
return self.control_files._lock_mode
1062
def get_physical_lock_status(self):
1063
return self.control_files.get_physical_lock_status()
851
1065
@needs_read_lock
852
1066
def print_file(self, file, revision_id):
853
1067
"""See Branch.print_file."""
854
tree = self.revision_tree(revision_id)
855
# use inventory as it was in that revision
856
file_id = tree.inventory.path2id(file)
859
revno = self.revision_id_to_revno(revision_id)
860
except errors.NoSuchRevision:
861
# TODO: This should not be BzrError,
862
# but NoSuchFile doesn't fit either
863
raise BzrError('%r is not present in revision %s'
864
% (file, revision_id))
866
raise BzrError('%r is not present in revision %s'
868
tree.print_file(file_id)
1068
return self.repository.print_file(file, revision_id)
870
1070
@needs_write_lock
871
1071
def append_revision(self, *revision_ids):
879
1079
@needs_write_lock
880
1080
def set_revision_history(self, rev_history):
881
1081
"""See Branch.set_revision_history."""
882
old_revision = self.last_revision()
883
new_revision = rev_history[-1]
884
self.put_controlfile('revision-history', '\n'.join(rev_history))
886
self.working_tree().set_last_revision(new_revision, old_revision)
887
except NoWorkingTree:
888
mutter('Unable to set_last_revision without a working tree.')
890
def has_revision(self, revision_id):
891
"""See Branch.has_revision."""
892
return (revision_id is None
893
or self.revision_store.has_id(revision_id))
896
def _get_revision_xml_file(self, revision_id):
897
if not revision_id or not isinstance(revision_id, basestring):
898
raise InvalidRevisionId(revision_id=revision_id, branch=self)
900
return self.revision_store.get(revision_id)
901
except (IndexError, KeyError):
902
raise bzrlib.errors.NoSuchRevision(self, revision_id)
904
def get_revision_xml(self, revision_id):
905
"""See Branch.get_revision_xml."""
906
return self._get_revision_xml_file(revision_id).read()
908
def get_revision(self, revision_id):
909
"""See Branch.get_revision."""
910
xml_file = self._get_revision_xml_file(revision_id)
913
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
914
except SyntaxError, e:
915
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
919
assert r.revision_id == revision_id
922
def get_revision_sha1(self, revision_id):
923
"""See Branch.get_revision_sha1."""
924
# In the future, revision entries will be signed. At that
925
# point, it is probably best *not* to include the signature
926
# in the revision hash. Because that lets you re-sign
927
# the revision, (add signatures/remove signatures) and still
928
# have all hash pointers stay consistent.
929
# But for now, just hash the contents.
930
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
932
def get_ancestry(self, revision_id):
933
"""See Branch.get_ancestry."""
934
if revision_id is None:
936
w = self._get_inventory_weave()
937
return [None] + map(w.idx_to_name,
938
w.inclusions([w.lookup(revision_id)]))
940
def _get_inventory_weave(self):
941
return self.control_weaves.get_weave('inventory',
942
self.get_transaction())
944
def get_inventory(self, revision_id):
945
"""See Branch.get_inventory."""
946
xml = self.get_inventory_xml(revision_id)
947
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
949
def get_inventory_xml(self, revision_id):
950
"""See Branch.get_inventory_xml."""
952
assert isinstance(revision_id, basestring), type(revision_id)
953
iw = self._get_inventory_weave()
954
return iw.get_text(iw.lookup(revision_id))
956
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
958
def get_inventory_sha1(self, revision_id):
959
"""See Branch.get_inventory_sha1."""
960
return self.get_revision(revision_id).inventory_sha1
962
def get_revision_inventory(self, revision_id):
963
"""See Branch.get_revision_inventory."""
964
# TODO: Unify this with get_inventory()
965
# bzr 0.0.6 and later imposes the constraint that the inventory_id
966
# must be the same as its revision, so this is trivial.
967
if revision_id == None:
968
# This does not make sense: if there is no revision,
969
# then it is the current tree inventory surely ?!
970
# and thus get_root_id() is something that looks at the last
971
# commit on the branch, and the get_root_id is an inventory check.
972
raise NotImplementedError
973
# return Inventory(self.get_root_id())
1082
self.control_files.put_utf8(
1083
'revision-history', '\n'.join(rev_history))
1084
transaction = self.get_transaction()
1085
history = transaction.map.find_revision_history()
1086
if history is not None:
1087
# update the revision history in the identity map.
1088
history[:] = list(rev_history)
1089
# this call is disabled because revision_history is
1090
# not really an object yet, and the transaction is for objects.
1091
# transaction.register_dirty(history)
975
return self.get_inventory(revision_id)
1093
transaction.map.add_revision_history(rev_history)
1094
# this call is disabled because revision_history is
1095
# not really an object yet, and the transaction is for objects.
1096
# transaction.register_clean(history)
977
1098
@needs_read_lock
978
1099
def revision_history(self):
980
1101
transaction = self.get_transaction()
981
1102
history = transaction.map.find_revision_history()
982
1103
if history is not None:
983
mutter("cache hit for revision-history in %s", self)
1104
# mutter("cache hit for revision-history in %s", self)
984
1105
return list(history)
985
history = [l.rstrip('\r\n') for l in
986
self.controlfile('revision-history', 'r').readlines()]
1106
decode_utf8 = cache_utf8.decode
1107
history = [decode_utf8(l.rstrip('\r\n')) for l in
1108
self.control_files.get('revision-history').readlines()]
987
1109
transaction.map.add_revision_history(history)
988
1110
# this call is disabled because revision_history is
989
1111
# not really an object yet, and the transaction is for objects.
990
1112
# transaction.register_clean(history, precious=True)
991
1113
return list(history)
1116
def generate_revision_history(self, revision_id, last_rev=None,
1118
"""Create a new revision history that will finish with revision_id.
1120
:param revision_id: the new tip to use.
1121
:param last_rev: The previous last_revision. If not None, then this
1122
must be a ancestory of revision_id, or DivergedBranches is raised.
1123
:param other_branch: The other branch that DivergedBranches should
1124
raise with respect to.
1126
# stop_revision must be a descendant of last_revision
1127
stop_graph = self.repository.get_revision_graph(revision_id)
1128
if last_rev is not None and last_rev not in stop_graph:
1129
# our previous tip is not merged into stop_revision
1130
raise errors.DivergedBranches(self, other_branch)
1131
# make a new revision history from the graph
1132
current_rev_id = revision_id
1134
while current_rev_id not in (None, revision.NULL_REVISION):
1135
new_history.append(current_rev_id)
1136
current_rev_id_parents = stop_graph[current_rev_id]
1138
current_rev_id = current_rev_id_parents[0]
1140
current_rev_id = None
1141
new_history.reverse()
1142
self.set_revision_history(new_history)
993
1145
def update_revisions(self, other, stop_revision=None):
994
1146
"""See Branch.update_revisions."""
995
from bzrlib.fetch import greedy_fetch
996
if stop_revision is None:
997
stop_revision = other.last_revision()
998
### Should this be checking is_ancestor instead of revision_history?
999
if (stop_revision is not None and
1000
stop_revision in self.revision_history()):
1002
greedy_fetch(to_branch=self, from_branch=other,
1003
revision=stop_revision)
1004
pullable_revs = self.pullable_revisions(other, stop_revision)
1005
if len(pullable_revs) > 0:
1006
self.append_revision(*pullable_revs)
1008
def pullable_revisions(self, other, stop_revision):
1009
"""See Branch.pullable_revisions."""
1010
other_revno = other.revision_id_to_revno(stop_revision)
1012
return self.missing_revisions(other, other_revno)
1013
except DivergedBranches, e:
1015
pullable_revs = get_intervening_revisions(self.last_revision(),
1016
stop_revision, self)
1017
assert self.last_revision() not in pullable_revs
1018
return pullable_revs
1019
except bzrlib.errors.NotAncestor:
1020
if is_ancestor(self.last_revision(), stop_revision, self):
1025
def revision_tree(self, revision_id):
1026
"""See Branch.revision_tree."""
1027
# TODO: refactor this to use an existing revision object
1028
# so we don't need to read it in twice.
1029
if revision_id == None or revision_id == NULL_REVISION:
1032
inv = self.get_revision_inventory(revision_id)
1033
return RevisionTree(self, inv, revision_id)
1149
if stop_revision is None:
1150
stop_revision = other.last_revision()
1151
if stop_revision is None:
1152
# if there are no commits, we're done.
1154
# whats the current last revision, before we fetch [and change it
1156
last_rev = self.last_revision()
1157
# we fetch here regardless of whether we need to so that we pickup
1159
self.fetch(other, stop_revision)
1160
my_ancestry = self.repository.get_ancestry(last_rev)
1161
if stop_revision in my_ancestry:
1162
# last_revision is a descendant of stop_revision
1164
self.generate_revision_history(stop_revision, last_rev=last_rev,
1035
1169
def basis_tree(self):
1036
1170
"""See Branch.basis_tree."""
1038
revision_id = self.revision_history()[-1]
1039
xml = self.working_tree().read_basis_inventory(revision_id)
1040
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1041
return RevisionTree(self, inv, revision_id)
1042
except (IndexError, NoSuchFile, NoWorkingTree), e:
1043
return self.revision_tree(self.last_revision())
1171
return self.repository.revision_tree(self.last_revision())
1173
@deprecated_method(zero_eight)
1045
1174
def working_tree(self):
1046
"""See Branch.working_tree."""
1047
from bzrlib.workingtree import WorkingTree
1048
if self._transport.base.find('://') != -1:
1175
"""Create a Working tree object for this branch."""
1177
from bzrlib.transport.local import LocalTransport
1178
if (self.base.find('://') != -1 or
1179
not isinstance(self._transport, LocalTransport)):
1049
1180
raise NoWorkingTree(self.base)
1050
return WorkingTree(self.base, branch=self)
1181
return self.bzrdir.open_workingtree()
1052
1183
@needs_write_lock
1053
def pull(self, source, overwrite=False):
1184
def pull(self, source, overwrite=False, stop_revision=None):
1054
1185
"""See Branch.pull."""
1055
1186
source.lock_read()
1057
1188
old_count = len(self.revision_history())
1059
self.update_revisions(source)
1190
self.update_revisions(source,stop_revision)
1060
1191
except DivergedBranches:
1061
1192
if not overwrite:
1070
1201
def get_parent(self):
1071
1202
"""See Branch.get_parent."""
1073
1204
_locs = ['parent', 'pull', 'x-pull']
1205
assert self.base[-1] == '/'
1074
1206
for l in _locs:
1076
return self.controlfile(l, 'r').read().strip('\n')
1208
parent = self.control_files.get(l).read().strip('\n')
1077
1209
except NoSuchFile:
1211
# This is an old-format absolute path to a local branch
1212
# turn it into a url
1213
if parent.startswith('/'):
1214
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1216
return urlutils.join(self.base[:-1], parent)
1217
except errors.InvalidURLJoin, e:
1218
raise errors.InaccessibleParent(parent, self.base)
1081
1221
def get_push_location(self):
1082
1222
"""See Branch.get_push_location."""
1083
config = bzrlib.config.BranchConfig(self)
1084
push_loc = config.get_user_option('push_location')
1223
push_loc = self.get_config().get_user_option('push_location')
1085
1224
return push_loc
1087
1226
def set_push_location(self, location):
1088
1227
"""See Branch.set_push_location."""
1089
config = bzrlib.config.LocationConfig(self.base)
1090
config.set_user_option('push_location', location)
1228
self.get_config().set_user_option('push_location', location,
1092
1231
@needs_write_lock
1093
1232
def set_parent(self, url):
1094
1233
"""See Branch.set_parent."""
1095
1234
# TODO: Maybe delete old location files?
1096
from bzrlib.atomicfile import AtomicFile
1097
f = AtomicFile(self.controlfilename('parent'))
1235
# URLs should never be unicode, even on the local fs,
1236
# FIXUP this and get_parent in a future branch format bump:
1237
# read and rewrite the file, and have the new format code read
1238
# using .get not .get_utf8. RBC 20060125
1240
self.control_files._transport.delete('parent')
1242
if isinstance(url, unicode):
1244
url = url.encode('ascii')
1245
except UnicodeEncodeError:
1246
raise bzrlib.errors.InvalidURL(url,
1247
"Urls must be 7-bit ascii, "
1248
"use bzrlib.urlutils.escape")
1250
url = urlutils.relative_url(self.base, url)
1251
self.control_files.put('parent', url + '\n')
1253
@deprecated_function(zero_nine)
1104
1254
def tree_config(self):
1255
"""DEPRECATED; call get_config instead.
1256
TreeConfig has become part of BranchConfig."""
1105
1257
return TreeConfig(self)
1107
def sign_revision(self, revision_id, gpg_strategy):
1108
"""See Branch.sign_revision."""
1109
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1110
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1113
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1114
"""See Branch.store_revision_signature."""
1115
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1119
class ScratchBranch(BzrBranch):
1120
"""Special test class: a branch that cleans up after itself.
1122
>>> b = ScratchBranch()
1126
>>> b._transport.__del__()
1260
class BzrBranch5(BzrBranch):
1261
"""A format 5 branch. This supports new features over plan branches.
1263
It has support for a master_branch which is the data for bound branches.
1131
def __init__(self, files=[], dirs=[], transport=None):
1132
"""Make a test branch.
1134
This creates a temporary directory and runs init-tree in it.
1136
If any files are listed, they are created in the working copy.
1138
if transport is None:
1139
transport = bzrlib.transport.local.ScratchTransport()
1140
super(ScratchBranch, self).__init__(transport, init=True)
1271
super(BzrBranch5, self).__init__(_format=_format,
1272
_control_files=_control_files,
1274
_repository=_repository)
1277
def pull(self, source, overwrite=False, stop_revision=None):
1278
"""Updates branch.pull to be bound branch aware."""
1279
bound_location = self.get_bound_location()
1280
if source.base != bound_location:
1281
# not pulling from master, so we need to update master.
1282
master_branch = self.get_master_branch()
1284
master_branch.pull(source)
1285
source = master_branch
1286
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1288
def get_bound_location(self):
1290
return self.control_files.get_utf8('bound').read()[:-1]
1291
except errors.NoSuchFile:
1295
def get_master_branch(self):
1296
"""Return the branch we are bound to.
1298
:return: Either a Branch, or None
1300
This could memoise the branch, but if thats done
1301
it must be revalidated on each new lock.
1302
So for now we just don't memoise it.
1303
# RBC 20060304 review this decision.
1305
bound_loc = self.get_bound_location()
1309
return Branch.open(bound_loc)
1310
except (errors.NotBranchError, errors.ConnectionError), e:
1311
raise errors.BoundBranchConnectionFailure(
1315
def set_bound_location(self, location):
1316
"""Set the target where this branch is bound to.
1318
:param location: URL to the target branch
1321
self.control_files.put_utf8('bound', location+'\n')
1142
super(ScratchBranch, self).__init__(transport)
1145
self._transport.mkdir(d)
1148
self._transport.put(f, 'content of %s' % f)
1153
>>> orig = ScratchBranch(files=["file1", "file2"])
1154
>>> clone = orig.clone()
1155
>>> if os.name != 'nt':
1156
... os.path.samefile(orig.base, clone.base)
1158
... orig.base == clone.base
1161
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1164
from shutil import copytree
1165
from bzrlib.osutils import mkdtemp
1168
copytree(self.base, base, symlinks=True)
1169
return ScratchBranch(
1170
transport=bzrlib.transport.local.ScratchTransport(base))
1324
self.control_files._transport.delete('bound')
1330
def bind(self, other):
1331
"""Bind the local branch the other branch.
1333
:param other: The branch to bind to
1336
# TODO: jam 20051230 Consider checking if the target is bound
1337
# It is debatable whether you should be able to bind to
1338
# a branch which is itself bound.
1339
# Committing is obviously forbidden,
1340
# but binding itself may not be.
1341
# Since we *have* to check at commit time, we don't
1342
# *need* to check here
1345
# we are now equal to or a suffix of other.
1347
# Since we have 'pulled' from the remote location,
1348
# now we should try to pull in the opposite direction
1349
# in case the local tree has more revisions than the
1351
# There may be a different check you could do here
1352
# rather than actually trying to install revisions remotely.
1353
# TODO: capture an exception which indicates the remote branch
1355
# If it is up-to-date, this probably should not be a failure
1357
# lock other for write so the revision-history syncing cannot race
1361
# if this does not error, other now has the same last rev we do
1362
# it can only error if the pull from other was concurrent with
1363
# a commit to other from someone else.
1365
# until we ditch revision-history, we need to sync them up:
1366
self.set_revision_history(other.revision_history())
1367
# now other and self are up to date with each other and have the
1368
# same revision-history.
1372
self.set_bound_location(other.base)
1376
"""If bound, unbind"""
1377
return self.set_bound_location(None)
1381
"""Synchronise this branch with the master branch if any.
1383
:return: None or the last_revision that was pivoted out during the
1386
master = self.get_master_branch()
1387
if master is not None:
1388
old_tip = self.last_revision()
1389
self.pull(master, overwrite=True)
1390
if old_tip in self.repository.get_ancestry(self.last_revision()):
1396
class BranchTestProviderAdapter(object):
1397
"""A tool to generate a suite testing multiple branch formats at once.
1399
This is done by copying the test once for each transport and injecting
1400
the transport_server, transport_readonly_server, and branch_format
1401
classes into each copy. Each copy is also given a new id() to make it
1405
def __init__(self, transport_server, transport_readonly_server, formats):
1406
self._transport_server = transport_server
1407
self._transport_readonly_server = transport_readonly_server
1408
self._formats = formats
1410
def adapt(self, test):
1411
result = TestSuite()
1412
for branch_format, bzrdir_format in self._formats:
1413
new_test = deepcopy(test)
1414
new_test.transport_server = self._transport_server
1415
new_test.transport_readonly_server = self._transport_readonly_server
1416
new_test.bzrdir_format = bzrdir_format
1417
new_test.branch_format = branch_format
1418
def make_new_test_id():
1419
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1420
return lambda: new_id
1421
new_test.id = make_new_test_id()
1422
result.addTest(new_test)
1426
class BranchCheckResult(object):
1427
"""Results of checking branch consistency.
1432
def __init__(self, branch):
1433
self.branch = branch
1435
def report_results(self, verbose):
1436
"""Report the check results via trace.note.
1438
:param verbose: Requests more detailed display of what was checked,
1441
note('checked branch %s format %s',
1443
self.branch._format)
1173
1446
######################################################################
1177
def is_control_file(filename):
1178
## FIXME: better check
1179
filename = normpath(filename)
1180
while filename != '':
1181
head, tail = os.path.split(filename)
1182
## mutter('check %r for control file' % ((head, tail), ))
1183
if tail == bzrlib.BZRDIR:
1185
if filename == head:
1450
@deprecated_function(zero_eight)
1451
def is_control_file(*args, **kwargs):
1452
"""See bzrlib.workingtree.is_control_file."""
1453
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
