323
535
policy = self.determine_repository_policy(force_new_repo)
324
536
return policy.acquire_repository()[0]
326
def _find_source_repo(self, exit_stack, source_branch):
327
"""Find the source branch and repo for a sprout operation.
329
This is helper intended for use by _sprout.
331
:returns: (source_branch, source_repository). Either or both may be
332
None. If not None, they will be read-locked (and their unlock(s)
333
scheduled via the exit_stack param).
539
def create_branch_convenience(base, force_new_repo=False,
540
force_new_tree=None, format=None,
541
possible_transports=None):
542
"""Create a new BzrDir, Branch and Repository at the url 'base'.
544
This is a convenience function - it will use an existing repository
545
if possible, can be told explicitly whether to create a working tree or
548
This will use the current default BzrDirFormat unless one is
549
specified, and use whatever
550
repository format that that uses via bzrdir.create_branch and
551
create_repository. If a shared repository is available that is used
552
preferentially. Whatever repository is used, its tree creation policy
555
The created Branch object is returned.
556
If a working tree cannot be made due to base not being a file:// url,
557
no error is raised unless force_new_tree is True, in which case no
558
data is created on disk and NotLocalUrl is raised.
560
:param base: The URL to create the branch at.
561
:param force_new_repo: If True a new repository is always created.
562
:param force_new_tree: If True or False force creation of a tree or
563
prevent such creation respectively.
564
:param format: Override for the bzrdir format to create.
565
:param possible_transports: An optional reusable transports list.
335
if source_branch is not None:
336
exit_stack.enter_context(source_branch.lock_read())
337
return source_branch, source_branch.repository
339
source_branch = self.open_branch()
340
source_repository = source_branch.repository
341
except errors.NotBranchError:
568
# check for non local urls
569
t = get_transport(base, possible_transports)
570
if not isinstance(t, local.LocalTransport):
571
raise errors.NotLocalUrl(base)
572
bzrdir = BzrDir.create(base, format, possible_transports)
573
repo = bzrdir._find_or_create_repository(force_new_repo)
574
result = bzrdir.create_branch()
575
if force_new_tree or (repo.make_working_trees() and
576
force_new_tree is None):
344
source_repository = self.open_repository()
345
except errors.NoRepositoryPresent:
346
source_repository = None
348
exit_stack.enter_context(source_repository.lock_read())
350
exit_stack.enter_context(source_branch.lock_read())
351
return source_branch, source_repository
353
def sprout(self, url, revision_id=None, force_new_repo=False,
354
recurse='down', possible_transports=None,
355
accelerator_tree=None, hardlink=False, stacked=False,
356
source_branch=None, create_tree_if_local=True,
358
"""Create a copy of this controldir prepared for use as a new line of
361
If url's last component does not exist, it will be created.
363
Attributes related to the identity of the source branch like
364
branch nickname will be cleaned, a working tree is created
365
whether one existed before or not; and a local branch is always
368
if revision_id is not None, then the clone operation may tune
369
itself to download less data.
578
bzrdir.create_workingtree()
579
except errors.NotLocalUrl:
584
def create_standalone_workingtree(base, format=None):
585
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
587
'base' must be a local path or a file:// url.
589
This will use the current default BzrDirFormat unless one is
590
specified, and use whatever
591
repository format that that uses for bzrdirformat.create_workingtree,
592
create_branch and create_repository.
594
:param format: Override for the bzrdir format to create.
595
:return: The WorkingTree object.
597
t = get_transport(base)
598
if not isinstance(t, local.LocalTransport):
599
raise errors.NotLocalUrl(base)
600
bzrdir = BzrDir.create_branch_and_repo(base,
602
format=format).bzrdir
603
return bzrdir.create_workingtree()
605
def create_workingtree(self, revision_id=None, from_branch=None,
606
accelerator_tree=None, hardlink=False):
607
"""Create a working tree at this BzrDir.
609
:param revision_id: create it as of this revision id.
610
:param from_branch: override bzrdir branch (for lightweight checkouts)
371
611
:param accelerator_tree: A tree which can be used for retrieving file
372
612
contents more quickly than the revision tree, i.e. a workingtree.
373
613
The revision tree will be used for cases where accelerator_tree's
374
614
content is different.
375
:param hardlink: If true, hard-link files from accelerator_tree,
377
:param stacked: If true, create a stacked branch referring to the
378
location of this control directory.
379
:param create_tree_if_local: If true, a working-tree will be created
380
when working locally.
381
:return: The created control directory
383
with cleanup.ExitStack() as stack:
384
fetch_spec_factory = fetch.FetchSpecFactory()
385
if revision_id is not None:
386
fetch_spec_factory.add_revision_ids([revision_id])
387
fetch_spec_factory.source_branch_stop_revision_id = revision_id
388
if possible_transports is None:
389
possible_transports = []
391
possible_transports = list(possible_transports) + [
393
target_transport = _mod_transport.get_transport(url,
395
target_transport.ensure_base()
396
cloning_format = self.cloning_metadir(stacked)
397
# Create/update the result branch
399
result = controldir.ControlDir.open_from_transport(
401
except errors.NotBranchError:
402
result = cloning_format.initialize_on_transport(target_transport)
403
source_branch, source_repository = self._find_source_repo(
404
stack, source_branch)
405
fetch_spec_factory.source_branch = source_branch
406
# if a stacked branch wasn't requested, we don't create one
407
# even if the origin was stacked
408
if stacked and source_branch is not None:
409
stacked_branch_url = self.root_transport.base
411
stacked_branch_url = None
412
repository_policy = result.determine_repository_policy(
413
force_new_repo, stacked_branch_url, require_stacking=stacked)
414
result_repo, is_new_repo = repository_policy.acquire_repository(
415
possible_transports=possible_transports)
416
stack.enter_context(result_repo.lock_write())
417
fetch_spec_factory.source_repo = source_repository
418
fetch_spec_factory.target_repo = result_repo
419
if stacked or (len(result_repo._fallback_repositories) != 0):
420
target_repo_kind = fetch.TargetRepoKinds.STACKED
422
target_repo_kind = fetch.TargetRepoKinds.EMPTY
424
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
425
fetch_spec_factory.target_repo_kind = target_repo_kind
426
if source_repository is not None:
427
fetch_spec = fetch_spec_factory.make_fetch_spec()
428
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
430
if source_branch is None:
431
# this is for sprouting a controldir without a branch; is that
433
# Not especially, but it's part of the contract.
434
result_branch = result.create_branch()
436
result_branch = source_branch.sprout(
437
result, revision_id=revision_id,
438
repository_policy=repository_policy, repository=result_repo)
439
mutter("created new branch %r" % (result_branch,))
441
# Create/update the result working tree
442
if (create_tree_if_local and not result.has_workingtree()
443
and isinstance(target_transport, local.LocalTransport)
444
and (result_repo is None or result_repo.make_working_trees())
445
and result.open_branch(
447
possible_transports=possible_transports).name == result_branch.name):
448
wt = result.create_workingtree(
449
accelerator_tree=accelerator_tree, hardlink=hardlink,
450
from_branch=result_branch)
451
with wt.lock_write():
452
if not wt.is_versioned(''):
454
wt.set_root_id(self.open_workingtree.path2id(''))
455
except errors.NoWorkingTree:
459
if recurse == 'down':
463
basis = tree.basis_tree()
464
stack.enter_context(basis.lock_read())
465
elif result_branch is not None:
466
basis = tree = result_branch.basis_tree()
467
elif source_branch is not None:
468
basis = tree = source_branch.basis_tree()
470
stack.enter_context(tree.lock_read())
471
subtrees = tree.iter_references()
474
for path in subtrees:
475
target = urlutils.join(url, urlutils.escape(path))
476
sublocation = tree.reference_parent(
477
path, branch=result_branch,
478
possible_transports=possible_transports)
479
if sublocation is None:
481
'Ignoring nested tree %s, parent location unknown.',
484
sublocation.controldir.sprout(
485
target, basis.get_reference_revision(path),
486
force_new_repo=force_new_repo, recurse=recurse,
490
def _available_backup_name(self, base):
491
"""Find a non-existing backup file name based on base.
493
See breezy.osutils.available_backup_name about race conditions.
495
return osutils.available_backup_name(base, self.root_transport.has)
616
raise NotImplementedError(self.create_workingtree)
618
def generate_backup_name(self, base):
619
"""Generate a non-existing backup file name based on base."""
621
name = "%s.~%d~" % (base, counter)
622
while self.root_transport.has(name):
624
name = "%s.~%d~" % (base, counter)
497
627
def backup_bzrdir(self):
498
628
"""Backup this bzr control directory.
652
854
:param _transport: the transport this dir is based at.
654
856
self._format = _format
655
# these are also under the more standard names of
857
# these are also under the more standard names of
656
858
# control_transport and user_transport
657
859
self.transport = _transport.clone('.bzr')
658
860
self.root_transport = _transport
659
861
self._mode_check_done = False
662
864
def user_transport(self):
663
865
return self.root_transport
666
868
def control_transport(self):
667
869
return self.transport
871
def is_control_filename(self, filename):
872
"""True if filename is the name of a path which is reserved for bzrdir's.
874
:param filename: A filename within the root transport of this bzrdir.
876
This is true IF and ONLY IF the filename is part of the namespace reserved
877
for bzr control dirs. Currently this is the '.bzr' directory in the root
878
of the root_transport. it is expected that plugins will need to extend
879
this in the future - for instance to make bzr talk with svn working
882
# this might be better on the BzrDirFormat class because it refers to
883
# all the possible bzrdir disk formats.
884
# This method is tested via the workingtree is_control_filename tests-
885
# it was extracted from WorkingTree.is_control_filename. If the method's
886
# contract is extended beyond the current trivial implementation, please
887
# add new tests for it to the appropriate place.
888
return filename == '.bzr' or filename.startswith('.bzr/')
890
def needs_format_conversion(self, format=None):
891
"""Return true if this bzrdir needs convert_format run on it.
893
For instance, if the repository format is out of date but the
894
branch and working tree are not, this should return True.
896
:param format: Optional parameter indicating a specific desired
897
format we plan to arrive at.
899
raise NotImplementedError(self.needs_format_conversion)
902
def open_unsupported(base):
903
"""Open a branch which is not supported."""
904
return BzrDir.open(base, _unsupported=True)
907
def open(base, _unsupported=False, possible_transports=None):
908
"""Open an existing bzrdir, rooted at 'base' (url).
910
:param _unsupported: a private parameter to the BzrDir class.
912
t = get_transport(base, possible_transports=possible_transports)
913
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
916
def open_from_transport(transport, _unsupported=False,
917
_server_formats=True):
918
"""Open a bzrdir within a particular directory.
920
:param transport: Transport containing the bzrdir.
921
:param _unsupported: private.
923
for hook in BzrDir.hooks['pre_open']:
925
# Keep initial base since 'transport' may be modified while following
927
base = transport.base
928
def find_format(transport):
929
return transport, BzrDirFormat.find_format(
930
transport, _server_formats=_server_formats)
932
def redirected(transport, e, redirection_notice):
933
redirected_transport = transport._redirected_to(e.source, e.target)
934
if redirected_transport is None:
935
raise errors.NotBranchError(base)
936
note('%s is%s redirected to %s',
937
transport.base, e.permanently, redirected_transport.base)
938
return redirected_transport
941
transport, format = do_catching_redirections(find_format,
944
except errors.TooManyRedirections:
945
raise errors.NotBranchError(base)
947
BzrDir._check_supported(format, _unsupported)
948
return format.open(transport, _found=True)
950
def open_branch(self, name=None, unsupported=False,
951
ignore_fallbacks=False):
952
"""Open the branch object at this BzrDir if one is present.
954
If unsupported is True, then no longer supported branch formats can
957
TODO: static convenience version of this?
959
raise NotImplementedError(self.open_branch)
962
def open_containing(url, possible_transports=None):
963
"""Open an existing branch which contains url.
965
:param url: url to search from.
966
See open_containing_from_transport for more detail.
968
transport = get_transport(url, possible_transports)
969
return BzrDir.open_containing_from_transport(transport)
972
def open_containing_from_transport(a_transport):
973
"""Open an existing branch which contains a_transport.base.
975
This probes for a branch at a_transport, and searches upwards from there.
977
Basically we keep looking up until we find the control directory or
978
run into the root. If there isn't one, raises NotBranchError.
979
If there is one and it is either an unrecognised format or an unsupported
980
format, UnknownFormatError or UnsupportedFormatError are raised.
981
If there is one, it is returned, along with the unused portion of url.
983
:return: The BzrDir that contains the path, and a Unicode path
984
for the rest of the URL.
986
# this gets the normalised url back. I.e. '.' -> the full path.
987
url = a_transport.base
990
result = BzrDir.open_from_transport(a_transport)
991
return result, urlutils.unescape(a_transport.relpath(url))
992
except errors.NotBranchError, e:
995
new_t = a_transport.clone('..')
996
except errors.InvalidURLJoin:
997
# reached the root, whatever that may be
998
raise errors.NotBranchError(path=url)
999
if new_t.base == a_transport.base:
1000
# reached the root, whatever that may be
1001
raise errors.NotBranchError(path=url)
1004
def _get_tree_branch(self, name=None):
1005
"""Return the branch and tree, if any, for this bzrdir.
1007
:param name: Name of colocated branch to open.
1009
Return None for tree if not present or inaccessible.
1010
Raise NotBranchError if no branch is present.
1011
:return: (tree, branch)
1014
tree = self.open_workingtree()
1015
except (errors.NoWorkingTree, errors.NotLocalUrl):
1017
branch = self.open_branch(name=name)
1019
if name is not None:
1020
branch = self.open_branch(name=name)
1022
branch = tree.branch
1026
def open_tree_or_branch(klass, location):
1027
"""Return the branch and working tree at a location.
1029
If there is no tree at the location, tree will be None.
1030
If there is no branch at the location, an exception will be
1032
:return: (tree, branch)
1034
bzrdir = klass.open(location)
1035
return bzrdir._get_tree_branch()
1038
def open_containing_tree_or_branch(klass, location):
1039
"""Return the branch and working tree contained by a location.
1041
Returns (tree, branch, relpath).
1042
If there is no tree at containing the location, tree will be None.
1043
If there is no branch containing the location, an exception will be
1045
relpath is the portion of the path that is contained by the branch.
1047
bzrdir, relpath = klass.open_containing(location)
1048
tree, branch = bzrdir._get_tree_branch()
1049
return tree, branch, relpath
1052
def open_containing_tree_branch_or_repository(klass, location):
1053
"""Return the working tree, branch and repo contained by a location.
1055
Returns (tree, branch, repository, relpath).
1056
If there is no tree containing the location, tree will be None.
1057
If there is no branch containing the location, branch will be None.
1058
If there is no repository containing the location, repository will be
1060
relpath is the portion of the path that is contained by the innermost
1063
If no tree, branch or repository is found, a NotBranchError is raised.
1065
bzrdir, relpath = klass.open_containing(location)
1067
tree, branch = bzrdir._get_tree_branch()
1068
except errors.NotBranchError:
1070
repo = bzrdir.find_repository()
1071
return None, None, repo, relpath
1072
except (errors.NoRepositoryPresent):
1073
raise errors.NotBranchError(location)
1074
return tree, branch, branch.repository, relpath
1076
def open_repository(self, _unsupported=False):
1077
"""Open the repository object at this BzrDir if one is present.
1079
This will not follow the Branch object pointer - it's strictly a direct
1080
open facility. Most client code should use open_branch().repository to
1081
get at a repository.
1083
:param _unsupported: a private parameter, not part of the api.
1084
TODO: static convenience version of this?
1086
raise NotImplementedError(self.open_repository)
1088
def open_workingtree(self, _unsupported=False,
1089
recommend_upgrade=True, from_branch=None):
1090
"""Open the workingtree object at this BzrDir if one is present.
1092
:param recommend_upgrade: Optional keyword parameter, when True (the
1093
default), emit through the ui module a recommendation that the user
1094
upgrade the working tree when the workingtree being opened is old
1095
(but still fully supported).
1096
:param from_branch: override bzrdir branch (for lightweight checkouts)
1098
raise NotImplementedError(self.open_workingtree)
1100
def has_branch(self, name=None):
1101
"""Tell if this bzrdir contains a branch.
1103
Note: if you're going to open the branch, you should just go ahead
1104
and try, and not ask permission first. (This method just opens the
1105
branch and discards it, and that's somewhat expensive.)
1108
self.open_branch(name)
1110
except errors.NotBranchError:
1113
def has_workingtree(self):
1114
"""Tell if this bzrdir contains a working tree.
1116
This will still raise an exception if the bzrdir has a workingtree that
1117
is remote & inaccessible.
1119
Note: if you're going to open the working tree, you should just go ahead
1120
and try, and not ask permission first. (This method just opens the
1121
workingtree and discards it, and that's somewhat expensive.)
1124
self.open_workingtree(recommend_upgrade=False)
1126
except errors.NoWorkingTree:
669
1129
def _cloning_metadir(self):
670
1130
"""Produce a metadir suitable for cloning with.
723
1184
# We have a repository, so set a working tree? (Why? This seems to
724
1185
# contradict the stated return value in the docstring).
726
repository._format._matchingcontroldir.workingtree_format)
1186
tree_format = repository._format._matchingbzrdir.workingtree_format
727
1187
format.workingtree_format = tree_format.__class__()
728
1188
if require_stacking:
729
1189
format.require_stacking()
1192
def checkout_metadir(self):
1193
return self.cloning_metadir()
1195
def sprout(self, url, revision_id=None, force_new_repo=False,
1196
recurse='down', possible_transports=None,
1197
accelerator_tree=None, hardlink=False, stacked=False,
1198
source_branch=None, create_tree_if_local=True):
1199
"""Create a copy of this bzrdir prepared for use as a new line of
1202
If url's last component does not exist, it will be created.
1204
Attributes related to the identity of the source branch like
1205
branch nickname will be cleaned, a working tree is created
1206
whether one existed before or not; and a local branch is always
1209
if revision_id is not None, then the clone operation may tune
1210
itself to download less data.
1211
:param accelerator_tree: A tree which can be used for retrieving file
1212
contents more quickly than the revision tree, i.e. a workingtree.
1213
The revision tree will be used for cases where accelerator_tree's
1214
content is different.
1215
:param hardlink: If true, hard-link files from accelerator_tree,
1217
:param stacked: If true, create a stacked branch referring to the
1218
location of this control directory.
1219
:param create_tree_if_local: If true, a working-tree will be created
1220
when working locally.
1222
target_transport = get_transport(url, possible_transports)
1223
target_transport.ensure_base()
1224
cloning_format = self.cloning_metadir(stacked)
1225
# Create/update the result branch
1226
result = cloning_format.initialize_on_transport(target_transport)
1227
# if a stacked branch wasn't requested, we don't create one
1228
# even if the origin was stacked
1229
stacked_branch_url = None
1230
if source_branch is not None:
1232
stacked_branch_url = self.root_transport.base
1233
source_repository = source_branch.repository
1236
source_branch = self.open_branch()
1237
source_repository = source_branch.repository
1239
stacked_branch_url = self.root_transport.base
1240
except errors.NotBranchError:
1241
source_branch = None
1243
source_repository = self.open_repository()
1244
except errors.NoRepositoryPresent:
1245
source_repository = None
1246
repository_policy = result.determine_repository_policy(
1247
force_new_repo, stacked_branch_url, require_stacking=stacked)
1248
result_repo, is_new_repo = repository_policy.acquire_repository()
1249
is_stacked = stacked or (len(result_repo._fallback_repositories) != 0)
1250
if is_new_repo and revision_id is not None and not is_stacked:
1251
fetch_spec = graph.PendingAncestryResult(
1252
[revision_id], source_repository)
1255
if source_repository is not None:
1256
# Fetch while stacked to prevent unstacked fetch from
1258
if fetch_spec is None:
1259
result_repo.fetch(source_repository, revision_id=revision_id)
1261
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1263
if source_branch is None:
1264
# this is for sprouting a bzrdir without a branch; is that
1266
# Not especially, but it's part of the contract.
1267
result_branch = result.create_branch()
1269
result_branch = source_branch.sprout(result,
1270
revision_id=revision_id, repository_policy=repository_policy)
1271
mutter("created new branch %r" % (result_branch,))
1273
# Create/update the result working tree
1274
if (create_tree_if_local and
1275
isinstance(target_transport, local.LocalTransport) and
1276
(result_repo is None or result_repo.make_working_trees())):
1277
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1281
if wt.path2id('') is None:
1283
wt.set_root_id(self.open_workingtree.get_root_id())
1284
except errors.NoWorkingTree:
1290
if recurse == 'down':
1292
basis = wt.basis_tree()
1294
subtrees = basis.iter_references()
1295
elif result_branch is not None:
1296
basis = result_branch.basis_tree()
1298
subtrees = basis.iter_references()
1299
elif source_branch is not None:
1300
basis = source_branch.basis_tree()
1302
subtrees = basis.iter_references()
1307
for path, file_id in subtrees:
1308
target = urlutils.join(url, urlutils.escape(path))
1309
sublocation = source_branch.reference_parent(file_id, path)
1310
sublocation.bzrdir.sprout(target,
1311
basis.get_reference_revision(file_id, path),
1312
force_new_repo=force_new_repo, recurse=recurse,
1315
if basis is not None:
1319
def push_branch(self, source, revision_id=None, overwrite=False,
1320
remember=False, create_prefix=False):
1321
"""Push the source branch into this BzrDir."""
1323
# If we can open a branch, use its direct repository, otherwise see
1324
# if there is a repository without a branch.
1326
br_to = self.open_branch()
1327
except errors.NotBranchError:
1328
# Didn't find a branch, can we find a repository?
1329
repository_to = self.find_repository()
1331
# Found a branch, so we must have found a repository
1332
repository_to = br_to.repository
1334
push_result = PushResult()
1335
push_result.source_branch = source
1337
# We have a repository but no branch, copy the revisions, and then
1339
repository_to.fetch(source.repository, revision_id=revision_id)
1340
br_to = source.clone(self, revision_id=revision_id)
1341
if source.get_push_location() is None or remember:
1342
source.set_push_location(br_to.base)
1343
push_result.stacked_on = None
1344
push_result.branch_push_result = None
1345
push_result.old_revno = None
1346
push_result.old_revid = _mod_revision.NULL_REVISION
1347
push_result.target_branch = br_to
1348
push_result.master_branch = None
1349
push_result.workingtree_updated = False
1351
# We have successfully opened the branch, remember if necessary:
1352
if source.get_push_location() is None or remember:
1353
source.set_push_location(br_to.base)
1355
tree_to = self.open_workingtree()
1356
except errors.NotLocalUrl:
1357
push_result.branch_push_result = source.push(br_to,
1358
overwrite, stop_revision=revision_id)
1359
push_result.workingtree_updated = False
1360
except errors.NoWorkingTree:
1361
push_result.branch_push_result = source.push(br_to,
1362
overwrite, stop_revision=revision_id)
1363
push_result.workingtree_updated = None # Not applicable
1365
tree_to.lock_write()
1367
push_result.branch_push_result = source.push(
1368
tree_to.branch, overwrite, stop_revision=revision_id)
1372
push_result.workingtree_updated = True
1373
push_result.old_revno = push_result.branch_push_result.old_revno
1374
push_result.old_revid = push_result.branch_push_result.old_revid
1375
push_result.target_branch = \
1376
push_result.branch_push_result.target_branch
1380
class BzrDirHooks(hooks.Hooks):
1381
"""Hooks for BzrDir operations."""
1384
"""Create the default hooks."""
1385
hooks.Hooks.__init__(self)
1386
self.create_hook(hooks.HookPoint('pre_open',
1387
"Invoked before attempting to open a BzrDir with the transport "
1388
"that the open will use.", (1, 14), None))
1389
self.create_hook(hooks.HookPoint('post_repo_init',
1390
"Invoked after a repository has been initialized. "
1391
"post_repo_init is called with a "
1392
"bzrlib.bzrdir.RepoInitHookParams.",
1395
# install the default hooks
1396
BzrDir.hooks = BzrDirHooks()
1399
class RepoInitHookParams(object):
1400
"""Object holding parameters passed to *_repo_init hooks.
1402
There are 4 fields that hooks may wish to access:
1404
:ivar repository: Repository created
1405
:ivar format: Repository format
1406
:ivar bzrdir: The bzrdir for the repository
1407
:ivar shared: The repository is shared
1410
def __init__(self, repository, format, a_bzrdir, shared):
1411
"""Create a group of RepoInitHook parameters.
1413
:param repository: Repository created
1414
:param format: Repository format
1415
:param bzrdir: The bzrdir for the repository
1416
:param shared: The repository is shared
1418
self.repository = repository
1419
self.format = format
1420
self.bzrdir = a_bzrdir
1421
self.shared = shared
1423
def __eq__(self, other):
1424
return self.__dict__ == other.__dict__
1428
return "<%s for %s>" % (self.__class__.__name__,
1431
return "<%s for %s>" % (self.__class__.__name__,
1435
class BzrDirPreSplitOut(BzrDir):
1436
"""A common class for the all-in-one formats."""
1438
def __init__(self, _transport, _format):
1439
"""See BzrDir.__init__."""
1440
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1441
self._control_files = lockable_files.LockableFiles(
1442
self.get_branch_transport(None),
1443
self._format._lock_file_name,
1444
self._format._lock_class)
1446
def break_lock(self):
1447
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1448
raise NotImplementedError(self.break_lock)
1450
def cloning_metadir(self, require_stacking=False):
1451
"""Produce a metadir suitable for cloning with."""
1452
if require_stacking:
1453
return format_registry.make_bzrdir('1.6')
1454
return self._format.__class__()
1456
def clone(self, url, revision_id=None, force_new_repo=False,
1457
preserve_stacking=False):
1458
"""See BzrDir.clone().
1460
force_new_repo has no effect, since this family of formats always
1461
require a new repository.
1462
preserve_stacking has no effect, since no source branch using this
1463
family of formats can be stacked, so there is no stacking to preserve.
1465
self._make_tail(url)
1466
result = self._format._initialize_for_clone(url)
1467
self.open_repository().clone(result, revision_id=revision_id)
1468
from_branch = self.open_branch()
1469
from_branch.clone(result, revision_id=revision_id)
1471
tree = self.open_workingtree()
1472
except errors.NotLocalUrl:
1473
# make a new one, this format always has to have one.
1474
result._init_workingtree()
1479
def create_branch(self, name=None):
1480
"""See BzrDir.create_branch."""
1481
return self._format.get_branch_format().initialize(self, name=name)
1483
def destroy_branch(self, name=None):
1484
"""See BzrDir.destroy_branch."""
1485
raise errors.UnsupportedOperation(self.destroy_branch, self)
1487
def create_repository(self, shared=False):
1488
"""See BzrDir.create_repository."""
1490
raise errors.IncompatibleFormat('shared repository', self._format)
1491
return self.open_repository()
1493
def destroy_repository(self):
1494
"""See BzrDir.destroy_repository."""
1495
raise errors.UnsupportedOperation(self.destroy_repository, self)
1497
def create_workingtree(self, revision_id=None, from_branch=None,
1498
accelerator_tree=None, hardlink=False):
1499
"""See BzrDir.create_workingtree."""
1500
# The workingtree is sometimes created when the bzrdir is created,
1501
# but not when cloning.
1503
# this looks buggy but is not -really-
1504
# because this format creates the workingtree when the bzrdir is
1506
# clone and sprout will have set the revision_id
1507
# and that will have set it for us, its only
1508
# specific uses of create_workingtree in isolation
1509
# that can do wonky stuff here, and that only
1510
# happens for creating checkouts, which cannot be
1511
# done on this format anyway. So - acceptable wart.
1513
warning("can't support hardlinked working trees in %r"
1516
result = self.open_workingtree(recommend_upgrade=False)
1517
except errors.NoSuchFile:
1518
result = self._init_workingtree()
1519
if revision_id is not None:
1520
if revision_id == _mod_revision.NULL_REVISION:
1521
result.set_parent_ids([])
1523
result.set_parent_ids([revision_id])
1526
def _init_workingtree(self):
1527
from bzrlib.workingtree import WorkingTreeFormat2
1529
return WorkingTreeFormat2().initialize(self)
1530
except errors.NotLocalUrl:
1531
# Even though we can't access the working tree, we need to
1532
# create its control files.
1533
return WorkingTreeFormat2()._stub_initialize_on_transport(
1534
self.transport, self._control_files._file_mode)
1536
def destroy_workingtree(self):
1537
"""See BzrDir.destroy_workingtree."""
1538
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1540
def destroy_workingtree_metadata(self):
1541
"""See BzrDir.destroy_workingtree_metadata."""
1542
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
732
1545
def get_branch_transport(self, branch_format, name=None):
733
"""Get the transport for use by branch format in this BzrDir.
735
Note that bzr dirs that do not support format strings will raise
736
IncompatibleFormat if the branch format they are given has
737
a format string, and vice versa.
739
If branch_format is None, the transport is returned with no
740
checking. If it is not None, then the returned transport is
741
guaranteed to point to an existing directory ready for use.
743
raise NotImplementedError(self.get_branch_transport)
1546
"""See BzrDir.get_branch_transport()."""
1547
if name is not None:
1548
raise errors.NoColocatedBranchSupport(self)
1549
if branch_format is None:
1550
return self.transport
1552
branch_format.get_format_string()
1553
except NotImplementedError:
1554
return self.transport
1555
raise errors.IncompatibleFormat(branch_format, self._format)
745
1557
def get_repository_transport(self, repository_format):
746
"""Get the transport for use by repository format in this BzrDir.
748
Note that bzr dirs that do not support format strings will raise
749
IncompatibleFormat if the repository format they are given has
750
a format string, and vice versa.
752
If repository_format is None, the transport is returned with no
753
checking. If it is not None, then the returned transport is
754
guaranteed to point to an existing directory ready for use.
756
raise NotImplementedError(self.get_repository_transport)
758
def get_workingtree_transport(self, tree_format):
759
"""Get the transport for use by workingtree format in this BzrDir.
761
Note that bzr dirs that do not support format strings will raise
762
IncompatibleFormat if the workingtree format they are given has a
763
format string, and vice versa.
765
If workingtree_format is None, the transport is returned with no
766
checking. If it is not None, then the returned transport is
767
guaranteed to point to an existing directory ready for use.
769
raise NotImplementedError(self.get_workingtree_transport)
772
def create(cls, base, format=None, possible_transports=None):
773
"""Create a new BzrDir at the url 'base'.
775
:param format: If supplied, the format of branch to create. If not
776
supplied, the default is used.
777
:param possible_transports: If supplied, a list of transports that
778
can be reused to share a remote connection.
780
if cls is not BzrDir:
781
raise AssertionError("BzrDir.create always creates the "
782
"default format, not one of %r" % cls)
783
return controldir.ControlDir.create(
784
base, format=format, possible_transports=possible_transports)
787
return "<%s at %r>" % (self.__class__.__name__, self.user_url)
789
def update_feature_flags(self, updated_flags):
790
"""Update the features required by this bzrdir.
792
:param updated_flags: Dictionary mapping feature names to necessities
793
A necessity can be None to indicate the feature should be removed
795
self.control_files.lock_write()
797
self._format._update_feature_flags(updated_flags)
798
self.transport.put_bytes('branch-format', self._format.as_string())
800
self.control_files.unlock()
1558
"""See BzrDir.get_repository_transport()."""
1559
if repository_format is None:
1560
return self.transport
1562
repository_format.get_format_string()
1563
except NotImplementedError:
1564
return self.transport
1565
raise errors.IncompatibleFormat(repository_format, self._format)
1567
def get_workingtree_transport(self, workingtree_format):
1568
"""See BzrDir.get_workingtree_transport()."""
1569
if workingtree_format is None:
1570
return self.transport
1572
workingtree_format.get_format_string()
1573
except NotImplementedError:
1574
return self.transport
1575
raise errors.IncompatibleFormat(workingtree_format, self._format)
1577
def needs_format_conversion(self, format=None):
1578
"""See BzrDir.needs_format_conversion()."""
1579
# if the format is not the same as the system default,
1580
# an upgrade is needed.
1582
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1583
% 'needs_format_conversion(format=None)')
1584
format = BzrDirFormat.get_default_format()
1585
return not isinstance(self._format, format.__class__)
1587
def open_branch(self, name=None, unsupported=False,
1588
ignore_fallbacks=False):
1589
"""See BzrDir.open_branch."""
1590
from bzrlib.branch import BzrBranchFormat4
1591
format = BzrBranchFormat4()
1592
self._check_supported(format, unsupported)
1593
return format.open(self, name, _found=True)
1595
def sprout(self, url, revision_id=None, force_new_repo=False,
1596
possible_transports=None, accelerator_tree=None,
1597
hardlink=False, stacked=False, create_tree_if_local=True,
1598
source_branch=None):
1599
"""See BzrDir.sprout()."""
1600
if source_branch is not None:
1601
my_branch = self.open_branch()
1602
if source_branch.base != my_branch.base:
1603
raise AssertionError(
1604
"source branch %r is not within %r with branch %r" %
1605
(source_branch, self, my_branch))
1607
raise errors.UnstackableBranchFormat(
1608
self._format, self.root_transport.base)
1609
if not create_tree_if_local:
1610
raise errors.MustHaveWorkingTree(
1611
self._format, self.root_transport.base)
1612
from bzrlib.workingtree import WorkingTreeFormat2
1613
self._make_tail(url)
1614
result = self._format._initialize_for_clone(url)
1616
self.open_repository().clone(result, revision_id=revision_id)
1617
except errors.NoRepositoryPresent:
1620
self.open_branch().sprout(result, revision_id=revision_id)
1621
except errors.NotBranchError:
1624
# we always want a working tree
1625
WorkingTreeFormat2().initialize(result,
1626
accelerator_tree=accelerator_tree,
1631
class BzrDir4(BzrDirPreSplitOut):
1632
"""A .bzr version 4 control object.
1634
This is a deprecated format and may be removed after sept 2006.
1637
def create_repository(self, shared=False):
1638
"""See BzrDir.create_repository."""
1639
return self._format.repository_format.initialize(self, shared)
1641
def needs_format_conversion(self, format=None):
1642
"""Format 4 dirs are always in need of conversion."""
1644
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1645
% 'needs_format_conversion(format=None)')
1648
def open_repository(self):
1649
"""See BzrDir.open_repository."""
1650
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1651
return RepositoryFormat4().open(self, _found=True)
1654
class BzrDir5(BzrDirPreSplitOut):
1655
"""A .bzr version 5 control object.
1657
This is a deprecated format and may be removed after sept 2006.
1660
def has_workingtree(self):
1661
"""See BzrDir.has_workingtree."""
1664
def open_repository(self):
1665
"""See BzrDir.open_repository."""
1666
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1667
return RepositoryFormat5().open(self, _found=True)
1669
def open_workingtree(self, _unsupported=False,
1670
recommend_upgrade=True):
1671
"""See BzrDir.create_workingtree."""
1672
from bzrlib.workingtree import WorkingTreeFormat2
1673
wt_format = WorkingTreeFormat2()
1674
# we don't warn here about upgrades; that ought to be handled for the
1676
return wt_format.open(self, _found=True)
1679
class BzrDir6(BzrDirPreSplitOut):
1680
"""A .bzr version 6 control object.
1682
This is a deprecated format and may be removed after sept 2006.
1685
def has_workingtree(self):
1686
"""See BzrDir.has_workingtree."""
1689
def open_repository(self):
1690
"""See BzrDir.open_repository."""
1691
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1692
return RepositoryFormat6().open(self, _found=True)
1694
def open_workingtree(self, _unsupported=False,
1695
recommend_upgrade=True):
1696
"""See BzrDir.create_workingtree."""
1697
# we don't warn here about upgrades; that ought to be handled for the
1699
from bzrlib.workingtree import WorkingTreeFormat2
1700
return WorkingTreeFormat2().open(self, _found=True)
803
1703
class BzrDirMeta1(BzrDir):
1087
1867
def open_branch(self, name=None, unsupported=False,
1088
ignore_fallbacks=False, possible_transports=None):
1089
"""See ControlDir.open_branch."""
1091
name = self._get_selected_branch()
1868
ignore_fallbacks=False):
1869
"""See BzrDir.open_branch."""
1092
1870
format = self.find_branch_format(name=name)
1093
format.check_support_status(unsupported)
1094
if possible_transports is None:
1095
possible_transports = []
1097
possible_transports = list(possible_transports)
1098
possible_transports.append(self.root_transport)
1871
self._check_supported(format, unsupported)
1099
1872
return format.open(self, name=name,
1100
_found=True, ignore_fallbacks=ignore_fallbacks,
1101
possible_transports=possible_transports)
1873
_found=True, ignore_fallbacks=ignore_fallbacks)
1103
1875
def open_repository(self, unsupported=False):
1104
1876
"""See BzrDir.open_repository."""
1105
from .repository import RepositoryFormatMetaDir
1106
format = RepositoryFormatMetaDir.find_format(self)
1107
format.check_support_status(unsupported)
1877
from bzrlib.repository import RepositoryFormat
1878
format = RepositoryFormat.find_format(self)
1879
self._check_supported(format, unsupported)
1108
1880
return format.open(self, _found=True)
1110
1882
def open_workingtree(self, unsupported=False,
1111
recommend_upgrade=True):
1883
recommend_upgrade=True):
1112
1884
"""See BzrDir.open_workingtree."""
1113
from .workingtree import WorkingTreeFormatMetaDir
1114
format = WorkingTreeFormatMetaDir.find_format(self)
1115
format.check_support_status(unsupported, recommend_upgrade,
1116
basedir=self.root_transport.base)
1885
from bzrlib.workingtree import WorkingTreeFormat
1886
format = WorkingTreeFormat.find_format(self)
1887
self._check_supported(format, unsupported,
1889
basedir=self.root_transport.base)
1117
1890
return format.open(self, _found=True)
1119
1892
def _get_config(self):
1120
1893
return config.TransportConfig(self.transport, 'control.conf')
1123
class BzrFormat(object):
1124
"""Base class for all formats of things living in metadirs.
1126
This class manages the format string that is stored in the 'format'
1127
or 'branch-format' file.
1129
All classes for (branch-, repository-, workingtree-) formats that
1130
live in meta directories and have their own 'format' file
1131
(i.e. different from .bzr/branch-format) derive from this class,
1132
as well as the relevant base class for their kind
1133
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1135
Each format is identified by a "format" or "branch-format" file with a
1136
single line containing the base format name and then an optional list of
1139
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1140
will render them inaccessible to older versions of bzr.
1142
:ivar features: Dictionary mapping feature names to their necessity
1145
_present_features = set()
1151
def register_feature(cls, name):
1152
"""Register a feature as being present.
1154
:param name: Name of the feature
1157
raise ValueError("spaces are not allowed in feature names")
1158
if name in cls._present_features:
1159
raise FeatureAlreadyRegistered(name)
1160
cls._present_features.add(name)
1163
def unregister_feature(cls, name):
1164
"""Unregister a feature."""
1165
cls._present_features.remove(name)
1167
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1169
for name, necessity in viewitems(self.features):
1170
if name in self._present_features:
1172
if necessity == b"optional":
1173
mutter("ignoring optional missing feature %s", name)
1175
elif necessity == b"required":
1176
raise MissingFeature(name)
1178
mutter("treating unknown necessity as require for %s",
1180
raise MissingFeature(name)
1183
def get_format_string(cls):
1184
"""Return the ASCII format string that identifies this format."""
1185
raise NotImplementedError(cls.get_format_string)
1188
def from_string(cls, text):
1189
format_string = cls.get_format_string()
1190
if not text.startswith(format_string):
1191
raise AssertionError(
1192
"Invalid format header %r for %r" % (text, cls))
1193
lines = text[len(format_string):].splitlines()
1195
for lineno, line in enumerate(lines):
1197
(necessity, feature) = line.split(b" ", 1)
1199
raise errors.ParseFormatError(format=cls, lineno=lineno + 2,
1200
line=line, text=text)
1201
ret.features[feature] = necessity
1204
def as_string(self):
1205
"""Return the string representation of this format.
1207
lines = [self.get_format_string()]
1208
lines.extend([(item[1] + b" " + item[0] + b"\n")
1209
for item in sorted(viewitems(self.features))])
1210
return b"".join(lines)
1213
def _find_format(klass, registry, kind, format_string):
1215
first_line = format_string[:format_string.index(b"\n") + 1]
1217
first_line = format_string
1219
cls = registry.get(first_line)
1221
raise errors.UnknownFormatError(format=first_line, kind=kind)
1222
return cls.from_string(format_string)
1224
def network_name(self):
1225
"""A simple byte string uniquely identifying this format for RPC calls.
1227
Metadir branch formats use their format string.
1229
return self.as_string()
1231
def __eq__(self, other):
1232
return (self.__class__ is other.__class__
1233
and self.features == other.features)
1235
def _update_feature_flags(self, updated_flags):
1236
"""Update the feature flags in this format.
1238
:param updated_flags: Updated feature flags
1240
for name, necessity in updated_flags.items():
1241
if necessity is None:
1243
del self.features[name]
1247
self.features[name] = necessity
1250
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1251
"""ControlDirFormat base class for .bzr/ directories.
1896
class BzrDirFormat(object):
1897
"""An encapsulation of the initialization and open routines for a format.
1899
Formats provide three things:
1900
* An initialization routine,
1253
1904
Formats are placed in a dict by their format string for reference
1254
1905
during bzrdir opening. These should be subclasses of BzrDirFormat
1461
2273
compatible with whatever sub formats are supported by self.
1464
other_format.features = dict(self.features)
1466
def supports_transport(self, transport):
1467
# bzr formats can be opened over all known transports
1470
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1472
controldir.ControlDirFormat.check_support_status(self,
1473
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1475
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1476
recommend_upgrade=recommend_upgrade, basedir=basedir)
1479
def is_control_filename(klass, filename):
1480
"""True if filename is the name of a path which is reserved for bzrdir's.
1482
:param filename: A filename within the root transport of this bzrdir.
1484
This is true IF and ONLY IF the filename is part of the namespace
1485
reserved for bzr control dirs. Currently this is the '.bzr' directory
1486
in the root of the root_transport.
1488
# this might be better on the BzrDirFormat class because it refers to
1489
# all the possible bzrdir disk formats.
1490
# This method is tested via the workingtree is_control_filename tests-
1491
# it was extracted from WorkingTree.is_control_filename. If the
1492
# method's contract is extended beyond the current trivial
1493
# implementation, please add new tests for it to the appropriate place.
1494
return filename == '.bzr' or filename.startswith('.bzr/')
2278
def unregister_format(klass, format):
2279
del klass._formats[format.get_format_string()]
2282
def unregister_control_format(klass, format):
2283
klass._control_formats.remove(format)
2286
class BzrDirFormat4(BzrDirFormat):
2287
"""Bzr dir format 4.
2289
This format is a combined format for working tree, branch and repository.
2291
- Format 1 working trees [always]
2292
- Format 4 branches [always]
2293
- Format 4 repositories [always]
2295
This format is deprecated: it indexes texts using a text it which is
2296
removed in format 5; write support for this format has been removed.
2299
_lock_class = lockable_files.TransportLock
2301
def get_format_string(self):
2302
"""See BzrDirFormat.get_format_string()."""
2303
return "Bazaar-NG branch, format 0.0.4\n"
2305
def get_format_description(self):
2306
"""See BzrDirFormat.get_format_description()."""
2307
return "All-in-one format 4"
2309
def get_converter(self, format=None):
2310
"""See BzrDirFormat.get_converter()."""
2311
# there is one and only one upgrade path here.
2312
return ConvertBzrDir4To5()
2314
def initialize_on_transport(self, transport):
2315
"""Format 4 branches cannot be created."""
2316
raise errors.UninitializableFormat(self)
2318
def is_supported(self):
2319
"""Format 4 is not supported.
2321
It is not supported because the model changed from 4 to 5 and the
2322
conversion logic is expensive - so doing it on the fly was not
2327
def network_name(self):
2328
return self.get_format_string()
2330
def _open(self, transport):
2331
"""See BzrDirFormat._open."""
2332
return BzrDir4(transport, self)
2334
def __return_repository_format(self):
2335
"""Circular import protection."""
2336
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2337
return RepositoryFormat4()
2338
repository_format = property(__return_repository_format)
2341
class BzrDirFormatAllInOne(BzrDirFormat):
2342
"""Common class for formats before meta-dirs."""
2344
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2345
create_prefix=False, force_new_repo=False, stacked_on=None,
2346
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2348
"""See BzrDirFormat.initialize_on_transport_ex."""
2349
require_stacking = (stacked_on is not None)
2350
# Format 5 cannot stack, but we've been asked to - actually init
2352
if require_stacking:
2353
format = BzrDirMetaFormat1()
2354
return format.initialize_on_transport_ex(transport,
2355
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2356
force_new_repo=force_new_repo, stacked_on=stacked_on,
2357
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2358
make_working_trees=make_working_trees, shared_repo=shared_repo)
2359
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2360
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2361
force_new_repo=force_new_repo, stacked_on=stacked_on,
2362
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2363
make_working_trees=make_working_trees, shared_repo=shared_repo)
2366
class BzrDirFormat5(BzrDirFormatAllInOne):
2367
"""Bzr control format 5.
2369
This format is a combined format for working tree, branch and repository.
2371
- Format 2 working trees [always]
2372
- Format 4 branches [always]
2373
- Format 5 repositories [always]
2374
Unhashed stores in the repository.
2377
_lock_class = lockable_files.TransportLock
2379
def get_format_string(self):
2380
"""See BzrDirFormat.get_format_string()."""
2381
return "Bazaar-NG branch, format 5\n"
2383
def get_branch_format(self):
2384
from bzrlib import branch
2385
return branch.BzrBranchFormat4()
2387
def get_format_description(self):
2388
"""See BzrDirFormat.get_format_description()."""
2389
return "All-in-one format 5"
2391
def get_converter(self, format=None):
2392
"""See BzrDirFormat.get_converter()."""
2393
# there is one and only one upgrade path here.
2394
return ConvertBzrDir5To6()
2396
def _initialize_for_clone(self, url):
2397
return self.initialize_on_transport(get_transport(url), _cloning=True)
2399
def initialize_on_transport(self, transport, _cloning=False):
2400
"""Format 5 dirs always have working tree, branch and repository.
2402
Except when they are being cloned.
2404
from bzrlib.branch import BzrBranchFormat4
2405
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2406
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2407
RepositoryFormat5().initialize(result, _internal=True)
2409
branch = BzrBranchFormat4().initialize(result)
2410
result._init_workingtree()
2413
def network_name(self):
2414
return self.get_format_string()
2416
def _open(self, transport):
2417
"""See BzrDirFormat._open."""
2418
return BzrDir5(transport, self)
2420
def __return_repository_format(self):
2421
"""Circular import protection."""
2422
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2423
return RepositoryFormat5()
2424
repository_format = property(__return_repository_format)
2427
class BzrDirFormat6(BzrDirFormatAllInOne):
2428
"""Bzr control format 6.
2430
This format is a combined format for working tree, branch and repository.
2432
- Format 2 working trees [always]
2433
- Format 4 branches [always]
2434
- Format 6 repositories [always]
2437
_lock_class = lockable_files.TransportLock
2439
def get_format_string(self):
2440
"""See BzrDirFormat.get_format_string()."""
2441
return "Bazaar-NG branch, format 6\n"
2443
def get_format_description(self):
2444
"""See BzrDirFormat.get_format_description()."""
2445
return "All-in-one format 6"
2447
def get_branch_format(self):
2448
from bzrlib import branch
2449
return branch.BzrBranchFormat4()
2451
def get_converter(self, format=None):
2452
"""See BzrDirFormat.get_converter()."""
2453
# there is one and only one upgrade path here.
2454
return ConvertBzrDir6ToMeta()
2456
def _initialize_for_clone(self, url):
2457
return self.initialize_on_transport(get_transport(url), _cloning=True)
2459
def initialize_on_transport(self, transport, _cloning=False):
2460
"""Format 6 dirs always have working tree, branch and repository.
2462
Except when they are being cloned.
2464
from bzrlib.branch import BzrBranchFormat4
2465
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2466
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2467
RepositoryFormat6().initialize(result, _internal=True)
2469
branch = BzrBranchFormat4().initialize(result)
2470
result._init_workingtree()
2473
def network_name(self):
2474
return self.get_format_string()
2476
def _open(self, transport):
2477
"""See BzrDirFormat._open."""
2478
return BzrDir6(transport, self)
2480
def __return_repository_format(self):
2481
"""Circular import protection."""
2482
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2483
return RepositoryFormat6()
2484
repository_format = property(__return_repository_format)
1497
2487
class BzrDirMetaFormat1(BzrDirFormat):
1705
2679
def __get_workingtree_format(self):
1706
2680
if self._workingtree_format is None:
1707
from .workingtree import (
1708
format_registry as wt_format_registry,
1710
self._workingtree_format = wt_format_registry.get_default()
2681
from bzrlib.workingtree import WorkingTreeFormat
2682
self._workingtree_format = WorkingTreeFormat.get_default_format()
1711
2683
return self._workingtree_format
1713
2685
def __set_workingtree_format(self, wt_format):
1714
2686
self._workingtree_format = wt_format
1717
return "<%r>" % (self.__class__.__name__,)
1719
2688
workingtree_format = property(__get_workingtree_format,
1720
2689
__set_workingtree_format)
1723
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1724
"""BzrDirMeta1 format with support for colocated branches."""
1726
colocated_branches = True
1729
def get_format_string(cls):
1730
"""See BzrDirFormat.get_format_string()."""
1731
return b"Bazaar meta directory, format 1 (with colocated branches)\n"
1733
def get_format_description(self):
1734
"""See BzrDirFormat.get_format_description()."""
1735
return "Meta directory format 1 with support for colocated branches"
1737
def _open(self, transport):
1738
"""See BzrDirFormat._open."""
1739
# Create a new format instance because otherwise initialisation of new
1740
# metadirs share the global default format object leading to alias
1742
format = BzrDirMetaFormat1Colo()
1743
self._supply_sub_formats_to(format)
1744
return BzrDirMeta1(transport, format)
1747
class ConvertMetaToMeta(controldir.Converter):
2692
network_format_registry = registry.FormatRegistry()
2693
"""Registry of formats indexed by their network name.
2695
The network name for a BzrDirFormat is an identifier that can be used when
2696
referring to formats with smart server operations. See
2697
BzrDirFormat.network_name() for more detail.
2701
# Register bzr control format
2702
BzrDirFormat.register_control_format(BzrDirFormat)
2704
# Register bzr formats
2705
BzrDirFormat.register_format(BzrDirFormat4())
2706
BzrDirFormat.register_format(BzrDirFormat5())
2707
BzrDirFormat.register_format(BzrDirFormat6())
2708
__default_format = BzrDirMetaFormat1()
2709
BzrDirFormat.register_format(__default_format)
2710
BzrDirFormat._default_format = __default_format
2713
class Converter(object):
2714
"""Converts a disk format object from one format to another."""
2716
def convert(self, to_convert, pb):
2717
"""Perform the conversion of to_convert, giving feedback via pb.
2719
:param to_convert: The disk object to convert.
2720
:param pb: a progress bar to use for progress information.
2723
def step(self, message):
2724
"""Update the pb by a step."""
2726
self.pb.update(message, self.count, self.total)
2729
class ConvertBzrDir4To5(Converter):
2730
"""Converts format 4 bzr dirs to format 5."""
2733
super(ConvertBzrDir4To5, self).__init__()
2734
self.converted_revs = set()
2735
self.absent_revisions = set()
2739
def convert(self, to_convert, pb):
2740
"""See Converter.convert()."""
2741
self.bzrdir = to_convert
2743
warnings.warn("pb parameter to convert() is deprecated")
2744
self.pb = ui.ui_factory.nested_progress_bar()
2746
ui.ui_factory.note('starting upgrade from format 4 to 5')
2747
if isinstance(self.bzrdir.transport, local.LocalTransport):
2748
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2749
self._convert_to_weaves()
2750
return BzrDir.open(self.bzrdir.user_url)
2754
def _convert_to_weaves(self):
2755
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2758
stat = self.bzrdir.transport.stat('weaves')
2759
if not S_ISDIR(stat.st_mode):
2760
self.bzrdir.transport.delete('weaves')
2761
self.bzrdir.transport.mkdir('weaves')
2762
except errors.NoSuchFile:
2763
self.bzrdir.transport.mkdir('weaves')
2764
# deliberately not a WeaveFile as we want to build it up slowly.
2765
self.inv_weave = Weave('inventory')
2766
# holds in-memory weaves for all files
2767
self.text_weaves = {}
2768
self.bzrdir.transport.delete('branch-format')
2769
self.branch = self.bzrdir.open_branch()
2770
self._convert_working_inv()
2771
rev_history = self.branch.revision_history()
2772
# to_read is a stack holding the revisions we still need to process;
2773
# appending to it adds new highest-priority revisions
2774
self.known_revisions = set(rev_history)
2775
self.to_read = rev_history[-1:]
2777
rev_id = self.to_read.pop()
2778
if (rev_id not in self.revisions
2779
and rev_id not in self.absent_revisions):
2780
self._load_one_rev(rev_id)
2782
to_import = self._make_order()
2783
for i, rev_id in enumerate(to_import):
2784
self.pb.update('converting revision', i, len(to_import))
2785
self._convert_one_rev(rev_id)
2787
self._write_all_weaves()
2788
self._write_all_revs()
2789
ui.ui_factory.note('upgraded to weaves:')
2790
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2791
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2792
ui.ui_factory.note(' %6d texts' % self.text_count)
2793
self._cleanup_spare_files_after_format4()
2794
self.branch._transport.put_bytes(
2796
BzrDirFormat5().get_format_string(),
2797
mode=self.bzrdir._get_file_mode())
2799
def _cleanup_spare_files_after_format4(self):
2800
# FIXME working tree upgrade foo.
2801
for n in 'merged-patches', 'pending-merged-patches':
2803
## assert os.path.getsize(p) == 0
2804
self.bzrdir.transport.delete(n)
2805
except errors.NoSuchFile:
2807
self.bzrdir.transport.delete_tree('inventory-store')
2808
self.bzrdir.transport.delete_tree('text-store')
2810
def _convert_working_inv(self):
2811
inv = xml4.serializer_v4.read_inventory(
2812
self.branch._transport.get('inventory'))
2813
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2814
self.branch._transport.put_bytes('inventory', new_inv_xml,
2815
mode=self.bzrdir._get_file_mode())
2817
def _write_all_weaves(self):
2818
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2819
weave_transport = self.bzrdir.transport.clone('weaves')
2820
weaves = WeaveStore(weave_transport, prefixed=False)
2821
transaction = WriteTransaction()
2825
for file_id, file_weave in self.text_weaves.items():
2826
self.pb.update('writing weave', i, len(self.text_weaves))
2827
weaves._put_weave(file_id, file_weave, transaction)
2829
self.pb.update('inventory', 0, 1)
2830
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2831
self.pb.update('inventory', 1, 1)
2835
def _write_all_revs(self):
2836
"""Write all revisions out in new form."""
2837
self.bzrdir.transport.delete_tree('revision-store')
2838
self.bzrdir.transport.mkdir('revision-store')
2839
revision_transport = self.bzrdir.transport.clone('revision-store')
2841
from bzrlib.xml5 import serializer_v5
2842
from bzrlib.repofmt.weaverepo import RevisionTextStore
2843
revision_store = RevisionTextStore(revision_transport,
2844
serializer_v5, False, versionedfile.PrefixMapper(),
2845
lambda:True, lambda:True)
2847
for i, rev_id in enumerate(self.converted_revs):
2848
self.pb.update('write revision', i, len(self.converted_revs))
2849
text = serializer_v5.write_revision_to_string(
2850
self.revisions[rev_id])
2852
revision_store.add_lines(key, None, osutils.split_lines(text))
2856
def _load_one_rev(self, rev_id):
2857
"""Load a revision object into memory.
2859
Any parents not either loaded or abandoned get queued to be
2861
self.pb.update('loading revision',
2862
len(self.revisions),
2863
len(self.known_revisions))
2864
if not self.branch.repository.has_revision(rev_id):
2866
ui.ui_factory.note('revision {%s} not present in branch; '
2867
'will be converted as a ghost' %
2869
self.absent_revisions.add(rev_id)
2871
rev = self.branch.repository.get_revision(rev_id)
2872
for parent_id in rev.parent_ids:
2873
self.known_revisions.add(parent_id)
2874
self.to_read.append(parent_id)
2875
self.revisions[rev_id] = rev
2877
def _load_old_inventory(self, rev_id):
2878
f = self.branch.repository.inventory_store.get(rev_id)
2880
old_inv_xml = f.read()
2883
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2884
inv.revision_id = rev_id
2885
rev = self.revisions[rev_id]
2888
def _load_updated_inventory(self, rev_id):
2889
inv_xml = self.inv_weave.get_text(rev_id)
2890
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2893
def _convert_one_rev(self, rev_id):
2894
"""Convert revision and all referenced objects to new format."""
2895
rev = self.revisions[rev_id]
2896
inv = self._load_old_inventory(rev_id)
2897
present_parents = [p for p in rev.parent_ids
2898
if p not in self.absent_revisions]
2899
self._convert_revision_contents(rev, inv, present_parents)
2900
self._store_new_inv(rev, inv, present_parents)
2901
self.converted_revs.add(rev_id)
2903
def _store_new_inv(self, rev, inv, present_parents):
2904
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2905
new_inv_sha1 = sha_string(new_inv_xml)
2906
self.inv_weave.add_lines(rev.revision_id,
2908
new_inv_xml.splitlines(True))
2909
rev.inventory_sha1 = new_inv_sha1
2911
def _convert_revision_contents(self, rev, inv, present_parents):
2912
"""Convert all the files within a revision.
2914
Also upgrade the inventory to refer to the text revision ids."""
2915
rev_id = rev.revision_id
2916
mutter('converting texts of revision {%s}',
2918
parent_invs = map(self._load_updated_inventory, present_parents)
2919
entries = inv.iter_entries()
2921
for path, ie in entries:
2922
self._convert_file_version(rev, ie, parent_invs)
2924
def _convert_file_version(self, rev, ie, parent_invs):
2925
"""Convert one version of one file.
2927
The file needs to be added into the weave if it is a merge
2928
of >=2 parents or if it's changed from its parent.
2930
file_id = ie.file_id
2931
rev_id = rev.revision_id
2932
w = self.text_weaves.get(file_id)
2935
self.text_weaves[file_id] = w
2936
text_changed = False
2937
parent_candiate_entries = ie.parent_candidates(parent_invs)
2938
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2939
# XXX: Note that this is unordered - and this is tolerable because
2940
# the previous code was also unordered.
2941
previous_entries = dict((head, parent_candiate_entries[head]) for head
2943
self.snapshot_ie(previous_entries, ie, w, rev_id)
2946
def get_parent_map(self, revision_ids):
2947
"""See graph.StackedParentsProvider.get_parent_map"""
2948
return dict((revision_id, self.revisions[revision_id])
2949
for revision_id in revision_ids
2950
if revision_id in self.revisions)
2952
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2953
# TODO: convert this logic, which is ~= snapshot to
2954
# a call to:. This needs the path figured out. rather than a work_tree
2955
# a v4 revision_tree can be given, or something that looks enough like
2956
# one to give the file content to the entry if it needs it.
2957
# and we need something that looks like a weave store for snapshot to
2959
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2960
if len(previous_revisions) == 1:
2961
previous_ie = previous_revisions.values()[0]
2962
if ie._unchanged(previous_ie):
2963
ie.revision = previous_ie.revision
2966
f = self.branch.repository._text_store.get(ie.text_id)
2968
file_lines = f.readlines()
2971
w.add_lines(rev_id, previous_revisions, file_lines)
2972
self.text_count += 1
2974
w.add_lines(rev_id, previous_revisions, [])
2975
ie.revision = rev_id
2977
def _make_order(self):
2978
"""Return a suitable order for importing revisions.
2980
The order must be such that an revision is imported after all
2981
its (present) parents.
2983
todo = set(self.revisions.keys())
2984
done = self.absent_revisions.copy()
2987
# scan through looking for a revision whose parents
2989
for rev_id in sorted(list(todo)):
2990
rev = self.revisions[rev_id]
2991
parent_ids = set(rev.parent_ids)
2992
if parent_ids.issubset(done):
2993
# can take this one now
2994
order.append(rev_id)
3000
class ConvertBzrDir5To6(Converter):
3001
"""Converts format 5 bzr dirs to format 6."""
3003
def convert(self, to_convert, pb):
3004
"""See Converter.convert()."""
3005
self.bzrdir = to_convert
3006
pb = ui.ui_factory.nested_progress_bar()
3008
ui.ui_factory.note('starting upgrade from format 5 to 6')
3009
self._convert_to_prefixed()
3010
return BzrDir.open(self.bzrdir.user_url)
3014
def _convert_to_prefixed(self):
3015
from bzrlib.store import TransportStore
3016
self.bzrdir.transport.delete('branch-format')
3017
for store_name in ["weaves", "revision-store"]:
3018
ui.ui_factory.note("adding prefixes to %s" % store_name)
3019
store_transport = self.bzrdir.transport.clone(store_name)
3020
store = TransportStore(store_transport, prefixed=True)
3021
for urlfilename in store_transport.list_dir('.'):
3022
filename = urlutils.unescape(urlfilename)
3023
if (filename.endswith(".weave") or
3024
filename.endswith(".gz") or
3025
filename.endswith(".sig")):
3026
file_id, suffix = os.path.splitext(filename)
3030
new_name = store._mapper.map((file_id,)) + suffix
3031
# FIXME keep track of the dirs made RBC 20060121
3033
store_transport.move(filename, new_name)
3034
except errors.NoSuchFile: # catches missing dirs strangely enough
3035
store_transport.mkdir(osutils.dirname(new_name))
3036
store_transport.move(filename, new_name)
3037
self.bzrdir.transport.put_bytes(
3039
BzrDirFormat6().get_format_string(),
3040
mode=self.bzrdir._get_file_mode())
3043
class ConvertBzrDir6ToMeta(Converter):
3044
"""Converts format 6 bzr dirs to metadirs."""
3046
def convert(self, to_convert, pb):
3047
"""See Converter.convert()."""
3048
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3049
from bzrlib.branch import BzrBranchFormat5
3050
self.bzrdir = to_convert
3051
self.pb = ui.ui_factory.nested_progress_bar()
3053
self.total = 20 # the steps we know about
3054
self.garbage_inventories = []
3055
self.dir_mode = self.bzrdir._get_dir_mode()
3056
self.file_mode = self.bzrdir._get_file_mode()
3058
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3059
self.bzrdir.transport.put_bytes(
3061
"Converting to format 6",
3062
mode=self.file_mode)
3063
# its faster to move specific files around than to open and use the apis...
3064
# first off, nuke ancestry.weave, it was never used.
3066
self.step('Removing ancestry.weave')
3067
self.bzrdir.transport.delete('ancestry.weave')
3068
except errors.NoSuchFile:
3070
# find out whats there
3071
self.step('Finding branch files')
3072
last_revision = self.bzrdir.open_branch().last_revision()
3073
bzrcontents = self.bzrdir.transport.list_dir('.')
3074
for name in bzrcontents:
3075
if name.startswith('basis-inventory.'):
3076
self.garbage_inventories.append(name)
3077
# create new directories for repository, working tree and branch
3078
repository_names = [('inventory.weave', True),
3079
('revision-store', True),
3081
self.step('Upgrading repository ')
3082
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3083
self.make_lock('repository')
3084
# we hard code the formats here because we are converting into
3085
# the meta format. The meta format upgrader can take this to a
3086
# future format within each component.
3087
self.put_format('repository', RepositoryFormat7())
3088
for entry in repository_names:
3089
self.move_entry('repository', entry)
3091
self.step('Upgrading branch ')
3092
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3093
self.make_lock('branch')
3094
self.put_format('branch', BzrBranchFormat5())
3095
branch_files = [('revision-history', True),
3096
('branch-name', True),
3098
for entry in branch_files:
3099
self.move_entry('branch', entry)
3101
checkout_files = [('pending-merges', True),
3102
('inventory', True),
3103
('stat-cache', False)]
3104
# If a mandatory checkout file is not present, the branch does not have
3105
# a functional checkout. Do not create a checkout in the converted
3107
for name, mandatory in checkout_files:
3108
if mandatory and name not in bzrcontents:
3109
has_checkout = False
3113
if not has_checkout:
3114
ui.ui_factory.note('No working tree.')
3115
# If some checkout files are there, we may as well get rid of them.
3116
for name, mandatory in checkout_files:
3117
if name in bzrcontents:
3118
self.bzrdir.transport.delete(name)
3120
from bzrlib.workingtree import WorkingTreeFormat3
3121
self.step('Upgrading working tree')
3122
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3123
self.make_lock('checkout')
3125
'checkout', WorkingTreeFormat3())
3126
self.bzrdir.transport.delete_multi(
3127
self.garbage_inventories, self.pb)
3128
for entry in checkout_files:
3129
self.move_entry('checkout', entry)
3130
if last_revision is not None:
3131
self.bzrdir.transport.put_bytes(
3132
'checkout/last-revision', last_revision)
3133
self.bzrdir.transport.put_bytes(
3135
BzrDirMetaFormat1().get_format_string(),
3136
mode=self.file_mode)
3138
return BzrDir.open(self.bzrdir.user_url)
3140
def make_lock(self, name):
3141
"""Make a lock for the new control dir name."""
3142
self.step('Make %s lock' % name)
3143
ld = lockdir.LockDir(self.bzrdir.transport,
3145
file_modebits=self.file_mode,
3146
dir_modebits=self.dir_mode)
3149
def move_entry(self, new_dir, entry):
3150
"""Move then entry name into new_dir."""
3152
mandatory = entry[1]
3153
self.step('Moving %s' % name)
3155
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3156
except errors.NoSuchFile:
3160
def put_format(self, dirname, format):
3161
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3162
format.get_format_string(),
3166
class ConvertMetaToMeta(Converter):
1748
3167
"""Converts the components of metadirs."""
1750
3169
def __init__(self, target_format):
1757
3176
def convert(self, to_convert, pb):
1758
3177
"""See Converter.convert()."""
1759
self.controldir = to_convert
1760
with ui.ui_factory.nested_progress_bar() as self.pb:
1763
self.step('checking repository format')
1765
repo = self.controldir.open_repository()
1766
except errors.NoRepositoryPresent:
1769
repo_fmt = self.target_format.repository_format
1770
if not isinstance(repo._format, repo_fmt.__class__):
1771
from ..repository import CopyConverter
1772
ui.ui_factory.note(gettext('starting repository conversion'))
1773
if not repo_fmt.supports_overriding_transport:
1774
raise AssertionError(
1775
"Repository in metadir does not support "
1776
"overriding transport")
1777
converter = CopyConverter(self.target_format.repository_format)
1778
converter.convert(repo, pb)
1779
for branch in self.controldir.list_branches():
1780
# TODO: conversions of Branch and Tree should be done by
1781
# InterXFormat lookups/some sort of registry.
1782
# Avoid circular imports
3178
self.bzrdir = to_convert
3179
self.pb = ui.ui_factory.nested_progress_bar()
3182
self.step('checking repository format')
3184
repo = self.bzrdir.open_repository()
3185
except errors.NoRepositoryPresent:
3188
if not isinstance(repo._format, self.target_format.repository_format.__class__):
3189
from bzrlib.repository import CopyConverter
3190
ui.ui_factory.note('starting repository conversion')
3191
converter = CopyConverter(self.target_format.repository_format)
3192
converter.convert(repo, pb)
3193
for branch in self.bzrdir.list_branches():
3194
# TODO: conversions of Branch and Tree should be done by
3195
# InterXFormat lookups/some sort of registry.
3196
# Avoid circular imports
3197
from bzrlib import branch as _mod_branch
3198
old = branch._format.__class__
3199
new = self.target_format.get_branch_format().__class__
3201
if (old == _mod_branch.BzrBranchFormat5 and
3202
new in (_mod_branch.BzrBranchFormat6,
3203
_mod_branch.BzrBranchFormat7,
3204
_mod_branch.BzrBranchFormat8)):
3205
branch_converter = _mod_branch.Converter5to6()
3206
elif (old == _mod_branch.BzrBranchFormat6 and
3207
new in (_mod_branch.BzrBranchFormat7,
3208
_mod_branch.BzrBranchFormat8)):
3209
branch_converter = _mod_branch.Converter6to7()
3210
elif (old == _mod_branch.BzrBranchFormat7 and
3211
new is _mod_branch.BzrBranchFormat8):
3212
branch_converter = _mod_branch.Converter7to8()
3214
raise errors.BadConversionTarget("No converter", new,
3216
branch_converter.convert(branch)
3217
branch = self.bzrdir.open_branch()
1783
3218
old = branch._format.__class__
1784
new = self.target_format.get_branch_format().__class__
1786
if (old == fullhistorybranch.BzrBranchFormat5
1787
and new in (_mod_bzrbranch.BzrBranchFormat6,
1788
_mod_bzrbranch.BzrBranchFormat7,
1789
_mod_bzrbranch.BzrBranchFormat8)):
1790
branch_converter = _mod_bzrbranch.Converter5to6()
1791
elif (old == _mod_bzrbranch.BzrBranchFormat6
1792
and new in (_mod_bzrbranch.BzrBranchFormat7,
1793
_mod_bzrbranch.BzrBranchFormat8)):
1794
branch_converter = _mod_bzrbranch.Converter6to7()
1795
elif (old == _mod_bzrbranch.BzrBranchFormat7
1796
and new is _mod_bzrbranch.BzrBranchFormat8):
1797
branch_converter = _mod_bzrbranch.Converter7to8()
1799
raise errors.BadConversionTarget("No converter", new,
1801
branch_converter.convert(branch)
1802
branch = self.controldir.open_branch()
1803
old = branch._format.__class__
1805
tree = self.controldir.open_workingtree(recommend_upgrade=False)
1806
except (errors.NoWorkingTree, errors.NotLocalUrl):
1809
# TODO: conversions of Branch and Tree should be done by
1810
# InterXFormat lookups
1811
if (isinstance(tree, workingtree_3.WorkingTree3)
1812
and not isinstance(tree, workingtree_4.DirStateWorkingTree)
1813
and isinstance(self.target_format.workingtree_format,
1814
workingtree_4.DirStateWorkingTreeFormat)):
1815
workingtree_4.Converter3to4().convert(tree)
1816
if (isinstance(tree, workingtree_4.DirStateWorkingTree)
1817
and not isinstance(tree, workingtree_4.WorkingTree5)
1818
and isinstance(self.target_format.workingtree_format,
1819
workingtree_4.WorkingTreeFormat5)):
1820
workingtree_4.Converter4to5().convert(tree)
1821
if (isinstance(tree, workingtree_4.DirStateWorkingTree)
1822
and not isinstance(tree, workingtree_4.WorkingTree6)
1823
and isinstance(self.target_format.workingtree_format,
1824
workingtree_4.WorkingTreeFormat6)):
1825
workingtree_4.Converter4or5to6().convert(tree)
3220
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3221
except (errors.NoWorkingTree, errors.NotLocalUrl):
3224
# TODO: conversions of Branch and Tree should be done by
3225
# InterXFormat lookups
3226
if (isinstance(tree, workingtree.WorkingTree3) and
3227
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3228
isinstance(self.target_format.workingtree_format,
3229
workingtree_4.DirStateWorkingTreeFormat)):
3230
workingtree_4.Converter3to4().convert(tree)
3231
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3232
not isinstance(tree, workingtree_4.WorkingTree5) and
3233
isinstance(self.target_format.workingtree_format,
3234
workingtree_4.WorkingTreeFormat5)):
3235
workingtree_4.Converter4to5().convert(tree)
3236
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3237
not isinstance(tree, workingtree_4.WorkingTree6) and
3238
isinstance(self.target_format.workingtree_format,
3239
workingtree_4.WorkingTreeFormat6)):
3240
workingtree_4.Converter4or5to6().convert(tree)
1826
3242
return to_convert
1829
class ConvertMetaToColo(controldir.Converter):
1830
"""Add colocated branch support."""
1832
def __init__(self, target_format):
1833
"""Create a converter.that upgrades a metadir to the colo format.
1835
:param target_format: The final metadir format that is desired.
1837
self.target_format = target_format
1839
def convert(self, to_convert, pb):
1840
"""See Converter.convert()."""
1841
to_convert.transport.put_bytes('branch-format',
1842
self.target_format.as_string())
1843
return BzrDir.open_from_transport(to_convert.root_transport)
1846
class ConvertMetaToColo(controldir.Converter):
1847
"""Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1849
def __init__(self, target_format):
1850
"""Create a converter that converts a 'development-colo' metadir
1853
:param target_format: The final metadir format that is desired.
1855
self.target_format = target_format
1857
def convert(self, to_convert, pb):
1858
"""See Converter.convert()."""
1859
to_convert.transport.put_bytes('branch-format',
1860
self.target_format.as_string())
1861
return BzrDir.open_from_transport(to_convert.root_transport)
1864
class CreateRepository(controldir.RepositoryAcquisitionPolicy):
3245
# This is not in remote.py because it's relatively small, and needs to be
3246
# registered. Putting it in remote.py creates a circular import problem.
3247
# we can make it a lazy object if the control formats is turned into something
3249
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3250
"""Format representing bzrdirs accessed via a smart server"""
3253
BzrDirMetaFormat1.__init__(self)
3254
# XXX: It's a bit ugly that the network name is here, because we'd
3255
# like to believe that format objects are stateless or at least
3256
# immutable, However, we do at least avoid mutating the name after
3257
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
3258
self._network_name = None
3261
return "%s(_network_name=%r)" % (self.__class__.__name__,
3264
def get_format_description(self):
3265
if self._network_name:
3266
real_format = network_format_registry.get(self._network_name)
3267
return 'Remote: ' + real_format.get_format_description()
3268
return 'bzr remote bzrdir'
3270
def get_format_string(self):
3271
raise NotImplementedError(self.get_format_string)
3273
def network_name(self):
3274
if self._network_name:
3275
return self._network_name
3277
raise AssertionError("No network name set.")
3280
def probe_transport(klass, transport):
3281
"""Return a RemoteBzrDirFormat object if it looks possible."""
3283
medium = transport.get_smart_medium()
3284
except (NotImplementedError, AttributeError,
3285
errors.TransportNotPossible, errors.NoSmartMedium,
3286
errors.SmartProtocolError):
3287
# no smart server, so not a branch for this format type.
3288
raise errors.NotBranchError(path=transport.base)
3290
# Decline to open it if the server doesn't support our required
3291
# version (3) so that the VFS-based transport will do it.
3292
if medium.should_probe():
3294
server_version = medium.protocol_version()
3295
except errors.SmartProtocolError:
3296
# Apparently there's no usable smart server there, even though
3297
# the medium supports the smart protocol.
3298
raise errors.NotBranchError(path=transport.base)
3299
if server_version != '2':
3300
raise errors.NotBranchError(path=transport.base)
3303
def initialize_on_transport(self, transport):
3305
# hand off the request to the smart server
3306
client_medium = transport.get_smart_medium()
3307
except errors.NoSmartMedium:
3308
# TODO: lookup the local format from a server hint.
3309
local_dir_format = BzrDirMetaFormat1()
3310
return local_dir_format.initialize_on_transport(transport)
3311
client = _SmartClient(client_medium)
3312
path = client.remote_path_from_transport(transport)
3314
response = client.call('BzrDirFormat.initialize', path)
3315
except errors.ErrorFromSmartServer, err:
3316
remote._translate_error(err, path=path)
3317
if response[0] != 'ok':
3318
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3319
format = RemoteBzrDirFormat()
3320
self._supply_sub_formats_to(format)
3321
return remote.RemoteBzrDir(transport, format)
3323
def parse_NoneTrueFalse(self, arg):
3330
raise AssertionError("invalid arg %r" % arg)
3332
def _serialize_NoneTrueFalse(self, arg):
3339
def _serialize_NoneString(self, arg):
3342
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3343
create_prefix=False, force_new_repo=False, stacked_on=None,
3344
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3347
# hand off the request to the smart server
3348
client_medium = transport.get_smart_medium()
3349
except errors.NoSmartMedium:
3352
# Decline to open it if the server doesn't support our required
3353
# version (3) so that the VFS-based transport will do it.
3354
if client_medium.should_probe():
3356
server_version = client_medium.protocol_version()
3357
if server_version != '2':
3361
except errors.SmartProtocolError:
3362
# Apparently there's no usable smart server there, even though
3363
# the medium supports the smart protocol.
3368
client = _SmartClient(client_medium)
3369
path = client.remote_path_from_transport(transport)
3370
if client_medium._is_remote_before((1, 16)):
3373
# TODO: lookup the local format from a server hint.
3374
local_dir_format = BzrDirMetaFormat1()
3375
self._supply_sub_formats_to(local_dir_format)
3376
return local_dir_format.initialize_on_transport_ex(transport,
3377
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3378
force_new_repo=force_new_repo, stacked_on=stacked_on,
3379
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3380
make_working_trees=make_working_trees, shared_repo=shared_repo,
3382
return self._initialize_on_transport_ex_rpc(client, path, transport,
3383
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3384
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3386
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3387
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3388
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3390
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3391
args.append(self._serialize_NoneTrueFalse(create_prefix))
3392
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3393
args.append(self._serialize_NoneString(stacked_on))
3394
# stack_on_pwd is often/usually our transport
3397
stack_on_pwd = transport.relpath(stack_on_pwd)
3398
if not stack_on_pwd:
3400
except errors.PathNotChild:
3402
args.append(self._serialize_NoneString(stack_on_pwd))
3403
args.append(self._serialize_NoneString(repo_format_name))
3404
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3405
args.append(self._serialize_NoneTrueFalse(shared_repo))
3406
request_network_name = self._network_name or \
3407
BzrDirFormat.get_default_format().network_name()
3409
response = client.call('BzrDirFormat.initialize_ex_1.16',
3410
request_network_name, path, *args)
3411
except errors.UnknownSmartMethod:
3412
client._medium._remember_remote_is_before((1,16))
3413
local_dir_format = BzrDirMetaFormat1()
3414
self._supply_sub_formats_to(local_dir_format)
3415
return local_dir_format.initialize_on_transport_ex(transport,
3416
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3417
force_new_repo=force_new_repo, stacked_on=stacked_on,
3418
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3419
make_working_trees=make_working_trees, shared_repo=shared_repo,
3421
except errors.ErrorFromSmartServer, err:
3422
remote._translate_error(err, path=path)
3423
repo_path = response[0]
3424
bzrdir_name = response[6]
3425
require_stacking = response[7]
3426
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3427
format = RemoteBzrDirFormat()
3428
format._network_name = bzrdir_name
3429
self._supply_sub_formats_to(format)
3430
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3432
repo_format = remote.response_tuple_to_repo_format(response[1:])
3433
if repo_path == '.':
3436
repo_bzrdir_format = RemoteBzrDirFormat()
3437
repo_bzrdir_format._network_name = response[5]
3438
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3442
final_stack = response[8] or None
3443
final_stack_pwd = response[9] or None
3445
final_stack_pwd = urlutils.join(
3446
transport.base, final_stack_pwd)
3447
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3448
if len(response) > 10:
3449
# Updated server verb that locks remotely.
3450
repo_lock_token = response[10] or None
3451
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3453
remote_repo.dont_leave_lock_in_place()
3455
remote_repo.lock_write()
3456
policy = UseExistingRepository(remote_repo, final_stack,
3457
final_stack_pwd, require_stacking)
3458
policy.acquire_repository()
3462
bzrdir._format.set_branch_format(self.get_branch_format())
3463
if require_stacking:
3464
# The repo has already been created, but we need to make sure that
3465
# we'll make a stackable branch.
3466
bzrdir._format.require_stacking(_skip_repo=True)
3467
return remote_repo, bzrdir, require_stacking, policy
3469
def _open(self, transport):
3470
return remote.RemoteBzrDir(transport, self)
3472
def __eq__(self, other):
3473
if not isinstance(other, RemoteBzrDirFormat):
3475
return self.get_format_description() == other.get_format_description()
3477
def __return_repository_format(self):
3478
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3479
# repository format has been asked for, tell the RemoteRepositoryFormat
3480
# that it should use that for init() etc.
3481
result = remote.RemoteRepositoryFormat()
3482
custom_format = getattr(self, '_repository_format', None)
3484
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3485
return custom_format
3487
# We will use the custom format to create repositories over the
3488
# wire; expose its details like rich_root_data for code to
3490
result._custom_format = custom_format
3493
def get_branch_format(self):
3494
result = BzrDirMetaFormat1.get_branch_format(self)
3495
if not isinstance(result, remote.RemoteBranchFormat):
3496
new_result = remote.RemoteBranchFormat()
3497
new_result._custom_format = result
3499
self.set_branch_format(new_result)
3503
repository_format = property(__return_repository_format,
3504
BzrDirMetaFormat1._set_repository_format) #.im_func)
3507
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3510
class BzrDirFormatInfo(object):
3512
def __init__(self, native, deprecated, hidden, experimental):
3513
self.deprecated = deprecated
3514
self.native = native
3515
self.hidden = hidden
3516
self.experimental = experimental
3519
class BzrDirFormatRegistry(registry.Registry):
3520
"""Registry of user-selectable BzrDir subformats.
3522
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3523
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3527
"""Create a BzrDirFormatRegistry."""
3528
self._aliases = set()
3529
self._registration_order = list()
3530
super(BzrDirFormatRegistry, self).__init__()
3533
"""Return a set of the format names which are aliases."""
3534
return frozenset(self._aliases)
3536
def register_metadir(self, key,
3537
repository_format, help, native=True, deprecated=False,
3543
"""Register a metadir subformat.
3545
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3546
by the Repository/Branch/WorkingTreeformats.
3548
:param repository_format: The fully-qualified repository format class
3550
:param branch_format: Fully-qualified branch format class name as
3552
:param tree_format: Fully-qualified tree format class name as
3555
# This should be expanded to support setting WorkingTree and Branch
3556
# formats, once BzrDirMetaFormat1 supports that.
3557
def _load(full_name):
3558
mod_name, factory_name = full_name.rsplit('.', 1)
3560
mod = __import__(mod_name, globals(), locals(),
3562
except ImportError, e:
3563
raise ImportError('failed to load %s: %s' % (full_name, e))
3565
factory = getattr(mod, factory_name)
3566
except AttributeError:
3567
raise AttributeError('no factory %s in module %r'
3572
bd = BzrDirMetaFormat1()
3573
if branch_format is not None:
3574
bd.set_branch_format(_load(branch_format))
3575
if tree_format is not None:
3576
bd.workingtree_format = _load(tree_format)
3577
if repository_format is not None:
3578
bd.repository_format = _load(repository_format)
3580
self.register(key, helper, help, native, deprecated, hidden,
3581
experimental, alias)
3583
def register(self, key, factory, help, native=True, deprecated=False,
3584
hidden=False, experimental=False, alias=False):
3585
"""Register a BzrDirFormat factory.
3587
The factory must be a callable that takes one parameter: the key.
3588
It must produce an instance of the BzrDirFormat when called.
3590
This function mainly exists to prevent the info object from being
3593
registry.Registry.register(self, key, factory, help,
3594
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3596
self._aliases.add(key)
3597
self._registration_order.append(key)
3599
def register_lazy(self, key, module_name, member_name, help, native=True,
3600
deprecated=False, hidden=False, experimental=False, alias=False):
3601
registry.Registry.register_lazy(self, key, module_name, member_name,
3602
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3604
self._aliases.add(key)
3605
self._registration_order.append(key)
3607
def set_default(self, key):
3608
"""Set the 'default' key to be a clone of the supplied key.
3610
This method must be called once and only once.
3612
registry.Registry.register(self, 'default', self.get(key),
3613
self.get_help(key), info=self.get_info(key))
3614
self._aliases.add('default')
3616
def set_default_repository(self, key):
3617
"""Set the FormatRegistry default and Repository default.
3619
This is a transitional method while Repository.set_default_format
3622
if 'default' in self:
3623
self.remove('default')
3624
self.set_default(key)
3625
format = self.get('default')()
3627
def make_bzrdir(self, key):
3628
return self.get(key)()
3630
def help_topic(self, topic):
3632
default_realkey = None
3633
default_help = self.get_help('default')
3635
for key in self._registration_order:
3636
if key == 'default':
3638
help = self.get_help(key)
3639
if help == default_help:
3640
default_realkey = key
3642
help_pairs.append((key, help))
3644
def wrapped(key, help, info):
3646
help = '(native) ' + help
3647
return ':%s:\n%s\n\n' % (key,
3648
textwrap.fill(help, initial_indent=' ',
3649
subsequent_indent=' ',
3650
break_long_words=False))
3651
if default_realkey is not None:
3652
output += wrapped(default_realkey, '(default) %s' % default_help,
3653
self.get_info('default'))
3654
deprecated_pairs = []
3655
experimental_pairs = []
3656
for key, help in help_pairs:
3657
info = self.get_info(key)
3660
elif info.deprecated:
3661
deprecated_pairs.append((key, help))
3662
elif info.experimental:
3663
experimental_pairs.append((key, help))
3665
output += wrapped(key, help, info)
3666
output += "\nSee :doc:`formats-help` for more about storage formats."
3668
if len(experimental_pairs) > 0:
3669
other_output += "Experimental formats are shown below.\n\n"
3670
for key, help in experimental_pairs:
3671
info = self.get_info(key)
3672
other_output += wrapped(key, help, info)
3675
"No experimental formats are available.\n\n"
3676
if len(deprecated_pairs) > 0:
3677
other_output += "\nDeprecated formats are shown below.\n\n"
3678
for key, help in deprecated_pairs:
3679
info = self.get_info(key)
3680
other_output += wrapped(key, help, info)
3683
"\nNo deprecated formats are available.\n\n"
3685
"\nSee :doc:`formats-help` for more about storage formats."
3687
if topic == 'other-formats':
3693
class RepositoryAcquisitionPolicy(object):
3694
"""Abstract base class for repository acquisition policies.
3696
A repository acquisition policy decides how a BzrDir acquires a repository
3697
for a branch that is being created. The most basic policy decision is
3698
whether to create a new repository or use an existing one.
3700
def __init__(self, stack_on, stack_on_pwd, require_stacking):
3703
:param stack_on: A location to stack on
3704
:param stack_on_pwd: If stack_on is relative, the location it is
3706
:param require_stacking: If True, it is a failure to not stack.
3708
self._stack_on = stack_on
3709
self._stack_on_pwd = stack_on_pwd
3710
self._require_stacking = require_stacking
3712
def configure_branch(self, branch):
3713
"""Apply any configuration data from this policy to the branch.
3715
Default implementation sets repository stacking.
3717
if self._stack_on is None:
3719
if self._stack_on_pwd is None:
3720
stack_on = self._stack_on
3723
stack_on = urlutils.rebase_url(self._stack_on,
3726
except errors.InvalidRebaseURLs:
3727
stack_on = self._get_full_stack_on()
3729
branch.set_stacked_on_url(stack_on)
3730
except (errors.UnstackableBranchFormat,
3731
errors.UnstackableRepositoryFormat):
3732
if self._require_stacking:
3735
def requires_stacking(self):
3736
"""Return True if this policy requires stacking."""
3737
return self._stack_on is not None and self._require_stacking
3739
def _get_full_stack_on(self):
3740
"""Get a fully-qualified URL for the stack_on location."""
3741
if self._stack_on is None:
3743
if self._stack_on_pwd is None:
3744
return self._stack_on
3746
return urlutils.join(self._stack_on_pwd, self._stack_on)
3748
def _add_fallback(self, repository, possible_transports=None):
3749
"""Add a fallback to the supplied repository, if stacking is set."""
3750
stack_on = self._get_full_stack_on()
3751
if stack_on is None:
3754
stacked_dir = BzrDir.open(stack_on,
3755
possible_transports=possible_transports)
3756
except errors.JailBreak:
3757
# We keep the stacking details, but we are in the server code so
3758
# actually stacking is not needed.
3761
stacked_repo = stacked_dir.open_branch().repository
3762
except errors.NotBranchError:
3763
stacked_repo = stacked_dir.open_repository()
3765
repository.add_fallback_repository(stacked_repo)
3766
except errors.UnstackableRepositoryFormat:
3767
if self._require_stacking:
3770
self._require_stacking = True
3772
def acquire_repository(self, make_working_trees=None, shared=False):
3773
"""Acquire a repository for this bzrdir.
3775
Implementations may create a new repository or use a pre-exising
3777
:param make_working_trees: If creating a repository, set
3778
make_working_trees to this value (if non-None)
3779
:param shared: If creating a repository, make it shared if True
3780
:return: A repository, is_new_flag (True if the repository was
3783
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3786
class CreateRepository(RepositoryAcquisitionPolicy):
1865
3787
"""A policy of creating a new repository"""
1867
def __init__(self, controldir, stack_on=None, stack_on_pwd=None,
3789
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1868
3790
require_stacking=False):
1871
:param controldir: The controldir to create the repository on.
3793
:param bzrdir: The bzrdir to create the repository on.
1872
3794
:param stack_on: A location to stack on
1873
3795
:param stack_on_pwd: If stack_on is relative, the location it is
1876
super(CreateRepository, self).__init__(
1877
stack_on, stack_on_pwd, require_stacking)
1878
self._controldir = controldir
3798
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3800
self._bzrdir = bzrdir
1880
def acquire_repository(self, make_working_trees=None, shared=False,
1881
possible_transports=None):
3802
def acquire_repository(self, make_working_trees=None, shared=False):
1882
3803
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
1884
Creates the desired repository in the controldir we already have.
3805
Creates the desired repository in the bzrdir we already have.
1886
if possible_transports is None:
1887
possible_transports = []
1889
possible_transports = list(possible_transports)
1890
possible_transports.append(self._controldir.root_transport)
1891
3807
stack_on = self._get_full_stack_on()
1893
format = self._controldir._format
3809
format = self._bzrdir._format
1894
3810
format.require_stacking(stack_on=stack_on,
1895
possible_transports=possible_transports)
3811
possible_transports=[self._bzrdir.root_transport])
1896
3812
if not self._require_stacking:
1897
3813
# We have picked up automatic stacking somewhere.
1898
note(gettext('Using default stacking branch {0} at {1}').format(
1899
self._stack_on, self._stack_on_pwd))
1900
repository = self._controldir.create_repository(shared=shared)
3814
note('Using default stacking branch %s at %s', self._stack_on,
3816
repository = self._bzrdir.create_repository(shared=shared)
1901
3817
self._add_fallback(repository,
1902
possible_transports=possible_transports)
3818
possible_transports=[self._bzrdir.transport])
1903
3819
if make_working_trees is not None:
1904
3820
repository.set_make_working_trees(make_working_trees)
1905
3821
return repository, True
1908
class UseExistingRepository(controldir.RepositoryAcquisitionPolicy):
3824
class UseExistingRepository(RepositoryAcquisitionPolicy):
1909
3825
"""A policy of reusing an existing repository"""
1911
3827
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
1917
3833
:param stack_on_pwd: If stack_on is relative, the location it is
1920
super(UseExistingRepository, self).__init__(
1921
stack_on, stack_on_pwd, require_stacking)
3836
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
1922
3838
self._repository = repository
1924
def acquire_repository(self, make_working_trees=None, shared=False,
1925
possible_transports=None):
3840
def acquire_repository(self, make_working_trees=None, shared=False):
1926
3841
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
1928
3843
Returns an existing repository to use.
1930
if possible_transports is None:
1931
possible_transports = []
1933
possible_transports = list(possible_transports)
1934
possible_transports.append(self._repository.controldir.transport)
1935
3845
self._add_fallback(self._repository,
1936
possible_transports=possible_transports)
3846
possible_transports=[self._repository.bzrdir.transport])
1937
3847
return self._repository, False
1940
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
3850
# Please register new formats after old formats so that formats
3851
# appear in chronological order and format descriptions can build
3853
format_registry = BzrDirFormatRegistry()
3854
# The pre-0.8 formats have their repository format network name registered in
3855
# repository.py. MetaDir formats have their repository format network name
3856
# inferred from their disk format string.
3857
format_registry.register('weave', BzrDirFormat6,
3858
'Pre-0.8 format. Slower than knit and does not'
3859
' support checkouts or shared repositories.',
3862
format_registry.register_metadir('metaweave',
3863
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3864
'Transitional format in 0.8. Slower than knit.',
3865
branch_format='bzrlib.branch.BzrBranchFormat5',
3866
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3869
format_registry.register_metadir('knit',
3870
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3871
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3872
branch_format='bzrlib.branch.BzrBranchFormat5',
3873
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3876
format_registry.register_metadir('dirstate',
3877
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3878
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3879
'above when accessed over the network.',
3880
branch_format='bzrlib.branch.BzrBranchFormat5',
3881
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3882
# directly from workingtree_4 triggers a circular import.
3883
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3886
format_registry.register_metadir('dirstate-tags',
3887
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3888
help='New in 0.15: Fast local operations and improved scaling for '
3889
'network operations. Additionally adds support for tags.'
3890
' Incompatible with bzr < 0.15.',
3891
branch_format='bzrlib.branch.BzrBranchFormat6',
3892
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3895
format_registry.register_metadir('rich-root',
3896
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3897
help='New in 1.0. Better handling of tree roots. Incompatible with'
3899
branch_format='bzrlib.branch.BzrBranchFormat6',
3900
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3903
format_registry.register_metadir('dirstate-with-subtree',
3904
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3905
help='New in 0.15: Fast local operations and improved scaling for '
3906
'network operations. Additionally adds support for versioning nested '
3907
'bzr branches. Incompatible with bzr < 0.15.',
3908
branch_format='bzrlib.branch.BzrBranchFormat6',
3909
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3913
format_registry.register_metadir('pack-0.92',
3914
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3915
help='New in 0.92: Pack-based format with data compatible with '
3916
'dirstate-tags format repositories. Interoperates with '
3917
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3919
branch_format='bzrlib.branch.BzrBranchFormat6',
3920
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3922
format_registry.register_metadir('pack-0.92-subtree',
3923
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3924
help='New in 0.92: Pack-based format with data compatible with '
3925
'dirstate-with-subtree format repositories. Interoperates with '
3926
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3928
branch_format='bzrlib.branch.BzrBranchFormat6',
3929
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3933
format_registry.register_metadir('rich-root-pack',
3934
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3935
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3936
'(needed for bzr-svn and bzr-git).',
3937
branch_format='bzrlib.branch.BzrBranchFormat6',
3938
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3941
format_registry.register_metadir('1.6',
3942
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3943
help='A format that allows a branch to indicate that there is another '
3944
'(stacked) repository that should be used to access data that is '
3945
'not present locally.',
3946
branch_format='bzrlib.branch.BzrBranchFormat7',
3947
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3950
format_registry.register_metadir('1.6.1-rich-root',
3951
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3952
help='A variant of 1.6 that supports rich-root data '
3953
'(needed for bzr-svn and bzr-git).',
3954
branch_format='bzrlib.branch.BzrBranchFormat7',
3955
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3958
format_registry.register_metadir('1.9',
3959
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3960
help='A repository format using B+tree indexes. These indexes '
3961
'are smaller in size, have smarter caching and provide faster '
3962
'performance for most operations.',
3963
branch_format='bzrlib.branch.BzrBranchFormat7',
3964
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3967
format_registry.register_metadir('1.9-rich-root',
3968
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3969
help='A variant of 1.9 that supports rich-root data '
3970
'(needed for bzr-svn and bzr-git).',
3971
branch_format='bzrlib.branch.BzrBranchFormat7',
3972
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3975
format_registry.register_metadir('1.14',
3976
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3977
help='A working-tree format that supports content filtering.',
3978
branch_format='bzrlib.branch.BzrBranchFormat7',
3979
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3981
format_registry.register_metadir('1.14-rich-root',
3982
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3983
help='A variant of 1.14 that supports rich-root data '
3984
'(needed for bzr-svn and bzr-git).',
3985
branch_format='bzrlib.branch.BzrBranchFormat7',
3986
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3988
# The following un-numbered 'development' formats should always just be aliases.
3989
format_registry.register_metadir('development-rich-root',
3990
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3991
help='Current development format. Supports rich roots. Can convert data '
3992
'to and from rich-root-pack (and anything compatible with '
3993
'rich-root-pack) format repositories. Repositories and branches in '
3994
'this format can only be read by bzr.dev. Please read '
3995
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3997
branch_format='bzrlib.branch.BzrBranchFormat7',
3998
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4003
format_registry.register_metadir('development-subtree',
4004
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
4005
help='Current development format, subtree variant. Can convert data to and '
4006
'from pack-0.92-subtree (and anything compatible with '
4007
'pack-0.92-subtree) format repositories. Repositories and branches in '
4008
'this format can only be read by bzr.dev. Please read '
4009
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4011
branch_format='bzrlib.branch.BzrBranchFormat7',
4012
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4015
alias=False, # Restore to being an alias when an actual development subtree format is added
4016
# This current non-alias status is simply because we did not introduce a
4017
# chk based subtree format.
4020
# And the development formats above will have aliased one of the following:
4021
format_registry.register_metadir('development6-rich-root',
4022
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4023
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4025
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4027
branch_format='bzrlib.branch.BzrBranchFormat7',
4028
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4033
format_registry.register_metadir('development7-rich-root',
4034
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4035
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4036
'rich roots. Please read '
4037
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4039
branch_format='bzrlib.branch.BzrBranchFormat7',
4040
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4045
format_registry.register_metadir('2a',
4046
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4047
help='First format for bzr 2.0 series.\n'
4048
'Uses group-compress storage.\n'
4049
'Provides rich roots which are a one-way transition.\n',
4050
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4051
# 'rich roots. Supported by bzr 1.16 and later.',
4052
branch_format='bzrlib.branch.BzrBranchFormat7',
4053
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4057
# The following format should be an alias for the rich root equivalent
4058
# of the default format
4059
format_registry.register_metadir('default-rich-root',
4060
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4061
branch_format='bzrlib.branch.BzrBranchFormat7',
4062
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4067
# The current format that is made on 'bzr init'.
4068
format_registry.set_default('2a')
added
removed
bzrlib/bzrdir.py
