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
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
23
# TODO: remove unittest dependency; put that stuff inside the test suite
25
# TODO: The Format probe_transport seems a bit redundant with just trying to
26
# open the bzrdir. -- mbp
28
# TODO: Can we move specific formats into separate modules to make this file
31
from cStringIO import StringIO
34
35
from bzrlib.lazy_import import lazy_import
35
36
lazy_import(globals(), """
37
from copy import deepcopy
36
38
from stat import S_ISDIR
40
42
from bzrlib import (
50
47
revision as _mod_revision,
60
55
from bzrlib.osutils import (
63
from bzrlib.push import (
66
from bzrlib.repofmt import pack_repo
67
from bzrlib.smart.client import _SmartClient
60
from bzrlib.store.revision.text import TextRevisionStore
61
from bzrlib.store.text import TextStore
68
62
from bzrlib.store.versioned import WeaveStore
69
63
from bzrlib.transactions import WriteTransaction
70
from bzrlib.transport import (
71
do_catching_redirections,
64
from bzrlib.transport import get_transport
75
65
from bzrlib.weave import Weave
78
from bzrlib.trace import (
91
class ControlComponent(object):
92
"""Abstract base class for control directory components.
94
This provides interfaces that are common across bzrdirs,
95
repositories, branches, and workingtree control directories.
97
They all expose two urls and transports: the *user* URL is the
98
one that stops above the control directory (eg .bzr) and that
99
should normally be used in messages, and the *control* URL is
100
under that in eg .bzr/checkout and is used to read the control
103
This can be used as a mixin and is intended to fit with
108
def control_transport(self):
109
raise NotImplementedError
112
def control_url(self):
113
return self.control_transport.base
116
def user_transport(self):
117
raise NotImplementedError
121
return self.user_transport.base
124
class BzrDir(ControlComponent):
68
from bzrlib.trace import mutter, note
69
from bzrlib.transport.local import LocalTransport
125
73
"""A .bzr control diretory.
127
75
BzrDir instances let you create or open any of the things that can be
128
76
found within .bzr - checkouts, branches and repositories.
131
79
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
:ivar root_transport:
133
a transport connected to the directory this bzr was opened from
134
(i.e. the parent directory holding the .bzr directory).
136
Everything in the bzrdir should have the same file permissions.
138
:cvar hooks: An instance of BzrDirHooks.
81
a transport connected to the directory this bzr was opened from.
141
84
def break_lock(self):
165
106
def check_conversion_target(self, target_format):
166
"""Check that a bzrdir as a whole can be converted to a new format."""
167
# The only current restriction is that the repository content can be
168
# fetched compatibly with the target.
169
107
target_repo_format = target_format.repository_format
171
self.open_repository()._format.check_conversion_target(
173
except errors.NoRepositoryPresent:
174
# No repo, no problem.
108
source_repo_format = self._format.repository_format
109
source_repo_format.check_conversion_target(target_repo_format)
178
def _check_supported(format, allow_unsupported,
179
recommend_upgrade=True,
181
"""Give an error or warning on old formats.
183
:param format: may be any kind of format - workingtree, branch,
186
:param allow_unsupported: If true, allow opening
187
formats that are strongly deprecated, and which may
188
have limited functionality.
190
:param recommend_upgrade: If true (default), warn
191
the user through the ui object that they may wish
192
to upgrade the object.
112
def _check_supported(format, allow_unsupported):
113
"""Check whether format is a supported format.
115
If allow_unsupported is True, this is a no-op.
194
# TODO: perhaps move this into a base Format class; it's not BzrDir
195
# specific. mbp 20070323
196
117
if not allow_unsupported and not format.is_supported():
197
118
# see open_downlevel to open legacy branches.
198
119
raise errors.UnsupportedFormatError(format=format)
199
if recommend_upgrade \
200
and getattr(format, 'upgrade_recommended', False):
201
ui.ui_factory.recommend_upgrade(
202
format.get_format_description(),
205
def clone(self, url, revision_id=None, force_new_repo=False,
206
preserve_stacking=False):
121
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
207
122
"""Clone this bzrdir and its contents to url verbatim.
209
:param url: The url create the clone at. If url's last component does
210
not exist, it will be created.
211
:param revision_id: The tip revision-id to use for any branch or
212
working tree. If not None, then the clone operation may tune
213
itself to download less data.
214
:param force_new_repo: Do not use a shared repository for the target
215
even if one is available.
216
:param preserve_stacking: When cloning a stacked branch, stack the
217
new branch on top of the other branch's stacked-on branch.
219
return self.clone_on_transport(get_transport(url),
220
revision_id=revision_id,
221
force_new_repo=force_new_repo,
222
preserve_stacking=preserve_stacking)
224
def clone_on_transport(self, transport, revision_id=None,
225
force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
create_prefix=False, use_existing_dir=True):
227
"""Clone this bzrdir and its contents to transport verbatim.
229
:param transport: The transport for the location to produce the clone
230
at. If the target directory does not exist, it will be created.
231
:param revision_id: The tip revision-id to use for any branch or
232
working tree. If not None, then the clone operation may tune
233
itself to download less data.
234
:param force_new_repo: Do not use a shared repository for the target,
235
even if one is available.
236
:param preserve_stacking: When cloning a stacked branch, stack the
237
new branch on top of the other branch's stacked-on branch.
238
:param create_prefix: Create any missing directories leading up to
240
:param use_existing_dir: Use an existing directory if one exists.
242
# Overview: put together a broad description of what we want to end up
243
# with; then make as few api calls as possible to do it.
245
# We may want to create a repo/branch/tree, if we do so what format
246
# would we want for each:
247
require_stacking = (stacked_on is not None)
248
format = self.cloning_metadir(require_stacking)
250
# Figure out what objects we want:
124
If urls last component does not exist, it will be created.
126
if revision_id is not None, then the clone operation may tune
127
itself to download less data.
128
:param force_new_repo: Do not use a shared repository for the target
129
even if one is available.
132
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
133
result = self._format.initialize(url)
252
135
local_repo = self.find_repository()
253
136
except errors.NoRepositoryPresent:
254
137
local_repo = None
256
local_branch = self.open_branch()
257
except errors.NotBranchError:
260
# enable fallbacks when branch is not a branch reference
261
if local_branch.repository.has_same_location(local_repo):
262
local_repo = local_branch.repository
263
if preserve_stacking:
265
stacked_on = local_branch.get_stacked_on_url()
266
except (errors.UnstackableBranchFormat,
267
errors.UnstackableRepositoryFormat,
270
# Bug: We create a metadir without knowing if it can support stacking,
271
# we should look up the policy needs first, or just use it as a hint,
274
make_working_trees = local_repo.make_working_trees()
275
want_shared = local_repo.is_shared()
276
repo_format_name = format.repository_format.network_name()
278
make_working_trees = False
280
repo_format_name = None
282
result_repo, result, require_stacking, repository_policy = \
283
format.initialize_on_transport_ex(transport,
284
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
force_new_repo=force_new_repo, stacked_on=stacked_on,
286
stack_on_pwd=self.root_transport.base,
287
repo_format_name=repo_format_name,
288
make_working_trees=make_working_trees, shared_repo=want_shared)
291
# If the result repository is in the same place as the
292
# resulting bzr dir, it will have no content, further if the
293
# result is not stacked then we know all content should be
294
# copied, and finally if we are copying up to a specific
295
# revision_id then we can use the pending-ancestry-result which
296
# does not require traversing all of history to describe it.
297
if (result_repo.user_url == result.user_url
298
and not require_stacking and
299
revision_id is not None):
300
fetch_spec = graph.PendingAncestryResult(
301
[revision_id], local_repo)
302
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
139
# may need to copy content in
141
result_repo = local_repo.clone(
143
revision_id=revision_id,
145
result_repo.set_make_working_trees(local_repo.make_working_trees())
148
result_repo = result.find_repository()
149
# fetch content this dir needs.
151
# XXX FIXME RBC 20060214 need tests for this when the basis
153
result_repo.fetch(basis_repo, revision_id=revision_id)
304
154
result_repo.fetch(local_repo, revision_id=revision_id)
308
if result_repo is not None:
309
raise AssertionError('result_repo not None(%r)' % result_repo)
155
except errors.NoRepositoryPresent:
156
# needed to make one anyway.
157
result_repo = local_repo.clone(
159
revision_id=revision_id,
161
result_repo.set_make_working_trees(local_repo.make_working_trees())
310
162
# 1 if there is a branch present
311
163
# make sure its content is available in the target repository
313
if local_branch is not None:
314
result_branch = local_branch.clone(result, revision_id=revision_id,
315
repository_policy=repository_policy)
317
# Cheaper to check if the target is not local, than to try making
319
result.root_transport.local_abspath('.')
320
if result_repo is None or result_repo.make_working_trees():
321
self.open_workingtree().clone(result)
166
self.open_branch().clone(result, revision_id=revision_id)
167
except errors.NotBranchError:
170
self.open_workingtree().clone(result, basis=basis_tree)
322
171
except (errors.NoWorkingTree, errors.NotLocalUrl):
175
def _get_basis_components(self, basis):
176
"""Retrieve the basis components that are available at basis."""
178
return None, None, None
180
basis_tree = basis.open_workingtree()
181
basis_branch = basis_tree.branch
182
basis_repo = basis_branch.repository
183
except (errors.NoWorkingTree, errors.NotLocalUrl):
186
basis_branch = basis.open_branch()
187
basis_repo = basis_branch.repository
188
except errors.NotBranchError:
191
basis_repo = basis.open_repository()
192
except errors.NoRepositoryPresent:
194
return basis_repo, basis_branch, basis_tree
326
196
# TODO: This should be given a Transport, and should chdir up; otherwise
327
197
# this will open a new connection.
328
198
def _make_tail(self, url):
329
t = get_transport(url)
199
head, tail = urlutils.split(url)
200
if tail and tail != '.':
201
t = get_transport(head)
204
except errors.FileExists:
207
# TODO: Should take a Transport
333
def create(cls, base, format=None, possible_transports=None):
209
def create(cls, base, format=None):
334
210
"""Create a new BzrDir at the url 'base'.
212
This will call the current default formats initialize with base
213
as the only parameter.
336
215
:param format: If supplied, the format of branch to create. If not
337
216
supplied, the default is used.
338
:param possible_transports: If supplied, a list of transports that
339
can be reused to share a remote connection.
341
218
if cls is not BzrDir:
342
219
raise AssertionError("BzrDir.create always creates the default"
343
220
" format, not one of %r" % cls)
344
t = get_transport(base, possible_transports)
221
head, tail = urlutils.split(base)
222
if tail and tail != '.':
223
t = get_transport(head)
226
except errors.FileExists:
346
228
if format is None:
347
229
format = BzrDirFormat.get_default_format()
348
return format.initialize_on_transport(t)
351
def find_bzrdirs(transport, evaluate=None, list_current=None):
352
"""Find bzrdirs recursively from current location.
354
This is intended primarily as a building block for more sophisticated
355
functionality, like finding trees under a directory, or finding
356
branches that use a given repository.
357
:param evaluate: An optional callable that yields recurse, value,
358
where recurse controls whether this bzrdir is recursed into
359
and value is the value to yield. By default, all bzrdirs
360
are recursed into, and the return value is the bzrdir.
361
:param list_current: if supplied, use this function to list the current
362
directory, instead of Transport.list_dir
363
:return: a generator of found bzrdirs, or whatever evaluate returns.
365
if list_current is None:
366
def list_current(transport):
367
return transport.list_dir('')
369
def evaluate(bzrdir):
372
pending = [transport]
373
while len(pending) > 0:
374
current_transport = pending.pop()
377
bzrdir = BzrDir.open_from_transport(current_transport)
378
except errors.NotBranchError:
381
recurse, value = evaluate(bzrdir)
384
subdirs = list_current(current_transport)
385
except errors.NoSuchFile:
388
for subdir in sorted(subdirs, reverse=True):
389
pending.append(current_transport.clone(subdir))
391
def list_branches(self):
392
"""Return a sequence of all branches local to this control directory.
396
return [self.open_branch()]
397
except errors.NotBranchError:
401
def find_branches(transport):
402
"""Find all branches under a transport.
404
This will find all branches below the transport, including branches
405
inside other branches. Where possible, it will use
406
Repository.find_branches.
408
To list all the branches that use a particular Repository, see
409
Repository.find_branches
411
def evaluate(bzrdir):
413
repository = bzrdir.open_repository()
414
except errors.NoRepositoryPresent:
417
return False, ([], repository)
418
return True, (bzrdir.list_branches(), None)
420
for branches, repo in BzrDir.find_bzrdirs(transport,
423
ret.extend(repo.find_branches())
424
if branches is not None:
428
def destroy_repository(self):
429
"""Destroy the repository in this BzrDir"""
430
raise NotImplementedError(self.destroy_repository)
432
def create_branch(self, name=None):
230
return format.initialize(safe_unicode(base))
232
def create_branch(self):
433
233
"""Create a branch in this BzrDir.
435
:param name: Name of the colocated branch to create, None for
438
The bzrdir's format will control what branch format is created.
235
The bzrdirs format will control what branch format is created.
439
236
For more control see BranchFormatXX.create(a_bzrdir).
441
238
raise NotImplementedError(self.create_branch)
443
def destroy_branch(self, name=None):
444
"""Destroy a branch in this BzrDir.
446
:param name: Name of the branch to destroy, None for the default
449
raise NotImplementedError(self.destroy_branch)
452
241
def create_branch_and_repo(base, force_new_repo=False, format=None):
453
242
"""Create a new BzrDir, Branch and Repository at the url 'base'.
455
This will use the current default BzrDirFormat unless one is
456
specified, and use whatever
244
This will use the current default BzrDirFormat, and use whatever
457
245
repository format that that uses via bzrdir.create_branch and
458
246
create_repository. If a shared repository is available that is used
463
251
:param base: The URL to create the branch at.
464
252
:param force_new_repo: If True a new repository is always created.
465
:param format: If supplied, the format of branch to create. If not
466
supplied, the default is used.
468
254
bzrdir = BzrDir.create(base, format)
469
255
bzrdir._find_or_create_repository(force_new_repo)
470
256
return bzrdir.create_branch()
472
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
stack_on_pwd=None, require_stacking=False):
474
"""Return an object representing a policy to use.
476
This controls whether a new repository is created, and the format of
477
that repository, or some existing shared repository used instead.
479
If stack_on is supplied, will not seek a containing shared repo.
481
:param force_new_repo: If True, require a new repository to be created.
482
:param stack_on: If supplied, the location to stack on. If not
483
supplied, a default_stack_on location may be used.
484
:param stack_on_pwd: If stack_on is relative, the location it is
487
def repository_policy(found_bzrdir):
490
config = found_bzrdir.get_config()
492
stack_on = config.get_default_stack_on()
493
if stack_on is not None:
494
stack_on_pwd = found_bzrdir.user_url
496
# does it have a repository ?
498
repository = found_bzrdir.open_repository()
499
except errors.NoRepositoryPresent:
502
if (found_bzrdir.user_url != self.user_url
503
and not repository.is_shared()):
504
# Don't look higher, can't use a higher shared repo.
512
return UseExistingRepository(repository, stack_on,
513
stack_on_pwd, require_stacking=require_stacking), True
515
return CreateRepository(self, stack_on, stack_on_pwd,
516
require_stacking=require_stacking), True
518
if not force_new_repo:
520
policy = self._find_containing(repository_policy)
521
if policy is not None:
525
return UseExistingRepository(self.open_repository(),
526
stack_on, stack_on_pwd,
527
require_stacking=require_stacking)
528
except errors.NoRepositoryPresent:
530
return CreateRepository(self, stack_on, stack_on_pwd,
531
require_stacking=require_stacking)
533
258
def _find_or_create_repository(self, force_new_repo):
534
259
"""Create a new repository if needed, returning the repository."""
535
policy = self.determine_repository_policy(force_new_repo)
536
return policy.acquire_repository()[0]
261
return self.create_repository()
263
return self.find_repository()
264
except errors.NoRepositoryPresent:
265
return self.create_repository()
539
268
def create_branch_convenience(base, force_new_repo=False,
540
force_new_tree=None, format=None,
541
possible_transports=None):
269
force_new_tree=None, format=None):
542
270
"""Create a new BzrDir, Branch and Repository at the url 'base'.
544
272
This is a convenience function - it will use an existing repository
545
273
if possible, can be told explicitly whether to create a working tree or
548
This will use the current default BzrDirFormat unless one is
549
specified, and use whatever
276
This will use the current default BzrDirFormat, and use whatever
550
277
repository format that that uses via bzrdir.create_branch and
551
278
create_repository. If a shared repository is available that is used
552
279
preferentially. Whatever repository is used, its tree creation policy
684
387
raise NotImplementedError(self.destroy_workingtree_metadata)
686
def _find_containing(self, evaluate):
687
"""Find something in a containing control directory.
689
This method will scan containing control dirs, until it finds what
690
it is looking for, decides that it will never find it, or runs out
691
of containing control directories to check.
693
It is used to implement find_repository and
694
determine_repository_policy.
696
:param evaluate: A function returning (value, stop). If stop is True,
697
the value will be returned.
389
def find_repository(self):
390
"""Find the repository that should be used for a_bzrdir.
392
This does not require a branch as we use it to find the repo for
393
new branches as well as to hook existing branches up to their
397
return self.open_repository()
398
except errors.NoRepositoryPresent:
400
next_transport = self.root_transport.clone('..')
701
result, stop = evaluate(found_bzrdir)
704
next_transport = found_bzrdir.root_transport.clone('..')
705
if (found_bzrdir.user_url == next_transport.base):
706
# top of the file system
708
402
# find the next containing bzrdir
710
404
found_bzrdir = BzrDir.open_containing_from_transport(
711
405
next_transport)[0]
712
406
except errors.NotBranchError:
715
def find_repository(self):
716
"""Find the repository that should be used.
718
This does not require a branch as we use it to find the repo for
719
new branches as well as to hook existing branches up to their
722
def usable_repository(found_bzrdir):
408
raise errors.NoRepositoryPresent(self)
723
409
# does it have a repository ?
725
411
repository = found_bzrdir.open_repository()
726
412
except errors.NoRepositoryPresent:
728
if found_bzrdir.user_url == self.user_url:
729
return repository, True
730
elif repository.is_shared():
731
return repository, True
413
next_transport = found_bzrdir.root_transport.clone('..')
414
if (found_bzrdir.root_transport.base == next_transport.base):
415
# top of the file system
419
if ((found_bzrdir.root_transport.base ==
420
self.root_transport.base) or repository.is_shared()):
735
found_repo = self._find_containing(usable_repository)
736
if found_repo is None:
737
raise errors.NoRepositoryPresent(self)
740
def get_branch_reference(self, name=None):
741
"""Return the referenced URL for the branch in this bzrdir.
743
:param name: Optional colocated branch name
744
:raises NotBranchError: If there is no Branch.
745
:raises NoColocatedBranchSupport: If a branch name was specified
746
but colocated branches are not supported.
747
:return: The URL the branch in this bzrdir references if it is a
748
reference branch, or None for regular branches.
751
raise errors.NoColocatedBranchSupport(self)
754
def get_branch_transport(self, branch_format, name=None):
423
raise errors.NoRepositoryPresent(self)
424
raise errors.NoRepositoryPresent(self)
426
def get_branch_transport(self, branch_format):
755
427
"""Get the transport for use by branch format in this BzrDir.
757
429
Note that bzr dirs that do not support format strings will raise
758
430
IncompatibleFormat if the branch format they are given has
759
431
a format string, and vice versa.
761
If branch_format is None, the transport is returned with no
762
checking. If it is not None, then the returned transport is
433
If branch_format is None, the transport is returned with no
434
checking. if it is not None, then the returned transport is
763
435
guaranteed to point to an existing directory ready for use.
765
437
raise NotImplementedError(self.get_branch_transport)
767
def _find_creation_modes(self):
768
"""Determine the appropriate modes for files and directories.
770
They're always set to be consistent with the base directory,
771
assuming that this transport allows setting modes.
773
# TODO: Do we need or want an option (maybe a config setting) to turn
774
# this off or override it for particular locations? -- mbp 20080512
775
if self._mode_check_done:
777
self._mode_check_done = True
779
st = self.transport.stat('.')
780
except errors.TransportNotPossible:
781
self._dir_mode = None
782
self._file_mode = None
784
# Check the directory mode, but also make sure the created
785
# directories and files are read-write for this user. This is
786
# mostly a workaround for filesystems which lie about being able to
787
# write to a directory (cygwin & win32)
788
if (st.st_mode & 07777 == 00000):
789
# FTP allows stat but does not return dir/file modes
790
self._dir_mode = None
791
self._file_mode = None
793
self._dir_mode = (st.st_mode & 07777) | 00700
794
# Remove the sticky and execute bits for files
795
self._file_mode = self._dir_mode & ~07111
797
def _get_file_mode(self):
798
"""Return Unix mode for newly created files, or None.
800
if not self._mode_check_done:
801
self._find_creation_modes()
802
return self._file_mode
804
def _get_dir_mode(self):
805
"""Return Unix mode for newly created directories, or None.
807
if not self._mode_check_done:
808
self._find_creation_modes()
809
return self._dir_mode
811
439
def get_repository_transport(self, repository_format):
812
440
"""Get the transport for use by repository format in this BzrDir.
900
509
def open_unsupported(base):
901
510
"""Open a branch which is not supported."""
902
511
return BzrDir.open(base, _unsupported=True)
905
def open(base, _unsupported=False, possible_transports=None):
906
"""Open an existing bzrdir, rooted at 'base' (url).
908
:param _unsupported: a private parameter to the BzrDir class.
514
def open(base, _unsupported=False):
515
"""Open an existing bzrdir, rooted at 'base' (url)
517
_unsupported is a private parameter to the BzrDir class.
910
t = get_transport(base, possible_transports=possible_transports)
519
t = get_transport(base)
911
520
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
914
def open_from_transport(transport, _unsupported=False,
915
_server_formats=True):
523
def open_from_transport(transport, _unsupported=False):
916
524
"""Open a bzrdir within a particular directory.
918
526
:param transport: Transport containing the bzrdir.
919
527
:param _unsupported: private.
921
for hook in BzrDir.hooks['pre_open']:
923
# Keep initial base since 'transport' may be modified while following
925
base = transport.base
926
def find_format(transport):
927
return transport, BzrDirFormat.find_format(
928
transport, _server_formats=_server_formats)
930
def redirected(transport, e, redirection_notice):
931
redirected_transport = transport._redirected_to(e.source, e.target)
932
if redirected_transport is None:
933
raise errors.NotBranchError(base)
934
note('%s is%s redirected to %s',
935
transport.base, e.permanently, redirected_transport.base)
936
return redirected_transport
939
transport, format = do_catching_redirections(find_format,
942
except errors.TooManyRedirections:
943
raise errors.NotBranchError(base)
529
format = BzrDirFormat.find_format(transport)
945
530
BzrDir._check_supported(format, _unsupported)
946
531
return format.open(transport, _found=True)
948
def open_branch(self, name=None, unsupported=False,
949
ignore_fallbacks=False):
533
def open_branch(self, unsupported=False):
950
534
"""Open the branch object at this BzrDir if one is present.
952
536
If unsupported is True, then no longer supported branch formats can
955
539
TODO: static convenience version of this?
957
541
raise NotImplementedError(self.open_branch)
960
def open_containing(url, possible_transports=None):
544
def open_containing(url):
961
545
"""Open an existing branch which contains url.
963
547
:param url: url to search from.
964
548
See open_containing_from_transport for more detail.
966
transport = get_transport(url, possible_transports)
967
return BzrDir.open_containing_from_transport(transport)
550
return BzrDir.open_containing_from_transport(get_transport(url))
970
553
def open_containing_from_transport(a_transport):
971
"""Open an existing branch which contains a_transport.base.
554
"""Open an existing branch which contains a_transport.base
973
556
This probes for a branch at a_transport, and searches upwards from there.
975
558
Basically we keep looking up until we find the control directory or
976
559
run into the root. If there isn't one, raises NotBranchError.
977
If there is one and it is either an unrecognised format or an unsupported
560
If there is one and it is either an unrecognised format or an unsupported
978
561
format, UnknownFormatError or UnsupportedFormatError are raised.
979
562
If there is one, it is returned, along with the unused portion of url.
981
:return: The BzrDir that contains the path, and a Unicode path
564
:return: The BzrDir that contains the path, and a Unicode path
982
565
for the rest of the URL.
984
567
# this gets the normalised url back. I.e. '.' -> the full path.
1043
589
relpath is the portion of the path that is contained by the branch.
1045
591
bzrdir, relpath = klass.open_containing(location)
1046
tree, branch = bzrdir._get_tree_branch()
593
tree = bzrdir.open_workingtree()
594
except (errors.NoWorkingTree, errors.NotLocalUrl):
596
branch = bzrdir.open_branch()
1047
599
return tree, branch, relpath
1050
def open_containing_tree_branch_or_repository(klass, location):
1051
"""Return the working tree, branch and repo contained by a location.
1053
Returns (tree, branch, repository, relpath).
1054
If there is no tree containing the location, tree will be None.
1055
If there is no branch containing the location, branch will be None.
1056
If there is no repository containing the location, repository will be
1058
relpath is the portion of the path that is contained by the innermost
1061
If no tree, branch or repository is found, a NotBranchError is raised.
1063
bzrdir, relpath = klass.open_containing(location)
1065
tree, branch = bzrdir._get_tree_branch()
1066
except errors.NotBranchError:
1068
repo = bzrdir.find_repository()
1069
return None, None, repo, relpath
1070
except (errors.NoRepositoryPresent):
1071
raise errors.NotBranchError(location)
1072
return tree, branch, branch.repository, relpath
1074
601
def open_repository(self, _unsupported=False):
1075
602
"""Open the repository object at this BzrDir if one is present.
1077
This will not follow the Branch object pointer - it's strictly a direct
604
This will not follow the Branch object pointer - its strictly a direct
1078
605
open facility. Most client code should use open_branch().repository to
1079
606
get at a repository.
1081
:param _unsupported: a private parameter, not part of the api.
608
_unsupported is a private parameter, not part of the api.
1082
609
TODO: static convenience version of this?
1084
611
raise NotImplementedError(self.open_repository)
1086
def open_workingtree(self, _unsupported=False,
1087
recommend_upgrade=True, from_branch=None):
613
def open_workingtree(self, _unsupported=False):
1088
614
"""Open the workingtree object at this BzrDir if one is present.
1090
:param recommend_upgrade: Optional keyword parameter, when True (the
1091
default), emit through the ui module a recommendation that the user
1092
upgrade the working tree when the workingtree being opened is old
1093
(but still fully supported).
1094
:param from_branch: override bzrdir branch (for lightweight checkouts)
616
TODO: static convenience version of this?
1096
618
raise NotImplementedError(self.open_workingtree)
1098
def has_branch(self, name=None):
620
def has_branch(self):
1099
621
"""Tell if this bzrdir contains a branch.
1101
623
Note: if you're going to open the branch, you should just go ahead
1102
and try, and not ask permission first. (This method just opens the
1103
branch and discards it, and that's somewhat expensive.)
624
and try, and not ask permission first. (This method just opens the
625
branch and discards it, and that's somewhat expensive.)
1106
self.open_branch(name)
1108
630
except errors.NotBranchError:
1114
636
This will still raise an exception if the bzrdir has a workingtree that
1115
637
is remote & inaccessible.
1117
639
Note: if you're going to open the working tree, you should just go ahead
1118
and try, and not ask permission first. (This method just opens the
1119
workingtree and discards it, and that's somewhat expensive.)
640
and try, and not ask permission first. (This method just opens the
641
workingtree and discards it, and that's somewhat expensive.)
1122
self.open_workingtree(recommend_upgrade=False)
644
self.open_workingtree()
1124
646
except errors.NoWorkingTree:
1127
def _cloning_metadir(self):
1128
"""Produce a metadir suitable for cloning with.
1130
:returns: (destination_bzrdir_format, source_repository)
649
def _cloning_metadir(self, basis=None):
650
def related_repository(bzrdir):
652
branch = bzrdir.open_branch()
653
return branch.repository
654
except errors.NotBranchError:
656
return bzrdir.open_repository()
1132
657
result_format = self._format.__class__()
1135
branch = self.open_branch(ignore_fallbacks=True)
1136
source_repository = branch.repository
1137
result_format._branch_format = branch._format
1138
except errors.NotBranchError:
1139
source_branch = None
1140
source_repository = self.open_repository()
660
source_repository = related_repository(self)
661
except errors.NoRepositoryPresent:
664
source_repository = related_repository(self)
665
result_format.repository_format = source_repository._format
1141
666
except errors.NoRepositoryPresent:
1142
667
source_repository = None
1144
# XXX TODO: This isinstance is here because we have not implemented
1145
# the fix recommended in bug # 103195 - to delegate this choice the
1146
# repository itself.
1147
repo_format = source_repository._format
1148
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1149
source_repository._ensure_real()
1150
repo_format = source_repository._real_repository._format
1151
result_format.repository_format = repo_format
1153
# TODO: Couldn't we just probe for the format in these cases,
1154
# rather than opening the whole tree? It would be a little
1155
# faster. mbp 20070401
1156
tree = self.open_workingtree(recommend_upgrade=False)
669
tree = self.open_workingtree()
1157
670
except (errors.NoWorkingTree, errors.NotLocalUrl):
1158
671
result_format.workingtree_format = None
1160
673
result_format.workingtree_format = tree._format.__class__()
1161
674
return result_format, source_repository
1163
def cloning_metadir(self, require_stacking=False):
676
def cloning_metadir(self, basis=None):
1164
677
"""Produce a metadir suitable for cloning or sprouting with.
1166
679
These operations may produce workingtrees (yes, even though they're
1167
"cloning" something that doesn't have a tree), so a viable workingtree
680
"cloning" something that doesn't have a tree, so a viable workingtree
1168
681
format must be selected.
1170
:require_stacking: If True, non-stackable formats will be upgraded
1171
to similar stackable formats.
1172
:returns: a BzrDirFormat with all component formats either set
1173
appropriately or set to None if that component should not be
1176
683
format, repository = self._cloning_metadir()
1177
684
if format._workingtree_format is None:
1179
685
if repository is None:
1180
# No repository either
1182
# We have a repository, so set a working tree? (Why? This seems to
1183
# contradict the stated return value in the docstring).
1184
687
tree_format = repository._format._matchingbzrdir.workingtree_format
1185
688
format.workingtree_format = tree_format.__class__()
1186
if require_stacking:
1187
format.require_stacking()
1190
691
def checkout_metadir(self):
1191
692
return self.cloning_metadir()
1193
def sprout(self, url, revision_id=None, force_new_repo=False,
1194
recurse='down', possible_transports=None,
1195
accelerator_tree=None, hardlink=False, stacked=False,
1196
source_branch=None, create_tree_if_local=True):
694
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False,
1197
696
"""Create a copy of this bzrdir prepared for use as a new line of
1200
If url's last component does not exist, it will be created.
699
If urls last component does not exist, it will be created.
1202
701
Attributes related to the identity of the source branch like
1203
702
branch nickname will be cleaned, a working tree is created
1207
706
if revision_id is not None, then the clone operation may tune
1208
707
itself to download less data.
1209
:param accelerator_tree: A tree which can be used for retrieving file
1210
contents more quickly than the revision tree, i.e. a workingtree.
1211
The revision tree will be used for cases where accelerator_tree's
1212
content is different.
1213
:param hardlink: If true, hard-link files from accelerator_tree,
1215
:param stacked: If true, create a stacked branch referring to the
1216
location of this control directory.
1217
:param create_tree_if_local: If true, a working-tree will be created
1218
when working locally.
1220
target_transport = get_transport(url, possible_transports)
1221
target_transport.ensure_base()
1222
cloning_format = self.cloning_metadir(stacked)
1223
# Create/update the result branch
1224
result = cloning_format.initialize_on_transport(target_transport)
1225
# if a stacked branch wasn't requested, we don't create one
1226
# even if the origin was stacked
1227
stacked_branch_url = None
1228
if source_branch is not None:
1230
stacked_branch_url = self.root_transport.base
710
cloning_format = self.cloning_metadir(basis)
711
result = cloning_format.initialize(url)
712
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
714
source_branch = self.open_branch()
1231
715
source_repository = source_branch.repository
1234
source_branch = self.open_branch()
1235
source_repository = source_branch.repository
1237
stacked_branch_url = self.root_transport.base
1238
except errors.NotBranchError:
1239
source_branch = None
1241
source_repository = self.open_repository()
1242
except errors.NoRepositoryPresent:
1243
source_repository = None
1244
repository_policy = result.determine_repository_policy(
1245
force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
result_repo, is_new_repo = repository_policy.acquire_repository()
1247
if is_new_repo and revision_id is not None and not stacked:
1248
fetch_spec = graph.PendingAncestryResult(
1249
[revision_id], source_repository)
1252
if source_repository is not None:
1253
# Fetch while stacked to prevent unstacked fetch from
1255
if fetch_spec is None:
716
except errors.NotBranchError:
719
source_repository = self.open_repository()
720
except errors.NoRepositoryPresent:
721
# copy the entire basis one if there is one
722
# but there is no repository.
723
source_repository = basis_repo
728
result_repo = result.find_repository()
729
except errors.NoRepositoryPresent:
731
if source_repository is None and result_repo is not None:
733
elif source_repository is None and result_repo is None:
734
# no repo available, make a new one
735
result.create_repository()
736
elif source_repository is not None and result_repo is None:
737
# have source, and want to make a new target repo
738
# we don't clone the repo because that preserves attributes
739
# like is_shared(), and we have not yet implemented a
740
# repository sprout().
741
result_repo = result.create_repository()
742
if result_repo is not None:
743
# fetch needed content into target.
745
# XXX FIXME RBC 20060214 need tests for this when the basis
747
result_repo.fetch(basis_repo, revision_id=revision_id)
748
if source_repository is not None:
1256
749
result_repo.fetch(source_repository, revision_id=revision_id)
1258
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1260
if source_branch is None:
1261
# this is for sprouting a bzrdir without a branch; is that
1263
# Not especially, but it's part of the contract.
1264
result_branch = result.create_branch()
750
if source_branch is not None:
751
source_branch.sprout(result, revision_id=revision_id)
1266
result_branch = source_branch.sprout(result,
1267
revision_id=revision_id, repository_policy=repository_policy)
1268
mutter("created new branch %r" % (result_branch,))
1270
# Create/update the result working tree
1271
if (create_tree_if_local and
1272
isinstance(target_transport, local.LocalTransport) and
1273
(result_repo is None or result_repo.make_working_trees())):
1274
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
753
result.create_branch()
754
# TODO: jam 20060426 we probably need a test in here in the
755
# case that the newly sprouted branch is a remote one
756
if result_repo is None or result_repo.make_working_trees():
757
wt = result.create_workingtree()
1278
760
if wt.path2id('') is None:
1306
786
sublocation = source_branch.reference_parent(file_id, path)
1307
787
sublocation.bzrdir.sprout(target,
1308
788
basis.get_reference_revision(file_id, path),
1309
force_new_repo=force_new_repo, recurse=recurse,
789
force_new_repo=force_new_repo, recurse=recurse)
1312
791
if basis is not None:
1316
def push_branch(self, source, revision_id=None, overwrite=False,
1317
remember=False, create_prefix=False):
1318
"""Push the source branch into this BzrDir."""
1320
# If we can open a branch, use its direct repository, otherwise see
1321
# if there is a repository without a branch.
1323
br_to = self.open_branch()
1324
except errors.NotBranchError:
1325
# Didn't find a branch, can we find a repository?
1326
repository_to = self.find_repository()
1328
# Found a branch, so we must have found a repository
1329
repository_to = br_to.repository
1331
push_result = PushResult()
1332
push_result.source_branch = source
1334
# We have a repository but no branch, copy the revisions, and then
1336
repository_to.fetch(source.repository, revision_id=revision_id)
1337
br_to = source.clone(self, revision_id=revision_id)
1338
if source.get_push_location() is None or remember:
1339
source.set_push_location(br_to.base)
1340
push_result.stacked_on = None
1341
push_result.branch_push_result = None
1342
push_result.old_revno = None
1343
push_result.old_revid = _mod_revision.NULL_REVISION
1344
push_result.target_branch = br_to
1345
push_result.master_branch = None
1346
push_result.workingtree_updated = False
1348
# We have successfully opened the branch, remember if necessary:
1349
if source.get_push_location() is None or remember:
1350
source.set_push_location(br_to.base)
1352
tree_to = self.open_workingtree()
1353
except errors.NotLocalUrl:
1354
push_result.branch_push_result = source.push(br_to,
1355
overwrite, stop_revision=revision_id)
1356
push_result.workingtree_updated = False
1357
except errors.NoWorkingTree:
1358
push_result.branch_push_result = source.push(br_to,
1359
overwrite, stop_revision=revision_id)
1360
push_result.workingtree_updated = None # Not applicable
1362
tree_to.lock_write()
1364
push_result.branch_push_result = source.push(
1365
tree_to.branch, overwrite, stop_revision=revision_id)
1369
push_result.workingtree_updated = True
1370
push_result.old_revno = push_result.branch_push_result.old_revno
1371
push_result.old_revid = push_result.branch_push_result.old_revid
1372
push_result.target_branch = \
1373
push_result.branch_push_result.target_branch
1377
class BzrDirHooks(hooks.Hooks):
1378
"""Hooks for BzrDir operations."""
1381
"""Create the default hooks."""
1382
hooks.Hooks.__init__(self)
1383
self.create_hook(hooks.HookPoint('pre_open',
1384
"Invoked before attempting to open a BzrDir with the transport "
1385
"that the open will use.", (1, 14), None))
1386
self.create_hook(hooks.HookPoint('post_repo_init',
1387
"Invoked after a repository has been initialized. "
1388
"post_repo_init is called with a "
1389
"bzrlib.bzrdir.RepoInitHookParams.",
1392
# install the default hooks
1393
BzrDir.hooks = BzrDirHooks()
1396
class RepoInitHookParams(object):
1397
"""Object holding parameters passed to *_repo_init hooks.
1399
There are 4 fields that hooks may wish to access:
1401
:ivar repository: Repository created
1402
:ivar format: Repository format
1403
:ivar bzrdir: The bzrdir for the repository
1404
:ivar shared: The repository is shared
1407
def __init__(self, repository, format, a_bzrdir, shared):
1408
"""Create a group of RepoInitHook parameters.
1410
:param repository: Repository created
1411
:param format: Repository format
1412
:param bzrdir: The bzrdir for the repository
1413
:param shared: The repository is shared
1415
self.repository = repository
1416
self.format = format
1417
self.bzrdir = a_bzrdir
1418
self.shared = shared
1420
def __eq__(self, other):
1421
return self.__dict__ == other.__dict__
1425
return "<%s for %s>" % (self.__class__.__name__,
1428
return "<%s for %s>" % (self.__class__.__name__,
1432
796
class BzrDirPreSplitOut(BzrDir):
1433
797
"""A common class for the all-in-one formats."""
1576
902
# if the format is not the same as the system default,
1577
903
# an upgrade is needed.
1578
904
if format is None:
1579
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
% 'needs_format_conversion(format=None)')
1581
905
format = BzrDirFormat.get_default_format()
1582
906
return not isinstance(self._format, format.__class__)
1584
def open_branch(self, name=None, unsupported=False,
1585
ignore_fallbacks=False):
908
def open_branch(self, unsupported=False):
1586
909
"""See BzrDir.open_branch."""
1587
910
from bzrlib.branch import BzrBranchFormat4
1588
911
format = BzrBranchFormat4()
1589
912
self._check_supported(format, unsupported)
1590
return format.open(self, name, _found=True)
913
return format.open(self, _found=True)
1592
def sprout(self, url, revision_id=None, force_new_repo=False,
1593
possible_transports=None, accelerator_tree=None,
1594
hardlink=False, stacked=False, create_tree_if_local=True,
1595
source_branch=None):
915
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1596
916
"""See BzrDir.sprout()."""
1597
if source_branch is not None:
1598
my_branch = self.open_branch()
1599
if source_branch.base != my_branch.base:
1600
raise AssertionError(
1601
"source branch %r is not within %r with branch %r" %
1602
(source_branch, self, my_branch))
1604
raise errors.UnstackableBranchFormat(
1605
self._format, self.root_transport.base)
1606
if not create_tree_if_local:
1607
raise errors.MustHaveWorkingTree(
1608
self._format, self.root_transport.base)
1609
917
from bzrlib.workingtree import WorkingTreeFormat2
1610
918
self._make_tail(url)
1611
919
result = self._format._initialize_for_clone(url)
920
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1613
self.open_repository().clone(result, revision_id=revision_id)
922
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1614
923
except errors.NoRepositoryPresent:
1617
926
self.open_branch().sprout(result, revision_id=revision_id)
1618
927
except errors.NotBranchError:
1621
929
# we always want a working tree
1622
WorkingTreeFormat2().initialize(result,
1623
accelerator_tree=accelerator_tree,
930
WorkingTreeFormat2().initialize(result)
1628
934
class BzrDir4(BzrDirPreSplitOut):
1629
935
"""A .bzr version 4 control object.
1631
937
This is a deprecated format and may be removed after sept 2006.
1710
998
"""See BzrDir.can_convert_format()."""
1713
def create_branch(self, name=None):
1714
"""See BzrDir.create_branch."""
1715
return self._format.get_branch_format().initialize(self, name=name)
1717
def destroy_branch(self, name=None):
1718
"""See BzrDir.create_branch."""
1719
if name is not None:
1720
raise errors.NoColocatedBranchSupport(self)
1721
self.transport.delete_tree('branch')
1001
def create_branch(self):
1002
"""See BzrDir.create_branch."""
1003
return self._format.get_branch_format().initialize(self)
1723
1005
def create_repository(self, shared=False):
1724
1006
"""See BzrDir.create_repository."""
1725
1007
return self._format.repository_format.initialize(self, shared)
1727
def destroy_repository(self):
1728
"""See BzrDir.destroy_repository."""
1729
self.transport.delete_tree('repository')
1731
def create_workingtree(self, revision_id=None, from_branch=None,
1732
accelerator_tree=None, hardlink=False):
1009
def create_workingtree(self, revision_id=None):
1733
1010
"""See BzrDir.create_workingtree."""
1734
return self._format.workingtree_format.initialize(
1735
self, revision_id, from_branch=from_branch,
1736
accelerator_tree=accelerator_tree, hardlink=hardlink)
1011
from bzrlib.workingtree import WorkingTreeFormat
1012
return self._format.workingtree_format.initialize(self, revision_id)
1738
1014
def destroy_workingtree(self):
1739
1015
"""See BzrDir.destroy_workingtree."""
1740
wt = self.open_workingtree(recommend_upgrade=False)
1016
wt = self.open_workingtree()
1741
1017
repository = wt.branch.repository
1742
1018
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1743
wt.revert(old_tree=empty)
1019
wt.revert([], old_tree=empty)
1744
1020
self.destroy_workingtree_metadata()
1746
1022
def destroy_workingtree_metadata(self):
1747
1023
self.transport.delete_tree('checkout')
1749
def find_branch_format(self, name=None):
1750
"""Find the branch 'format' for this bzrdir.
1752
This might be a synthetic object for e.g. RemoteBranch and SVN.
1754
from bzrlib.branch import BranchFormat
1755
return BranchFormat.find_format(self, name=name)
1757
1025
def _get_mkdir_mode(self):
1758
1026
"""Figure out the mode to use when creating a bzrdir subdir."""
1759
1027
temp_control = lockable_files.LockableFiles(self.transport, '',
1760
1028
lockable_files.TransportLock)
1761
1029
return temp_control._dir_mode
1763
def get_branch_reference(self, name=None):
1764
"""See BzrDir.get_branch_reference()."""
1765
from bzrlib.branch import BranchFormat
1766
format = BranchFormat.find_format(self, name=name)
1767
return format.get_reference(self, name=name)
1769
def get_branch_transport(self, branch_format, name=None):
1031
def get_branch_transport(self, branch_format):
1770
1032
"""See BzrDir.get_branch_transport()."""
1771
if name is not None:
1772
raise errors.NoColocatedBranchSupport(self)
1773
# XXX: this shouldn't implicitly create the directory if it's just
1774
# promising to get a transport -- mbp 20090727
1775
1033
if branch_format is None:
1776
1034
return self.transport.clone('branch')
1986
1203
current default format. In the case of plugins we can/should provide
1987
1204
some means for them to extend the range of returnable converters.
1989
:param format: Optional format to override the default format of the
1206
:param format: Optional format to override the default format of the
1992
1209
raise NotImplementedError(self.get_converter)
1994
def initialize(self, url, possible_transports=None):
1211
def initialize(self, url):
1995
1212
"""Create a bzr control dir at this url and return an opened copy.
1997
While not deprecated, this method is very specific and its use will
1998
lead to many round trips to setup a working environment. See
1999
initialize_on_transport_ex for a [nearly] all-in-one method.
2001
1214
Subclasses should typically override initialize_on_transport
2002
1215
instead of this method.
2004
return self.initialize_on_transport(get_transport(url,
2005
possible_transports))
1217
return self.initialize_on_transport(get_transport(url))
2007
1219
def initialize_on_transport(self, transport):
2008
1220
"""Initialize a new bzrdir in the base directory of a Transport."""
2010
# can we hand off the request to the smart server rather than using
2012
client_medium = transport.get_smart_medium()
2013
except errors.NoSmartMedium:
2014
return self._initialize_on_transport_vfs(transport)
2016
# Current RPC's only know how to create bzr metadir1 instances, so
2017
# we still delegate to vfs methods if the requested format is not a
2019
if type(self) != BzrDirMetaFormat1:
2020
return self._initialize_on_transport_vfs(transport)
2021
remote_format = RemoteBzrDirFormat()
2022
self._supply_sub_formats_to(remote_format)
2023
return remote_format.initialize_on_transport(transport)
2025
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2026
create_prefix=False, force_new_repo=False, stacked_on=None,
2027
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2028
shared_repo=False, vfs_only=False):
2029
"""Create this format on transport.
2031
The directory to initialize will be created.
2033
:param force_new_repo: Do not use a shared repository for the target,
2034
even if one is available.
2035
:param create_prefix: Create any missing directories leading up to
2037
:param use_existing_dir: Use an existing directory if one exists.
2038
:param stacked_on: A url to stack any created branch on, None to follow
2039
any target stacking policy.
2040
:param stack_on_pwd: If stack_on is relative, the location it is
2042
:param repo_format_name: If non-None, a repository will be
2043
made-or-found. Should none be found, or if force_new_repo is True
2044
the repo_format_name is used to select the format of repository to
2046
:param make_working_trees: Control the setting of make_working_trees
2047
for a new shared repository when one is made. None to use whatever
2048
default the format has.
2049
:param shared_repo: Control whether made repositories are shared or
2051
:param vfs_only: If True do not attempt to use a smart server
2052
:return: repo, bzrdir, require_stacking, repository_policy. repo is
2053
None if none was created or found, bzrdir is always valid.
2054
require_stacking is the result of examining the stacked_on
2055
parameter and any stacking policy found for the target.
2058
# Try to hand off to a smart server
2060
client_medium = transport.get_smart_medium()
2061
except errors.NoSmartMedium:
2064
# TODO: lookup the local format from a server hint.
2065
remote_dir_format = RemoteBzrDirFormat()
2066
remote_dir_format._network_name = self.network_name()
2067
self._supply_sub_formats_to(remote_dir_format)
2068
return remote_dir_format.initialize_on_transport_ex(transport,
2069
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2070
force_new_repo=force_new_repo, stacked_on=stacked_on,
2071
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2072
make_working_trees=make_working_trees, shared_repo=shared_repo)
2073
# XXX: Refactor the create_prefix/no_create_prefix code into a
2074
# common helper function
2075
# The destination may not exist - if so make it according to policy.
2076
def make_directory(transport):
2077
transport.mkdir('.')
2079
def redirected(transport, e, redirection_notice):
2080
note(redirection_notice)
2081
return transport._redirected_to(e.source, e.target)
2083
transport = do_catching_redirections(make_directory, transport,
2085
except errors.FileExists:
2086
if not use_existing_dir:
2088
except errors.NoSuchFile:
2089
if not create_prefix:
2091
transport.create_prefix()
2093
require_stacking = (stacked_on is not None)
2094
# Now the target directory exists, but doesn't have a .bzr
2095
# directory. So we need to create it, along with any work to create
2096
# all of the dependent branches, etc.
2098
result = self.initialize_on_transport(transport)
2099
if repo_format_name:
2101
# use a custom format
2102
result._format.repository_format = \
2103
repository.network_format_registry.get(repo_format_name)
2104
except AttributeError:
2105
# The format didn't permit it to be set.
2107
# A repository is desired, either in-place or shared.
2108
repository_policy = result.determine_repository_policy(
2109
force_new_repo, stacked_on, stack_on_pwd,
2110
require_stacking=require_stacking)
2111
result_repo, is_new_repo = repository_policy.acquire_repository(
2112
make_working_trees, shared_repo)
2113
if not require_stacking and repository_policy._require_stacking:
2114
require_stacking = True
2115
result._format.require_stacking()
2116
result_repo.lock_write()
2119
repository_policy = None
2120
return result_repo, result, require_stacking, repository_policy
2122
def _initialize_on_transport_vfs(self, transport):
2123
"""Initialize a new bzrdir using VFS calls.
2125
:param transport: The transport to create the .bzr directory in.
2128
# Since we are creating a .bzr directory, inherit the
1221
# Since we don't have a .bzr directory, inherit the
2129
1222
# mode from the root directory
2130
1223
temp_control = lockable_files.LockableFiles(transport,
2131
1224
'', lockable_files.TransportLock)
2521
1551
def set_branch_format(self, format):
2522
1552
self._branch_format = format
2524
def require_stacking(self, stack_on=None, possible_transports=None,
2526
"""We have a request to stack, try to ensure the formats support it.
2528
:param stack_on: If supplied, it is the URL to a branch that we want to
2529
stack on. Check to see if that format supports stacking before
2532
# Stacking is desired. requested by the target, but does the place it
2533
# points at support stacking? If it doesn't then we should
2534
# not implicitly upgrade. We check this here.
2535
new_repo_format = None
2536
new_branch_format = None
2538
# a bit of state for get_target_branch so that we don't try to open it
2539
# 2 times, for both repo *and* branch
2540
target = [None, False, None] # target_branch, checked, upgrade anyway
2541
def get_target_branch():
2543
# We've checked, don't check again
2545
if stack_on is None:
2546
# No target format, that means we want to force upgrading
2547
target[:] = [None, True, True]
2550
target_dir = BzrDir.open(stack_on,
2551
possible_transports=possible_transports)
2552
except errors.NotBranchError:
2553
# Nothing there, don't change formats
2554
target[:] = [None, True, False]
2556
except errors.JailBreak:
2557
# JailBreak, JFDI and upgrade anyway
2558
target[:] = [None, True, True]
2561
target_branch = target_dir.open_branch()
2562
except errors.NotBranchError:
2563
# No branch, don't upgrade formats
2564
target[:] = [None, True, False]
2566
target[:] = [target_branch, True, False]
2569
if (not _skip_repo and
2570
not self.repository_format.supports_external_lookups):
2571
# We need to upgrade the Repository.
2572
target_branch, _, do_upgrade = get_target_branch()
2573
if target_branch is None:
2574
# We don't have a target branch, should we upgrade anyway?
2576
# stack_on is inaccessible, JFDI.
2577
# TODO: bad monkey, hard-coded formats...
2578
if self.repository_format.rich_root_data:
2579
new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2581
new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2583
# If the target already supports stacking, then we know the
2584
# project is already able to use stacking, so auto-upgrade
2586
new_repo_format = target_branch.repository._format
2587
if not new_repo_format.supports_external_lookups:
2588
# target doesn't, source doesn't, so don't auto upgrade
2590
new_repo_format = None
2591
if new_repo_format is not None:
2592
self.repository_format = new_repo_format
2593
note('Source repository format does not support stacking,'
2594
' using format:\n %s',
2595
new_repo_format.get_format_description())
2597
if not self.get_branch_format().supports_stacking():
2598
# We just checked the repo, now lets check if we need to
2599
# upgrade the branch format
2600
target_branch, _, do_upgrade = get_target_branch()
2601
if target_branch is None:
2603
# TODO: bad monkey, hard-coded formats...
2604
new_branch_format = branch.BzrBranchFormat7()
2606
new_branch_format = target_branch._format
2607
if not new_branch_format.supports_stacking():
2608
new_branch_format = None
2609
if new_branch_format is not None:
2610
# Does support stacking, use its format.
2611
self.set_branch_format(new_branch_format)
2612
note('Source branch format does not support stacking,'
2613
' using format:\n %s',
2614
new_branch_format.get_format_description())
2616
1554
def get_converter(self, format=None):
2617
1555
"""See BzrDirFormat.get_converter()."""
2618
1556
if format is None:
3179
2092
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
2093
from bzrlib.repository import CopyConverter
3181
ui.ui_factory.note('starting repository conversion')
2094
self.pb.note('starting repository conversion')
3182
2095
converter = CopyConverter(self.target_format.repository_format)
3183
2096
converter.convert(repo, pb)
3184
for branch in self.bzrdir.list_branches():
2098
branch = self.bzrdir.open_branch()
2099
except errors.NotBranchError:
3185
2102
# TODO: conversions of Branch and Tree should be done by
3186
# InterXFormat lookups/some sort of registry.
2103
# InterXFormat lookups
3187
2104
# Avoid circular imports
3188
2105
from bzrlib import branch as _mod_branch
3189
old = branch._format.__class__
3190
new = self.target_format.get_branch_format().__class__
3192
if (old == _mod_branch.BzrBranchFormat5 and
3193
new in (_mod_branch.BzrBranchFormat6,
3194
_mod_branch.BzrBranchFormat7,
3195
_mod_branch.BzrBranchFormat8)):
3196
branch_converter = _mod_branch.Converter5to6()
3197
elif (old == _mod_branch.BzrBranchFormat6 and
3198
new in (_mod_branch.BzrBranchFormat7,
3199
_mod_branch.BzrBranchFormat8)):
3200
branch_converter = _mod_branch.Converter6to7()
3201
elif (old == _mod_branch.BzrBranchFormat7 and
3202
new is _mod_branch.BzrBranchFormat8):
3203
branch_converter = _mod_branch.Converter7to8()
3205
raise errors.BadConversionTarget("No converter", new,
2106
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2107
self.target_format.get_branch_format().__class__ is
2108
_mod_branch.BzrBranchFormat6):
2109
branch_converter = _mod_branch.Converter5to6()
3207
2110
branch_converter.convert(branch)
3208
branch = self.bzrdir.open_branch()
3209
old = branch._format.__class__
3211
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2112
tree = self.bzrdir.open_workingtree()
3212
2113
except (errors.NoWorkingTree, errors.NotLocalUrl):
3215
2116
# TODO: conversions of Branch and Tree should be done by
3216
2117
# InterXFormat lookups
3217
2118
if (isinstance(tree, workingtree.WorkingTree3) and
3218
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2119
not isinstance(tree, workingtree_4.WorkingTree4) and
3219
2120
isinstance(self.target_format.workingtree_format,
3220
workingtree_4.DirStateWorkingTreeFormat)):
2121
workingtree_4.WorkingTreeFormat4)):
3221
2122
workingtree_4.Converter3to4().convert(tree)
3222
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3223
not isinstance(tree, workingtree_4.WorkingTree5) and
3224
isinstance(self.target_format.workingtree_format,
3225
workingtree_4.WorkingTreeFormat5)):
3226
workingtree_4.Converter4to5().convert(tree)
3227
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3228
not isinstance(tree, workingtree_4.WorkingTree6) and
3229
isinstance(self.target_format.workingtree_format,
3230
workingtree_4.WorkingTreeFormat6)):
3231
workingtree_4.Converter4or5to6().convert(tree)
3233
2123
return to_convert
3236
# This is not in remote.py because it's relatively small, and needs to be
3237
# registered. Putting it in remote.py creates a circular import problem.
3238
# we can make it a lazy object if the control formats is turned into something
3240
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
"""Format representing bzrdirs accessed via a smart server"""
3244
BzrDirMetaFormat1.__init__(self)
3245
# XXX: It's a bit ugly that the network name is here, because we'd
3246
# like to believe that format objects are stateless or at least
3247
# immutable, However, we do at least avoid mutating the name after
3248
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
self._network_name = None
3252
return "%s(_network_name=%r)" % (self.__class__.__name__,
3255
def get_format_description(self):
3256
if self._network_name:
3257
real_format = network_format_registry.get(self._network_name)
3258
return 'Remote: ' + real_format.get_format_description()
3259
return 'bzr remote bzrdir'
3261
def get_format_string(self):
3262
raise NotImplementedError(self.get_format_string)
3264
def network_name(self):
3265
if self._network_name:
3266
return self._network_name
3268
raise AssertionError("No network name set.")
3271
def probe_transport(klass, transport):
3272
"""Return a RemoteBzrDirFormat object if it looks possible."""
3274
medium = transport.get_smart_medium()
3275
except (NotImplementedError, AttributeError,
3276
errors.TransportNotPossible, errors.NoSmartMedium,
3277
errors.SmartProtocolError):
3278
# no smart server, so not a branch for this format type.
3279
raise errors.NotBranchError(path=transport.base)
3281
# Decline to open it if the server doesn't support our required
3282
# version (3) so that the VFS-based transport will do it.
3283
if medium.should_probe():
3285
server_version = medium.protocol_version()
3286
except errors.SmartProtocolError:
3287
# Apparently there's no usable smart server there, even though
3288
# the medium supports the smart protocol.
3289
raise errors.NotBranchError(path=transport.base)
3290
if server_version != '2':
3291
raise errors.NotBranchError(path=transport.base)
3294
def initialize_on_transport(self, transport):
3296
# hand off the request to the smart server
3297
client_medium = transport.get_smart_medium()
3298
except errors.NoSmartMedium:
3299
# TODO: lookup the local format from a server hint.
3300
local_dir_format = BzrDirMetaFormat1()
3301
return local_dir_format.initialize_on_transport(transport)
3302
client = _SmartClient(client_medium)
3303
path = client.remote_path_from_transport(transport)
3305
response = client.call('BzrDirFormat.initialize', path)
3306
except errors.ErrorFromSmartServer, err:
3307
remote._translate_error(err, path=path)
3308
if response[0] != 'ok':
3309
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3310
format = RemoteBzrDirFormat()
3311
self._supply_sub_formats_to(format)
3312
return remote.RemoteBzrDir(transport, format)
3314
def parse_NoneTrueFalse(self, arg):
3321
raise AssertionError("invalid arg %r" % arg)
3323
def _serialize_NoneTrueFalse(self, arg):
3330
def _serialize_NoneString(self, arg):
3333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3334
create_prefix=False, force_new_repo=False, stacked_on=None,
3335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3338
# hand off the request to the smart server
3339
client_medium = transport.get_smart_medium()
3340
except errors.NoSmartMedium:
3343
# Decline to open it if the server doesn't support our required
3344
# version (3) so that the VFS-based transport will do it.
3345
if client_medium.should_probe():
3347
server_version = client_medium.protocol_version()
3348
if server_version != '2':
3352
except errors.SmartProtocolError:
3353
# Apparently there's no usable smart server there, even though
3354
# the medium supports the smart protocol.
3359
client = _SmartClient(client_medium)
3360
path = client.remote_path_from_transport(transport)
3361
if client_medium._is_remote_before((1, 16)):
3364
# TODO: lookup the local format from a server hint.
3365
local_dir_format = BzrDirMetaFormat1()
3366
self._supply_sub_formats_to(local_dir_format)
3367
return local_dir_format.initialize_on_transport_ex(transport,
3368
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3369
force_new_repo=force_new_repo, stacked_on=stacked_on,
3370
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3371
make_working_trees=make_working_trees, shared_repo=shared_repo,
3373
return self._initialize_on_transport_ex_rpc(client, path, transport,
3374
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3375
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3377
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3378
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3379
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3381
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3382
args.append(self._serialize_NoneTrueFalse(create_prefix))
3383
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3384
args.append(self._serialize_NoneString(stacked_on))
3385
# stack_on_pwd is often/usually our transport
3388
stack_on_pwd = transport.relpath(stack_on_pwd)
3389
if not stack_on_pwd:
3391
except errors.PathNotChild:
3393
args.append(self._serialize_NoneString(stack_on_pwd))
3394
args.append(self._serialize_NoneString(repo_format_name))
3395
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
request_network_name = self._network_name or \
3398
BzrDirFormat.get_default_format().network_name()
3400
response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
request_network_name, path, *args)
3402
except errors.UnknownSmartMethod:
3403
client._medium._remember_remote_is_before((1,16))
3404
local_dir_format = BzrDirMetaFormat1()
3405
self._supply_sub_formats_to(local_dir_format)
3406
return local_dir_format.initialize_on_transport_ex(transport,
3407
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3408
force_new_repo=force_new_repo, stacked_on=stacked_on,
3409
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3410
make_working_trees=make_working_trees, shared_repo=shared_repo,
3412
except errors.ErrorFromSmartServer, err:
3413
remote._translate_error(err, path=path)
3414
repo_path = response[0]
3415
bzrdir_name = response[6]
3416
require_stacking = response[7]
3417
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3418
format = RemoteBzrDirFormat()
3419
format._network_name = bzrdir_name
3420
self._supply_sub_formats_to(format)
3421
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3423
repo_format = remote.response_tuple_to_repo_format(response[1:])
3424
if repo_path == '.':
3427
repo_bzrdir_format = RemoteBzrDirFormat()
3428
repo_bzrdir_format._network_name = response[5]
3429
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3433
final_stack = response[8] or None
3434
final_stack_pwd = response[9] or None
3436
final_stack_pwd = urlutils.join(
3437
transport.base, final_stack_pwd)
3438
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3439
if len(response) > 10:
3440
# Updated server verb that locks remotely.
3441
repo_lock_token = response[10] or None
3442
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3444
remote_repo.dont_leave_lock_in_place()
3446
remote_repo.lock_write()
3447
policy = UseExistingRepository(remote_repo, final_stack,
3448
final_stack_pwd, require_stacking)
3449
policy.acquire_repository()
3453
bzrdir._format.set_branch_format(self.get_branch_format())
3454
if require_stacking:
3455
# The repo has already been created, but we need to make sure that
3456
# we'll make a stackable branch.
3457
bzrdir._format.require_stacking(_skip_repo=True)
3458
return remote_repo, bzrdir, require_stacking, policy
3460
def _open(self, transport):
3461
return remote.RemoteBzrDir(transport, self)
3463
def __eq__(self, other):
3464
if not isinstance(other, RemoteBzrDirFormat):
3466
return self.get_format_description() == other.get_format_description()
3468
def __return_repository_format(self):
3469
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3470
# repository format has been asked for, tell the RemoteRepositoryFormat
3471
# that it should use that for init() etc.
3472
result = remote.RemoteRepositoryFormat()
3473
custom_format = getattr(self, '_repository_format', None)
3475
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3476
return custom_format
3478
# We will use the custom format to create repositories over the
3479
# wire; expose its details like rich_root_data for code to
3481
result._custom_format = custom_format
3484
def get_branch_format(self):
3485
result = BzrDirMetaFormat1.get_branch_format(self)
3486
if not isinstance(result, remote.RemoteBranchFormat):
3487
new_result = remote.RemoteBranchFormat()
3488
new_result._custom_format = result
3490
self.set_branch_format(new_result)
3494
repository_format = property(__return_repository_format,
3495
BzrDirMetaFormat1._set_repository_format) #.im_func)
3498
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3501
2126
class BzrDirFormatInfo(object):
3503
def __init__(self, native, deprecated, hidden, experimental):
2128
def __init__(self, native, deprecated, hidden):
3504
2129
self.deprecated = deprecated
3505
2130
self.native = native
3506
2131
self.hidden = hidden
3507
self.experimental = experimental
3510
2134
class BzrDirFormatRegistry(registry.Registry):
3511
2135
"""Registry of user-selectable BzrDir subformats.
3513
2137
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
2138
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3518
"""Create a BzrDirFormatRegistry."""
3519
self._aliases = set()
3520
self._registration_order = list()
3521
super(BzrDirFormatRegistry, self).__init__()
3524
"""Return a set of the format names which are aliases."""
3525
return frozenset(self._aliases)
3527
2141
def register_metadir(self, key,
3528
2142
repository_format, help, native=True, deprecated=False,
3529
2143
branch_format=None,
3530
2144
tree_format=None,
3534
2146
"""Register a metadir subformat.
3536
2148
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
by the Repository/Branch/WorkingTreeformats.
2149
by the Repository format.
3539
2151
:param repository_format: The fully-qualified repository format class
3540
2152
name as a string.
3568
2180
if repository_format is not None:
3569
2181
bd.repository_format = _load(repository_format)
3571
self.register(key, helper, help, native, deprecated, hidden,
3572
experimental, alias)
2183
self.register(key, helper, help, native, deprecated, hidden)
3574
2185
def register(self, key, factory, help, native=True, deprecated=False,
3575
hidden=False, experimental=False, alias=False):
3576
2187
"""Register a BzrDirFormat factory.
3578
2189
The factory must be a callable that takes one parameter: the key.
3579
2190
It must produce an instance of the BzrDirFormat when called.
3581
2192
This function mainly exists to prevent the info object from being
3582
2193
supplied directly.
3584
registry.Registry.register(self, key, factory, help,
3585
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3587
self._aliases.add(key)
3588
self._registration_order.append(key)
2195
registry.Registry.register(self, key, factory, help,
2196
BzrDirFormatInfo(native, deprecated, hidden))
3590
2198
def register_lazy(self, key, module_name, member_name, help, native=True,
3591
deprecated=False, hidden=False, experimental=False, alias=False):
3592
registry.Registry.register_lazy(self, key, module_name, member_name,
3593
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3595
self._aliases.add(key)
3596
self._registration_order.append(key)
2199
deprecated=False, hidden=False):
2200
registry.Registry.register_lazy(self, key, module_name, member_name,
2201
help, BzrDirFormatInfo(native, deprecated, hidden))
3598
2203
def set_default(self, key):
3599
2204
"""Set the 'default' key to be a clone of the supplied key.
3601
2206
This method must be called once and only once.
3603
registry.Registry.register(self, 'default', self.get(key),
2208
registry.Registry.register(self, 'default', self.get(key),
3604
2209
self.get_help(key), info=self.get_info(key))
3605
self._aliases.add('default')
3607
2211
def set_default_repository(self, key):
3608
2212
"""Set the FormatRegistry default and Repository default.
3610
2214
This is a transitional method while Repository.set_default_format
3635
2246
def wrapped(key, help, info):
3636
2247
if info.native:
3637
2248
help = '(native) ' + help
3638
return ':%s:\n%s\n\n' % (key,
3639
textwrap.fill(help, initial_indent=' ',
3640
subsequent_indent=' ',
3641
break_long_words=False))
3642
if default_realkey is not None:
3643
output += wrapped(default_realkey, '(default) %s' % default_help,
3644
self.get_info('default'))
2249
return ' %s:\n%s\n\n' % (key,
2250
textwrap.fill(help, initial_indent=' ',
2251
subsequent_indent=' '))
2252
output += wrapped('%s/default' % default_realkey, default_help,
2253
self.get_info('default'))
3645
2254
deprecated_pairs = []
3646
experimental_pairs = []
3647
2255
for key, help in help_pairs:
3648
2256
info = self.get_info(key)
3649
2257
if info.hidden:
3651
2259
elif info.deprecated:
3652
2260
deprecated_pairs.append((key, help))
3653
elif info.experimental:
3654
experimental_pairs.append((key, help))
3656
2262
output += wrapped(key, help, info)
3657
output += "\nSee :doc:`formats-help` for more about storage formats."
3659
if len(experimental_pairs) > 0:
3660
other_output += "Experimental formats are shown below.\n\n"
3661
for key, help in experimental_pairs:
3662
info = self.get_info(key)
3663
other_output += wrapped(key, help, info)
3666
"No experimental formats are available.\n\n"
3667
2263
if len(deprecated_pairs) > 0:
3668
other_output += "\nDeprecated formats are shown below.\n\n"
2264
output += "Deprecated formats\n------------------\n\n"
3669
2265
for key, help in deprecated_pairs:
3670
2266
info = self.get_info(key)
3671
other_output += wrapped(key, help, info)
3674
"\nNo deprecated formats are available.\n\n"
3676
"\nSee :doc:`formats-help` for more about storage formats."
3678
if topic == 'other-formats':
3684
class RepositoryAcquisitionPolicy(object):
3685
"""Abstract base class for repository acquisition policies.
3687
A repository acquisition policy decides how a BzrDir acquires a repository
3688
for a branch that is being created. The most basic policy decision is
3689
whether to create a new repository or use an existing one.
3691
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3694
:param stack_on: A location to stack on
3695
:param stack_on_pwd: If stack_on is relative, the location it is
3697
:param require_stacking: If True, it is a failure to not stack.
3699
self._stack_on = stack_on
3700
self._stack_on_pwd = stack_on_pwd
3701
self._require_stacking = require_stacking
3703
def configure_branch(self, branch):
3704
"""Apply any configuration data from this policy to the branch.
3706
Default implementation sets repository stacking.
3708
if self._stack_on is None:
3710
if self._stack_on_pwd is None:
3711
stack_on = self._stack_on
3714
stack_on = urlutils.rebase_url(self._stack_on,
3717
except errors.InvalidRebaseURLs:
3718
stack_on = self._get_full_stack_on()
3720
branch.set_stacked_on_url(stack_on)
3721
except (errors.UnstackableBranchFormat,
3722
errors.UnstackableRepositoryFormat):
3723
if self._require_stacking:
3726
def requires_stacking(self):
3727
"""Return True if this policy requires stacking."""
3728
return self._stack_on is not None and self._require_stacking
3730
def _get_full_stack_on(self):
3731
"""Get a fully-qualified URL for the stack_on location."""
3732
if self._stack_on is None:
3734
if self._stack_on_pwd is None:
3735
return self._stack_on
3737
return urlutils.join(self._stack_on_pwd, self._stack_on)
3739
def _add_fallback(self, repository, possible_transports=None):
3740
"""Add a fallback to the supplied repository, if stacking is set."""
3741
stack_on = self._get_full_stack_on()
3742
if stack_on is None:
3745
stacked_dir = BzrDir.open(stack_on,
3746
possible_transports=possible_transports)
3747
except errors.JailBreak:
3748
# We keep the stacking details, but we are in the server code so
3749
# actually stacking is not needed.
3752
stacked_repo = stacked_dir.open_branch().repository
3753
except errors.NotBranchError:
3754
stacked_repo = stacked_dir.open_repository()
3756
repository.add_fallback_repository(stacked_repo)
3757
except errors.UnstackableRepositoryFormat:
3758
if self._require_stacking:
3761
self._require_stacking = True
3763
def acquire_repository(self, make_working_trees=None, shared=False):
3764
"""Acquire a repository for this bzrdir.
3766
Implementations may create a new repository or use a pre-exising
3768
:param make_working_trees: If creating a repository, set
3769
make_working_trees to this value (if non-None)
3770
:param shared: If creating a repository, make it shared if True
3771
:return: A repository, is_new_flag (True if the repository was
3774
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3777
class CreateRepository(RepositoryAcquisitionPolicy):
3778
"""A policy of creating a new repository"""
3780
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3781
require_stacking=False):
3784
:param bzrdir: The bzrdir to create the repository on.
3785
:param stack_on: A location to stack on
3786
:param stack_on_pwd: If stack_on is relative, the location it is
3789
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3791
self._bzrdir = bzrdir
3793
def acquire_repository(self, make_working_trees=None, shared=False):
3794
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3796
Creates the desired repository in the bzrdir we already have.
3798
stack_on = self._get_full_stack_on()
3800
format = self._bzrdir._format
3801
format.require_stacking(stack_on=stack_on,
3802
possible_transports=[self._bzrdir.root_transport])
3803
if not self._require_stacking:
3804
# We have picked up automatic stacking somewhere.
3805
note('Using default stacking branch %s at %s', self._stack_on,
3807
repository = self._bzrdir.create_repository(shared=shared)
3808
self._add_fallback(repository,
3809
possible_transports=[self._bzrdir.transport])
3810
if make_working_trees is not None:
3811
repository.set_make_working_trees(make_working_trees)
3812
return repository, True
3815
class UseExistingRepository(RepositoryAcquisitionPolicy):
3816
"""A policy of reusing an existing repository"""
3818
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3819
require_stacking=False):
3822
:param repository: The repository to use.
3823
:param stack_on: A location to stack on
3824
:param stack_on_pwd: If stack_on is relative, the location it is
3827
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3829
self._repository = repository
3831
def acquire_repository(self, make_working_trees=None, shared=False):
3832
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3834
Returns an existing repository to use.
3836
self._add_fallback(self._repository,
3837
possible_transports=[self._repository.bzrdir.transport])
3838
return self._repository, False
3841
# Please register new formats after old formats so that formats
3842
# appear in chronological order and format descriptions can build
2267
output += wrapped(key, help, info)
3844
2272
format_registry = BzrDirFormatRegistry()
3845
# The pre-0.8 formats have their repository format network name registered in
3846
# repository.py. MetaDir formats have their repository format network name
3847
# inferred from their disk format string.
3848
2273
format_registry.register('weave', BzrDirFormat6,
3849
2274
'Pre-0.8 format. Slower than knit and does not'
3850
2275
' support checkouts or shared repositories.',
3852
2276
deprecated=True)
2277
format_registry.register_metadir('knit',
2278
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2279
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2280
branch_format='bzrlib.branch.BzrBranchFormat5',
2281
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3853
2282
format_registry.register_metadir('metaweave',
3854
2283
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
2284
'Transitional format in 0.8. Slower than knit.',
3856
2285
branch_format='bzrlib.branch.BzrBranchFormat5',
3857
2286
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3860
format_registry.register_metadir('knit',
3861
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3863
branch_format='bzrlib.branch.BzrBranchFormat5',
3864
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3866
2287
deprecated=True)
3867
2288
format_registry.register_metadir('dirstate',
3868
2289
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3898
2309
'bzr branches. Incompatible with bzr < 0.15.',
3899
2310
branch_format='bzrlib.branch.BzrBranchFormat6',
3900
2311
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3904
format_registry.register_metadir('pack-0.92',
3905
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3906
help='New in 0.92: Pack-based format with data compatible with '
3907
'dirstate-tags format repositories. Interoperates with '
3908
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3910
branch_format='bzrlib.branch.BzrBranchFormat6',
3911
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3913
format_registry.register_metadir('pack-0.92-subtree',
3914
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3915
help='New in 0.92: Pack-based format with data compatible with '
3916
'dirstate-with-subtree format repositories. Interoperates with '
3917
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3919
branch_format='bzrlib.branch.BzrBranchFormat6',
3920
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3924
format_registry.register_metadir('rich-root-pack',
3925
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3926
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3927
'(needed for bzr-svn and bzr-git).',
3928
branch_format='bzrlib.branch.BzrBranchFormat6',
3929
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3932
format_registry.register_metadir('1.6',
3933
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3934
help='A format that allows a branch to indicate that there is another '
3935
'(stacked) repository that should be used to access data that is '
3936
'not present locally.',
3937
branch_format='bzrlib.branch.BzrBranchFormat7',
3938
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3941
format_registry.register_metadir('1.6.1-rich-root',
3942
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3943
help='A variant of 1.6 that supports rich-root data '
3944
'(needed for bzr-svn and bzr-git).',
3945
branch_format='bzrlib.branch.BzrBranchFormat7',
3946
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3949
format_registry.register_metadir('1.9',
3950
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3951
help='A repository format using B+tree indexes. These indexes '
3952
'are smaller in size, have smarter caching and provide faster '
3953
'performance for most operations.',
3954
branch_format='bzrlib.branch.BzrBranchFormat7',
3955
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3958
format_registry.register_metadir('1.9-rich-root',
3959
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3960
help='A variant of 1.9 that supports rich-root data '
3961
'(needed for bzr-svn and bzr-git).',
3962
branch_format='bzrlib.branch.BzrBranchFormat7',
3963
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3966
format_registry.register_metadir('1.14',
3967
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3968
help='A working-tree format that supports content filtering.',
3969
branch_format='bzrlib.branch.BzrBranchFormat7',
3970
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3972
format_registry.register_metadir('1.14-rich-root',
3973
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3974
help='A variant of 1.14 that supports rich-root data '
3975
'(needed for bzr-svn and bzr-git).',
3976
branch_format='bzrlib.branch.BzrBranchFormat7',
3977
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3979
# The following un-numbered 'development' formats should always just be aliases.
3980
format_registry.register_metadir('development-rich-root',
3981
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3982
help='Current development format. Supports rich roots. Can convert data '
3983
'to and from rich-root-pack (and anything compatible with '
3984
'rich-root-pack) format repositories. Repositories and branches in '
3985
'this format can only be read by bzr.dev. Please read '
3986
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3988
branch_format='bzrlib.branch.BzrBranchFormat7',
3989
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3994
format_registry.register_metadir('development-subtree',
3995
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3996
help='Current development format, subtree variant. Can convert data to and '
3997
'from pack-0.92-subtree (and anything compatible with '
3998
'pack-0.92-subtree) format repositories. Repositories and branches in '
3999
'this format can only be read by bzr.dev. Please read '
4000
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4002
branch_format='bzrlib.branch.BzrBranchFormat7',
4003
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4006
alias=False, # Restore to being an alias when an actual development subtree format is added
4007
# This current non-alias status is simply because we did not introduce a
4008
# chk based subtree format.
4011
# And the development formats above will have aliased one of the following:
4012
format_registry.register_metadir('development6-rich-root',
4013
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4014
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4016
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4018
branch_format='bzrlib.branch.BzrBranchFormat7',
4019
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4024
format_registry.register_metadir('development7-rich-root',
4025
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4026
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4027
'rich roots. Please read '
4028
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4030
branch_format='bzrlib.branch.BzrBranchFormat7',
4031
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4036
format_registry.register_metadir('2a',
4037
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4038
help='First format for bzr 2.0 series.\n'
4039
'Uses group-compress storage.\n'
4040
'Provides rich roots which are a one-way transition.\n',
4041
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4042
# 'rich roots. Supported by bzr 1.16 and later.',
4043
branch_format='bzrlib.branch.BzrBranchFormat7',
4044
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4048
# The following format should be an alias for the rich root equivalent
4049
# of the default format
4050
format_registry.register_metadir('default-rich-root',
4051
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4052
branch_format='bzrlib.branch.BzrBranchFormat7',
4053
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4058
# The current format that is made on 'bzr init'.
4059
format_registry.set_default('2a')
2314
format_registry.set_default('dirstate')
added
removed
bzrlib/bzrdir.py
