174
215
errors.UnstackableRepositoryFormat,
175
216
errors.NotStacked):
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)
220
# may need to copy content in
221
repository_policy = result.determine_repository_policy(
222
force_new_repo, stacked_on, self.root_transport.base,
223
require_stacking=require_stacking)
224
make_working_trees = local_repo.make_working_trees()
225
result_repo = repository_policy.acquire_repository(
226
make_working_trees, local_repo.is_shared())
227
result_repo.fetch(local_repo, revision_id=revision_id)
217
230
# 1 if there is a branch present
218
231
# make sure its content is available in the target repository
220
233
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):
234
result_branch = local_branch.clone(result, revision_id=revision_id)
235
if repository_policy is not None:
236
repository_policy.configure_branch(result_branch)
237
if result_repo is None or result_repo.make_working_trees():
239
self.open_workingtree().clone(result)
240
except (errors.NoWorkingTree, errors.NotLocalUrl):
233
244
# TODO: This should be given a Transport, and should chdir up; otherwise
234
245
# this will open a new connection.
235
246
def _make_tail(self, url):
236
t = _mod_transport.get_transport(url)
247
t = get_transport(url)
251
def create(cls, base, format=None, possible_transports=None):
252
"""Create a new BzrDir at the url 'base'.
254
:param format: If supplied, the format of branch to create. If not
255
supplied, the default is used.
256
:param possible_transports: If supplied, a list of transports that
257
can be reused to share a remote connection.
259
if cls is not BzrDir:
260
raise AssertionError("BzrDir.create always creates the default"
261
" format, not one of %r" % cls)
262
t = get_transport(base, possible_transports)
265
format = BzrDirFormat.get_default_format()
266
return format.initialize_on_transport(t)
269
def find_bzrdirs(transport, evaluate=None, list_current=None):
270
"""Find bzrdirs recursively from current location.
272
This is intended primarily as a building block for more sophisticated
273
functionality, like finding trees under a directory, or finding
274
branches that use a given repository.
275
:param evaluate: An optional callable that yields recurse, value,
276
where recurse controls whether this bzrdir is recursed into
277
and value is the value to yield. By default, all bzrdirs
278
are recursed into, and the return value is the bzrdir.
279
:param list_current: if supplied, use this function to list the current
280
directory, instead of Transport.list_dir
281
:return: a generator of found bzrdirs, or whatever evaluate returns.
283
if list_current is None:
284
def list_current(transport):
285
return transport.list_dir('')
287
def evaluate(bzrdir):
290
pending = [transport]
291
while len(pending) > 0:
292
current_transport = pending.pop()
295
bzrdir = BzrDir.open_from_transport(current_transport)
296
except errors.NotBranchError:
299
recurse, value = evaluate(bzrdir)
302
subdirs = list_current(current_transport)
303
except errors.NoSuchFile:
306
for subdir in sorted(subdirs, reverse=True):
307
pending.append(current_transport.clone(subdir))
310
def find_branches(transport):
311
"""Find all branches under a transport.
313
This will find all branches below the transport, including branches
314
inside other branches. Where possible, it will use
315
Repository.find_branches.
317
To list all the branches that use a particular Repository, see
318
Repository.find_branches
320
def evaluate(bzrdir):
322
repository = bzrdir.open_repository()
323
except errors.NoRepositoryPresent:
326
return False, (None, repository)
328
branch = bzrdir.open_branch()
329
except errors.NotBranchError:
330
return True, (None, None)
332
return True, (branch, None)
334
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
336
branches.extend(repo.find_branches())
337
if branch is not None:
338
branches.append(branch)
341
def destroy_repository(self):
342
"""Destroy the repository in this BzrDir"""
343
raise NotImplementedError(self.destroy_repository)
345
def create_branch(self):
346
"""Create a branch in this BzrDir.
348
The bzrdir's format will control what branch format is created.
349
For more control see BranchFormatXX.create(a_bzrdir).
351
raise NotImplementedError(self.create_branch)
353
def destroy_branch(self):
354
"""Destroy the branch in this BzrDir"""
355
raise NotImplementedError(self.destroy_branch)
358
def create_branch_and_repo(base, force_new_repo=False, format=None):
359
"""Create a new BzrDir, Branch and Repository at the url 'base'.
361
This will use the current default BzrDirFormat unless one is
362
specified, and use whatever
363
repository format that that uses via bzrdir.create_branch and
364
create_repository. If a shared repository is available that is used
367
The created Branch object is returned.
369
:param base: The URL to create the branch at.
370
:param force_new_repo: If True a new repository is always created.
371
:param format: If supplied, the format of branch to create. If not
372
supplied, the default is used.
374
bzrdir = BzrDir.create(base, format)
375
bzrdir._find_or_create_repository(force_new_repo)
376
return bzrdir.create_branch()
239
378
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
379
stack_on_pwd=None, require_stacking=False):
241
380
"""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.
382
This controls whether a new repository is created, or a shared
383
repository used instead.
246
385
If stack_on is supplied, will not seek a containing shared repo.
300
440
def _find_or_create_repository(self, force_new_repo):
301
441
"""Create a new repository if needed, returning the repository."""
302
442
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.
443
return policy.acquire_repository()
446
def create_branch_convenience(base, force_new_repo=False,
447
force_new_tree=None, format=None,
448
possible_transports=None):
449
"""Create a new BzrDir, Branch and Repository at the url 'base'.
451
This is a convenience function - it will use an existing repository
452
if possible, can be told explicitly whether to create a working tree or
455
This will use the current default BzrDirFormat unless one is
456
specified, and use whatever
457
repository format that that uses via bzrdir.create_branch and
458
create_repository. If a shared repository is available that is used
459
preferentially. Whatever repository is used, its tree creation policy
462
The created Branch object is returned.
463
If a working tree cannot be made due to base not being a file:// url,
464
no error is raised unless force_new_tree is True, in which case no
465
data is created on disk and NotLocalUrl is raised.
467
:param base: The URL to create the branch at.
468
:param force_new_repo: If True a new repository is always created.
469
:param force_new_tree: If True or False force creation of a tree or
470
prevent such creation respectively.
471
:param format: Override for the bzrdir format to create.
472
:param possible_transports: An optional reusable transports list.
475
# check for non local urls
476
t = get_transport(base, possible_transports)
477
if not isinstance(t, LocalTransport):
478
raise errors.NotLocalUrl(base)
479
bzrdir = BzrDir.create(base, format, possible_transports)
480
repo = bzrdir._find_or_create_repository(force_new_repo)
481
result = bzrdir.create_branch()
482
if force_new_tree or (repo.make_working_trees() and
483
force_new_tree is None):
485
bzrdir.create_workingtree()
486
except errors.NotLocalUrl:
491
def create_standalone_workingtree(base, format=None):
492
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
494
'base' must be a local path or a file:// url.
496
This will use the current default BzrDirFormat unless one is
497
specified, and use whatever
498
repository format that that uses for bzrdirformat.create_workingtree,
499
create_branch and create_repository.
501
:param format: Override for the bzrdir format to create.
502
:return: The WorkingTree object.
504
t = get_transport(base)
505
if not isinstance(t, LocalTransport):
506
raise errors.NotLocalUrl(base)
507
bzrdir = BzrDir.create_branch_and_repo(base,
509
format=format).bzrdir
510
return bzrdir.create_workingtree()
512
def create_workingtree(self, revision_id=None, from_branch=None,
513
accelerator_tree=None, hardlink=False):
514
"""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.
516
:param revision_id: create it as of this revision id.
517
:param from_branch: override bzrdir branch (for lightweight checkouts)
349
518
:param accelerator_tree: A tree which can be used for retrieving file
350
519
contents more quickly than the revision tree, i.e. a workingtree.
351
520
The revision tree will be used for cases where accelerator_tree's
352
521
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)
523
raise NotImplementedError(self.create_workingtree)
495
525
def retire_bzrdir(self, limit=10000):
496
526
"""Permanently disable the bzrdir.
633
723
:param _transport: the transport this dir is based at.
635
725
self._format = _format
636
# these are also under the more standard names of
637
# control_transport and user_transport
638
726
self.transport = _transport.clone('.bzr')
639
727
self.root_transport = _transport
640
728
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
730
def is_control_filename(self, filename):
651
731
"""True if filename is the name of a path which is reserved for bzrdir's.
653
733
:param filename: A filename within the root transport of this bzrdir.
655
735
This is true IF and ONLY IF the filename is part of the namespace reserved
656
736
for bzr control dirs. Currently this is the '.bzr' directory in the root
657
of the root_transport.
737
of the root_transport. it is expected that plugins will need to extend
738
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-
741
# this might be better on the BzrDirFormat class because it refers to
742
# all the possible bzrdir disk formats.
743
# This method is tested via the workingtree is_control_filename tests-
662
744
# it was extracted from WorkingTree.is_control_filename. If the method's
663
745
# contract is extended beyond the current trivial implementation, please
664
746
# add new tests for it to the appropriate place.
665
747
return filename == '.bzr' or filename.startswith('.bzr/')
749
def needs_format_conversion(self, format=None):
750
"""Return true if this bzrdir needs convert_format run on it.
752
For instance, if the repository format is out of date but the
753
branch and working tree are not, this should return True.
755
:param format: Optional parameter indicating a specific desired
756
format we plan to arrive at.
758
raise NotImplementedError(self.needs_format_conversion)
761
def open_unsupported(base):
762
"""Open a branch which is not supported."""
763
return BzrDir.open(base, _unsupported=True)
766
def open(base, _unsupported=False, possible_transports=None):
767
"""Open an existing bzrdir, rooted at 'base' (url).
769
:param _unsupported: a private parameter to the BzrDir class.
771
t = get_transport(base, possible_transports=possible_transports)
772
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
775
def open_from_transport(transport, _unsupported=False,
776
_server_formats=True):
777
"""Open a bzrdir within a particular directory.
779
:param transport: Transport containing the bzrdir.
780
:param _unsupported: private.
782
base = transport.base
784
def find_format(transport):
785
return transport, BzrDirFormat.find_format(
786
transport, _server_formats=_server_formats)
788
def redirected(transport, e, redirection_notice):
789
qualified_source = e.get_source_url()
790
relpath = transport.relpath(qualified_source)
791
if not e.target.endswith(relpath):
792
# Not redirected to a branch-format, not a branch
793
raise errors.NotBranchError(path=e.target)
794
target = e.target[:-len(relpath)]
795
note('%s is%s redirected to %s',
796
transport.base, e.permanently, target)
797
# Let's try with a new transport
798
# FIXME: If 'transport' has a qualifier, this should
799
# be applied again to the new transport *iff* the
800
# schemes used are the same. Uncomment this code
801
# once the function (and tests) exist.
803
#target = urlutils.copy_url_qualifiers(original, target)
804
return get_transport(target)
807
transport, format = do_catching_redirections(find_format,
810
except errors.TooManyRedirections:
811
raise errors.NotBranchError(base)
813
BzrDir._check_supported(format, _unsupported)
814
return format.open(transport, _found=True)
816
def open_branch(self, unsupported=False):
817
"""Open the branch object at this BzrDir if one is present.
819
If unsupported is True, then no longer supported branch formats can
822
TODO: static convenience version of this?
824
raise NotImplementedError(self.open_branch)
827
def open_containing(url, possible_transports=None):
828
"""Open an existing branch which contains url.
830
:param url: url to search from.
831
See open_containing_from_transport for more detail.
833
transport = get_transport(url, possible_transports)
834
return BzrDir.open_containing_from_transport(transport)
837
def open_containing_from_transport(a_transport):
838
"""Open an existing branch which contains a_transport.base.
840
This probes for a branch at a_transport, and searches upwards from there.
842
Basically we keep looking up until we find the control directory or
843
run into the root. If there isn't one, raises NotBranchError.
844
If there is one and it is either an unrecognised format or an unsupported
845
format, UnknownFormatError or UnsupportedFormatError are raised.
846
If there is one, it is returned, along with the unused portion of url.
848
:return: The BzrDir that contains the path, and a Unicode path
849
for the rest of the URL.
851
# this gets the normalised url back. I.e. '.' -> the full path.
852
url = a_transport.base
855
result = BzrDir.open_from_transport(a_transport)
856
return result, urlutils.unescape(a_transport.relpath(url))
857
except errors.NotBranchError, e:
860
new_t = a_transport.clone('..')
861
except errors.InvalidURLJoin:
862
# reached the root, whatever that may be
863
raise errors.NotBranchError(path=url)
864
if new_t.base == a_transport.base:
865
# reached the root, whatever that may be
866
raise errors.NotBranchError(path=url)
869
def _get_tree_branch(self):
870
"""Return the branch and tree, if any, for this bzrdir.
872
Return None for tree if not present or inaccessible.
873
Raise NotBranchError if no branch is present.
874
:return: (tree, branch)
877
tree = self.open_workingtree()
878
except (errors.NoWorkingTree, errors.NotLocalUrl):
880
branch = self.open_branch()
886
def open_tree_or_branch(klass, location):
887
"""Return the branch and working tree at a location.
889
If there is no tree at the location, tree will be None.
890
If there is no branch at the location, an exception will be
892
:return: (tree, branch)
894
bzrdir = klass.open(location)
895
return bzrdir._get_tree_branch()
898
def open_containing_tree_or_branch(klass, location):
899
"""Return the branch and working tree contained by a location.
901
Returns (tree, branch, relpath).
902
If there is no tree at containing the location, tree will be None.
903
If there is no branch containing the location, an exception will be
905
relpath is the portion of the path that is contained by the branch.
907
bzrdir, relpath = klass.open_containing(location)
908
tree, branch = bzrdir._get_tree_branch()
909
return tree, branch, relpath
912
def open_containing_tree_branch_or_repository(klass, location):
913
"""Return the working tree, branch and repo contained by a location.
915
Returns (tree, branch, repository, relpath).
916
If there is no tree containing the location, tree will be None.
917
If there is no branch containing the location, branch will be None.
918
If there is no repository containing the location, repository will be
920
relpath is the portion of the path that is contained by the innermost
923
If no tree, branch or repository is found, a NotBranchError is raised.
925
bzrdir, relpath = klass.open_containing(location)
927
tree, branch = bzrdir._get_tree_branch()
928
except errors.NotBranchError:
930
repo = bzrdir.find_repository()
931
return None, None, repo, relpath
932
except (errors.NoRepositoryPresent):
933
raise errors.NotBranchError(location)
934
return tree, branch, branch.repository, relpath
936
def open_repository(self, _unsupported=False):
937
"""Open the repository object at this BzrDir if one is present.
939
This will not follow the Branch object pointer - it's strictly a direct
940
open facility. Most client code should use open_branch().repository to
943
:param _unsupported: a private parameter, not part of the api.
944
TODO: static convenience version of this?
946
raise NotImplementedError(self.open_repository)
948
def open_workingtree(self, _unsupported=False,
949
recommend_upgrade=True, from_branch=None):
950
"""Open the workingtree object at this BzrDir if one is present.
952
:param recommend_upgrade: Optional keyword parameter, when True (the
953
default), emit through the ui module a recommendation that the user
954
upgrade the working tree when the workingtree being opened is old
955
(but still fully supported).
956
:param from_branch: override bzrdir branch (for lightweight checkouts)
958
raise NotImplementedError(self.open_workingtree)
960
def has_branch(self):
961
"""Tell if this bzrdir contains a branch.
963
Note: if you're going to open the branch, you should just go ahead
964
and try, and not ask permission first. (This method just opens the
965
branch and discards it, and that's somewhat expensive.)
970
except errors.NotBranchError:
973
def has_workingtree(self):
974
"""Tell if this bzrdir contains a working tree.
976
This will still raise an exception if the bzrdir has a workingtree that
977
is remote & inaccessible.
979
Note: if you're going to open the working tree, you should just go ahead
980
and try, and not ask permission first. (This method just opens the
981
workingtree and discards it, and that's somewhat expensive.)
984
self.open_workingtree(recommend_upgrade=False)
986
except errors.NoWorkingTree:
667
989
def _cloning_metadir(self):
668
990
"""Produce a metadir suitable for cloning with.
670
992
:returns: (destination_bzrdir_format, source_repository)
672
994
result_format = self._format.__class__()
675
branch = self.open_branch(ignore_fallbacks=True)
997
branch = self.open_branch()
676
998
source_repository = branch.repository
677
999
result_format._branch_format = branch._format
678
1000
except errors.NotBranchError:
710
1030
:require_stacking: If True, non-stackable formats will be upgraded
711
1031
to similar stackable formats.
712
:returns: a ControlDirFormat with all component formats either set
1032
:returns: a BzrDirFormat with all component formats either set
713
1033
appropriately or set to None if that component should not be
716
1036
format, repository = self._cloning_metadir()
717
1037
if format._workingtree_format is None:
719
1038
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
1040
tree_format = repository._format._matchingbzrdir.workingtree_format
725
1041
format.workingtree_format = tree_format.__class__()
1042
if (require_stacking and not
1043
format.get_branch_format().supports_stacking()):
1044
# We need to make a stacked branch, but the default format for the
1045
# target doesn't support stacking. So force a branch that *can*
1047
from bzrlib.branch import BzrBranchFormat7
1048
format._branch_format = BzrBranchFormat7()
1049
mutter("using %r for stacking" % (format._branch_format,))
1050
from bzrlib.repofmt import pack_repo
1051
if format.repository_format.rich_root_data:
1052
bzrdir_format_name = '1.6.1-rich-root'
1053
repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1055
bzrdir_format_name = '1.6'
1056
repo_format = pack_repo.RepositoryFormatKnitPack5()
1057
note('Source format does not support stacking, using format:'
1059
bzrdir_format_name, repo_format.get_format_description())
1060
format.repository_format = repo_format
1063
def checkout_metadir(self):
1064
return self.cloning_metadir()
1066
def sprout(self, url, revision_id=None, force_new_repo=False,
1067
recurse='down', possible_transports=None,
1068
accelerator_tree=None, hardlink=False, stacked=False):
1069
"""Create a copy of this bzrdir prepared for use as a new line of
1072
If url's last component does not exist, it will be created.
1074
Attributes related to the identity of the source branch like
1075
branch nickname will be cleaned, a working tree is created
1076
whether one existed before or not; and a local branch is always
1079
if revision_id is not None, then the clone operation may tune
1080
itself to download less data.
1081
:param accelerator_tree: A tree which can be used for retrieving file
1082
contents more quickly than the revision tree, i.e. a workingtree.
1083
The revision tree will be used for cases where accelerator_tree's
1084
content is different.
1085
:param hardlink: If true, hard-link files from accelerator_tree,
1087
:param stacked: If true, create a stacked branch referring to the
1088
location of this control directory.
1090
target_transport = get_transport(url, possible_transports)
1091
target_transport.ensure_base()
1092
cloning_format = self.cloning_metadir(stacked)
1093
# Create/update the result branch
1094
result = cloning_format.initialize_on_transport(target_transport)
1096
source_branch = self.open_branch()
1097
source_repository = source_branch.repository
1099
stacked_branch_url = self.root_transport.base
1101
# if a stacked branch wasn't requested, we don't create one
1102
# even if the origin was stacked
1103
stacked_branch_url = None
1104
except errors.NotBranchError:
1105
source_branch = None
1107
source_repository = self.open_repository()
1108
except errors.NoRepositoryPresent:
1109
source_repository = None
1110
stacked_branch_url = None
1111
repository_policy = result.determine_repository_policy(
1112
force_new_repo, stacked_branch_url, require_stacking=stacked)
1113
result_repo = repository_policy.acquire_repository()
1114
if source_repository is not None:
1115
# Fetch while stacked to prevent unstacked fetch from
1117
result_repo.fetch(source_repository, revision_id=revision_id)
1119
if source_branch is None:
1120
# this is for sprouting a bzrdir without a branch; is that
1122
# Not especially, but it's part of the contract.
1123
result_branch = result.create_branch()
1125
# Force NULL revision to avoid using repository before stacking
1127
result_branch = source_branch.sprout(
1128
result, revision_id=_mod_revision.NULL_REVISION)
1129
parent_location = result_branch.get_parent()
1130
mutter("created new branch %r" % (result_branch,))
1131
repository_policy.configure_branch(result_branch)
1132
if source_branch is not None:
1133
source_branch.copy_content_into(result_branch, revision_id)
1134
# Override copy_content_into
1135
result_branch.set_parent(parent_location)
1137
# Create/update the result working tree
1138
if isinstance(target_transport, LocalTransport) and (
1139
result_repo is None or result_repo.make_working_trees()):
1140
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1144
if wt.path2id('') is None:
1146
wt.set_root_id(self.open_workingtree.get_root_id())
1147
except errors.NoWorkingTree:
1153
if recurse == 'down':
1155
basis = wt.basis_tree()
1157
subtrees = basis.iter_references()
1158
elif source_branch is not None:
1159
basis = source_branch.basis_tree()
1161
subtrees = basis.iter_references()
1166
for path, file_id in subtrees:
1167
target = urlutils.join(url, urlutils.escape(path))
1168
sublocation = source_branch.reference_parent(file_id, path)
1169
sublocation.bzrdir.sprout(target,
1170
basis.get_reference_revision(file_id, path),
1171
force_new_repo=force_new_repo, recurse=recurse,
1174
if basis is not None:
1179
class BzrDirPreSplitOut(BzrDir):
1180
"""A common class for the all-in-one formats."""
1182
def __init__(self, _transport, _format):
1183
"""See BzrDir.__init__."""
1184
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1185
self._control_files = lockable_files.LockableFiles(
1186
self.get_branch_transport(None),
1187
self._format._lock_file_name,
1188
self._format._lock_class)
1190
def break_lock(self):
1191
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1192
raise NotImplementedError(self.break_lock)
1194
def cloning_metadir(self, require_stacking=False):
1195
"""Produce a metadir suitable for cloning with."""
726
1196
if require_stacking:
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.
1197
return format_registry.make_bzrdir('1.6')
1198
return self._format.__class__()
1200
def clone(self, url, revision_id=None, force_new_repo=False,
1201
preserve_stacking=False):
1202
"""See BzrDir.clone().
1204
force_new_repo has no effect, since this family of formats always
1205
require a new repository.
1206
preserve_stacking has no effect, since no source branch using this
1207
family of formats can be stacked, so there is no stacking to preserve.
741
raise NotImplementedError(self.get_branch_transport)
1209
self._make_tail(url)
1210
result = self._format._initialize_for_clone(url)
1211
self.open_repository().clone(result, revision_id=revision_id)
1212
from_branch = self.open_branch()
1213
from_branch.clone(result, revision_id=revision_id)
1215
tree = self.open_workingtree()
1216
except errors.NotLocalUrl:
1217
# make a new one, this format always has to have one.
1218
result._init_workingtree()
1223
def create_branch(self):
1224
"""See BzrDir.create_branch."""
1225
return self._format.get_branch_format().initialize(self)
1227
def destroy_branch(self):
1228
"""See BzrDir.destroy_branch."""
1229
raise errors.UnsupportedOperation(self.destroy_branch, self)
1231
def create_repository(self, shared=False):
1232
"""See BzrDir.create_repository."""
1234
raise errors.IncompatibleFormat('shared repository', self._format)
1235
return self.open_repository()
1237
def destroy_repository(self):
1238
"""See BzrDir.destroy_repository."""
1239
raise errors.UnsupportedOperation(self.destroy_repository, self)
1241
def create_workingtree(self, revision_id=None, from_branch=None,
1242
accelerator_tree=None, hardlink=False):
1243
"""See BzrDir.create_workingtree."""
1244
# The workingtree is sometimes created when the bzrdir is created,
1245
# but not when cloning.
1247
# this looks buggy but is not -really-
1248
# because this format creates the workingtree when the bzrdir is
1250
# clone and sprout will have set the revision_id
1251
# and that will have set it for us, its only
1252
# specific uses of create_workingtree in isolation
1253
# that can do wonky stuff here, and that only
1254
# happens for creating checkouts, which cannot be
1255
# done on this format anyway. So - acceptable wart.
1257
result = self.open_workingtree(recommend_upgrade=False)
1258
except errors.NoSuchFile:
1259
result = self._init_workingtree()
1260
if revision_id is not None:
1261
if revision_id == _mod_revision.NULL_REVISION:
1262
result.set_parent_ids([])
1264
result.set_parent_ids([revision_id])
1267
def _init_workingtree(self):
1268
from bzrlib.workingtree import WorkingTreeFormat2
1270
return WorkingTreeFormat2().initialize(self)
1271
except errors.NotLocalUrl:
1272
# Even though we can't access the working tree, we need to
1273
# create its control files.
1274
return WorkingTreeFormat2()._stub_initialize_on_transport(
1275
self.transport, self._control_files._file_mode)
1277
def destroy_workingtree(self):
1278
"""See BzrDir.destroy_workingtree."""
1279
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1281
def destroy_workingtree_metadata(self):
1282
"""See BzrDir.destroy_workingtree_metadata."""
1283
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1286
def get_branch_transport(self, branch_format):
1287
"""See BzrDir.get_branch_transport()."""
1288
if branch_format is None:
1289
return self.transport
1291
branch_format.get_format_string()
1292
except NotImplementedError:
1293
return self.transport
1294
raise errors.IncompatibleFormat(branch_format, self._format)
743
1296
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()
1297
"""See BzrDir.get_repository_transport()."""
1298
if repository_format is None:
1299
return self.transport
1301
repository_format.get_format_string()
1302
except NotImplementedError:
1303
return self.transport
1304
raise errors.IncompatibleFormat(repository_format, self._format)
1306
def get_workingtree_transport(self, workingtree_format):
1307
"""See BzrDir.get_workingtree_transport()."""
1308
if workingtree_format is None:
1309
return self.transport
1311
workingtree_format.get_format_string()
1312
except NotImplementedError:
1313
return self.transport
1314
raise errors.IncompatibleFormat(workingtree_format, self._format)
1316
def needs_format_conversion(self, format=None):
1317
"""See BzrDir.needs_format_conversion()."""
1318
# if the format is not the same as the system default,
1319
# an upgrade is needed.
1321
format = BzrDirFormat.get_default_format()
1322
return not isinstance(self._format, format.__class__)
1324
def open_branch(self, unsupported=False):
1325
"""See BzrDir.open_branch."""
1326
from bzrlib.branch import BzrBranchFormat4
1327
format = BzrBranchFormat4()
1328
self._check_supported(format, unsupported)
1329
return format.open(self, _found=True)
1331
def sprout(self, url, revision_id=None, force_new_repo=False,
1332
possible_transports=None, accelerator_tree=None,
1333
hardlink=False, stacked=False):
1334
"""See BzrDir.sprout()."""
1336
raise errors.UnstackableBranchFormat(
1337
self._format, self.root_transport.base)
1338
from bzrlib.workingtree import WorkingTreeFormat2
1339
self._make_tail(url)
1340
result = self._format._initialize_for_clone(url)
1342
self.open_repository().clone(result, revision_id=revision_id)
1343
except errors.NoRepositoryPresent:
1346
self.open_branch().sprout(result, revision_id=revision_id)
1347
except errors.NotBranchError:
1349
# we always want a working tree
1350
WorkingTreeFormat2().initialize(result,
1351
accelerator_tree=accelerator_tree,
1356
class BzrDir4(BzrDirPreSplitOut):
1357
"""A .bzr version 4 control object.
1359
This is a deprecated format and may be removed after sept 2006.
1362
def create_repository(self, shared=False):
1363
"""See BzrDir.create_repository."""
1364
return self._format.repository_format.initialize(self, shared)
1366
def needs_format_conversion(self, format=None):
1367
"""Format 4 dirs are always in need of conversion."""
1370
def open_repository(self):
1371
"""See BzrDir.open_repository."""
1372
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1373
return RepositoryFormat4().open(self, _found=True)
1376
class BzrDir5(BzrDirPreSplitOut):
1377
"""A .bzr version 5 control object.
1379
This is a deprecated format and may be removed after sept 2006.
1382
def open_repository(self):
1383
"""See BzrDir.open_repository."""
1384
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1385
return RepositoryFormat5().open(self, _found=True)
1387
def open_workingtree(self, _unsupported=False,
1388
recommend_upgrade=True):
1389
"""See BzrDir.create_workingtree."""
1390
from bzrlib.workingtree import WorkingTreeFormat2
1391
wt_format = WorkingTreeFormat2()
1392
# we don't warn here about upgrades; that ought to be handled for the
1394
return wt_format.open(self, _found=True)
1397
class BzrDir6(BzrDirPreSplitOut):
1398
"""A .bzr version 6 control object.
1400
This is a deprecated format and may be removed after sept 2006.
1403
def open_repository(self):
1404
"""See BzrDir.open_repository."""
1405
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1406
return RepositoryFormat6().open(self, _found=True)
1408
def open_workingtree(self, _unsupported=False,
1409
recommend_upgrade=True):
1410
"""See BzrDir.create_workingtree."""
1411
# we don't warn here about upgrades; that ought to be handled for the
1413
from bzrlib.workingtree import WorkingTreeFormat2
1414
return WorkingTreeFormat2().open(self, _found=True)
801
1417
class BzrDirMeta1(BzrDir):
802
1418
"""A .bzr meta version 1 control object.
804
This is the first control object where the
1420
This is the first control object where the
805
1421
individual aspects are really split out: there are separate repository,
806
1422
workingtree and branch subdirectories and any subset of the three can be
807
1423
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
1426
def can_convert_format(self):
857
1427
"""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)
1430
def create_branch(self):
1431
"""See BzrDir.create_branch."""
1432
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,
1434
def destroy_branch(self):
1435
"""See BzrDir.create_branch."""
1436
self.transport.delete_tree('branch')
891
1438
def create_repository(self, shared=False):
892
1439
"""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)
1558
def open_branch(self, unsupported=False):
1559
"""See BzrDir.open_branch."""
1560
format = self.find_branch_format()
1561
self._check_supported(format, unsupported)
1562
return format.open(self, _found=True)
1081
1564
def open_repository(self, unsupported=False):
1082
1565
"""See BzrDir.open_repository."""
1083
from bzrlib.repository import RepositoryFormatMetaDir
1084
format = RepositoryFormatMetaDir.find_format(self)
1085
format.check_support_status(unsupported)
1566
from bzrlib.repository import RepositoryFormat
1567
format = RepositoryFormat.find_format(self)
1568
self._check_supported(format, unsupported)
1086
1569
return format.open(self, _found=True)
1088
1571
def open_workingtree(self, unsupported=False,
1089
1572
recommend_upgrade=True):
1090
1573
"""See BzrDir.open_workingtree."""
1091
from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
format = WorkingTreeFormatMetaDir.find_format(self)
1093
format.check_support_status(unsupported, recommend_upgrade,
1574
from bzrlib.workingtree import WorkingTreeFormat
1575
format = WorkingTreeFormat.find_format(self)
1576
self._check_supported(format, unsupported,
1094
1578
basedir=self.root_transport.base)
1095
1579
return format.open(self, _found=True)
1097
1581
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
1582
return config.BzrDirConfig(self.transport)
1585
class BzrDirFormat(object):
1586
"""An encapsulation of the initialization and open routines for a format.
1588
Formats provide three things:
1589
* An initialization routine,
1593
Formats are placed in a dict by their format string for reference
1301
1594
during bzrdir opening. These should be subclasses of BzrDirFormat
1302
1595
for consistency.
1304
1597
Once a format is deprecated, just deprecate the initialize and open
1305
methods on the format class. Do not deprecate the object, as the
1598
methods on the format class. Do not deprecate the object, as the
1306
1599
object will be created every system load.
1602
_default_format = None
1603
"""The default format used for new .bzr dirs."""
1606
"""The known formats."""
1608
_control_formats = []
1609
"""The registered control formats - .bzr, ....
1611
This is a list of BzrDirFormat objects.
1614
_control_server_formats = []
1615
"""The registered control server formats, e.g. RemoteBzrDirs.
1617
This is a list of BzrDirFormat objects.
1309
1620
_lock_file_name = 'branch-lock'
1311
1622
# _lock_class must be set in subclasses to the lock type, typ.
1312
1623
# TransportLock or LockDir
1626
def find_format(klass, transport, _server_formats=True):
1627
"""Return the format present at transport."""
1629
formats = klass._control_server_formats + klass._control_formats
1631
formats = klass._control_formats
1632
for format in formats:
1634
return format.probe_transport(transport)
1635
except errors.NotBranchError:
1636
# this format does not find a control dir here.
1638
raise errors.NotBranchError(path=transport.base)
1641
def probe_transport(klass, transport):
1642
"""Return the .bzrdir style format present in a directory."""
1644
format_string = transport.get(".bzr/branch-format").read()
1645
except errors.NoSuchFile:
1646
raise errors.NotBranchError(path=transport.base)
1649
return klass._formats[format_string]
1651
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1654
def get_default_format(klass):
1655
"""Return the current default format."""
1656
return klass._default_format
1658
def get_format_string(self):
1659
"""Return the ASCII format string that identifies this format."""
1660
raise NotImplementedError(self.get_format_string)
1662
def get_format_description(self):
1663
"""Return the short description for this format."""
1664
raise NotImplementedError(self.get_format_description)
1666
def get_converter(self, format=None):
1667
"""Return the converter to use to convert bzrdirs needing converts.
1669
This returns a bzrlib.bzrdir.Converter object.
1671
This should return the best upgrader to step this format towards the
1672
current default format. In the case of plugins we can/should provide
1673
some means for them to extend the range of returnable converters.
1675
:param format: Optional format to override the default format of the
1678
raise NotImplementedError(self.get_converter)
1680
def initialize(self, url, possible_transports=None):
1681
"""Create a bzr control dir at this url and return an opened copy.
1683
Subclasses should typically override initialize_on_transport
1684
instead of this method.
1686
return self.initialize_on_transport(get_transport(url,
1687
possible_transports))
1314
1689
def initialize_on_transport(self, transport):
1315
1690
"""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
1691
# Since we don't have a .bzr directory, inherit the
1438
1692
# mode from the root directory
1439
1693
temp_control = lockable_files.LockableFiles(transport,
1440
1694
'', 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):
1695
temp_control._transport.mkdir('.bzr',
1696
# FIXME: RBC 20060121 don't peek under
1698
mode=temp_control._dir_mode)
1699
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1449
1700
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1450
1701
file_mode = temp_control._file_mode
1451
1702
del temp_control
1494
1774
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)
1777
def register_format(klass, format):
1778
klass._formats[format.get_format_string()] = format
1781
def register_control_format(klass, format):
1782
"""Register a format that does not use '.bzr' for its control dir.
1784
TODO: This should be pulled up into a 'ControlDirFormat' base class
1785
which BzrDirFormat can inherit from, and renamed to register_format
1786
there. It has been done without that for now for simplicity of
1789
klass._control_formats.append(format)
1792
def register_control_server_format(klass, format):
1793
"""Register a control format for client-server environments.
1795
These formats will be tried before ones registered with
1796
register_control_format. This gives implementations that decide to the
1797
chance to grab it before anything looks at the contents of the format
1800
klass._control_server_formats.append(format)
1803
def _set_default_format(klass, format):
1804
"""Set default format (for testing behavior of defaults only)"""
1805
klass._default_format = format
1809
return self.get_format_string().rstrip()
1812
def unregister_format(klass, format):
1813
del klass._formats[format.get_format_string()]
1816
def unregister_control_format(klass, format):
1817
klass._control_formats.remove(format)
1820
class BzrDirFormat4(BzrDirFormat):
1821
"""Bzr dir format 4.
1823
This format is a combined format for working tree, branch and repository.
1825
- Format 1 working trees [always]
1826
- Format 4 branches [always]
1827
- Format 4 repositories [always]
1829
This format is deprecated: it indexes texts using a text it which is
1830
removed in format 5; write support for this format has been removed.
1833
_lock_class = lockable_files.TransportLock
1835
def get_format_string(self):
1836
"""See BzrDirFormat.get_format_string()."""
1837
return "Bazaar-NG branch, format 0.0.4\n"
1839
def get_format_description(self):
1840
"""See BzrDirFormat.get_format_description()."""
1841
return "All-in-one format 4"
1843
def get_converter(self, format=None):
1844
"""See BzrDirFormat.get_converter()."""
1845
# there is one and only one upgrade path here.
1846
return ConvertBzrDir4To5()
1848
def initialize_on_transport(self, transport):
1849
"""Format 4 branches cannot be created."""
1850
raise errors.UninitializableFormat(self)
1852
def is_supported(self):
1853
"""Format 4 is not supported.
1855
It is not supported because the model changed from 4 to 5 and the
1856
conversion logic is expensive - so doing it on the fly was not
1861
def _open(self, transport):
1862
"""See BzrDirFormat._open."""
1863
return BzrDir4(transport, self)
1865
def __return_repository_format(self):
1866
"""Circular import protection."""
1867
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1868
return RepositoryFormat4()
1869
repository_format = property(__return_repository_format)
1872
class BzrDirFormat5(BzrDirFormat):
1873
"""Bzr control format 5.
1875
This format is a combined format for working tree, branch and repository.
1877
- Format 2 working trees [always]
1878
- Format 4 branches [always]
1879
- Format 5 repositories [always]
1880
Unhashed stores in the repository.
1883
_lock_class = lockable_files.TransportLock
1885
def get_format_string(self):
1886
"""See BzrDirFormat.get_format_string()."""
1887
return "Bazaar-NG branch, format 5\n"
1889
def get_branch_format(self):
1890
from bzrlib import branch
1891
return branch.BzrBranchFormat4()
1893
def get_format_description(self):
1894
"""See BzrDirFormat.get_format_description()."""
1895
return "All-in-one format 5"
1897
def get_converter(self, format=None):
1898
"""See BzrDirFormat.get_converter()."""
1899
# there is one and only one upgrade path here.
1900
return ConvertBzrDir5To6()
1902
def _initialize_for_clone(self, url):
1903
return self.initialize_on_transport(get_transport(url), _cloning=True)
1905
def initialize_on_transport(self, transport, _cloning=False):
1906
"""Format 5 dirs always have working tree, branch and repository.
1908
Except when they are being cloned.
1910
from bzrlib.branch import BzrBranchFormat4
1911
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1912
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1913
RepositoryFormat5().initialize(result, _internal=True)
1915
branch = BzrBranchFormat4().initialize(result)
1916
result._init_workingtree()
1919
def _open(self, transport):
1920
"""See BzrDirFormat._open."""
1921
return BzrDir5(transport, self)
1923
def __return_repository_format(self):
1924
"""Circular import protection."""
1925
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1926
return RepositoryFormat5()
1927
repository_format = property(__return_repository_format)
1930
class BzrDirFormat6(BzrDirFormat):
1931
"""Bzr control format 6.
1933
This format is a combined format for working tree, branch and repository.
1935
- Format 2 working trees [always]
1936
- Format 4 branches [always]
1937
- Format 6 repositories [always]
1940
_lock_class = lockable_files.TransportLock
1942
def get_format_string(self):
1943
"""See BzrDirFormat.get_format_string()."""
1944
return "Bazaar-NG branch, format 6\n"
1946
def get_format_description(self):
1947
"""See BzrDirFormat.get_format_description()."""
1948
return "All-in-one format 6"
1950
def get_branch_format(self):
1951
from bzrlib import branch
1952
return branch.BzrBranchFormat4()
1954
def get_converter(self, format=None):
1955
"""See BzrDirFormat.get_converter()."""
1956
# there is one and only one upgrade path here.
1957
return ConvertBzrDir6ToMeta()
1959
def _initialize_for_clone(self, url):
1960
return self.initialize_on_transport(get_transport(url), _cloning=True)
1962
def initialize_on_transport(self, transport, _cloning=False):
1963
"""Format 6 dirs always have working tree, branch and repository.
1965
Except when they are being cloned.
1967
from bzrlib.branch import BzrBranchFormat4
1968
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1969
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1970
RepositoryFormat6().initialize(result, _internal=True)
1972
branch = BzrBranchFormat4().initialize(result)
1973
result._init_workingtree()
1976
def _open(self, transport):
1977
"""See BzrDirFormat._open."""
1978
return BzrDir6(transport, self)
1980
def __return_repository_format(self):
1981
"""Circular import protection."""
1982
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1983
return RepositoryFormat6()
1984
repository_format = property(__return_repository_format)
1522
1987
class BzrDirMetaFormat1(BzrDirFormat):
1561
2016
def get_branch_format(self):
1562
2017
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()
2018
from bzrlib.branch import BranchFormat
2019
self._branch_format = BranchFormat.get_default_format()
1565
2020
return self._branch_format
1567
2022
def set_branch_format(self, format):
1568
2023
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
2025
def get_converter(self, format=None):
1664
2026
"""See BzrDirFormat.get_converter()."""
1665
2027
if format is None:
1666
2028
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
2029
if not isinstance(self, format.__class__):
1674
2030
# converting away from metadir is not implemented
1675
2031
raise NotImplementedError(self.get_converter)
1676
2032
return ConvertMetaToMeta(format)
1679
def get_format_string(cls):
2034
def get_format_string(self):
1680
2035
"""See BzrDirFormat.get_format_string()."""
1681
2036
return "Bazaar-NG meta directory, format 1\n"
1687
2042
def _open(self, transport):
1688
2043
"""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)
2044
return BzrDirMeta1(transport, self)
1696
2046
def __return_repository_format(self):
1697
2047
"""Circular import protection."""
1698
if self._repository_format:
2048
if getattr(self, '_repository_format', None):
1699
2049
return self._repository_format
1700
from bzrlib.repository import format_registry
1701
return format_registry.get_default()
2050
from bzrlib.repository import RepositoryFormat
2051
return RepositoryFormat.get_default_format()
1703
def _set_repository_format(self, value):
2053
def __set_repository_format(self, value):
1704
2054
"""Allow changing the repository format for metadir formats."""
1705
2055
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
2057
repository_format = property(__return_repository_format, __set_repository_format)
1729
2059
def __get_workingtree_format(self):
1730
2060
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()
2061
from bzrlib.workingtree import WorkingTreeFormat
2062
self._workingtree_format = WorkingTreeFormat.get_default_format()
1735
2063
return self._workingtree_format
1737
2065
def __set_workingtree_format(self, wt_format):
1738
2066
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
1743
2068
workingtree_format = property(__get_workingtree_format,
1744
2069
__set_workingtree_format)
2072
# Register bzr control format
2073
BzrDirFormat.register_control_format(BzrDirFormat)
1747
2075
# 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):
2076
BzrDirFormat.register_format(BzrDirFormat4())
2077
BzrDirFormat.register_format(BzrDirFormat5())
2078
BzrDirFormat.register_format(BzrDirFormat6())
2079
__default_format = BzrDirMetaFormat1()
2080
BzrDirFormat.register_format(__default_format)
2081
BzrDirFormat._default_format = __default_format
2084
class Converter(object):
2085
"""Converts a disk format object from one format to another."""
2087
def convert(self, to_convert, pb):
2088
"""Perform the conversion of to_convert, giving feedback via pb.
2090
:param to_convert: The disk object to convert.
2091
:param pb: a progress bar to use for progress information.
2094
def step(self, message):
2095
"""Update the pb by a step."""
2097
self.pb.update(message, self.count, self.total)
2100
class ConvertBzrDir4To5(Converter):
2101
"""Converts format 4 bzr dirs to format 5."""
2104
super(ConvertBzrDir4To5, self).__init__()
2105
self.converted_revs = set()
2106
self.absent_revisions = set()
2110
def convert(self, to_convert, pb):
2111
"""See Converter.convert()."""
2112
self.bzrdir = to_convert
2114
self.pb.note('starting upgrade from format 4 to 5')
2115
if isinstance(self.bzrdir.transport, LocalTransport):
2116
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2117
self._convert_to_weaves()
2118
return BzrDir.open(self.bzrdir.root_transport.base)
2120
def _convert_to_weaves(self):
2121
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2124
stat = self.bzrdir.transport.stat('weaves')
2125
if not S_ISDIR(stat.st_mode):
2126
self.bzrdir.transport.delete('weaves')
2127
self.bzrdir.transport.mkdir('weaves')
2128
except errors.NoSuchFile:
2129
self.bzrdir.transport.mkdir('weaves')
2130
# deliberately not a WeaveFile as we want to build it up slowly.
2131
self.inv_weave = Weave('inventory')
2132
# holds in-memory weaves for all files
2133
self.text_weaves = {}
2134
self.bzrdir.transport.delete('branch-format')
2135
self.branch = self.bzrdir.open_branch()
2136
self._convert_working_inv()
2137
rev_history = self.branch.revision_history()
2138
# to_read is a stack holding the revisions we still need to process;
2139
# appending to it adds new highest-priority revisions
2140
self.known_revisions = set(rev_history)
2141
self.to_read = rev_history[-1:]
2143
rev_id = self.to_read.pop()
2144
if (rev_id not in self.revisions
2145
and rev_id not in self.absent_revisions):
2146
self._load_one_rev(rev_id)
2148
to_import = self._make_order()
2149
for i, rev_id in enumerate(to_import):
2150
self.pb.update('converting revision', i, len(to_import))
2151
self._convert_one_rev(rev_id)
2153
self._write_all_weaves()
2154
self._write_all_revs()
2155
self.pb.note('upgraded to weaves:')
2156
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2157
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2158
self.pb.note(' %6d texts', self.text_count)
2159
self._cleanup_spare_files_after_format4()
2160
self.branch._transport.put_bytes(
2162
BzrDirFormat5().get_format_string(),
2163
mode=self.bzrdir._get_file_mode())
2165
def _cleanup_spare_files_after_format4(self):
2166
# FIXME working tree upgrade foo.
2167
for n in 'merged-patches', 'pending-merged-patches':
2169
## assert os.path.getsize(p) == 0
2170
self.bzrdir.transport.delete(n)
2171
except errors.NoSuchFile:
2173
self.bzrdir.transport.delete_tree('inventory-store')
2174
self.bzrdir.transport.delete_tree('text-store')
2176
def _convert_working_inv(self):
2177
inv = xml4.serializer_v4.read_inventory(
2178
self.branch._transport.get('inventory'))
2179
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2180
self.branch._transport.put_bytes('inventory', new_inv_xml,
2181
mode=self.bzrdir._get_file_mode())
2183
def _write_all_weaves(self):
2184
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2185
weave_transport = self.bzrdir.transport.clone('weaves')
2186
weaves = WeaveStore(weave_transport, prefixed=False)
2187
transaction = WriteTransaction()
2191
for file_id, file_weave in self.text_weaves.items():
2192
self.pb.update('writing weave', i, len(self.text_weaves))
2193
weaves._put_weave(file_id, file_weave, transaction)
2195
self.pb.update('inventory', 0, 1)
2196
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2197
self.pb.update('inventory', 1, 1)
2201
def _write_all_revs(self):
2202
"""Write all revisions out in new form."""
2203
self.bzrdir.transport.delete_tree('revision-store')
2204
self.bzrdir.transport.mkdir('revision-store')
2205
revision_transport = self.bzrdir.transport.clone('revision-store')
2207
from bzrlib.xml5 import serializer_v5
2208
from bzrlib.repofmt.weaverepo import RevisionTextStore
2209
revision_store = RevisionTextStore(revision_transport,
2210
serializer_v5, False, versionedfile.PrefixMapper(),
2211
lambda:True, lambda:True)
2213
for i, rev_id in enumerate(self.converted_revs):
2214
self.pb.update('write revision', i, len(self.converted_revs))
2215
text = serializer_v5.write_revision_to_string(
2216
self.revisions[rev_id])
2218
revision_store.add_lines(key, None, osutils.split_lines(text))
2222
def _load_one_rev(self, rev_id):
2223
"""Load a revision object into memory.
2225
Any parents not either loaded or abandoned get queued to be
2227
self.pb.update('loading revision',
2228
len(self.revisions),
2229
len(self.known_revisions))
2230
if not self.branch.repository.has_revision(rev_id):
2232
self.pb.note('revision {%s} not present in branch; '
2233
'will be converted as a ghost',
2235
self.absent_revisions.add(rev_id)
2237
rev = self.branch.repository.get_revision(rev_id)
2238
for parent_id in rev.parent_ids:
2239
self.known_revisions.add(parent_id)
2240
self.to_read.append(parent_id)
2241
self.revisions[rev_id] = rev
2243
def _load_old_inventory(self, rev_id):
2244
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2245
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2246
inv.revision_id = rev_id
2247
rev = self.revisions[rev_id]
2250
def _load_updated_inventory(self, rev_id):
2251
inv_xml = self.inv_weave.get_text(rev_id)
2252
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2255
def _convert_one_rev(self, rev_id):
2256
"""Convert revision and all referenced objects to new format."""
2257
rev = self.revisions[rev_id]
2258
inv = self._load_old_inventory(rev_id)
2259
present_parents = [p for p in rev.parent_ids
2260
if p not in self.absent_revisions]
2261
self._convert_revision_contents(rev, inv, present_parents)
2262
self._store_new_inv(rev, inv, present_parents)
2263
self.converted_revs.add(rev_id)
2265
def _store_new_inv(self, rev, inv, present_parents):
2266
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2267
new_inv_sha1 = sha_string(new_inv_xml)
2268
self.inv_weave.add_lines(rev.revision_id,
2270
new_inv_xml.splitlines(True))
2271
rev.inventory_sha1 = new_inv_sha1
2273
def _convert_revision_contents(self, rev, inv, present_parents):
2274
"""Convert all the files within a revision.
2276
Also upgrade the inventory to refer to the text revision ids."""
2277
rev_id = rev.revision_id
2278
mutter('converting texts of revision {%s}',
2280
parent_invs = map(self._load_updated_inventory, present_parents)
2281
entries = inv.iter_entries()
2283
for path, ie in entries:
2284
self._convert_file_version(rev, ie, parent_invs)
2286
def _convert_file_version(self, rev, ie, parent_invs):
2287
"""Convert one version of one file.
2289
The file needs to be added into the weave if it is a merge
2290
of >=2 parents or if it's changed from its parent.
2292
file_id = ie.file_id
2293
rev_id = rev.revision_id
2294
w = self.text_weaves.get(file_id)
2297
self.text_weaves[file_id] = w
2298
text_changed = False
2299
parent_candiate_entries = ie.parent_candidates(parent_invs)
2300
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2301
# XXX: Note that this is unordered - and this is tolerable because
2302
# the previous code was also unordered.
2303
previous_entries = dict((head, parent_candiate_entries[head]) for head
2305
self.snapshot_ie(previous_entries, ie, w, rev_id)
2308
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2309
def get_parents(self, revision_ids):
2310
for revision_id in revision_ids:
2311
yield self.revisions[revision_id].parent_ids
2313
def get_parent_map(self, revision_ids):
2314
"""See graph._StackedParentsProvider.get_parent_map"""
2315
return dict((revision_id, self.revisions[revision_id])
2316
for revision_id in revision_ids
2317
if revision_id in self.revisions)
2319
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2320
# TODO: convert this logic, which is ~= snapshot to
2321
# a call to:. This needs the path figured out. rather than a work_tree
2322
# a v4 revision_tree can be given, or something that looks enough like
2323
# one to give the file content to the entry if it needs it.
2324
# and we need something that looks like a weave store for snapshot to
2326
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2327
if len(previous_revisions) == 1:
2328
previous_ie = previous_revisions.values()[0]
2329
if ie._unchanged(previous_ie):
2330
ie.revision = previous_ie.revision
2333
text = self.branch.repository._text_store.get(ie.text_id)
2334
file_lines = text.readlines()
2335
w.add_lines(rev_id, previous_revisions, file_lines)
2336
self.text_count += 1
2338
w.add_lines(rev_id, previous_revisions, [])
2339
ie.revision = rev_id
2341
def _make_order(self):
2342
"""Return a suitable order for importing revisions.
2344
The order must be such that an revision is imported after all
2345
its (present) parents.
2347
todo = set(self.revisions.keys())
2348
done = self.absent_revisions.copy()
2351
# scan through looking for a revision whose parents
2353
for rev_id in sorted(list(todo)):
2354
rev = self.revisions[rev_id]
2355
parent_ids = set(rev.parent_ids)
2356
if parent_ids.issubset(done):
2357
# can take this one now
2358
order.append(rev_id)
2364
class ConvertBzrDir5To6(Converter):
2365
"""Converts format 5 bzr dirs to format 6."""
2367
def convert(self, to_convert, pb):
2368
"""See Converter.convert()."""
2369
self.bzrdir = to_convert
2371
self.pb.note('starting upgrade from format 5 to 6')
2372
self._convert_to_prefixed()
2373
return BzrDir.open(self.bzrdir.root_transport.base)
2375
def _convert_to_prefixed(self):
2376
from bzrlib.store import TransportStore
2377
self.bzrdir.transport.delete('branch-format')
2378
for store_name in ["weaves", "revision-store"]:
2379
self.pb.note("adding prefixes to %s" % store_name)
2380
store_transport = self.bzrdir.transport.clone(store_name)
2381
store = TransportStore(store_transport, prefixed=True)
2382
for urlfilename in store_transport.list_dir('.'):
2383
filename = urlutils.unescape(urlfilename)
2384
if (filename.endswith(".weave") or
2385
filename.endswith(".gz") or
2386
filename.endswith(".sig")):
2387
file_id, suffix = os.path.splitext(filename)
2391
new_name = store._mapper.map((file_id,)) + suffix
2392
# FIXME keep track of the dirs made RBC 20060121
2394
store_transport.move(filename, new_name)
2395
except errors.NoSuchFile: # catches missing dirs strangely enough
2396
store_transport.mkdir(osutils.dirname(new_name))
2397
store_transport.move(filename, new_name)
2398
self.bzrdir.transport.put_bytes(
2400
BzrDirFormat6().get_format_string(),
2401
mode=self.bzrdir._get_file_mode())
2404
class ConvertBzrDir6ToMeta(Converter):
2405
"""Converts format 6 bzr dirs to metadirs."""
2407
def convert(self, to_convert, pb):
2408
"""See Converter.convert()."""
2409
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2410
from bzrlib.branch import BzrBranchFormat5
2411
self.bzrdir = to_convert
2414
self.total = 20 # the steps we know about
2415
self.garbage_inventories = []
2416
self.dir_mode = self.bzrdir._get_dir_mode()
2417
self.file_mode = self.bzrdir._get_file_mode()
2419
self.pb.note('starting upgrade from format 6 to metadir')
2420
self.bzrdir.transport.put_bytes(
2422
"Converting to format 6",
2423
mode=self.file_mode)
2424
# its faster to move specific files around than to open and use the apis...
2425
# first off, nuke ancestry.weave, it was never used.
2427
self.step('Removing ancestry.weave')
2428
self.bzrdir.transport.delete('ancestry.weave')
2429
except errors.NoSuchFile:
2431
# find out whats there
2432
self.step('Finding branch files')
2433
last_revision = self.bzrdir.open_branch().last_revision()
2434
bzrcontents = self.bzrdir.transport.list_dir('.')
2435
for name in bzrcontents:
2436
if name.startswith('basis-inventory.'):
2437
self.garbage_inventories.append(name)
2438
# create new directories for repository, working tree and branch
2439
repository_names = [('inventory.weave', True),
2440
('revision-store', True),
2442
self.step('Upgrading repository ')
2443
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2444
self.make_lock('repository')
2445
# we hard code the formats here because we are converting into
2446
# the meta format. The meta format upgrader can take this to a
2447
# future format within each component.
2448
self.put_format('repository', RepositoryFormat7())
2449
for entry in repository_names:
2450
self.move_entry('repository', entry)
2452
self.step('Upgrading branch ')
2453
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2454
self.make_lock('branch')
2455
self.put_format('branch', BzrBranchFormat5())
2456
branch_files = [('revision-history', True),
2457
('branch-name', True),
2459
for entry in branch_files:
2460
self.move_entry('branch', entry)
2462
checkout_files = [('pending-merges', True),
2463
('inventory', True),
2464
('stat-cache', False)]
2465
# If a mandatory checkout file is not present, the branch does not have
2466
# a functional checkout. Do not create a checkout in the converted
2468
for name, mandatory in checkout_files:
2469
if mandatory and name not in bzrcontents:
2470
has_checkout = False
2474
if not has_checkout:
2475
self.pb.note('No working tree.')
2476
# If some checkout files are there, we may as well get rid of them.
2477
for name, mandatory in checkout_files:
2478
if name in bzrcontents:
2479
self.bzrdir.transport.delete(name)
2481
from bzrlib.workingtree import WorkingTreeFormat3
2482
self.step('Upgrading working tree')
2483
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2484
self.make_lock('checkout')
2486
'checkout', WorkingTreeFormat3())
2487
self.bzrdir.transport.delete_multi(
2488
self.garbage_inventories, self.pb)
2489
for entry in checkout_files:
2490
self.move_entry('checkout', entry)
2491
if last_revision is not None:
2492
self.bzrdir.transport.put_bytes(
2493
'checkout/last-revision', last_revision)
2494
self.bzrdir.transport.put_bytes(
2496
BzrDirMetaFormat1().get_format_string(),
2497
mode=self.file_mode)
2498
return BzrDir.open(self.bzrdir.root_transport.base)
2500
def make_lock(self, name):
2501
"""Make a lock for the new control dir name."""
2502
self.step('Make %s lock' % name)
2503
ld = lockdir.LockDir(self.bzrdir.transport,
2505
file_modebits=self.file_mode,
2506
dir_modebits=self.dir_mode)
2509
def move_entry(self, new_dir, entry):
2510
"""Move then entry name into new_dir."""
2512
mandatory = entry[1]
2513
self.step('Moving %s' % name)
2515
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2516
except errors.NoSuchFile:
2520
def put_format(self, dirname, format):
2521
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2522
format.get_format_string(),
2526
class ConvertMetaToMeta(Converter):
1782
2527
"""Converts the components of metadirs."""
1784
2529
def __init__(self, target_format):
1838
2582
# TODO: conversions of Branch and Tree should be done by
1839
2583
# InterXFormat lookups
1840
if (isinstance(tree, workingtree_3.WorkingTree3) and
1841
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2584
if (isinstance(tree, workingtree.WorkingTree3) and
2585
not isinstance(tree, workingtree_4.WorkingTree4) and
1842
2586
isinstance(self.target_format.workingtree_format,
1843
workingtree_4.DirStateWorkingTreeFormat)):
2587
workingtree_4.WorkingTreeFormat4)):
1844
2588
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
2589
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)
2592
# This is not in remote.py because it's small, and needs to be registered.
2593
# Putting it in remote.py creates a circular import problem.
2594
# we can make it a lazy object if the control formats is turned into something
2596
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2597
"""Format representing bzrdirs accessed via a smart server"""
2599
def get_format_description(self):
2600
return 'bzr remote bzrdir'
2603
def probe_transport(klass, transport):
2604
"""Return a RemoteBzrDirFormat object if it looks possible."""
2606
medium = transport.get_smart_medium()
2607
except (NotImplementedError, AttributeError,
2608
errors.TransportNotPossible, errors.NoSmartMedium,
2609
errors.SmartProtocolError):
2610
# no smart server, so not a branch for this format type.
2611
raise errors.NotBranchError(path=transport.base)
2613
# Decline to open it if the server doesn't support our required
2614
# version (3) so that the VFS-based transport will do it.
2615
if medium.should_probe():
2617
server_version = medium.protocol_version()
2618
except errors.SmartProtocolError:
2619
# Apparently there's no usable smart server there, even though
2620
# the medium supports the smart protocol.
2621
raise errors.NotBranchError(path=transport.base)
2622
if server_version != '2':
2623
raise errors.NotBranchError(path=transport.base)
2626
def initialize_on_transport(self, transport):
2628
# hand off the request to the smart server
2629
client_medium = transport.get_smart_medium()
2630
except errors.NoSmartMedium:
2631
# TODO: lookup the local format from a server hint.
2632
local_dir_format = BzrDirMetaFormat1()
2633
return local_dir_format.initialize_on_transport(transport)
2634
client = _SmartClient(client_medium)
2635
path = client.remote_path_from_transport(transport)
2636
response = client.call('BzrDirFormat.initialize', path)
2637
if response[0] != 'ok':
2638
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2639
return remote.RemoteBzrDir(transport)
2641
def _open(self, transport):
2642
return remote.RemoteBzrDir(transport)
2644
def __eq__(self, other):
2645
if not isinstance(other, RemoteBzrDirFormat):
2647
return self.get_format_description() == other.get_format_description()
2650
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2653
class BzrDirFormatInfo(object):
2655
def __init__(self, native, deprecated, hidden, experimental):
2656
self.deprecated = deprecated
2657
self.native = native
2658
self.hidden = hidden
2659
self.experimental = experimental
2662
class BzrDirFormatRegistry(registry.Registry):
2663
"""Registry of user-selectable BzrDir subformats.
2665
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2666
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2670
"""Create a BzrDirFormatRegistry."""
2671
self._aliases = set()
2672
super(BzrDirFormatRegistry, self).__init__()
2675
"""Return a set of the format names which are aliases."""
2676
return frozenset(self._aliases)
2678
def register_metadir(self, key,
2679
repository_format, help, native=True, deprecated=False,
2685
"""Register a metadir subformat.
2687
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2688
by the Repository format.
2690
:param repository_format: The fully-qualified repository format class
2692
:param branch_format: Fully-qualified branch format class name as
2694
:param tree_format: Fully-qualified tree format class name as
2697
# This should be expanded to support setting WorkingTree and Branch
2698
# formats, once BzrDirMetaFormat1 supports that.
2699
def _load(full_name):
2700
mod_name, factory_name = full_name.rsplit('.', 1)
2702
mod = __import__(mod_name, globals(), locals(),
2704
except ImportError, e:
2705
raise ImportError('failed to load %s: %s' % (full_name, e))
2707
factory = getattr(mod, factory_name)
2708
except AttributeError:
2709
raise AttributeError('no factory %s in module %r'
2714
bd = BzrDirMetaFormat1()
2715
if branch_format is not None:
2716
bd.set_branch_format(_load(branch_format))
2717
if tree_format is not None:
2718
bd.workingtree_format = _load(tree_format)
2719
if repository_format is not None:
2720
bd.repository_format = _load(repository_format)
2722
self.register(key, helper, help, native, deprecated, hidden,
2723
experimental, alias)
2725
def register(self, key, factory, help, native=True, deprecated=False,
2726
hidden=False, experimental=False, alias=False):
2727
"""Register a BzrDirFormat factory.
2729
The factory must be a callable that takes one parameter: the key.
2730
It must produce an instance of the BzrDirFormat when called.
2732
This function mainly exists to prevent the info object from being
2735
registry.Registry.register(self, key, factory, help,
2736
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2738
self._aliases.add(key)
2740
def register_lazy(self, key, module_name, member_name, help, native=True,
2741
deprecated=False, hidden=False, experimental=False, alias=False):
2742
registry.Registry.register_lazy(self, key, module_name, member_name,
2743
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2745
self._aliases.add(key)
2747
def set_default(self, key):
2748
"""Set the 'default' key to be a clone of the supplied key.
2750
This method must be called once and only once.
2752
registry.Registry.register(self, 'default', self.get(key),
2753
self.get_help(key), info=self.get_info(key))
2754
self._aliases.add('default')
2756
def set_default_repository(self, key):
2757
"""Set the FormatRegistry default and Repository default.
2759
This is a transitional method while Repository.set_default_format
2762
if 'default' in self:
2763
self.remove('default')
2764
self.set_default(key)
2765
format = self.get('default')()
2767
def make_bzrdir(self, key):
2768
return self.get(key)()
2770
def help_topic(self, topic):
2771
output = textwrap.dedent("""\
2772
These formats can be used for creating branches, working trees, and
2776
default_realkey = None
2777
default_help = self.get_help('default')
2779
for key in self.keys():
2780
if key == 'default':
2782
help = self.get_help(key)
2783
if help == default_help:
2784
default_realkey = key
2786
help_pairs.append((key, help))
2788
def wrapped(key, help, info):
2790
help = '(native) ' + help
2791
return ':%s:\n%s\n\n' % (key,
2792
textwrap.fill(help, initial_indent=' ',
2793
subsequent_indent=' '))
2794
if default_realkey is not None:
2795
output += wrapped(default_realkey, '(default) %s' % default_help,
2796
self.get_info('default'))
2797
deprecated_pairs = []
2798
experimental_pairs = []
2799
for key, help in help_pairs:
2800
info = self.get_info(key)
2803
elif info.deprecated:
2804
deprecated_pairs.append((key, help))
2805
elif info.experimental:
2806
experimental_pairs.append((key, help))
2808
output += wrapped(key, help, info)
2809
if len(experimental_pairs) > 0:
2810
output += "Experimental formats are shown below.\n\n"
2811
for key, help in experimental_pairs:
2812
info = self.get_info(key)
2813
output += wrapped(key, help, info)
2814
if len(deprecated_pairs) > 0:
2815
output += "Deprecated formats are shown below.\n\n"
2816
for key, help in deprecated_pairs:
2817
info = self.get_info(key)
2818
output += wrapped(key, help, info)
1897
2823
class RepositoryAcquisitionPolicy(object):
2049
2943
require_stacking)
2050
2944
self._repository = repository
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
2946
def acquire_repository(self, make_working_trees=None, shared=False):
2054
2947
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2056
Returns an existing repository to use.
2949
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',
2951
self._add_fallback(self._repository)
2952
return self._repository
2955
format_registry = BzrDirFormatRegistry()
2956
format_registry.register('weave', BzrDirFormat6,
2957
'Pre-0.8 format. Slower than knit and does not'
2958
' support checkouts or shared repositories.',
2960
format_registry.register_metadir('knit',
2115
2961
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
2962
'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.',
2963
branch_format='bzrlib.branch.BzrBranchFormat5',
2964
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2965
format_registry.register_metadir('metaweave',
2966
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2967
'Transitional format in 0.8. Slower than knit.',
2968
branch_format='bzrlib.branch.BzrBranchFormat5',
2969
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2971
format_registry.register_metadir('dirstate',
2972
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2973
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2974
'above when accessed over the network.',
2975
branch_format='bzrlib.branch.BzrBranchFormat5',
2976
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2977
# directly from workingtree_4 triggers a circular import.
2978
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2980
format_registry.register_metadir('dirstate-tags',
2981
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2982
help='New in 0.15: Fast local operations and improved scaling for '
2983
'network operations. Additionally adds support for tags.'
2984
' Incompatible with bzr < 0.15.',
2134
2985
branch_format='bzrlib.branch.BzrBranchFormat6',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
register_metadir(controldir.format_registry, 'rich-root',
2986
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2988
format_registry.register_metadir('rich-root',
2139
2989
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
2990
help='New in 1.0. Better handling of tree roots. Incompatible with'
2142
2992
branch_format='bzrlib.branch.BzrBranchFormat6',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2993
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2995
format_registry.register_metadir('dirstate-with-subtree',
2147
2996
'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',
2997
help='New in 0.15: Fast local operations and improved scaling for '
2998
'network operations. Additionally adds support for versioning nested '
2999
'bzr branches. Incompatible with bzr < 0.15.',
3000
branch_format='bzrlib.branch.BzrBranchFormat6',
3001
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3005
format_registry.register_metadir('pack-0.92',
3006
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3007
help='New in 0.92: Pack-based format with data compatible with '
3008
'dirstate-tags format repositories. Interoperates with '
3009
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3010
'Previously called knitpack-experimental. '
3011
'For more information, see '
3012
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3013
branch_format='bzrlib.branch.BzrBranchFormat6',
3014
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3016
format_registry.register_metadir('pack-0.92-subtree',
3017
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3018
help='New in 0.92: Pack-based format with data compatible with '
3019
'dirstate-with-subtree format repositories. Interoperates with '
3020
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3021
'Previously called knitpack-experimental. '
3022
'For more information, see '
3023
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3024
branch_format='bzrlib.branch.BzrBranchFormat6',
3025
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3029
format_registry.register_metadir('rich-root-pack',
3030
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3031
help='New in 1.0: Pack-based format with data compatible with '
3032
'rich-root format repositories. Incompatible with'
3034
branch_format='bzrlib.branch.BzrBranchFormat6',
3035
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3037
format_registry.register_metadir('1.6',
3038
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3039
help='A branch and pack based repository that supports stacking. ',
3040
branch_format='bzrlib.branch.BzrBranchFormat7',
3041
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3043
format_registry.register_metadir('1.6.1-rich-root',
3044
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3045
help='A branch and pack based repository that supports stacking '
3046
'and rich root data (needed for bzr-svn). ',
3047
branch_format='bzrlib.branch.BzrBranchFormat7',
3048
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3050
# The following two formats should always just be aliases.
3051
format_registry.register_metadir('development',
3052
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3053
help='Current development format. Can convert data to and from pack-0.92 '
3054
'(and anything compatible with pack-0.92) format repositories. '
3055
'Repositories and branches in this format can only be read by bzr.dev. '
3057
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3059
branch_format='bzrlib.branch.BzrBranchFormat7',
3060
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3064
format_registry.register_metadir('development-subtree',
3065
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
2244
3066
help='Current development format, subtree variant. Can convert data to and '
2245
3067
'from pack-0.92-subtree (and anything compatible with '
2246
3068
'pack-0.92-subtree) format repositories. Repositories and branches in '
2247
3069
'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',
3070
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3072
branch_format='bzrlib.branch.BzrBranchFormat7',
3073
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3077
# And the development formats which the will have aliased one of follow:
3078
format_registry.register_metadir('development1',
3079
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3080
help='A branch and pack based repository that supports stacking. '
3082
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3084
branch_format='bzrlib.branch.BzrBranchFormat7',
3085
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3089
format_registry.register_metadir('development1-subtree',
3090
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3091
help='A branch and pack based repository that supports stacking. '
3093
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3095
branch_format='bzrlib.branch.BzrBranchFormat7',
3096
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2308
3100
# 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
3101
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
