116
120
thing_to_unlock.break_lock()
122
def can_convert_format(self):
123
"""Return true if this bzrdir is one whose format we can convert from."""
118
126
def check_conversion_target(self, target_format):
119
"""Check that a bzrdir as a whole can be converted to a new format."""
120
# The only current restriction is that the repository content can be
121
# fetched compatibly with the target.
122
127
target_repo_format = target_format.repository_format
124
self.open_repository()._format.check_conversion_target(
126
except errors.NoRepositoryPresent:
127
# No repo, no problem.
128
source_repo_format = self._format.repository_format
129
source_repo_format.check_conversion_target(target_repo_format)
132
def _check_supported(format, allow_unsupported,
133
recommend_upgrade=True,
135
"""Give an error or warning on old formats.
137
:param format: may be any kind of format - workingtree, branch,
140
:param allow_unsupported: If true, allow opening
141
formats that are strongly deprecated, and which may
142
have limited functionality.
144
:param recommend_upgrade: If true (default), warn
145
the user through the ui object that they may wish
146
to upgrade the object.
148
# TODO: perhaps move this into a base Format class; it's not BzrDir
149
# specific. mbp 20070323
150
if not allow_unsupported and not format.is_supported():
151
# see open_downlevel to open legacy branches.
152
raise errors.UnsupportedFormatError(format=format)
153
if recommend_upgrade \
154
and getattr(format, 'upgrade_recommended', False):
155
ui.ui_factory.recommend_upgrade(
156
format.get_format_description(),
159
def clone(self, url, revision_id=None, force_new_repo=False):
160
"""Clone this bzrdir and its contents to url verbatim.
162
If url's last component does not exist, it will be created.
164
if revision_id is not None, then the clone operation may tune
165
itself to download less data.
166
:param force_new_repo: Do not use a shared repository for the target
167
even if one is available.
169
return self.clone_on_transport(get_transport(url),
170
revision_id=revision_id,
171
force_new_repo=force_new_repo)
130
173
def clone_on_transport(self, transport, revision_id=None,
131
force_new_repo=False, preserve_stacking=False, stacked_on=None,
132
create_prefix=False, use_existing_dir=True, no_tree=False):
174
force_new_repo=False):
133
175
"""Clone this bzrdir and its contents to transport verbatim.
135
:param transport: The transport for the location to produce the clone
136
at. If the target directory does not exist, it will be created.
137
:param revision_id: The tip revision-id to use for any branch or
138
working tree. If not None, then the clone operation may tune
177
If the target directory does not exist, it will be created.
179
if revision_id is not None, then the clone operation may tune
139
180
itself to download less data.
140
:param force_new_repo: Do not use a shared repository for the target,
181
:param force_new_repo: Do not use a shared repository for the target
141
182
even if one is available.
142
:param preserve_stacking: When cloning a stacked branch, stack the
143
new branch on top of the other branch's stacked-on branch.
144
:param create_prefix: Create any missing directories leading up to
146
:param use_existing_dir: Use an existing directory if one exists.
147
:param no_tree: If set to true prevents creation of a working tree.
149
# Overview: put together a broad description of what we want to end up
150
# with; then make as few api calls as possible to do it.
152
# We may want to create a repo/branch/tree, if we do so what format
153
# would we want for each:
154
require_stacking = (stacked_on is not None)
155
format = self.cloning_metadir(require_stacking)
157
# Figure out what objects we want:
184
transport.ensure_base()
185
result = self.cloning_metadir().initialize_on_transport(transport)
186
repository_policy = None
159
188
local_repo = self.find_repository()
160
189
except errors.NoRepositoryPresent:
161
190
local_repo = None
163
local_branch = self.open_branch()
164
except errors.NotBranchError:
167
# enable fallbacks when branch is not a branch reference
168
if local_branch.repository.has_same_location(local_repo):
169
local_repo = local_branch.repository
170
if preserve_stacking:
172
stacked_on = local_branch.get_stacked_on_url()
173
except (errors.UnstackableBranchFormat,
174
errors.UnstackableRepositoryFormat,
177
# Bug: We create a metadir without knowing if it can support stacking,
178
# we should look up the policy needs first, or just use it as a hint,
181
make_working_trees = local_repo.make_working_trees() and not no_tree
182
want_shared = local_repo.is_shared()
183
repo_format_name = format.repository_format.network_name()
185
make_working_trees = False
187
repo_format_name = None
189
result_repo, result, require_stacking, repository_policy = \
190
format.initialize_on_transport_ex(transport,
191
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
192
force_new_repo=force_new_repo, stacked_on=stacked_on,
193
stack_on_pwd=self.root_transport.base,
194
repo_format_name=repo_format_name,
195
make_working_trees=make_working_trees, shared_repo=want_shared)
198
# If the result repository is in the same place as the
199
# resulting bzr dir, it will have no content, further if the
200
# result is not stacked then we know all content should be
201
# copied, and finally if we are copying up to a specific
202
# revision_id then we can use the pending-ancestry-result which
203
# does not require traversing all of history to describe it.
204
if (result_repo.user_url == result.user_url
205
and not require_stacking and
206
revision_id is not None):
207
fetch_spec = vf_search.PendingAncestryResult(
208
[revision_id], local_repo)
209
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
211
result_repo.fetch(local_repo, revision_id=revision_id)
215
if result_repo is not None:
216
raise AssertionError('result_repo not None(%r)' % result_repo)
192
# may need to copy content in
193
repository_policy = result.determine_repository_policy(
195
make_working_trees = local_repo.make_working_trees()
196
result_repo = repository_policy.acquire_repository(
197
make_working_trees, local_repo.is_shared())
198
result_repo.fetch(local_repo, revision_id=revision_id)
217
199
# 1 if there is a branch present
218
200
# make sure its content is available in the target repository
220
if local_branch is not None:
221
result_branch = local_branch.clone(result, revision_id=revision_id,
222
repository_policy=repository_policy)
224
# Cheaper to check if the target is not local, than to try making
226
result.root_transport.local_abspath('.')
227
if result_repo is None or result_repo.make_working_trees():
228
self.open_workingtree().clone(result, revision_id=revision_id)
229
except (errors.NoWorkingTree, errors.NotLocalUrl):
203
local_branch = self.open_branch()
204
except errors.NotBranchError:
207
result_branch = local_branch.clone(result, revision_id=revision_id)
208
if repository_policy is not None:
209
repository_policy.configure_branch(result_branch)
211
result_repo = result.find_repository()
212
except errors.NoRepositoryPresent:
214
if result_repo is None or result_repo.make_working_trees():
216
self.open_workingtree().clone(result)
217
except (errors.NoWorkingTree, errors.NotLocalUrl):
233
221
# TODO: This should be given a Transport, and should chdir up; otherwise
234
222
# this will open a new connection.
235
223
def _make_tail(self, url):
236
t = _mod_transport.get_transport(url)
239
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
stack_on_pwd=None, require_stacking=False):
224
t = get_transport(url)
228
def create(cls, base, format=None, possible_transports=None):
229
"""Create a new BzrDir at the url 'base'.
231
:param format: If supplied, the format of branch to create. If not
232
supplied, the default is used.
233
:param possible_transports: If supplied, a list of transports that
234
can be reused to share a remote connection.
236
if cls is not BzrDir:
237
raise AssertionError("BzrDir.create always creates the default"
238
" format, not one of %r" % cls)
239
t = get_transport(base, possible_transports)
242
format = BzrDirFormat.get_default_format()
243
return format.initialize_on_transport(t)
246
def find_bzrdirs(transport, evaluate=None, list_current=None):
247
"""Find bzrdirs recursively from current location.
249
This is intended primarily as a building block for more sophisticated
250
functionality, like finding trees under a directory, or finding
251
branches that use a given repository.
252
:param evaluate: An optional callable that yields recurse, value,
253
where recurse controls whether this bzrdir is recursed into
254
and value is the value to yield. By default, all bzrdirs
255
are recursed into, and the return value is the bzrdir.
256
:param list_current: if supplied, use this function to list the current
257
directory, instead of Transport.list_dir
258
:return: a generator of found bzrdirs, or whatever evaluate returns.
260
if list_current is None:
261
def list_current(transport):
262
return transport.list_dir('')
264
def evaluate(bzrdir):
267
pending = [transport]
268
while len(pending) > 0:
269
current_transport = pending.pop()
272
bzrdir = BzrDir.open_from_transport(current_transport)
273
except errors.NotBranchError:
276
recurse, value = evaluate(bzrdir)
279
subdirs = list_current(current_transport)
280
except errors.NoSuchFile:
283
for subdir in sorted(subdirs, reverse=True):
284
pending.append(current_transport.clone(subdir))
287
def find_branches(transport):
288
"""Find all branches under a transport.
290
This will find all branches below the transport, including branches
291
inside other branches. Where possible, it will use
292
Repository.find_branches.
294
To list all the branches that use a particular Repository, see
295
Repository.find_branches
297
def evaluate(bzrdir):
299
repository = bzrdir.open_repository()
300
except errors.NoRepositoryPresent:
303
return False, (None, repository)
305
branch = bzrdir.open_branch()
306
except errors.NotBranchError:
307
return True, (None, None)
309
return True, (branch, None)
311
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
313
branches.extend(repo.find_branches())
314
if branch is not None:
315
branches.append(branch)
318
def destroy_repository(self):
319
"""Destroy the repository in this BzrDir"""
320
raise NotImplementedError(self.destroy_repository)
322
def create_branch(self):
323
"""Create a branch in this BzrDir.
325
The bzrdir's format will control what branch format is created.
326
For more control see BranchFormatXX.create(a_bzrdir).
328
raise NotImplementedError(self.create_branch)
330
def destroy_branch(self):
331
"""Destroy the branch in this BzrDir"""
332
raise NotImplementedError(self.destroy_branch)
335
def create_branch_and_repo(base, force_new_repo=False, format=None):
336
"""Create a new BzrDir, Branch and Repository at the url 'base'.
338
This will use the current default BzrDirFormat unless one is
339
specified, and use whatever
340
repository format that that uses via bzrdir.create_branch and
341
create_repository. If a shared repository is available that is used
344
The created Branch object is returned.
346
:param base: The URL to create the branch at.
347
:param force_new_repo: If True a new repository is always created.
348
:param format: If supplied, the format of branch to create. If not
349
supplied, the default is used.
351
bzrdir = BzrDir.create(base, format)
352
bzrdir._find_or_create_repository(force_new_repo)
353
return bzrdir.create_branch()
355
def determine_repository_policy(self, force_new_repo=False):
241
356
"""Return an object representing a policy to use.
243
This controls whether a new repository is created, and the format of
244
that repository, or some existing shared repository used instead.
246
If stack_on is supplied, will not seek a containing shared repo.
248
:param force_new_repo: If True, require a new repository to be created.
249
:param stack_on: If supplied, the location to stack on. If not
250
supplied, a default_stack_on location may be used.
251
:param stack_on_pwd: If stack_on is relative, the location it is
358
This controls whether a new repository is created, or a shared
359
repository used instead.
254
361
def repository_policy(found_bzrdir):
257
config = found_bzrdir.get_config()
259
stack_on = config.get_default_stack_on()
260
if stack_on is not None:
261
stack_on_pwd = found_bzrdir.user_url
263
363
# does it have a repository ?
265
365
repository = found_bzrdir.open_repository()
266
366
except errors.NoRepositoryPresent:
267
367
repository = None
269
if (found_bzrdir.user_url != self.user_url
270
and not repository.is_shared()):
271
# Don't look higher, can't use a higher shared repo.
369
if ((found_bzrdir.root_transport.base !=
370
self.root_transport.base) and not repository.is_shared()):
272
371
repository = None
277
375
return None, False
279
return UseExistingRepository(repository, stack_on,
280
stack_on_pwd, require_stacking=require_stacking), True
377
return UseExistingRepository(repository), True
282
return CreateRepository(self, stack_on, stack_on_pwd,
283
require_stacking=require_stacking), True
379
return CreateRepository(self), True
285
381
if not force_new_repo:
287
policy = self._find_containing(repository_policy)
288
if policy is not None:
292
return UseExistingRepository(self.open_repository(),
293
stack_on, stack_on_pwd,
294
require_stacking=require_stacking)
295
except errors.NoRepositoryPresent:
297
return CreateRepository(self, stack_on, stack_on_pwd,
298
require_stacking=require_stacking)
382
policy = self._find_containing(repository_policy)
383
if policy is not None:
385
return CreateRepository(self)
300
387
def _find_or_create_repository(self, force_new_repo):
301
388
"""Create a new repository if needed, returning the repository."""
302
389
policy = self.determine_repository_policy(force_new_repo)
303
return policy.acquire_repository()[0]
305
def _find_source_repo(self, add_cleanup, source_branch):
306
"""Find the source branch and repo for a sprout operation.
390
return policy.acquire_repository()
393
def create_branch_convenience(base, force_new_repo=False,
394
force_new_tree=None, format=None,
395
possible_transports=None):
396
"""Create a new BzrDir, Branch and Repository at the url 'base'.
398
This is a convenience function - it will use an existing repository
399
if possible, can be told explicitly whether to create a working tree or
402
This will use the current default BzrDirFormat unless one is
403
specified, and use whatever
404
repository format that that uses via bzrdir.create_branch and
405
create_repository. If a shared repository is available that is used
406
preferentially. Whatever repository is used, its tree creation policy
409
The created Branch object is returned.
410
If a working tree cannot be made due to base not being a file:// url,
411
no error is raised unless force_new_tree is True, in which case no
412
data is created on disk and NotLocalUrl is raised.
414
:param base: The URL to create the branch at.
415
:param force_new_repo: If True a new repository is always created.
416
:param force_new_tree: If True or False force creation of a tree or
417
prevent such creation respectively.
418
:param format: Override for the bzrdir format to create.
419
:param possible_transports: An optional reusable transports list.
422
# check for non local urls
423
t = get_transport(base, possible_transports)
424
if not isinstance(t, LocalTransport):
425
raise errors.NotLocalUrl(base)
426
bzrdir = BzrDir.create(base, format, possible_transports)
427
repo = bzrdir._find_or_create_repository(force_new_repo)
428
result = bzrdir.create_branch()
429
if force_new_tree or (repo.make_working_trees() and
430
force_new_tree is None):
432
bzrdir.create_workingtree()
433
except errors.NotLocalUrl:
438
def create_standalone_workingtree(base, format=None):
439
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
441
'base' must be a local path or a file:// url.
443
This will use the current default BzrDirFormat unless one is
444
specified, and use whatever
445
repository format that that uses for bzrdirformat.create_workingtree,
446
create_branch and create_repository.
448
:param format: Override for the bzrdir format to create.
449
:return: The WorkingTree object.
451
t = get_transport(base)
452
if not isinstance(t, LocalTransport):
453
raise errors.NotLocalUrl(base)
454
bzrdir = BzrDir.create_branch_and_repo(base,
456
format=format).bzrdir
457
return bzrdir.create_workingtree()
459
def create_workingtree(self, revision_id=None, from_branch=None,
460
accelerator_tree=None, hardlink=False):
461
"""Create a working tree at this BzrDir.
308
This is helper intended for use by _sprout.
310
:returns: (source_branch, source_repository). Either or both may be
311
None. If not None, they will be read-locked (and their unlock(s)
312
scheduled via the add_cleanup param).
314
if source_branch is not None:
315
add_cleanup(source_branch.lock_read().unlock)
316
return source_branch, source_branch.repository
318
source_branch = self.open_branch()
319
source_repository = source_branch.repository
320
except errors.NotBranchError:
323
source_repository = self.open_repository()
324
except errors.NoRepositoryPresent:
325
source_repository = None
327
add_cleanup(source_repository.lock_read().unlock)
329
add_cleanup(source_branch.lock_read().unlock)
330
return source_branch, source_repository
332
def sprout(self, url, revision_id=None, force_new_repo=False,
333
recurse='down', possible_transports=None,
334
accelerator_tree=None, hardlink=False, stacked=False,
335
source_branch=None, create_tree_if_local=True):
336
"""Create a copy of this controldir prepared for use as a new line of
339
If url's last component does not exist, it will be created.
341
Attributes related to the identity of the source branch like
342
branch nickname will be cleaned, a working tree is created
343
whether one existed before or not; and a local branch is always
346
if revision_id is not None, then the clone operation may tune
347
itself to download less data.
463
:param revision_id: create it as of this revision id.
464
:param from_branch: override bzrdir branch (for lightweight checkouts)
349
465
:param accelerator_tree: A tree which can be used for retrieving file
350
466
contents more quickly than the revision tree, i.e. a workingtree.
351
467
The revision tree will be used for cases where accelerator_tree's
352
468
content is different.
353
:param hardlink: If true, hard-link files from accelerator_tree,
355
:param stacked: If true, create a stacked branch referring to the
356
location of this control directory.
357
:param create_tree_if_local: If true, a working-tree will be created
358
when working locally.
359
:return: The created control directory
361
operation = cleanup.OperationWithCleanups(self._sprout)
362
return operation.run(url, revision_id=revision_id,
363
force_new_repo=force_new_repo, recurse=recurse,
364
possible_transports=possible_transports,
365
accelerator_tree=accelerator_tree, hardlink=hardlink,
366
stacked=stacked, source_branch=source_branch,
367
create_tree_if_local=create_tree_if_local)
369
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
370
recurse='down', possible_transports=None,
371
accelerator_tree=None, hardlink=False, stacked=False,
372
source_branch=None, create_tree_if_local=True):
373
add_cleanup = op.add_cleanup
374
fetch_spec_factory = fetch.FetchSpecFactory()
375
if revision_id is not None:
376
fetch_spec_factory.add_revision_ids([revision_id])
377
fetch_spec_factory.source_branch_stop_revision_id = revision_id
378
if possible_transports is None:
379
possible_transports = []
381
possible_transports = list(possible_transports) + [
383
target_transport = _mod_transport.get_transport(url,
385
target_transport.ensure_base()
386
cloning_format = self.cloning_metadir(stacked)
387
# Create/update the result branch
389
result = controldir.ControlDir.open_from_transport(target_transport)
390
except errors.NotBranchError:
391
result = cloning_format.initialize_on_transport(target_transport)
392
source_branch, source_repository = self._find_source_repo(
393
add_cleanup, source_branch)
394
fetch_spec_factory.source_branch = source_branch
395
# if a stacked branch wasn't requested, we don't create one
396
# even if the origin was stacked
397
if stacked and source_branch is not None:
398
stacked_branch_url = self.root_transport.base
400
stacked_branch_url = None
401
repository_policy = result.determine_repository_policy(
402
force_new_repo, stacked_branch_url, require_stacking=stacked)
403
result_repo, is_new_repo = repository_policy.acquire_repository(
404
possible_transports=possible_transports)
405
add_cleanup(result_repo.lock_write().unlock)
406
fetch_spec_factory.source_repo = source_repository
407
fetch_spec_factory.target_repo = result_repo
408
if stacked or (len(result_repo._fallback_repositories) != 0):
409
target_repo_kind = fetch.TargetRepoKinds.STACKED
411
target_repo_kind = fetch.TargetRepoKinds.EMPTY
413
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
414
fetch_spec_factory.target_repo_kind = target_repo_kind
415
if source_repository is not None:
416
fetch_spec = fetch_spec_factory.make_fetch_spec()
417
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
419
if source_branch is None:
420
# this is for sprouting a controldir without a branch; is that
422
# Not especially, but it's part of the contract.
423
result_branch = result.create_branch()
425
result_branch = source_branch.sprout(result,
426
revision_id=revision_id, repository_policy=repository_policy,
427
repository=result_repo)
428
mutter("created new branch %r" % (result_branch,))
430
# Create/update the result working tree
431
if (create_tree_if_local and not result.has_workingtree() and
432
isinstance(target_transport, local.LocalTransport) and
433
(result_repo is None or result_repo.make_working_trees())):
434
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
435
hardlink=hardlink, from_branch=result_branch)
438
if wt.path2id('') is None:
440
wt.set_root_id(self.open_workingtree.get_root_id())
441
except errors.NoWorkingTree:
447
if recurse == 'down':
450
basis = wt.basis_tree()
451
elif result_branch is not None:
452
basis = result_branch.basis_tree()
453
elif source_branch is not None:
454
basis = source_branch.basis_tree()
455
if basis is not None:
456
add_cleanup(basis.lock_read().unlock)
457
subtrees = basis.iter_references()
460
for path, file_id in subtrees:
461
target = urlutils.join(url, urlutils.escape(path))
462
sublocation = source_branch.reference_parent(file_id, path)
463
sublocation.bzrdir.sprout(target,
464
basis.get_reference_revision(file_id, path),
465
force_new_repo=force_new_repo, recurse=recurse,
469
def _available_backup_name(self, base):
470
"""Find a non-existing backup file name based on base.
472
See bzrlib.osutils.available_backup_name about race conditions.
474
return osutils.available_backup_name(base, self.root_transport.has)
476
def backup_bzrdir(self):
477
"""Backup this bzr control directory.
479
:return: Tuple with old path name and new path name
482
pb = ui.ui_factory.nested_progress_bar()
484
old_path = self.root_transport.abspath('.bzr')
485
backup_dir = self._available_backup_name('backup.bzr')
486
new_path = self.root_transport.abspath(backup_dir)
487
ui.ui_factory.note(gettext('making backup of {0}\n to {1}').format(
488
urlutils.unescape_for_display(old_path, 'utf-8'),
489
urlutils.unescape_for_display(new_path, 'utf-8')))
490
self.root_transport.copy_tree('.bzr', backup_dir)
491
return (old_path, new_path)
470
raise NotImplementedError(self.create_workingtree)
495
472
def retire_bzrdir(self, limit=10000):
496
473
"""Permanently disable the bzrdir.
633
660
:param _transport: the transport this dir is based at.
635
662
self._format = _format
636
# these are also under the more standard names of
637
# control_transport and user_transport
638
663
self.transport = _transport.clone('.bzr')
639
664
self.root_transport = _transport
640
665
self._mode_check_done = False
643
def user_transport(self):
644
return self.root_transport
647
def control_transport(self):
648
return self.transport
650
667
def is_control_filename(self, filename):
651
668
"""True if filename is the name of a path which is reserved for bzrdir's.
653
670
:param filename: A filename within the root transport of this bzrdir.
655
672
This is true IF and ONLY IF the filename is part of the namespace reserved
656
673
for bzr control dirs. Currently this is the '.bzr' directory in the root
657
of the root_transport.
674
of the root_transport. it is expected that plugins will need to extend
675
this in the future - for instance to make bzr talk with svn working
659
# this might be better on the BzrDirFormat class because it refers to
660
# all the possible bzrdir disk formats.
661
# This method is tested via the workingtree is_control_filename tests-
678
# this might be better on the BzrDirFormat class because it refers to
679
# all the possible bzrdir disk formats.
680
# This method is tested via the workingtree is_control_filename tests-
662
681
# it was extracted from WorkingTree.is_control_filename. If the method's
663
682
# contract is extended beyond the current trivial implementation, please
664
683
# add new tests for it to the appropriate place.
665
684
return filename == '.bzr' or filename.startswith('.bzr/')
686
def needs_format_conversion(self, format=None):
687
"""Return true if this bzrdir needs convert_format run on it.
689
For instance, if the repository format is out of date but the
690
branch and working tree are not, this should return True.
692
:param format: Optional parameter indicating a specific desired
693
format we plan to arrive at.
695
raise NotImplementedError(self.needs_format_conversion)
698
def open_unsupported(base):
699
"""Open a branch which is not supported."""
700
return BzrDir.open(base, _unsupported=True)
703
def open(base, _unsupported=False, possible_transports=None):
704
"""Open an existing bzrdir, rooted at 'base' (url).
706
:param _unsupported: a private parameter to the BzrDir class.
708
t = get_transport(base, possible_transports=possible_transports)
709
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
712
def open_from_transport(transport, _unsupported=False,
713
_server_formats=True):
714
"""Open a bzrdir within a particular directory.
716
:param transport: Transport containing the bzrdir.
717
:param _unsupported: private.
719
base = transport.base
721
def find_format(transport):
722
return transport, BzrDirFormat.find_format(
723
transport, _server_formats=_server_formats)
725
def redirected(transport, e, redirection_notice):
726
qualified_source = e.get_source_url()
727
relpath = transport.relpath(qualified_source)
728
if not e.target.endswith(relpath):
729
# Not redirected to a branch-format, not a branch
730
raise errors.NotBranchError(path=e.target)
731
target = e.target[:-len(relpath)]
732
note('%s is%s redirected to %s',
733
transport.base, e.permanently, target)
734
# Let's try with a new transport
735
# FIXME: If 'transport' has a qualifier, this should
736
# be applied again to the new transport *iff* the
737
# schemes used are the same. Uncomment this code
738
# once the function (and tests) exist.
740
#target = urlutils.copy_url_qualifiers(original, target)
741
return get_transport(target)
744
transport, format = do_catching_redirections(find_format,
747
except errors.TooManyRedirections:
748
raise errors.NotBranchError(base)
750
BzrDir._check_supported(format, _unsupported)
751
return format.open(transport, _found=True)
753
def open_branch(self, unsupported=False):
754
"""Open the branch object at this BzrDir if one is present.
756
If unsupported is True, then no longer supported branch formats can
759
TODO: static convenience version of this?
761
raise NotImplementedError(self.open_branch)
764
def open_containing(url, possible_transports=None):
765
"""Open an existing branch which contains url.
767
:param url: url to search from.
768
See open_containing_from_transport for more detail.
770
transport = get_transport(url, possible_transports)
771
return BzrDir.open_containing_from_transport(transport)
774
def open_containing_from_transport(a_transport):
775
"""Open an existing branch which contains a_transport.base.
777
This probes for a branch at a_transport, and searches upwards from there.
779
Basically we keep looking up until we find the control directory or
780
run into the root. If there isn't one, raises NotBranchError.
781
If there is one and it is either an unrecognised format or an unsupported
782
format, UnknownFormatError or UnsupportedFormatError are raised.
783
If there is one, it is returned, along with the unused portion of url.
785
:return: The BzrDir that contains the path, and a Unicode path
786
for the rest of the URL.
788
# this gets the normalised url back. I.e. '.' -> the full path.
789
url = a_transport.base
792
result = BzrDir.open_from_transport(a_transport)
793
return result, urlutils.unescape(a_transport.relpath(url))
794
except errors.NotBranchError, e:
797
new_t = a_transport.clone('..')
798
except errors.InvalidURLJoin:
799
# reached the root, whatever that may be
800
raise errors.NotBranchError(path=url)
801
if new_t.base == a_transport.base:
802
# reached the root, whatever that may be
803
raise errors.NotBranchError(path=url)
806
def _get_tree_branch(self):
807
"""Return the branch and tree, if any, for this bzrdir.
809
Return None for tree if not present or inaccessible.
810
Raise NotBranchError if no branch is present.
811
:return: (tree, branch)
814
tree = self.open_workingtree()
815
except (errors.NoWorkingTree, errors.NotLocalUrl):
817
branch = self.open_branch()
823
def open_tree_or_branch(klass, location):
824
"""Return the branch and working tree at a location.
826
If there is no tree at the location, tree will be None.
827
If there is no branch at the location, an exception will be
829
:return: (tree, branch)
831
bzrdir = klass.open(location)
832
return bzrdir._get_tree_branch()
835
def open_containing_tree_or_branch(klass, location):
836
"""Return the branch and working tree contained by a location.
838
Returns (tree, branch, relpath).
839
If there is no tree at containing the location, tree will be None.
840
If there is no branch containing the location, an exception will be
842
relpath is the portion of the path that is contained by the branch.
844
bzrdir, relpath = klass.open_containing(location)
845
tree, branch = bzrdir._get_tree_branch()
846
return tree, branch, relpath
849
def open_containing_tree_branch_or_repository(klass, location):
850
"""Return the working tree, branch and repo contained by a location.
852
Returns (tree, branch, repository, relpath).
853
If there is no tree containing the location, tree will be None.
854
If there is no branch containing the location, branch will be None.
855
If there is no repository containing the location, repository will be
857
relpath is the portion of the path that is contained by the innermost
860
If no tree, branch or repository is found, a NotBranchError is raised.
862
bzrdir, relpath = klass.open_containing(location)
864
tree, branch = bzrdir._get_tree_branch()
865
except errors.NotBranchError:
867
repo = bzrdir.find_repository()
868
return None, None, repo, relpath
869
except (errors.NoRepositoryPresent):
870
raise errors.NotBranchError(location)
871
return tree, branch, branch.repository, relpath
873
def open_repository(self, _unsupported=False):
874
"""Open the repository object at this BzrDir if one is present.
876
This will not follow the Branch object pointer - it's strictly a direct
877
open facility. Most client code should use open_branch().repository to
880
:param _unsupported: a private parameter, not part of the api.
881
TODO: static convenience version of this?
883
raise NotImplementedError(self.open_repository)
885
def open_workingtree(self, _unsupported=False,
886
recommend_upgrade=True, from_branch=None):
887
"""Open the workingtree object at this BzrDir if one is present.
889
:param recommend_upgrade: Optional keyword parameter, when True (the
890
default), emit through the ui module a recommendation that the user
891
upgrade the working tree when the workingtree being opened is old
892
(but still fully supported).
893
:param from_branch: override bzrdir branch (for lightweight checkouts)
895
raise NotImplementedError(self.open_workingtree)
897
def has_branch(self):
898
"""Tell if this bzrdir contains a branch.
900
Note: if you're going to open the branch, you should just go ahead
901
and try, and not ask permission first. (This method just opens the
902
branch and discards it, and that's somewhat expensive.)
907
except errors.NotBranchError:
910
def has_workingtree(self):
911
"""Tell if this bzrdir contains a working tree.
913
This will still raise an exception if the bzrdir has a workingtree that
914
is remote & inaccessible.
916
Note: if you're going to open the working tree, you should just go ahead
917
and try, and not ask permission first. (This method just opens the
918
workingtree and discards it, and that's somewhat expensive.)
921
self.open_workingtree(recommend_upgrade=False)
923
except errors.NoWorkingTree:
667
926
def _cloning_metadir(self):
668
"""Produce a metadir suitable for cloning with.
670
:returns: (destination_bzrdir_format, source_repository)
927
"""Produce a metadir suitable for cloning with."""
672
928
result_format = self._format.__class__()
675
branch = self.open_branch(ignore_fallbacks=True)
931
branch = self.open_branch()
676
932
source_repository = branch.repository
677
result_format._branch_format = branch._format
678
933
except errors.NotBranchError:
679
934
source_branch = None
680
935
source_repository = self.open_repository()
700
953
result_format.workingtree_format = tree._format.__class__()
701
954
return result_format, source_repository
703
def cloning_metadir(self, require_stacking=False):
956
def cloning_metadir(self):
704
957
"""Produce a metadir suitable for cloning or sprouting with.
706
959
These operations may produce workingtrees (yes, even though they're
707
960
"cloning" something that doesn't have a tree), so a viable workingtree
708
961
format must be selected.
710
:require_stacking: If True, non-stackable formats will be upgraded
711
to similar stackable formats.
712
:returns: a ControlDirFormat with all component formats either set
713
appropriately or set to None if that component should not be
716
963
format, repository = self._cloning_metadir()
717
964
if format._workingtree_format is None:
719
965
if repository is None:
720
# No repository either
722
# We have a repository, so set a working tree? (Why? This seems to
723
# contradict the stated return value in the docstring).
724
967
tree_format = repository._format._matchingbzrdir.workingtree_format
725
968
format.workingtree_format = tree_format.__class__()
727
format.require_stacking()
730
def get_branch_transport(self, branch_format, name=None):
731
"""Get the transport for use by branch format in this BzrDir.
733
Note that bzr dirs that do not support format strings will raise
734
IncompatibleFormat if the branch format they are given has
735
a format string, and vice versa.
737
If branch_format is None, the transport is returned with no
738
checking. If it is not None, then the returned transport is
739
guaranteed to point to an existing directory ready for use.
971
def checkout_metadir(self):
972
return self.cloning_metadir()
974
def sprout(self, url, revision_id=None, force_new_repo=False,
975
recurse='down', possible_transports=None,
976
accelerator_tree=None, hardlink=False):
977
"""Create a copy of this bzrdir prepared for use as a new line of
980
If url's last component does not exist, it will be created.
982
Attributes related to the identity of the source branch like
983
branch nickname will be cleaned, a working tree is created
984
whether one existed before or not; and a local branch is always
987
if revision_id is not None, then the clone operation may tune
988
itself to download less data.
989
:param accelerator_tree: A tree which can be used for retrieving file
990
contents more quickly than the revision tree, i.e. a workingtree.
991
The revision tree will be used for cases where accelerator_tree's
992
content is different.
993
:param hardlink: If true, hard-link files from accelerator_tree,
741
raise NotImplementedError(self.get_branch_transport)
996
target_transport = get_transport(url, possible_transports)
997
target_transport.ensure_base()
998
cloning_format = self.cloning_metadir()
999
result = cloning_format.initialize_on_transport(target_transport)
1001
source_branch = self.open_branch()
1002
source_repository = source_branch.repository
1003
except errors.NotBranchError:
1004
source_branch = None
1006
source_repository = self.open_repository()
1007
except errors.NoRepositoryPresent:
1008
source_repository = None
1013
result_repo = result.find_repository()
1014
except errors.NoRepositoryPresent:
1016
if source_repository is None and result_repo is not None:
1018
elif source_repository is None and result_repo is None:
1019
# no repo available, make a new one
1020
result.create_repository()
1021
elif source_repository is not None and result_repo is None:
1022
# have source, and want to make a new target repo
1023
result_repo = source_repository.sprout(result,
1024
revision_id=revision_id)
1026
# fetch needed content into target.
1027
if source_repository is not None:
1029
# source_repository.copy_content_into(result_repo,
1030
# revision_id=revision_id)
1031
# so we can override the copy method
1032
result_repo.fetch(source_repository, revision_id=revision_id)
1033
if source_branch is not None:
1034
source_branch.sprout(result, revision_id=revision_id)
1036
result.create_branch()
1037
if isinstance(target_transport, LocalTransport) and (
1038
result_repo is None or result_repo.make_working_trees()):
1039
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1043
if wt.path2id('') is None:
1045
wt.set_root_id(self.open_workingtree.get_root_id())
1046
except errors.NoWorkingTree:
1052
if recurse == 'down':
1054
basis = wt.basis_tree()
1056
subtrees = basis.iter_references()
1057
recurse_branch = wt.branch
1058
elif source_branch is not None:
1059
basis = source_branch.basis_tree()
1061
subtrees = basis.iter_references()
1062
recurse_branch = source_branch
1067
for path, file_id in subtrees:
1068
target = urlutils.join(url, urlutils.escape(path))
1069
sublocation = source_branch.reference_parent(file_id, path)
1070
sublocation.bzrdir.sprout(target,
1071
basis.get_reference_revision(file_id, path),
1072
force_new_repo=force_new_repo, recurse=recurse)
1074
if basis is not None:
1079
class BzrDirPreSplitOut(BzrDir):
1080
"""A common class for the all-in-one formats."""
1082
def __init__(self, _transport, _format):
1083
"""See BzrDir.__init__."""
1084
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1085
self._control_files = lockable_files.LockableFiles(
1086
self.get_branch_transport(None),
1087
self._format._lock_file_name,
1088
self._format._lock_class)
1090
def break_lock(self):
1091
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1092
raise NotImplementedError(self.break_lock)
1094
def cloning_metadir(self):
1095
"""Produce a metadir suitable for cloning with."""
1096
return self._format.__class__()
1098
def clone(self, url, revision_id=None, force_new_repo=False):
1099
"""See BzrDir.clone()."""
1100
from bzrlib.workingtree import WorkingTreeFormat2
1101
self._make_tail(url)
1102
result = self._format._initialize_for_clone(url)
1103
self.open_repository().clone(result, revision_id=revision_id)
1104
from_branch = self.open_branch()
1105
from_branch.clone(result, revision_id=revision_id)
1107
self.open_workingtree().clone(result)
1108
except errors.NotLocalUrl:
1109
# make a new one, this format always has to have one.
1111
WorkingTreeFormat2().initialize(result)
1112
except errors.NotLocalUrl:
1113
# but we cannot do it for remote trees.
1114
to_branch = result.open_branch()
1115
WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1118
def create_branch(self):
1119
"""See BzrDir.create_branch."""
1120
return self.open_branch()
1122
def destroy_branch(self):
1123
"""See BzrDir.destroy_branch."""
1124
raise errors.UnsupportedOperation(self.destroy_branch, self)
1126
def create_repository(self, shared=False):
1127
"""See BzrDir.create_repository."""
1129
raise errors.IncompatibleFormat('shared repository', self._format)
1130
return self.open_repository()
1132
def destroy_repository(self):
1133
"""See BzrDir.destroy_repository."""
1134
raise errors.UnsupportedOperation(self.destroy_repository, self)
1136
def create_workingtree(self, revision_id=None, from_branch=None,
1137
accelerator_tree=None, hardlink=False):
1138
"""See BzrDir.create_workingtree."""
1139
# this looks buggy but is not -really-
1140
# because this format creates the workingtree when the bzrdir is
1142
# clone and sprout will have set the revision_id
1143
# and that will have set it for us, its only
1144
# specific uses of create_workingtree in isolation
1145
# that can do wonky stuff here, and that only
1146
# happens for creating checkouts, which cannot be
1147
# done on this format anyway. So - acceptable wart.
1148
result = self.open_workingtree(recommend_upgrade=False)
1149
if revision_id is not None:
1150
if revision_id == _mod_revision.NULL_REVISION:
1151
result.set_parent_ids([])
1153
result.set_parent_ids([revision_id])
1156
def destroy_workingtree(self):
1157
"""See BzrDir.destroy_workingtree."""
1158
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1160
def destroy_workingtree_metadata(self):
1161
"""See BzrDir.destroy_workingtree_metadata."""
1162
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1165
def get_branch_transport(self, branch_format):
1166
"""See BzrDir.get_branch_transport()."""
1167
if branch_format is None:
1168
return self.transport
1170
branch_format.get_format_string()
1171
except NotImplementedError:
1172
return self.transport
1173
raise errors.IncompatibleFormat(branch_format, self._format)
743
1175
def get_repository_transport(self, repository_format):
744
"""Get the transport for use by repository format in this BzrDir.
746
Note that bzr dirs that do not support format strings will raise
747
IncompatibleFormat if the repository format they are given has
748
a format string, and vice versa.
750
If repository_format is None, the transport is returned with no
751
checking. If it is not None, then the returned transport is
752
guaranteed to point to an existing directory ready for use.
754
raise NotImplementedError(self.get_repository_transport)
756
def get_workingtree_transport(self, tree_format):
757
"""Get the transport for use by workingtree format in this BzrDir.
759
Note that bzr dirs that do not support format strings will raise
760
IncompatibleFormat if the workingtree format they are given has a
761
format string, and vice versa.
763
If workingtree_format is None, the transport is returned with no
764
checking. If it is not None, then the returned transport is
765
guaranteed to point to an existing directory ready for use.
767
raise NotImplementedError(self.get_workingtree_transport)
770
def create(cls, base, format=None, possible_transports=None):
771
"""Create a new BzrDir at the url 'base'.
773
:param format: If supplied, the format of branch to create. If not
774
supplied, the default is used.
775
:param possible_transports: If supplied, a list of transports that
776
can be reused to share a remote connection.
778
if cls is not BzrDir:
779
raise AssertionError("BzrDir.create always creates the "
780
"default format, not one of %r" % cls)
781
return controldir.ControlDir.create(base, format=format,
782
possible_transports=possible_transports)
785
return "<%s at %r>" % (self.__class__.__name__, self.user_url)
787
def update_feature_flags(self, updated_flags):
788
"""Update the features required by this bzrdir.
790
:param updated_flags: Dictionary mapping feature names to necessities
791
A necessity can be None to indicate the feature should be removed
793
self.control_files.lock_write()
795
self._format._update_feature_flags(updated_flags)
796
self.transport.put_bytes('branch-format', self._format.as_string())
798
self.control_files.unlock()
1176
"""See BzrDir.get_repository_transport()."""
1177
if repository_format is None:
1178
return self.transport
1180
repository_format.get_format_string()
1181
except NotImplementedError:
1182
return self.transport
1183
raise errors.IncompatibleFormat(repository_format, self._format)
1185
def get_workingtree_transport(self, workingtree_format):
1186
"""See BzrDir.get_workingtree_transport()."""
1187
if workingtree_format is None:
1188
return self.transport
1190
workingtree_format.get_format_string()
1191
except NotImplementedError:
1192
return self.transport
1193
raise errors.IncompatibleFormat(workingtree_format, self._format)
1195
def needs_format_conversion(self, format=None):
1196
"""See BzrDir.needs_format_conversion()."""
1197
# if the format is not the same as the system default,
1198
# an upgrade is needed.
1200
format = BzrDirFormat.get_default_format()
1201
return not isinstance(self._format, format.__class__)
1203
def open_branch(self, unsupported=False):
1204
"""See BzrDir.open_branch."""
1205
from bzrlib.branch import BzrBranchFormat4
1206
format = BzrBranchFormat4()
1207
self._check_supported(format, unsupported)
1208
return format.open(self, _found=True)
1210
def sprout(self, url, revision_id=None, force_new_repo=False,
1211
possible_transports=None, accelerator_tree=None,
1213
"""See BzrDir.sprout()."""
1214
from bzrlib.workingtree import WorkingTreeFormat2
1215
self._make_tail(url)
1216
result = self._format._initialize_for_clone(url)
1218
self.open_repository().clone(result, revision_id=revision_id)
1219
except errors.NoRepositoryPresent:
1222
self.open_branch().sprout(result, revision_id=revision_id)
1223
except errors.NotBranchError:
1225
# we always want a working tree
1226
WorkingTreeFormat2().initialize(result,
1227
accelerator_tree=accelerator_tree,
1232
class BzrDir4(BzrDirPreSplitOut):
1233
"""A .bzr version 4 control object.
1235
This is a deprecated format and may be removed after sept 2006.
1238
def create_repository(self, shared=False):
1239
"""See BzrDir.create_repository."""
1240
return self._format.repository_format.initialize(self, shared)
1242
def needs_format_conversion(self, format=None):
1243
"""Format 4 dirs are always in need of conversion."""
1246
def open_repository(self):
1247
"""See BzrDir.open_repository."""
1248
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1249
return RepositoryFormat4().open(self, _found=True)
1252
class BzrDir5(BzrDirPreSplitOut):
1253
"""A .bzr version 5 control object.
1255
This is a deprecated format and may be removed after sept 2006.
1258
def open_repository(self):
1259
"""See BzrDir.open_repository."""
1260
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1261
return RepositoryFormat5().open(self, _found=True)
1263
def open_workingtree(self, _unsupported=False,
1264
recommend_upgrade=True):
1265
"""See BzrDir.create_workingtree."""
1266
from bzrlib.workingtree import WorkingTreeFormat2
1267
wt_format = WorkingTreeFormat2()
1268
# we don't warn here about upgrades; that ought to be handled for the
1270
return wt_format.open(self, _found=True)
1273
class BzrDir6(BzrDirPreSplitOut):
1274
"""A .bzr version 6 control object.
1276
This is a deprecated format and may be removed after sept 2006.
1279
def open_repository(self):
1280
"""See BzrDir.open_repository."""
1281
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1282
return RepositoryFormat6().open(self, _found=True)
1284
def open_workingtree(self, _unsupported=False,
1285
recommend_upgrade=True):
1286
"""See BzrDir.create_workingtree."""
1287
# we don't warn here about upgrades; that ought to be handled for the
1289
from bzrlib.workingtree import WorkingTreeFormat2
1290
return WorkingTreeFormat2().open(self, _found=True)
801
1293
class BzrDirMeta1(BzrDir):
802
1294
"""A .bzr meta version 1 control object.
804
This is the first control object where the
1296
This is the first control object where the
805
1297
individual aspects are really split out: there are separate repository,
806
1298
workingtree and branch subdirectories and any subset of the three can be
807
1299
present within a BzrDir.
810
def _get_branch_path(self, name):
811
"""Obtain the branch path to use.
813
This uses the API specified branch name first, and then falls back to
814
the branch name specified in the URL. If neither of those is specified,
815
it uses the default branch.
817
:param name: Optional branch name to use
818
:return: Relative path to branch
822
return urlutils.join('branches', name.encode("utf-8"))
824
def _read_branch_list(self):
825
"""Read the branch list.
827
:return: List of utf-8 encoded branch names.
830
f = self.control_transport.get('branch-list')
831
except errors.NoSuchFile:
837
ret.append(name.rstrip("\n"))
842
def _write_branch_list(self, branches):
843
"""Write out the branch list.
845
:param branches: List of utf-8 branch names to write
847
self.transport.put_bytes('branch-list',
848
"".join([name+"\n" for name in branches]))
850
def __init__(self, _transport, _format):
851
super(BzrDirMeta1, self).__init__(_transport, _format)
852
self.control_files = lockable_files.LockableFiles(
853
self.control_transport, self._format._lock_file_name,
854
self._format._lock_class)
856
1302
def can_convert_format(self):
857
1303
"""See BzrDir.can_convert_format()."""
860
def create_branch(self, name=None, repository=None,
861
append_revisions_only=None):
862
"""See ControlDir.create_branch."""
864
name = self._get_selected_branch()
865
return self._format.get_branch_format().initialize(self, name=name,
866
repository=repository,
867
append_revisions_only=append_revisions_only)
1306
def create_branch(self):
1307
"""See BzrDir.create_branch."""
1308
return self._format.get_branch_format().initialize(self)
869
def destroy_branch(self, name=None):
870
"""See ControlDir.destroy_branch."""
872
name = self._get_selected_branch()
873
path = self._get_branch_path(name)
875
self.control_files.lock_write()
877
branches = self._read_branch_list()
879
branches.remove(name.encode("utf-8"))
881
raise errors.NotBranchError(name)
882
self._write_branch_list(branches)
884
self.control_files.unlock()
886
self.transport.delete_tree(path)
887
except errors.NoSuchFile:
888
raise errors.NotBranchError(path=urlutils.join(self.transport.base,
1310
def destroy_branch(self):
1311
"""See BzrDir.create_branch."""
1312
self.transport.delete_tree('branch')
891
1314
def create_repository(self, shared=False):
892
1315
"""See BzrDir.create_repository."""
1070
def open_branch(self, name=None, unsupported=False,
1071
ignore_fallbacks=False, possible_transports=None):
1072
"""See ControlDir.open_branch."""
1074
name = self._get_selected_branch()
1075
format = self.find_branch_format(name=name)
1076
format.check_support_status(unsupported)
1077
return format.open(self, name=name,
1078
_found=True, ignore_fallbacks=ignore_fallbacks,
1079
possible_transports=possible_transports)
1434
def open_branch(self, unsupported=False):
1435
"""See BzrDir.open_branch."""
1436
format = self.find_branch_format()
1437
self._check_supported(format, unsupported)
1438
return format.open(self, _found=True)
1081
1440
def open_repository(self, unsupported=False):
1082
1441
"""See BzrDir.open_repository."""
1083
from bzrlib.repository import RepositoryFormatMetaDir
1084
format = RepositoryFormatMetaDir.find_format(self)
1085
format.check_support_status(unsupported)
1442
from bzrlib.repository import RepositoryFormat
1443
format = RepositoryFormat.find_format(self)
1444
self._check_supported(format, unsupported)
1086
1445
return format.open(self, _found=True)
1088
1447
def open_workingtree(self, unsupported=False,
1089
1448
recommend_upgrade=True):
1090
1449
"""See BzrDir.open_workingtree."""
1091
from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
format = WorkingTreeFormatMetaDir.find_format(self)
1093
format.check_support_status(unsupported, recommend_upgrade,
1450
from bzrlib.workingtree import WorkingTreeFormat
1451
format = WorkingTreeFormat.find_format(self)
1452
self._check_supported(format, unsupported,
1094
1454
basedir=self.root_transport.base)
1095
1455
return format.open(self, _found=True)
1097
def _get_config(self):
1098
return config.TransportConfig(self.transport, 'control.conf')
1101
class BzrFormat(object):
1102
"""Base class for all formats of things living in metadirs.
1104
This class manages the format string that is stored in the 'format'
1105
or 'branch-format' file.
1107
All classes for (branch-, repository-, workingtree-) formats that
1108
live in meta directories and have their own 'format' file
1109
(i.e. different from .bzr/branch-format) derive from this class,
1110
as well as the relevant base class for their kind
1111
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1113
Each format is identified by a "format" or "branch-format" file with a
1114
single line containing the base format name and then an optional list of
1117
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1118
will render them inaccessible to older versions of bzr.
1120
:ivar features: Dictionary mapping feature names to their necessity
1123
_present_features = set()
1129
def register_feature(cls, name):
1130
"""Register a feature as being present.
1132
:param name: Name of the feature
1135
raise ValueError("spaces are not allowed in feature names")
1136
if name in cls._present_features:
1137
raise errors.FeatureAlreadyRegistered(name)
1138
cls._present_features.add(name)
1141
def unregister_feature(cls, name):
1142
"""Unregister a feature."""
1143
cls._present_features.remove(name)
1145
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1147
for name, necessity in self.features.iteritems():
1148
if name in self._present_features:
1150
if necessity == "optional":
1151
mutter("ignoring optional missing feature %s", name)
1153
elif necessity == "required":
1154
raise errors.MissingFeature(name)
1156
mutter("treating unknown necessity as require for %s",
1158
raise errors.MissingFeature(name)
1161
def get_format_string(cls):
1162
"""Return the ASCII format string that identifies this format."""
1163
raise NotImplementedError(cls.get_format_string)
1166
def from_string(cls, text):
1167
format_string = cls.get_format_string()
1168
if not text.startswith(format_string):
1169
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1170
lines = text[len(format_string):].splitlines()
1172
for lineno, line in enumerate(lines):
1174
(necessity, feature) = line.split(" ", 1)
1176
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1177
line=line, text=text)
1178
ret.features[feature] = necessity
1181
def as_string(self):
1182
"""Return the string representation of this format.
1184
lines = [self.get_format_string()]
1185
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1186
self.features.iteritems()])
1187
return "".join(lines)
1190
def _find_format(klass, registry, kind, format_string):
1192
first_line = format_string[:format_string.index("\n")+1]
1194
first_line = format_string
1196
cls = registry.get(first_line)
1198
raise errors.UnknownFormatError(format=first_line, kind=kind)
1199
return cls.from_string(format_string)
1201
def network_name(self):
1202
"""A simple byte string uniquely identifying this format for RPC calls.
1204
Metadir branch formats use their format string.
1206
return self.as_string()
1208
def __eq__(self, other):
1209
return (self.__class__ is other.__class__ and
1210
self.features == other.features)
1212
def _update_feature_flags(self, updated_flags):
1213
"""Update the feature flags in this format.
1215
:param updated_flags: Updated feature flags
1217
for name, necessity in updated_flags.iteritems():
1218
if necessity is None:
1220
del self.features[name]
1224
self.features[name] = necessity
1227
class BzrProber(controldir.Prober):
1228
"""Prober for formats that use a .bzr/ control directory."""
1230
formats = registry.FormatRegistry(controldir.network_format_registry)
1231
"""The known .bzr formats."""
1234
def probe_transport(klass, transport):
1235
"""Return the .bzrdir style format present in a directory."""
1237
format_string = transport.get_bytes(".bzr/branch-format")
1238
except errors.NoSuchFile:
1239
raise errors.NotBranchError(path=transport.base)
1241
first_line = format_string[:format_string.index("\n")+1]
1243
first_line = format_string
1245
cls = klass.formats.get(first_line)
1247
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
return cls.from_string(format_string)
1251
def known_formats(cls):
1253
for name, format in cls.formats.iteritems():
1254
if callable(format):
1260
controldir.ControlDirFormat.register_prober(BzrProber)
1263
class RemoteBzrProber(controldir.Prober):
1264
"""Prober for remote servers that provide a Bazaar smart server."""
1267
def probe_transport(klass, transport):
1268
"""Return a RemoteBzrDirFormat object if it looks possible."""
1270
medium = transport.get_smart_medium()
1271
except (NotImplementedError, AttributeError,
1272
errors.TransportNotPossible, errors.NoSmartMedium,
1273
errors.SmartProtocolError):
1274
# no smart server, so not a branch for this format type.
1275
raise errors.NotBranchError(path=transport.base)
1277
# Decline to open it if the server doesn't support our required
1278
# version (3) so that the VFS-based transport will do it.
1279
if medium.should_probe():
1281
server_version = medium.protocol_version()
1282
except errors.SmartProtocolError:
1283
# Apparently there's no usable smart server there, even though
1284
# the medium supports the smart protocol.
1285
raise errors.NotBranchError(path=transport.base)
1286
if server_version != '2':
1287
raise errors.NotBranchError(path=transport.base)
1288
from bzrlib.remote import RemoteBzrDirFormat
1289
return RemoteBzrDirFormat()
1292
def known_formats(cls):
1293
from bzrlib.remote import RemoteBzrDirFormat
1294
return set([RemoteBzrDirFormat()])
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1298
"""ControlDirFormat base class for .bzr/ directories.
1300
Formats are placed in a dict by their format string for reference
1458
class BzrDirFormat(object):
1459
"""An encapsulation of the initialization and open routines for a format.
1461
Formats provide three things:
1462
* An initialization routine,
1466
Formats are placed in a dict by their format string for reference
1301
1467
during bzrdir opening. These should be subclasses of BzrDirFormat
1302
1468
for consistency.
1304
1470
Once a format is deprecated, just deprecate the initialize and open
1305
methods on the format class. Do not deprecate the object, as the
1471
methods on the format class. Do not deprecate the object, as the
1306
1472
object will be created every system load.
1475
_default_format = None
1476
"""The default format used for new .bzr dirs."""
1479
"""The known formats."""
1481
_control_formats = []
1482
"""The registered control formats - .bzr, ....
1484
This is a list of BzrDirFormat objects.
1487
_control_server_formats = []
1488
"""The registered control server formats, e.g. RemoteBzrDirs.
1490
This is a list of BzrDirFormat objects.
1309
1493
_lock_file_name = 'branch-lock'
1311
1495
# _lock_class must be set in subclasses to the lock type, typ.
1312
1496
# TransportLock or LockDir
1499
def find_format(klass, transport, _server_formats=True):
1500
"""Return the format present at transport."""
1502
formats = klass._control_server_formats + klass._control_formats
1504
formats = klass._control_formats
1505
for format in formats:
1507
return format.probe_transport(transport)
1508
except errors.NotBranchError:
1509
# this format does not find a control dir here.
1511
raise errors.NotBranchError(path=transport.base)
1514
def probe_transport(klass, transport):
1515
"""Return the .bzrdir style format present in a directory."""
1517
format_string = transport.get(".bzr/branch-format").read()
1518
except errors.NoSuchFile:
1519
raise errors.NotBranchError(path=transport.base)
1522
return klass._formats[format_string]
1524
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1527
def get_default_format(klass):
1528
"""Return the current default format."""
1529
return klass._default_format
1531
def get_format_string(self):
1532
"""Return the ASCII format string that identifies this format."""
1533
raise NotImplementedError(self.get_format_string)
1535
def get_format_description(self):
1536
"""Return the short description for this format."""
1537
raise NotImplementedError(self.get_format_description)
1539
def get_converter(self, format=None):
1540
"""Return the converter to use to convert bzrdirs needing converts.
1542
This returns a bzrlib.bzrdir.Converter object.
1544
This should return the best upgrader to step this format towards the
1545
current default format. In the case of plugins we can/should provide
1546
some means for them to extend the range of returnable converters.
1548
:param format: Optional format to override the default format of the
1551
raise NotImplementedError(self.get_converter)
1553
def initialize(self, url, possible_transports=None):
1554
"""Create a bzr control dir at this url and return an opened copy.
1556
Subclasses should typically override initialize_on_transport
1557
instead of this method.
1559
return self.initialize_on_transport(get_transport(url,
1560
possible_transports))
1314
1562
def initialize_on_transport(self, transport):
1315
1563
"""Initialize a new bzrdir in the base directory of a Transport."""
1317
# can we hand off the request to the smart server rather than using
1319
client_medium = transport.get_smart_medium()
1320
except errors.NoSmartMedium:
1321
return self._initialize_on_transport_vfs(transport)
1323
# Current RPC's only know how to create bzr metadir1 instances, so
1324
# we still delegate to vfs methods if the requested format is not a
1326
if type(self) != BzrDirMetaFormat1:
1327
return self._initialize_on_transport_vfs(transport)
1328
from bzrlib.remote import RemoteBzrDirFormat
1329
remote_format = RemoteBzrDirFormat()
1330
self._supply_sub_formats_to(remote_format)
1331
return remote_format.initialize_on_transport(transport)
1333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1334
create_prefix=False, force_new_repo=False, stacked_on=None,
1335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1336
shared_repo=False, vfs_only=False):
1337
"""Create this format on transport.
1339
The directory to initialize will be created.
1341
:param force_new_repo: Do not use a shared repository for the target,
1342
even if one is available.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1346
:param stacked_on: A url to stack any created branch on, None to follow
1347
any target stacking policy.
1348
:param stack_on_pwd: If stack_on is relative, the location it is
1350
:param repo_format_name: If non-None, a repository will be
1351
made-or-found. Should none be found, or if force_new_repo is True
1352
the repo_format_name is used to select the format of repository to
1354
:param make_working_trees: Control the setting of make_working_trees
1355
for a new shared repository when one is made. None to use whatever
1356
default the format has.
1357
:param shared_repo: Control whether made repositories are shared or
1359
:param vfs_only: If True do not attempt to use a smart server
1360
:return: repo, controldir, require_stacking, repository_policy. repo is
1361
None if none was created or found, bzrdir is always valid.
1362
require_stacking is the result of examining the stacked_on
1363
parameter and any stacking policy found for the target.
1366
# Try to hand off to a smart server
1368
client_medium = transport.get_smart_medium()
1369
except errors.NoSmartMedium:
1372
from bzrlib.remote import RemoteBzrDirFormat
1373
# TODO: lookup the local format from a server hint.
1374
remote_dir_format = RemoteBzrDirFormat()
1375
remote_dir_format._network_name = self.network_name()
1376
self._supply_sub_formats_to(remote_dir_format)
1377
return remote_dir_format.initialize_on_transport_ex(transport,
1378
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1379
force_new_repo=force_new_repo, stacked_on=stacked_on,
1380
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1381
make_working_trees=make_working_trees, shared_repo=shared_repo)
1382
# XXX: Refactor the create_prefix/no_create_prefix code into a
1383
# common helper function
1384
# The destination may not exist - if so make it according to policy.
1385
def make_directory(transport):
1386
transport.mkdir('.')
1388
def redirected(transport, e, redirection_notice):
1389
note(redirection_notice)
1390
return transport._redirected_to(e.source, e.target)
1392
transport = do_catching_redirections(make_directory, transport,
1394
except errors.FileExists:
1395
if not use_existing_dir:
1397
except errors.NoSuchFile:
1398
if not create_prefix:
1400
transport.create_prefix()
1402
require_stacking = (stacked_on is not None)
1403
# Now the target directory exists, but doesn't have a .bzr
1404
# directory. So we need to create it, along with any work to create
1405
# all of the dependent branches, etc.
1407
result = self.initialize_on_transport(transport)
1408
if repo_format_name:
1410
# use a custom format
1411
result._format.repository_format = \
1412
repository.network_format_registry.get(repo_format_name)
1413
except AttributeError:
1414
# The format didn't permit it to be set.
1416
# A repository is desired, either in-place or shared.
1417
repository_policy = result.determine_repository_policy(
1418
force_new_repo, stacked_on, stack_on_pwd,
1419
require_stacking=require_stacking)
1420
result_repo, is_new_repo = repository_policy.acquire_repository(
1421
make_working_trees, shared_repo)
1422
if not require_stacking and repository_policy._require_stacking:
1423
require_stacking = True
1424
result._format.require_stacking()
1425
result_repo.lock_write()
1428
repository_policy = None
1429
return result_repo, result, require_stacking, repository_policy
1431
def _initialize_on_transport_vfs(self, transport):
1432
"""Initialize a new bzrdir using VFS calls.
1434
:param transport: The transport to create the .bzr directory in.
1437
# Since we are creating a .bzr directory, inherit the
1564
# Since we don't have a .bzr directory, inherit the
1438
1565
# mode from the root directory
1439
1566
temp_control = lockable_files.LockableFiles(transport,
1440
1567
'', lockable_files.TransportLock)
1442
temp_control._transport.mkdir('.bzr',
1443
# FIXME: RBC 20060121 don't peek under
1445
mode=temp_control._dir_mode)
1446
except errors.FileExists:
1447
raise errors.AlreadyControlDirError(transport.base)
1448
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1568
temp_control._transport.mkdir('.bzr',
1569
# FIXME: RBC 20060121 don't peek under
1571
mode=temp_control._dir_mode)
1572
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1449
1573
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1450
1574
file_mode = temp_control._file_mode
1451
1575
del temp_control
1494
1647
raise NotImplementedError(self._open)
1496
def _supply_sub_formats_to(self, other_format):
1497
"""Give other_format the same values for sub formats as this has.
1499
This method is expected to be used when parameterising a
1500
RemoteBzrDirFormat instance with the parameters from a
1501
BzrDirMetaFormat1 instance.
1503
:param other_format: other_format is a format which should be
1504
compatible with whatever sub formats are supported by self.
1507
other_format.features = dict(self.features)
1509
def supports_transport(self, transport):
1510
# bzr formats can be opened over all known transports
1513
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1515
controldir.ControlDirFormat.check_support_status(self,
1516
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1518
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1519
recommend_upgrade=recommend_upgrade, basedir=basedir)
1650
def register_format(klass, format):
1651
klass._formats[format.get_format_string()] = format
1654
def register_control_format(klass, format):
1655
"""Register a format that does not use '.bzr' for its control dir.
1657
TODO: This should be pulled up into a 'ControlDirFormat' base class
1658
which BzrDirFormat can inherit from, and renamed to register_format
1659
there. It has been done without that for now for simplicity of
1662
klass._control_formats.append(format)
1665
def register_control_server_format(klass, format):
1666
"""Register a control format for client-server environments.
1668
These formats will be tried before ones registered with
1669
register_control_format. This gives implementations that decide to the
1670
chance to grab it before anything looks at the contents of the format
1673
klass._control_server_formats.append(format)
1676
def _set_default_format(klass, format):
1677
"""Set default format (for testing behavior of defaults only)"""
1678
klass._default_format = format
1682
return self.get_format_string().rstrip()
1685
def unregister_format(klass, format):
1686
del klass._formats[format.get_format_string()]
1689
def unregister_control_format(klass, format):
1690
klass._control_formats.remove(format)
1693
class BzrDirFormat4(BzrDirFormat):
1694
"""Bzr dir format 4.
1696
This format is a combined format for working tree, branch and repository.
1698
- Format 1 working trees [always]
1699
- Format 4 branches [always]
1700
- Format 4 repositories [always]
1702
This format is deprecated: it indexes texts using a text it which is
1703
removed in format 5; write support for this format has been removed.
1706
_lock_class = lockable_files.TransportLock
1708
def get_format_string(self):
1709
"""See BzrDirFormat.get_format_string()."""
1710
return "Bazaar-NG branch, format 0.0.4\n"
1712
def get_format_description(self):
1713
"""See BzrDirFormat.get_format_description()."""
1714
return "All-in-one format 4"
1716
def get_converter(self, format=None):
1717
"""See BzrDirFormat.get_converter()."""
1718
# there is one and only one upgrade path here.
1719
return ConvertBzrDir4To5()
1721
def initialize_on_transport(self, transport):
1722
"""Format 4 branches cannot be created."""
1723
raise errors.UninitializableFormat(self)
1725
def is_supported(self):
1726
"""Format 4 is not supported.
1728
It is not supported because the model changed from 4 to 5 and the
1729
conversion logic is expensive - so doing it on the fly was not
1734
def _open(self, transport):
1735
"""See BzrDirFormat._open."""
1736
return BzrDir4(transport, self)
1738
def __return_repository_format(self):
1739
"""Circular import protection."""
1740
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1741
return RepositoryFormat4()
1742
repository_format = property(__return_repository_format)
1745
class BzrDirFormat5(BzrDirFormat):
1746
"""Bzr control format 5.
1748
This format is a combined format for working tree, branch and repository.
1750
- Format 2 working trees [always]
1751
- Format 4 branches [always]
1752
- Format 5 repositories [always]
1753
Unhashed stores in the repository.
1756
_lock_class = lockable_files.TransportLock
1758
def get_format_string(self):
1759
"""See BzrDirFormat.get_format_string()."""
1760
return "Bazaar-NG branch, format 5\n"
1762
def get_format_description(self):
1763
"""See BzrDirFormat.get_format_description()."""
1764
return "All-in-one format 5"
1766
def get_converter(self, format=None):
1767
"""See BzrDirFormat.get_converter()."""
1768
# there is one and only one upgrade path here.
1769
return ConvertBzrDir5To6()
1771
def _initialize_for_clone(self, url):
1772
return self.initialize_on_transport(get_transport(url), _cloning=True)
1774
def initialize_on_transport(self, transport, _cloning=False):
1775
"""Format 5 dirs always have working tree, branch and repository.
1777
Except when they are being cloned.
1779
from bzrlib.branch import BzrBranchFormat4
1780
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1781
from bzrlib.workingtree import WorkingTreeFormat2
1782
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1783
RepositoryFormat5().initialize(result, _internal=True)
1785
branch = BzrBranchFormat4().initialize(result)
1787
WorkingTreeFormat2().initialize(result)
1788
except errors.NotLocalUrl:
1789
# Even though we can't access the working tree, we need to
1790
# create its control files.
1791
WorkingTreeFormat2()._stub_initialize_remote(branch)
1794
def _open(self, transport):
1795
"""See BzrDirFormat._open."""
1796
return BzrDir5(transport, self)
1798
def __return_repository_format(self):
1799
"""Circular import protection."""
1800
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1801
return RepositoryFormat5()
1802
repository_format = property(__return_repository_format)
1805
class BzrDirFormat6(BzrDirFormat):
1806
"""Bzr control format 6.
1808
This format is a combined format for working tree, branch and repository.
1810
- Format 2 working trees [always]
1811
- Format 4 branches [always]
1812
- Format 6 repositories [always]
1815
_lock_class = lockable_files.TransportLock
1817
def get_format_string(self):
1818
"""See BzrDirFormat.get_format_string()."""
1819
return "Bazaar-NG branch, format 6\n"
1821
def get_format_description(self):
1822
"""See BzrDirFormat.get_format_description()."""
1823
return "All-in-one format 6"
1825
def get_converter(self, format=None):
1826
"""See BzrDirFormat.get_converter()."""
1827
# there is one and only one upgrade path here.
1828
return ConvertBzrDir6ToMeta()
1830
def _initialize_for_clone(self, url):
1831
return self.initialize_on_transport(get_transport(url), _cloning=True)
1833
def initialize_on_transport(self, transport, _cloning=False):
1834
"""Format 6 dirs always have working tree, branch and repository.
1836
Except when they are being cloned.
1838
from bzrlib.branch import BzrBranchFormat4
1839
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1840
from bzrlib.workingtree import WorkingTreeFormat2
1841
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1842
RepositoryFormat6().initialize(result, _internal=True)
1844
branch = BzrBranchFormat4().initialize(result)
1846
WorkingTreeFormat2().initialize(result)
1847
except errors.NotLocalUrl:
1848
# Even though we can't access the working tree, we need to
1849
# create its control files.
1850
WorkingTreeFormat2()._stub_initialize_remote(branch)
1853
def _open(self, transport):
1854
"""See BzrDirFormat._open."""
1855
return BzrDir6(transport, self)
1857
def __return_repository_format(self):
1858
"""Circular import protection."""
1859
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1860
return RepositoryFormat6()
1861
repository_format = property(__return_repository_format)
1522
1864
class BzrDirMetaFormat1(BzrDirFormat):
1561
1893
def get_branch_format(self):
1562
1894
if self._branch_format is None:
1563
from bzrlib.branch import format_registry as branch_format_registry
1564
self._branch_format = branch_format_registry.get_default()
1895
from bzrlib.branch import BranchFormat
1896
self._branch_format = BranchFormat.get_default_format()
1565
1897
return self._branch_format
1567
1899
def set_branch_format(self, format):
1568
1900
self._branch_format = format
1570
def require_stacking(self, stack_on=None, possible_transports=None,
1572
"""We have a request to stack, try to ensure the formats support it.
1574
:param stack_on: If supplied, it is the URL to a branch that we want to
1575
stack on. Check to see if that format supports stacking before
1578
# Stacking is desired. requested by the target, but does the place it
1579
# points at support stacking? If it doesn't then we should
1580
# not implicitly upgrade. We check this here.
1581
new_repo_format = None
1582
new_branch_format = None
1584
# a bit of state for get_target_branch so that we don't try to open it
1585
# 2 times, for both repo *and* branch
1586
target = [None, False, None] # target_branch, checked, upgrade anyway
1587
def get_target_branch():
1589
# We've checked, don't check again
1591
if stack_on is None:
1592
# No target format, that means we want to force upgrading
1593
target[:] = [None, True, True]
1596
target_dir = BzrDir.open(stack_on,
1597
possible_transports=possible_transports)
1598
except errors.NotBranchError:
1599
# Nothing there, don't change formats
1600
target[:] = [None, True, False]
1602
except errors.JailBreak:
1603
# JailBreak, JFDI and upgrade anyway
1604
target[:] = [None, True, True]
1607
target_branch = target_dir.open_branch()
1608
except errors.NotBranchError:
1609
# No branch, don't upgrade formats
1610
target[:] = [None, True, False]
1612
target[:] = [target_branch, True, False]
1615
if (not _skip_repo and
1616
not self.repository_format.supports_external_lookups):
1617
# We need to upgrade the Repository.
1618
target_branch, _, do_upgrade = get_target_branch()
1619
if target_branch is None:
1620
# We don't have a target branch, should we upgrade anyway?
1622
# stack_on is inaccessible, JFDI.
1623
# TODO: bad monkey, hard-coded formats...
1624
if self.repository_format.rich_root_data:
1625
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
1627
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
1629
# If the target already supports stacking, then we know the
1630
# project is already able to use stacking, so auto-upgrade
1632
new_repo_format = target_branch.repository._format
1633
if not new_repo_format.supports_external_lookups:
1634
# target doesn't, source doesn't, so don't auto upgrade
1636
new_repo_format = None
1637
if new_repo_format is not None:
1638
self.repository_format = new_repo_format
1639
note(gettext('Source repository format does not support stacking,'
1640
' using format:\n %s'),
1641
new_repo_format.get_format_description())
1643
if not self.get_branch_format().supports_stacking():
1644
# We just checked the repo, now lets check if we need to
1645
# upgrade the branch format
1646
target_branch, _, do_upgrade = get_target_branch()
1647
if target_branch is None:
1649
# TODO: bad monkey, hard-coded formats...
1650
from bzrlib.branch import BzrBranchFormat7
1651
new_branch_format = BzrBranchFormat7()
1653
new_branch_format = target_branch._format
1654
if not new_branch_format.supports_stacking():
1655
new_branch_format = None
1656
if new_branch_format is not None:
1657
# Does support stacking, use its format.
1658
self.set_branch_format(new_branch_format)
1659
note(gettext('Source branch format does not support stacking,'
1660
' using format:\n %s'),
1661
new_branch_format.get_format_description())
1663
1902
def get_converter(self, format=None):
1664
1903
"""See BzrDirFormat.get_converter()."""
1665
1904
if format is None:
1666
1905
format = BzrDirFormat.get_default_format()
1667
if (type(self) is BzrDirMetaFormat1 and
1668
type(format) is BzrDirMetaFormat1Colo):
1669
return ConvertMetaToColo(format)
1670
if (type(self) is BzrDirMetaFormat1Colo and
1671
type(format) is BzrDirMetaFormat1):
1672
return ConvertMetaToColo(format)
1673
1906
if not isinstance(self, format.__class__):
1674
1907
# converting away from metadir is not implemented
1675
1908
raise NotImplementedError(self.get_converter)
1676
1909
return ConvertMetaToMeta(format)
1679
def get_format_string(cls):
1911
def get_format_string(self):
1680
1912
"""See BzrDirFormat.get_format_string()."""
1681
1913
return "Bazaar-NG meta directory, format 1\n"
1687
1919
def _open(self, transport):
1688
1920
"""See BzrDirFormat._open."""
1689
# Create a new format instance because otherwise initialisation of new
1690
# metadirs share the global default format object leading to alias
1692
format = BzrDirMetaFormat1()
1693
self._supply_sub_formats_to(format)
1694
return BzrDirMeta1(transport, format)
1921
return BzrDirMeta1(transport, self)
1696
1923
def __return_repository_format(self):
1697
1924
"""Circular import protection."""
1698
if self._repository_format:
1925
if getattr(self, '_repository_format', None):
1699
1926
return self._repository_format
1700
from bzrlib.repository import format_registry
1701
return format_registry.get_default()
1927
from bzrlib.repository import RepositoryFormat
1928
return RepositoryFormat.get_default_format()
1703
def _set_repository_format(self, value):
1930
def __set_repository_format(self, value):
1704
1931
"""Allow changing the repository format for metadir formats."""
1705
1932
self._repository_format = value
1707
repository_format = property(__return_repository_format,
1708
_set_repository_format)
1710
def _supply_sub_formats_to(self, other_format):
1711
"""Give other_format the same values for sub formats as this has.
1713
This method is expected to be used when parameterising a
1714
RemoteBzrDirFormat instance with the parameters from a
1715
BzrDirMetaFormat1 instance.
1717
:param other_format: other_format is a format which should be
1718
compatible with whatever sub formats are supported by self.
1721
super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1722
if getattr(self, '_repository_format', None) is not None:
1723
other_format.repository_format = self.repository_format
1724
if self._branch_format is not None:
1725
other_format._branch_format = self._branch_format
1726
if self._workingtree_format is not None:
1727
other_format.workingtree_format = self.workingtree_format
1934
repository_format = property(__return_repository_format, __set_repository_format)
1729
1936
def __get_workingtree_format(self):
1730
1937
if self._workingtree_format is None:
1731
from bzrlib.workingtree import (
1732
format_registry as wt_format_registry,
1734
self._workingtree_format = wt_format_registry.get_default()
1938
from bzrlib.workingtree import WorkingTreeFormat
1939
self._workingtree_format = WorkingTreeFormat.get_default_format()
1735
1940
return self._workingtree_format
1737
1942
def __set_workingtree_format(self, wt_format):
1738
1943
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
1743
1945
workingtree_format = property(__get_workingtree_format,
1744
1946
__set_workingtree_format)
1949
# Register bzr control format
1950
BzrDirFormat.register_control_format(BzrDirFormat)
1747
1952
# Register bzr formats
1748
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1754
"""BzrDirMeta1 format with support for colocated branches."""
1756
colocated_branches = True
1759
def get_format_string(cls):
1760
"""See BzrDirFormat.get_format_string()."""
1761
return "Bazaar meta directory, format 1 (with colocated branches)\n"
1763
def get_format_description(self):
1764
"""See BzrDirFormat.get_format_description()."""
1765
return "Meta directory format 1 with support for colocated branches"
1767
def _open(self, transport):
1768
"""See BzrDirFormat._open."""
1769
# Create a new format instance because otherwise initialisation of new
1770
# metadirs share the global default format object leading to alias
1772
format = BzrDirMetaFormat1Colo()
1773
self._supply_sub_formats_to(format)
1774
return BzrDirMeta1(transport, format)
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1778
BzrDirMetaFormat1Colo)
1781
class ConvertMetaToMeta(controldir.Converter):
1953
BzrDirFormat.register_format(BzrDirFormat4())
1954
BzrDirFormat.register_format(BzrDirFormat5())
1955
BzrDirFormat.register_format(BzrDirFormat6())
1956
__default_format = BzrDirMetaFormat1()
1957
BzrDirFormat.register_format(__default_format)
1958
BzrDirFormat._default_format = __default_format
1961
class Converter(object):
1962
"""Converts a disk format object from one format to another."""
1964
def convert(self, to_convert, pb):
1965
"""Perform the conversion of to_convert, giving feedback via pb.
1967
:param to_convert: The disk object to convert.
1968
:param pb: a progress bar to use for progress information.
1971
def step(self, message):
1972
"""Update the pb by a step."""
1974
self.pb.update(message, self.count, self.total)
1977
class ConvertBzrDir4To5(Converter):
1978
"""Converts format 4 bzr dirs to format 5."""
1981
super(ConvertBzrDir4To5, self).__init__()
1982
self.converted_revs = set()
1983
self.absent_revisions = set()
1987
def convert(self, to_convert, pb):
1988
"""See Converter.convert()."""
1989
self.bzrdir = to_convert
1991
self.pb.note('starting upgrade from format 4 to 5')
1992
if isinstance(self.bzrdir.transport, LocalTransport):
1993
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1994
self._convert_to_weaves()
1995
return BzrDir.open(self.bzrdir.root_transport.base)
1997
def _convert_to_weaves(self):
1998
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2001
stat = self.bzrdir.transport.stat('weaves')
2002
if not S_ISDIR(stat.st_mode):
2003
self.bzrdir.transport.delete('weaves')
2004
self.bzrdir.transport.mkdir('weaves')
2005
except errors.NoSuchFile:
2006
self.bzrdir.transport.mkdir('weaves')
2007
# deliberately not a WeaveFile as we want to build it up slowly.
2008
self.inv_weave = Weave('inventory')
2009
# holds in-memory weaves for all files
2010
self.text_weaves = {}
2011
self.bzrdir.transport.delete('branch-format')
2012
self.branch = self.bzrdir.open_branch()
2013
self._convert_working_inv()
2014
rev_history = self.branch.revision_history()
2015
# to_read is a stack holding the revisions we still need to process;
2016
# appending to it adds new highest-priority revisions
2017
self.known_revisions = set(rev_history)
2018
self.to_read = rev_history[-1:]
2020
rev_id = self.to_read.pop()
2021
if (rev_id not in self.revisions
2022
and rev_id not in self.absent_revisions):
2023
self._load_one_rev(rev_id)
2025
to_import = self._make_order()
2026
for i, rev_id in enumerate(to_import):
2027
self.pb.update('converting revision', i, len(to_import))
2028
self._convert_one_rev(rev_id)
2030
self._write_all_weaves()
2031
self._write_all_revs()
2032
self.pb.note('upgraded to weaves:')
2033
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2034
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2035
self.pb.note(' %6d texts', self.text_count)
2036
self._cleanup_spare_files_after_format4()
2037
self.branch._transport.put_bytes(
2039
BzrDirFormat5().get_format_string(),
2040
mode=self.bzrdir._get_file_mode())
2042
def _cleanup_spare_files_after_format4(self):
2043
# FIXME working tree upgrade foo.
2044
for n in 'merged-patches', 'pending-merged-patches':
2046
## assert os.path.getsize(p) == 0
2047
self.bzrdir.transport.delete(n)
2048
except errors.NoSuchFile:
2050
self.bzrdir.transport.delete_tree('inventory-store')
2051
self.bzrdir.transport.delete_tree('text-store')
2053
def _convert_working_inv(self):
2054
inv = xml4.serializer_v4.read_inventory(
2055
self.branch._transport.get('inventory'))
2056
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2057
self.branch._transport.put_bytes('inventory', new_inv_xml,
2058
mode=self.bzrdir._get_file_mode())
2060
def _write_all_weaves(self):
2061
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2062
weave_transport = self.bzrdir.transport.clone('weaves')
2063
weaves = WeaveStore(weave_transport, prefixed=False)
2064
transaction = WriteTransaction()
2068
for file_id, file_weave in self.text_weaves.items():
2069
self.pb.update('writing weave', i, len(self.text_weaves))
2070
weaves._put_weave(file_id, file_weave, transaction)
2072
self.pb.update('inventory', 0, 1)
2073
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2074
self.pb.update('inventory', 1, 1)
2078
def _write_all_revs(self):
2079
"""Write all revisions out in new form."""
2080
self.bzrdir.transport.delete_tree('revision-store')
2081
self.bzrdir.transport.mkdir('revision-store')
2082
revision_transport = self.bzrdir.transport.clone('revision-store')
2084
from bzrlib.xml5 import serializer_v5
2085
from bzrlib.repofmt.weaverepo import RevisionTextStore
2086
revision_store = RevisionTextStore(revision_transport,
2087
serializer_v5, False, versionedfile.PrefixMapper(),
2088
lambda:True, lambda:True)
2090
for i, rev_id in enumerate(self.converted_revs):
2091
self.pb.update('write revision', i, len(self.converted_revs))
2092
text = serializer_v5.write_revision_to_string(
2093
self.revisions[rev_id])
2095
revision_store.add_lines(key, None, osutils.split_lines(text))
2099
def _load_one_rev(self, rev_id):
2100
"""Load a revision object into memory.
2102
Any parents not either loaded or abandoned get queued to be
2104
self.pb.update('loading revision',
2105
len(self.revisions),
2106
len(self.known_revisions))
2107
if not self.branch.repository.has_revision(rev_id):
2109
self.pb.note('revision {%s} not present in branch; '
2110
'will be converted as a ghost',
2112
self.absent_revisions.add(rev_id)
2114
rev = self.branch.repository.get_revision(rev_id)
2115
for parent_id in rev.parent_ids:
2116
self.known_revisions.add(parent_id)
2117
self.to_read.append(parent_id)
2118
self.revisions[rev_id] = rev
2120
def _load_old_inventory(self, rev_id):
2121
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2122
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2123
inv.revision_id = rev_id
2124
rev = self.revisions[rev_id]
2127
def _load_updated_inventory(self, rev_id):
2128
inv_xml = self.inv_weave.get_text(rev_id)
2129
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2132
def _convert_one_rev(self, rev_id):
2133
"""Convert revision and all referenced objects to new format."""
2134
rev = self.revisions[rev_id]
2135
inv = self._load_old_inventory(rev_id)
2136
present_parents = [p for p in rev.parent_ids
2137
if p not in self.absent_revisions]
2138
self._convert_revision_contents(rev, inv, present_parents)
2139
self._store_new_inv(rev, inv, present_parents)
2140
self.converted_revs.add(rev_id)
2142
def _store_new_inv(self, rev, inv, present_parents):
2143
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2144
new_inv_sha1 = sha_string(new_inv_xml)
2145
self.inv_weave.add_lines(rev.revision_id,
2147
new_inv_xml.splitlines(True))
2148
rev.inventory_sha1 = new_inv_sha1
2150
def _convert_revision_contents(self, rev, inv, present_parents):
2151
"""Convert all the files within a revision.
2153
Also upgrade the inventory to refer to the text revision ids."""
2154
rev_id = rev.revision_id
2155
mutter('converting texts of revision {%s}',
2157
parent_invs = map(self._load_updated_inventory, present_parents)
2158
entries = inv.iter_entries()
2160
for path, ie in entries:
2161
self._convert_file_version(rev, ie, parent_invs)
2163
def _convert_file_version(self, rev, ie, parent_invs):
2164
"""Convert one version of one file.
2166
The file needs to be added into the weave if it is a merge
2167
of >=2 parents or if it's changed from its parent.
2169
file_id = ie.file_id
2170
rev_id = rev.revision_id
2171
w = self.text_weaves.get(file_id)
2174
self.text_weaves[file_id] = w
2175
text_changed = False
2176
parent_candiate_entries = ie.parent_candidates(parent_invs)
2177
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2178
# XXX: Note that this is unordered - and this is tolerable because
2179
# the previous code was also unordered.
2180
previous_entries = dict((head, parent_candiate_entries[head]) for head
2182
self.snapshot_ie(previous_entries, ie, w, rev_id)
2185
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2186
def get_parents(self, revision_ids):
2187
for revision_id in revision_ids:
2188
yield self.revisions[revision_id].parent_ids
2190
def get_parent_map(self, revision_ids):
2191
"""See graph._StackedParentsProvider.get_parent_map"""
2192
return dict((revision_id, self.revisions[revision_id])
2193
for revision_id in revision_ids
2194
if revision_id in self.revisions)
2196
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2197
# TODO: convert this logic, which is ~= snapshot to
2198
# a call to:. This needs the path figured out. rather than a work_tree
2199
# a v4 revision_tree can be given, or something that looks enough like
2200
# one to give the file content to the entry if it needs it.
2201
# and we need something that looks like a weave store for snapshot to
2203
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2204
if len(previous_revisions) == 1:
2205
previous_ie = previous_revisions.values()[0]
2206
if ie._unchanged(previous_ie):
2207
ie.revision = previous_ie.revision
2210
text = self.branch.repository._text_store.get(ie.text_id)
2211
file_lines = text.readlines()
2212
w.add_lines(rev_id, previous_revisions, file_lines)
2213
self.text_count += 1
2215
w.add_lines(rev_id, previous_revisions, [])
2216
ie.revision = rev_id
2218
def _make_order(self):
2219
"""Return a suitable order for importing revisions.
2221
The order must be such that an revision is imported after all
2222
its (present) parents.
2224
todo = set(self.revisions.keys())
2225
done = self.absent_revisions.copy()
2228
# scan through looking for a revision whose parents
2230
for rev_id in sorted(list(todo)):
2231
rev = self.revisions[rev_id]
2232
parent_ids = set(rev.parent_ids)
2233
if parent_ids.issubset(done):
2234
# can take this one now
2235
order.append(rev_id)
2241
class ConvertBzrDir5To6(Converter):
2242
"""Converts format 5 bzr dirs to format 6."""
2244
def convert(self, to_convert, pb):
2245
"""See Converter.convert()."""
2246
self.bzrdir = to_convert
2248
self.pb.note('starting upgrade from format 5 to 6')
2249
self._convert_to_prefixed()
2250
return BzrDir.open(self.bzrdir.root_transport.base)
2252
def _convert_to_prefixed(self):
2253
from bzrlib.store import TransportStore
2254
self.bzrdir.transport.delete('branch-format')
2255
for store_name in ["weaves", "revision-store"]:
2256
self.pb.note("adding prefixes to %s" % store_name)
2257
store_transport = self.bzrdir.transport.clone(store_name)
2258
store = TransportStore(store_transport, prefixed=True)
2259
for urlfilename in store_transport.list_dir('.'):
2260
filename = urlutils.unescape(urlfilename)
2261
if (filename.endswith(".weave") or
2262
filename.endswith(".gz") or
2263
filename.endswith(".sig")):
2264
file_id, suffix = os.path.splitext(filename)
2268
new_name = store._mapper.map((file_id,)) + suffix
2269
# FIXME keep track of the dirs made RBC 20060121
2271
store_transport.move(filename, new_name)
2272
except errors.NoSuchFile: # catches missing dirs strangely enough
2273
store_transport.mkdir(osutils.dirname(new_name))
2274
store_transport.move(filename, new_name)
2275
self.bzrdir.transport.put_bytes(
2277
BzrDirFormat6().get_format_string(),
2278
mode=self.bzrdir._get_file_mode())
2281
class ConvertBzrDir6ToMeta(Converter):
2282
"""Converts format 6 bzr dirs to metadirs."""
2284
def convert(self, to_convert, pb):
2285
"""See Converter.convert()."""
2286
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2287
from bzrlib.branch import BzrBranchFormat5
2288
self.bzrdir = to_convert
2291
self.total = 20 # the steps we know about
2292
self.garbage_inventories = []
2293
self.dir_mode = self.bzrdir._get_dir_mode()
2294
self.file_mode = self.bzrdir._get_file_mode()
2296
self.pb.note('starting upgrade from format 6 to metadir')
2297
self.bzrdir.transport.put_bytes(
2299
"Converting to format 6",
2300
mode=self.file_mode)
2301
# its faster to move specific files around than to open and use the apis...
2302
# first off, nuke ancestry.weave, it was never used.
2304
self.step('Removing ancestry.weave')
2305
self.bzrdir.transport.delete('ancestry.weave')
2306
except errors.NoSuchFile:
2308
# find out whats there
2309
self.step('Finding branch files')
2310
last_revision = self.bzrdir.open_branch().last_revision()
2311
bzrcontents = self.bzrdir.transport.list_dir('.')
2312
for name in bzrcontents:
2313
if name.startswith('basis-inventory.'):
2314
self.garbage_inventories.append(name)
2315
# create new directories for repository, working tree and branch
2316
repository_names = [('inventory.weave', True),
2317
('revision-store', True),
2319
self.step('Upgrading repository ')
2320
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2321
self.make_lock('repository')
2322
# we hard code the formats here because we are converting into
2323
# the meta format. The meta format upgrader can take this to a
2324
# future format within each component.
2325
self.put_format('repository', RepositoryFormat7())
2326
for entry in repository_names:
2327
self.move_entry('repository', entry)
2329
self.step('Upgrading branch ')
2330
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2331
self.make_lock('branch')
2332
self.put_format('branch', BzrBranchFormat5())
2333
branch_files = [('revision-history', True),
2334
('branch-name', True),
2336
for entry in branch_files:
2337
self.move_entry('branch', entry)
2339
checkout_files = [('pending-merges', True),
2340
('inventory', True),
2341
('stat-cache', False)]
2342
# If a mandatory checkout file is not present, the branch does not have
2343
# a functional checkout. Do not create a checkout in the converted
2345
for name, mandatory in checkout_files:
2346
if mandatory and name not in bzrcontents:
2347
has_checkout = False
2351
if not has_checkout:
2352
self.pb.note('No working tree.')
2353
# If some checkout files are there, we may as well get rid of them.
2354
for name, mandatory in checkout_files:
2355
if name in bzrcontents:
2356
self.bzrdir.transport.delete(name)
2358
from bzrlib.workingtree import WorkingTreeFormat3
2359
self.step('Upgrading working tree')
2360
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2361
self.make_lock('checkout')
2363
'checkout', WorkingTreeFormat3())
2364
self.bzrdir.transport.delete_multi(
2365
self.garbage_inventories, self.pb)
2366
for entry in checkout_files:
2367
self.move_entry('checkout', entry)
2368
if last_revision is not None:
2369
self.bzrdir.transport.put_bytes(
2370
'checkout/last-revision', last_revision)
2371
self.bzrdir.transport.put_bytes(
2373
BzrDirMetaFormat1().get_format_string(),
2374
mode=self.file_mode)
2375
return BzrDir.open(self.bzrdir.root_transport.base)
2377
def make_lock(self, name):
2378
"""Make a lock for the new control dir name."""
2379
self.step('Make %s lock' % name)
2380
ld = lockdir.LockDir(self.bzrdir.transport,
2382
file_modebits=self.file_mode,
2383
dir_modebits=self.dir_mode)
2386
def move_entry(self, new_dir, entry):
2387
"""Move then entry name into new_dir."""
2389
mandatory = entry[1]
2390
self.step('Moving %s' % name)
2392
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2393
except errors.NoSuchFile:
2397
def put_format(self, dirname, format):
2398
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2399
format.get_format_string(),
2403
class ConvertMetaToMeta(Converter):
1782
2404
"""Converts the components of metadirs."""
1784
2406
def __init__(self, target_format):
1838
2449
# TODO: conversions of Branch and Tree should be done by
1839
2450
# InterXFormat lookups
1840
if (isinstance(tree, workingtree_3.WorkingTree3) and
1841
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2451
if (isinstance(tree, workingtree.WorkingTree3) and
2452
not isinstance(tree, workingtree_4.WorkingTree4) and
1842
2453
isinstance(self.target_format.workingtree_format,
1843
workingtree_4.DirStateWorkingTreeFormat)):
2454
workingtree_4.WorkingTreeFormat4)):
1844
2455
workingtree_4.Converter3to4().convert(tree)
1845
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1846
not isinstance(tree, workingtree_4.WorkingTree5) and
1847
isinstance(self.target_format.workingtree_format,
1848
workingtree_4.WorkingTreeFormat5)):
1849
workingtree_4.Converter4to5().convert(tree)
1850
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1851
not isinstance(tree, workingtree_4.WorkingTree6) and
1852
isinstance(self.target_format.workingtree_format,
1853
workingtree_4.WorkingTreeFormat6)):
1854
workingtree_4.Converter4or5to6().convert(tree)
1856
2456
return to_convert
1859
class ConvertMetaToColo(controldir.Converter):
1860
"""Add colocated branch support."""
1862
def __init__(self, target_format):
1863
"""Create a converter.that upgrades a metadir to the colo format.
1865
:param target_format: The final metadir format that is desired.
1867
self.target_format = target_format
1869
def convert(self, to_convert, pb):
1870
"""See Converter.convert()."""
1871
to_convert.transport.put_bytes('branch-format',
1872
self.target_format.as_string())
1873
return BzrDir.open_from_transport(to_convert.root_transport)
1876
class ConvertMetaToColo(controldir.Converter):
1877
"""Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1879
def __init__(self, target_format):
1880
"""Create a converter that converts a 'development-colo' metadir
1883
:param target_format: The final metadir format that is desired.
1885
self.target_format = target_format
1887
def convert(self, to_convert, pb):
1888
"""See Converter.convert()."""
1889
to_convert.transport.put_bytes('branch-format',
1890
self.target_format.as_string())
1891
return BzrDir.open_from_transport(to_convert.root_transport)
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
2459
# This is not in remote.py because it's small, and needs to be registered.
2460
# Putting it in remote.py creates a circular import problem.
2461
# we can make it a lazy object if the control formats is turned into something
2463
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2464
"""Format representing bzrdirs accessed via a smart server"""
2466
def get_format_description(self):
2467
return 'bzr remote bzrdir'
2470
def probe_transport(klass, transport):
2471
"""Return a RemoteBzrDirFormat object if it looks possible."""
2473
medium = transport.get_smart_medium()
2474
except (NotImplementedError, AttributeError,
2475
errors.TransportNotPossible, errors.NoSmartMedium,
2476
errors.SmartProtocolError):
2477
# no smart server, so not a branch for this format type.
2478
raise errors.NotBranchError(path=transport.base)
2480
# Decline to open it if the server doesn't support our required
2481
# version (3) so that the VFS-based transport will do it.
2482
if medium.should_probe():
2484
server_version = medium.protocol_version()
2485
except errors.SmartProtocolError:
2486
# Apparently there's no usable smart server there, even though
2487
# the medium supports the smart protocol.
2488
raise errors.NotBranchError(path=transport.base)
2489
if server_version != '2':
2490
raise errors.NotBranchError(path=transport.base)
2493
def initialize_on_transport(self, transport):
2495
# hand off the request to the smart server
2496
client_medium = transport.get_smart_medium()
2497
except errors.NoSmartMedium:
2498
# TODO: lookup the local format from a server hint.
2499
local_dir_format = BzrDirMetaFormat1()
2500
return local_dir_format.initialize_on_transport(transport)
2501
client = _SmartClient(client_medium)
2502
path = client.remote_path_from_transport(transport)
2503
response = client.call('BzrDirFormat.initialize', path)
2504
if response[0] != 'ok':
2505
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2506
return remote.RemoteBzrDir(transport)
2508
def _open(self, transport):
2509
return remote.RemoteBzrDir(transport)
2511
def __eq__(self, other):
2512
if not isinstance(other, RemoteBzrDirFormat):
2514
return self.get_format_description() == other.get_format_description()
2517
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2520
class BzrDirFormatInfo(object):
2522
def __init__(self, native, deprecated, hidden, experimental):
2523
self.deprecated = deprecated
2524
self.native = native
2525
self.hidden = hidden
2526
self.experimental = experimental
2529
class BzrDirFormatRegistry(registry.Registry):
2530
"""Registry of user-selectable BzrDir subformats.
2532
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2533
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2537
"""Create a BzrDirFormatRegistry."""
2538
self._aliases = set()
2539
super(BzrDirFormatRegistry, self).__init__()
2542
"""Return a set of the format names which are aliases."""
2543
return frozenset(self._aliases)
2545
def register_metadir(self, key,
2546
repository_format, help, native=True, deprecated=False,
2552
"""Register a metadir subformat.
2554
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2555
by the Repository format.
2557
:param repository_format: The fully-qualified repository format class
2559
:param branch_format: Fully-qualified branch format class name as
2561
:param tree_format: Fully-qualified tree format class name as
2564
# This should be expanded to support setting WorkingTree and Branch
2565
# formats, once BzrDirMetaFormat1 supports that.
2566
def _load(full_name):
2567
mod_name, factory_name = full_name.rsplit('.', 1)
2569
mod = __import__(mod_name, globals(), locals(),
2571
except ImportError, e:
2572
raise ImportError('failed to load %s: %s' % (full_name, e))
2574
factory = getattr(mod, factory_name)
2575
except AttributeError:
2576
raise AttributeError('no factory %s in module %r'
2581
bd = BzrDirMetaFormat1()
2582
if branch_format is not None:
2583
bd.set_branch_format(_load(branch_format))
2584
if tree_format is not None:
2585
bd.workingtree_format = _load(tree_format)
2586
if repository_format is not None:
2587
bd.repository_format = _load(repository_format)
2589
self.register(key, helper, help, native, deprecated, hidden,
2590
experimental, alias)
2592
def register(self, key, factory, help, native=True, deprecated=False,
2593
hidden=False, experimental=False, alias=False):
2594
"""Register a BzrDirFormat factory.
2596
The factory must be a callable that takes one parameter: the key.
2597
It must produce an instance of the BzrDirFormat when called.
2599
This function mainly exists to prevent the info object from being
2602
registry.Registry.register(self, key, factory, help,
2603
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2605
self._aliases.add(key)
2607
def register_lazy(self, key, module_name, member_name, help, native=True,
2608
deprecated=False, hidden=False, experimental=False, alias=False):
2609
registry.Registry.register_lazy(self, key, module_name, member_name,
2610
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2612
self._aliases.add(key)
2614
def set_default(self, key):
2615
"""Set the 'default' key to be a clone of the supplied key.
2617
This method must be called once and only once.
2619
registry.Registry.register(self, 'default', self.get(key),
2620
self.get_help(key), info=self.get_info(key))
2621
self._aliases.add('default')
2623
def set_default_repository(self, key):
2624
"""Set the FormatRegistry default and Repository default.
2626
This is a transitional method while Repository.set_default_format
2629
if 'default' in self:
2630
self.remove('default')
2631
self.set_default(key)
2632
format = self.get('default')()
2634
def make_bzrdir(self, key):
2635
return self.get(key)()
2637
def help_topic(self, topic):
2638
output = textwrap.dedent("""\
2639
These formats can be used for creating branches, working trees, and
2643
default_realkey = None
2644
default_help = self.get_help('default')
2646
for key in self.keys():
2647
if key == 'default':
2649
help = self.get_help(key)
2650
if help == default_help:
2651
default_realkey = key
2653
help_pairs.append((key, help))
2655
def wrapped(key, help, info):
2657
help = '(native) ' + help
2658
return ':%s:\n%s\n\n' % (key,
2659
textwrap.fill(help, initial_indent=' ',
2660
subsequent_indent=' '))
2661
if default_realkey is not None:
2662
output += wrapped(default_realkey, '(default) %s' % default_help,
2663
self.get_info('default'))
2664
deprecated_pairs = []
2665
experimental_pairs = []
2666
for key, help in help_pairs:
2667
info = self.get_info(key)
2670
elif info.deprecated:
2671
deprecated_pairs.append((key, help))
2672
elif info.experimental:
2673
experimental_pairs.append((key, help))
2675
output += wrapped(key, help, info)
2676
if len(experimental_pairs) > 0:
2677
output += "Experimental formats are shown below.\n\n"
2678
for key, help in experimental_pairs:
2679
info = self.get_info(key)
2680
output += wrapped(key, help, info)
2681
if len(deprecated_pairs) > 0:
2682
output += "Deprecated formats are shown below.\n\n"
2683
for key, help in deprecated_pairs:
2684
info = self.get_info(key)
2685
output += wrapped(key, help, info)
1897
2690
class RepositoryAcquisitionPolicy(object):
1901
2694
for a branch that is being created. The most basic policy decision is
1902
2695
whether to create a new repository or use an existing one.
1904
def __init__(self, stack_on, stack_on_pwd, require_stacking):
1907
:param stack_on: A location to stack on
1908
:param stack_on_pwd: If stack_on is relative, the location it is
1910
:param require_stacking: If True, it is a failure to not stack.
1912
self._stack_on = stack_on
1913
self._stack_on_pwd = stack_on_pwd
1914
self._require_stacking = require_stacking
1916
2698
def configure_branch(self, branch):
1917
2699
"""Apply any configuration data from this policy to the branch.
1919
Default implementation sets repository stacking.
2701
Default implementation does nothing.
1921
if self._stack_on is None:
1923
if self._stack_on_pwd is None:
1924
stack_on = self._stack_on
1927
stack_on = urlutils.rebase_url(self._stack_on,
1930
except errors.InvalidRebaseURLs:
1931
stack_on = self._get_full_stack_on()
1933
branch.set_stacked_on_url(stack_on)
1934
except (errors.UnstackableBranchFormat,
1935
errors.UnstackableRepositoryFormat):
1936
if self._require_stacking:
1939
def requires_stacking(self):
1940
"""Return True if this policy requires stacking."""
1941
return self._stack_on is not None and self._require_stacking
1943
def _get_full_stack_on(self):
1944
"""Get a fully-qualified URL for the stack_on location."""
1945
if self._stack_on is None:
1947
if self._stack_on_pwd is None:
1948
return self._stack_on
1950
return urlutils.join(self._stack_on_pwd, self._stack_on)
1952
def _add_fallback(self, repository, possible_transports=None):
1953
"""Add a fallback to the supplied repository, if stacking is set."""
1954
stack_on = self._get_full_stack_on()
1955
if stack_on is None:
1958
stacked_dir = BzrDir.open(stack_on,
1959
possible_transports=possible_transports)
1960
except errors.JailBreak:
1961
# We keep the stacking details, but we are in the server code so
1962
# actually stacking is not needed.
1965
stacked_repo = stacked_dir.open_branch().repository
1966
except errors.NotBranchError:
1967
stacked_repo = stacked_dir.open_repository()
1969
repository.add_fallback_repository(stacked_repo)
1970
except errors.UnstackableRepositoryFormat:
1971
if self._require_stacking:
1974
self._require_stacking = True
1976
def acquire_repository(self, make_working_trees=None, shared=False,
1977
possible_transports=None):
2705
def acquire_repository(self, make_working_trees=None, shared=False):
1978
2706
"""Acquire a repository for this bzrdir.
1980
2708
Implementations may create a new repository or use a pre-exising
1983
2710
:param make_working_trees: If creating a repository, set
1984
2711
make_working_trees to this value (if non-None)
1985
2712
:param shared: If creating a repository, make it shared if True
1986
:return: A repository, is_new_flag (True if the repository was
2713
:return: A repository
1989
raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
2715
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
1992
2718
class CreateRepository(RepositoryAcquisitionPolicy):
1993
2719
"""A policy of creating a new repository"""
1995
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1996
require_stacking=False):
1999
:param bzrdir: The bzrdir to create the repository on.
2000
:param stack_on: A location to stack on
2001
:param stack_on_pwd: If stack_on is relative, the location it is
2004
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2721
def __init__(self, bzrdir):
2722
RepositoryAcquisitionPolicy.__init__(self)
2006
2723
self._bzrdir = bzrdir
2008
def acquire_repository(self, make_working_trees=None, shared=False,
2009
possible_transports=None):
2725
def acquire_repository(self, make_working_trees=None, shared=False):
2010
2726
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2012
2728
Creates the desired repository in the bzrdir we already have.
2014
if possible_transports is None:
2015
possible_transports = []
2017
possible_transports = list(possible_transports)
2018
possible_transports.append(self._bzrdir.root_transport)
2019
stack_on = self._get_full_stack_on()
2021
format = self._bzrdir._format
2022
format.require_stacking(stack_on=stack_on,
2023
possible_transports=possible_transports)
2024
if not self._require_stacking:
2025
# We have picked up automatic stacking somewhere.
2026
note(gettext('Using default stacking branch {0} at {1}').format(
2027
self._stack_on, self._stack_on_pwd))
2028
2730
repository = self._bzrdir.create_repository(shared=shared)
2029
self._add_fallback(repository,
2030
possible_transports=possible_transports)
2031
2731
if make_working_trees is not None:
2032
2732
repository.set_make_working_trees(make_working_trees)
2033
return repository, True
2036
2736
class UseExistingRepository(RepositoryAcquisitionPolicy):
2037
2737
"""A policy of reusing an existing repository"""
2039
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2040
require_stacking=False):
2043
:param repository: The repository to use.
2044
:param stack_on: A location to stack on
2045
:param stack_on_pwd: If stack_on is relative, the location it is
2048
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2739
def __init__(self, repository):
2740
RepositoryAcquisitionPolicy.__init__(self)
2050
2741
self._repository = repository
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
2743
def acquire_repository(self, make_working_trees=None, shared=False):
2054
2744
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2056
Returns an existing repository to use.
2746
Returns an existing repository to use
2058
if possible_transports is None:
2059
possible_transports = []
2061
possible_transports = list(possible_transports)
2062
possible_transports.append(self._repository.bzrdir.transport)
2063
self._add_fallback(self._repository,
2064
possible_transports=possible_transports)
2065
return self._repository, False
2068
def register_metadir(registry, key,
2069
repository_format, help, native=True, deprecated=False,
2074
alias=False, bzrdir_format=None):
2075
"""Register a metadir subformat.
2077
These all use a meta bzrdir, but can be parameterized by the
2078
Repository/Branch/WorkingTreeformats.
2080
:param repository_format: The fully-qualified repository format class
2082
:param branch_format: Fully-qualified branch format class name as
2084
:param tree_format: Fully-qualified tree format class name as
2087
if bzrdir_format is None:
2088
bzrdir_format = BzrDirMetaFormat1
2089
# This should be expanded to support setting WorkingTree and Branch
2090
# formats, once the API supports that.
2091
def _load(full_name):
2092
mod_name, factory_name = full_name.rsplit('.', 1)
2094
factory = pyutils.get_named_object(mod_name, factory_name)
2095
except ImportError, e:
2096
raise ImportError('failed to load %s: %s' % (full_name, e))
2097
except AttributeError:
2098
raise AttributeError('no factory %s in module %r'
2099
% (full_name, sys.modules[mod_name]))
2103
bd = bzrdir_format()
2104
if branch_format is not None:
2105
bd.set_branch_format(_load(branch_format))
2106
if tree_format is not None:
2107
bd.workingtree_format = _load(tree_format)
2108
if repository_format is not None:
2109
bd.repository_format = _load(repository_format)
2111
registry.register(key, helper, help, native, deprecated, hidden,
2112
experimental, alias)
2114
register_metadir(controldir.format_registry, 'knit',
2748
return self._repository
2751
format_registry = BzrDirFormatRegistry()
2752
format_registry.register('weave', BzrDirFormat6,
2753
'Pre-0.8 format. Slower than knit and does not'
2754
' support checkouts or shared repositories.',
2756
format_registry.register_metadir('knit',
2115
2757
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
2758
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2117
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2118
tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2121
register_metadir(controldir.format_registry, 'dirstate',
2122
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2123
help='Format using dirstate for working trees. '
2124
'Compatible with bzr 0.8 and '
2125
'above when accessed over the network. Introduced in bzr 0.15.',
2126
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2127
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2131
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
help='Variant of dirstate with support for tags. '
2133
'Introduced in bzr 0.15.',
2759
branch_format='bzrlib.branch.BzrBranchFormat5',
2760
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2761
format_registry.register_metadir('metaweave',
2762
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2763
'Transitional format in 0.8. Slower than knit.',
2764
branch_format='bzrlib.branch.BzrBranchFormat5',
2765
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2767
format_registry.register_metadir('dirstate',
2768
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2769
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2770
'above when accessed over the network.',
2771
branch_format='bzrlib.branch.BzrBranchFormat5',
2772
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2773
# directly from workingtree_4 triggers a circular import.
2774
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2776
format_registry.register_metadir('dirstate-tags',
2777
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2778
help='New in 0.15: Fast local operations and improved scaling for '
2779
'network operations. Additionally adds support for tags.'
2780
' Incompatible with bzr < 0.15.',
2134
2781
branch_format='bzrlib.branch.BzrBranchFormat6',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
register_metadir(controldir.format_registry, 'rich-root',
2782
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2784
format_registry.register_metadir('rich-root',
2139
2785
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
2786
help='New in 1.0. Better handling of tree roots. Incompatible with'
2142
2788
branch_format='bzrlib.branch.BzrBranchFormat6',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2789
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2791
format_registry.register_metadir('dirstate-with-subtree',
2147
2792
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2148
help='Variant of dirstate with support for nested trees. '
2149
'Introduced in 0.15.',
2150
branch_format='bzrlib.branch.BzrBranchFormat6',
2151
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2155
register_metadir(controldir.format_registry, 'pack-0.92',
2156
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2157
help='Pack-based format used in 1.x series. Introduced in 0.92. '
2158
'Interoperates with bzr repositories before 0.92 but cannot be '
2159
'read by bzr < 0.92. '
2161
branch_format='bzrlib.branch.BzrBranchFormat6',
2162
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2167
help='Pack-based format used in 1.x series, with subtree support. '
2168
'Introduced in 0.92. Interoperates with '
2169
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
branch_format='bzrlib.branch.BzrBranchFormat6',
2172
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2179
help='A variant of pack-0.92 that supports rich-root data '
2180
'(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2181
branch_format='bzrlib.branch.BzrBranchFormat6',
2182
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2186
register_metadir(controldir.format_registry, '1.6',
2187
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2188
help='A format that allows a branch to indicate that there is another '
2189
'(stacked) repository that should be used to access data that is '
2190
'not present locally.',
2191
branch_format='bzrlib.branch.BzrBranchFormat7',
2192
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2198
help='A variant of 1.6 that supports rich-root data '
2199
'(needed for bzr-svn and bzr-git).',
2200
branch_format='bzrlib.branch.BzrBranchFormat7',
2201
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2205
register_metadir(controldir.format_registry, '1.9',
2206
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2207
help='A repository format using B+tree indexes. These indexes '
2208
'are smaller in size, have smarter caching and provide faster '
2209
'performance for most operations.',
2210
branch_format='bzrlib.branch.BzrBranchFormat7',
2211
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2217
help='A variant of 1.9 that supports rich-root data '
2218
'(needed for bzr-svn and bzr-git).',
2219
branch_format='bzrlib.branch.BzrBranchFormat7',
2220
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2224
register_metadir(controldir.format_registry, '1.14',
2225
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2226
help='A working-tree format that supports content filtering.',
2227
branch_format='bzrlib.branch.BzrBranchFormat7',
2228
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2234
help='A variant of 1.14 that supports rich-root data '
2235
'(needed for bzr-svn and bzr-git).',
2236
branch_format='bzrlib.branch.BzrBranchFormat7',
2237
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2241
# The following un-numbered 'development' formats should always just be aliases.
2242
register_metadir(controldir.format_registry, 'development-subtree',
2243
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
2793
help='New in 0.15: Fast local operations and improved scaling for '
2794
'network operations. Additionally adds support for versioning nested '
2795
'bzr branches. Incompatible with bzr < 0.15.',
2796
branch_format='bzrlib.branch.BzrBranchFormat6',
2797
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2801
format_registry.register_metadir('pack-0.92',
2802
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2803
help='New in 0.92: Pack-based format with data compatible with '
2804
'dirstate-tags format repositories. Interoperates with '
2805
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2806
'Previously called knitpack-experimental. '
2807
'For more information, see '
2808
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2809
branch_format='bzrlib.branch.BzrBranchFormat6',
2810
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2812
format_registry.register_metadir('pack-0.92-subtree',
2813
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2814
help='New in 0.92: Pack-based format with data compatible with '
2815
'dirstate-with-subtree format repositories. Interoperates with '
2816
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2817
'Previously called knitpack-experimental. '
2818
'For more information, see '
2819
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2820
branch_format='bzrlib.branch.BzrBranchFormat6',
2821
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2825
format_registry.register_metadir('rich-root-pack',
2826
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2827
help='New in 1.0: Pack-based format with data compatible with '
2828
'rich-root format repositories. Incompatible with'
2830
branch_format='bzrlib.branch.BzrBranchFormat6',
2831
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2833
# The following two formats should always just be aliases.
2834
format_registry.register_metadir('development',
2835
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2836
help='Current development format. Can convert data to and from pack-0.92 '
2837
'(and anything compatible with pack-0.92) format repositories. '
2838
'Repositories in this format can only be read by bzr.dev. '
2840
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2842
branch_format='bzrlib.branch.BzrBranchFormat6',
2843
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2847
format_registry.register_metadir('development-subtree',
2848
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2244
2849
help='Current development format, subtree variant. Can convert data to and '
2245
'from pack-0.92-subtree (and anything compatible with '
2246
'pack-0.92-subtree) format repositories. Repositories and branches in '
2247
'this format can only be read by bzr.dev. Please read '
2248
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2250
branch_format='bzrlib.branch.BzrBranchFormat7',
2251
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2254
alias=False, # Restore to being an alias when an actual development subtree format is added
2255
# This current non-alias status is simply because we did not introduce a
2256
# chk based subtree format.
2258
register_metadir(controldir.format_registry, 'development5-subtree',
2259
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2260
help='Development format, subtree variant. Can convert data to and '
2261
'from pack-0.92-subtree (and anything compatible with '
2262
'pack-0.92-subtree) format repositories. Repositories and branches in '
2263
'this format can only be read by bzr.dev. Please read '
2264
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2266
branch_format='bzrlib.branch.BzrBranchFormat7',
2267
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2273
register_metadir(controldir.format_registry, 'development-colo',
2274
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2275
help='The 2a format with experimental support for colocated branches.\n',
2276
branch_format='bzrlib.branch.BzrBranchFormat7',
2277
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2279
bzrdir_format=BzrDirMetaFormat1Colo,
2283
# And the development formats above will have aliased one of the following:
2285
# Finally, the current format.
2286
register_metadir(controldir.format_registry, '2a',
2287
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
help='Format for the bzr 2.0 series.\n'
2289
'Uses group-compress storage.\n'
2290
'Provides rich roots which are a one-way transition.\n',
2291
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2292
# 'rich roots. Supported by bzr 1.16 and later.',
2293
branch_format='bzrlib.branch.BzrBranchFormat7',
2294
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2298
# The following format should be an alias for the rich root equivalent
2299
# of the default format
2300
register_metadir(controldir.format_registry, 'default-rich-root',
2301
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2302
branch_format='bzrlib.branch.BzrBranchFormat7',
2303
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2850
'from pack-0.92 (and anything compatible with pack-0.92) format '
2851
'repositories. Repositories in this format can only be read by '
2852
'bzr.dev. Please read '
2853
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2855
branch_format='bzrlib.branch.BzrBranchFormat6',
2856
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2308
# The current format that is made on 'bzr init'.
2309
format_name = config.GlobalStack().get('default_format')
2310
controldir.format_registry.set_default(format_name)
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2314
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2315
format_registry = controldir.format_registry
2860
# And the development formats which the will have aliased one of follow:
2861
format_registry.register_metadir('development0',
2862
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2863
help='Trivial rename of pack-0.92 to provide a development format. '
2865
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2867
branch_format='bzrlib.branch.BzrBranchFormat6',
2868
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2872
format_registry.register_metadir('development0-subtree',
2873
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2874
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2876
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2878
branch_format='bzrlib.branch.BzrBranchFormat6',
2879
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2883
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
