293
232
# TODO: This should be given a Transport, and should chdir up; otherwise
294
233
# this will open a new connection.
295
234
def _make_tail(self, url):
296
t = get_transport(url)
300
def create(cls, base, format=None, possible_transports=None):
301
"""Create a new BzrDir at the url 'base'.
303
:param format: If supplied, the format of branch to create. If not
304
supplied, the default is used.
305
:param possible_transports: If supplied, a list of transports that
306
can be reused to share a remote connection.
308
if cls is not BzrDir:
309
raise AssertionError("BzrDir.create always creates the default"
310
" format, not one of %r" % cls)
311
t = get_transport(base, possible_transports)
314
format = BzrDirFormat.get_default_format()
315
return format.initialize_on_transport(t)
318
def find_bzrdirs(transport, evaluate=None, list_current=None):
319
"""Find bzrdirs recursively from current location.
321
This is intended primarily as a building block for more sophisticated
322
functionality, like finding trees under a directory, or finding
323
branches that use a given repository.
324
:param evaluate: An optional callable that yields recurse, value,
325
where recurse controls whether this bzrdir is recursed into
326
and value is the value to yield. By default, all bzrdirs
327
are recursed into, and the return value is the bzrdir.
328
:param list_current: if supplied, use this function to list the current
329
directory, instead of Transport.list_dir
330
:return: a generator of found bzrdirs, or whatever evaluate returns.
332
if list_current is None:
333
def list_current(transport):
334
return transport.list_dir('')
336
def evaluate(bzrdir):
339
pending = [transport]
340
while len(pending) > 0:
341
current_transport = pending.pop()
344
bzrdir = BzrDir.open_from_transport(current_transport)
345
except errors.NotBranchError:
348
recurse, value = evaluate(bzrdir)
351
subdirs = list_current(current_transport)
352
except errors.NoSuchFile:
355
for subdir in sorted(subdirs, reverse=True):
356
pending.append(current_transport.clone(subdir))
358
def list_branches(self):
359
"""Return a sequence of all branches local to this control directory.
363
return [self.open_branch()]
364
except errors.NotBranchError:
368
def find_branches(transport):
369
"""Find all branches under a transport.
371
This will find all branches below the transport, including branches
372
inside other branches. Where possible, it will use
373
Repository.find_branches.
375
To list all the branches that use a particular Repository, see
376
Repository.find_branches
378
def evaluate(bzrdir):
380
repository = bzrdir.open_repository()
381
except errors.NoRepositoryPresent:
384
return False, ([], repository)
385
return True, (bzrdir.list_branches(), None)
387
for branches, repo in BzrDir.find_bzrdirs(transport,
390
ret.extend(repo.find_branches())
391
if branches is not None:
395
def destroy_repository(self):
396
"""Destroy the repository in this BzrDir"""
397
raise NotImplementedError(self.destroy_repository)
399
def create_branch(self):
400
"""Create a branch in this BzrDir.
402
The bzrdir's format will control what branch format is created.
403
For more control see BranchFormatXX.create(a_bzrdir).
405
raise NotImplementedError(self.create_branch)
407
def destroy_branch(self):
408
"""Destroy the branch in this BzrDir"""
409
raise NotImplementedError(self.destroy_branch)
412
def create_branch_and_repo(base, force_new_repo=False, format=None):
413
"""Create a new BzrDir, Branch and Repository at the url 'base'.
415
This will use the current default BzrDirFormat unless one is
416
specified, and use whatever
417
repository format that that uses via bzrdir.create_branch and
418
create_repository. If a shared repository is available that is used
421
The created Branch object is returned.
423
:param base: The URL to create the branch at.
424
:param force_new_repo: If True a new repository is always created.
425
:param format: If supplied, the format of branch to create. If not
426
supplied, the default is used.
428
bzrdir = BzrDir.create(base, format)
429
bzrdir._find_or_create_repository(force_new_repo)
430
return bzrdir.create_branch()
235
t = _mod_transport.get_transport(url)
432
238
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
433
239
stack_on_pwd=None, require_stacking=False):
495
301
policy = self.determine_repository_policy(force_new_repo)
496
302
return policy.acquire_repository()[0]
499
def create_branch_convenience(base, force_new_repo=False,
500
force_new_tree=None, format=None,
501
possible_transports=None):
502
"""Create a new BzrDir, Branch and Repository at the url 'base'.
504
This is a convenience function - it will use an existing repository
505
if possible, can be told explicitly whether to create a working tree or
508
This will use the current default BzrDirFormat unless one is
509
specified, and use whatever
510
repository format that that uses via bzrdir.create_branch and
511
create_repository. If a shared repository is available that is used
512
preferentially. Whatever repository is used, its tree creation policy
515
The created Branch object is returned.
516
If a working tree cannot be made due to base not being a file:// url,
517
no error is raised unless force_new_tree is True, in which case no
518
data is created on disk and NotLocalUrl is raised.
520
:param base: The URL to create the branch at.
521
:param force_new_repo: If True a new repository is always created.
522
:param force_new_tree: If True or False force creation of a tree or
523
prevent such creation respectively.
524
:param format: Override for the bzrdir format to create.
525
:param possible_transports: An optional reusable transports list.
304
def _find_source_repo(self, add_cleanup, source_branch):
305
"""Find the source branch and repo for a sprout operation.
307
This is helper intended for use by _sprout.
309
:returns: (source_branch, source_repository). Either or both may be
310
None. If not None, they will be read-locked (and their unlock(s)
311
scheduled via the add_cleanup param).
528
# check for non local urls
529
t = get_transport(base, possible_transports)
530
if not isinstance(t, local.LocalTransport):
531
raise errors.NotLocalUrl(base)
532
bzrdir = BzrDir.create(base, format, possible_transports)
533
repo = bzrdir._find_or_create_repository(force_new_repo)
534
result = bzrdir.create_branch()
535
if force_new_tree or (repo.make_working_trees() and
536
force_new_tree is None):
313
if source_branch is not None:
314
add_cleanup(source_branch.lock_read().unlock)
315
return source_branch, source_branch.repository
317
source_branch = self.open_branch()
318
source_repository = source_branch.repository
319
except errors.NotBranchError:
538
bzrdir.create_workingtree()
539
except errors.NotLocalUrl:
544
def create_standalone_workingtree(base, format=None):
545
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
547
'base' must be a local path or a file:// url.
549
This will use the current default BzrDirFormat unless one is
550
specified, and use whatever
551
repository format that that uses for bzrdirformat.create_workingtree,
552
create_branch and create_repository.
554
:param format: Override for the bzrdir format to create.
555
:return: The WorkingTree object.
557
t = get_transport(base)
558
if not isinstance(t, local.LocalTransport):
559
raise errors.NotLocalUrl(base)
560
bzrdir = BzrDir.create_branch_and_repo(base,
562
format=format).bzrdir
563
return bzrdir.create_workingtree()
565
def create_workingtree(self, revision_id=None, from_branch=None,
566
accelerator_tree=None, hardlink=False):
567
"""Create a working tree at this BzrDir.
569
:param revision_id: create it as of this revision id.
570
:param from_branch: override bzrdir branch (for lightweight checkouts)
322
source_repository = self.open_repository()
323
except errors.NoRepositoryPresent:
324
source_repository = None
326
add_cleanup(source_repository.lock_read().unlock)
328
add_cleanup(source_branch.lock_read().unlock)
329
return source_branch, source_repository
331
def sprout(self, url, revision_id=None, force_new_repo=False,
332
recurse='down', possible_transports=None,
333
accelerator_tree=None, hardlink=False, stacked=False,
334
source_branch=None, create_tree_if_local=True):
335
"""Create a copy of this controldir prepared for use as a new line of
338
If url's last component does not exist, it will be created.
340
Attributes related to the identity of the source branch like
341
branch nickname will be cleaned, a working tree is created
342
whether one existed before or not; and a local branch is always
345
if revision_id is not None, then the clone operation may tune
346
itself to download less data.
571
348
:param accelerator_tree: A tree which can be used for retrieving file
572
349
contents more quickly than the revision tree, i.e. a workingtree.
573
350
The revision tree will be used for cases where accelerator_tree's
574
351
content is different.
576
raise NotImplementedError(self.create_workingtree)
352
:param hardlink: If true, hard-link files from accelerator_tree,
354
:param stacked: If true, create a stacked branch referring to the
355
location of this control directory.
356
:param create_tree_if_local: If true, a working-tree will be created
357
when working locally.
359
operation = cleanup.OperationWithCleanups(self._sprout)
360
return operation.run(url, revision_id=revision_id,
361
force_new_repo=force_new_repo, recurse=recurse,
362
possible_transports=possible_transports,
363
accelerator_tree=accelerator_tree, hardlink=hardlink,
364
stacked=stacked, source_branch=source_branch,
365
create_tree_if_local=create_tree_if_local)
367
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
368
recurse='down', possible_transports=None,
369
accelerator_tree=None, hardlink=False, stacked=False,
370
source_branch=None, create_tree_if_local=True):
371
add_cleanup = op.add_cleanup
372
fetch_spec_factory = fetch.FetchSpecFactory()
373
if revision_id is not None:
374
fetch_spec_factory.add_revision_ids([revision_id])
375
fetch_spec_factory.source_branch_stop_revision_id = revision_id
376
if possible_transports is None:
377
possible_transports = []
379
possible_transports = list(possible_transports) + [
381
target_transport = _mod_transport.get_transport(url,
383
target_transport.ensure_base()
384
cloning_format = self.cloning_metadir(stacked)
385
# Create/update the result branch
387
result = controldir.ControlDir.open_from_transport(target_transport)
388
except errors.NotBranchError:
389
result = cloning_format.initialize_on_transport(target_transport)
390
source_branch, source_repository = self._find_source_repo(
391
add_cleanup, source_branch)
392
fetch_spec_factory.source_branch = source_branch
393
# if a stacked branch wasn't requested, we don't create one
394
# even if the origin was stacked
395
if stacked and source_branch is not None:
396
stacked_branch_url = self.root_transport.base
398
stacked_branch_url = None
399
repository_policy = result.determine_repository_policy(
400
force_new_repo, stacked_branch_url, require_stacking=stacked)
401
result_repo, is_new_repo = repository_policy.acquire_repository(
402
possible_transports=possible_transports)
403
add_cleanup(result_repo.lock_write().unlock)
404
fetch_spec_factory.source_repo = source_repository
405
fetch_spec_factory.target_repo = result_repo
406
if stacked or (len(result_repo._fallback_repositories) != 0):
407
target_repo_kind = fetch.TargetRepoKinds.STACKED
409
target_repo_kind = fetch.TargetRepoKinds.EMPTY
411
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
412
fetch_spec_factory.target_repo_kind = target_repo_kind
413
if source_repository is not None:
414
fetch_spec = fetch_spec_factory.make_fetch_spec()
415
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
417
if source_branch is None:
418
# this is for sprouting a controldir without a branch; is that
420
# Not especially, but it's part of the contract.
421
result_branch = result.create_branch()
423
result_branch = source_branch.sprout(result,
424
revision_id=revision_id, repository_policy=repository_policy,
425
repository=result_repo)
426
mutter("created new branch %r" % (result_branch,))
428
# Create/update the result working tree
429
if (create_tree_if_local and not result.has_workingtree() and
430
isinstance(target_transport, local.LocalTransport) and
431
(result_repo is None or result_repo.make_working_trees())):
432
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
433
hardlink=hardlink, from_branch=result_branch)
436
if wt.path2id('') is None:
438
wt.set_root_id(self.open_workingtree.get_root_id())
439
except errors.NoWorkingTree:
445
if recurse == 'down':
448
basis = wt.basis_tree()
449
elif result_branch is not None:
450
basis = result_branch.basis_tree()
451
elif source_branch is not None:
452
basis = source_branch.basis_tree()
453
if basis is not None:
454
add_cleanup(basis.lock_read().unlock)
455
subtrees = basis.iter_references()
458
for path, file_id in subtrees:
459
target = urlutils.join(url, urlutils.escape(path))
460
sublocation = source_branch.reference_parent(file_id, path)
461
sublocation.bzrdir.sprout(target,
462
basis.get_reference_revision(file_id, path),
463
force_new_repo=force_new_repo, recurse=recurse,
467
@deprecated_method(deprecated_in((2, 3, 0)))
468
def generate_backup_name(self, base):
469
return self._available_backup_name(base)
471
def _available_backup_name(self, base):
472
"""Find a non-existing backup file name based on base.
474
See bzrlib.osutils.available_backup_name about race conditions.
476
return osutils.available_backup_name(base, self.root_transport.has)
578
478
def backup_bzrdir(self):
579
479
"""Backup this bzr control directory.
581
481
:return: Tuple with old path name and new path name
583
484
pb = ui.ui_factory.nested_progress_bar()
585
# FIXME: bug 300001 -- the backup fails if the backup directory
586
# already exists, but it should instead either remove it or make
587
# a new backup directory.
589
# FIXME: bug 262450 -- the backup directory should have the same
590
# permissions as the .bzr directory (probably a bug in copy_tree)
591
486
old_path = self.root_transport.abspath('.bzr')
592
new_path = self.root_transport.abspath('backup.bzr')
593
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
594
self.root_transport.copy_tree('.bzr', 'backup.bzr')
487
backup_dir = self._available_backup_name('backup.bzr')
488
new_path = self.root_transport.abspath(backup_dir)
489
ui.ui_factory.note(gettext('making backup of {0}\n to {1}').format(
490
urlutils.unescape_for_display(old_path, 'utf-8'),
491
urlutils.unescape_for_display(new_path, 'utf-8')))
492
self.root_transport.copy_tree('.bzr', backup_dir)
595
493
return (old_path, new_path)
823
666
# add new tests for it to the appropriate place.
824
667
return filename == '.bzr' or filename.startswith('.bzr/')
826
def needs_format_conversion(self, format=None):
827
"""Return true if this bzrdir needs convert_format run on it.
829
For instance, if the repository format is out of date but the
830
branch and working tree are not, this should return True.
832
:param format: Optional parameter indicating a specific desired
833
format we plan to arrive at.
835
raise NotImplementedError(self.needs_format_conversion)
838
def open_unsupported(base):
839
"""Open a branch which is not supported."""
840
return BzrDir.open(base, _unsupported=True)
843
def open(base, _unsupported=False, possible_transports=None):
844
"""Open an existing bzrdir, rooted at 'base' (url).
846
:param _unsupported: a private parameter to the BzrDir class.
848
t = get_transport(base, possible_transports=possible_transports)
849
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
852
def open_from_transport(transport, _unsupported=False,
853
_server_formats=True):
854
"""Open a bzrdir within a particular directory.
856
:param transport: Transport containing the bzrdir.
857
:param _unsupported: private.
859
for hook in BzrDir.hooks['pre_open']:
861
# Keep initial base since 'transport' may be modified while following
863
base = transport.base
864
def find_format(transport):
865
return transport, BzrDirFormat.find_format(
866
transport, _server_formats=_server_formats)
868
def redirected(transport, e, redirection_notice):
869
redirected_transport = transport._redirected_to(e.source, e.target)
870
if redirected_transport is None:
871
raise errors.NotBranchError(base)
872
note('%s is%s redirected to %s',
873
transport.base, e.permanently, redirected_transport.base)
874
return redirected_transport
877
transport, format = do_catching_redirections(find_format,
880
except errors.TooManyRedirections:
881
raise errors.NotBranchError(base)
883
BzrDir._check_supported(format, _unsupported)
884
return format.open(transport, _found=True)
886
def open_branch(self, unsupported=False, ignore_fallbacks=False):
887
"""Open the branch object at this BzrDir if one is present.
889
If unsupported is True, then no longer supported branch formats can
892
TODO: static convenience version of this?
894
raise NotImplementedError(self.open_branch)
897
def open_containing(url, possible_transports=None):
898
"""Open an existing branch which contains url.
900
:param url: url to search from.
901
See open_containing_from_transport for more detail.
903
transport = get_transport(url, possible_transports)
904
return BzrDir.open_containing_from_transport(transport)
907
def open_containing_from_transport(a_transport):
908
"""Open an existing branch which contains a_transport.base.
910
This probes for a branch at a_transport, and searches upwards from there.
912
Basically we keep looking up until we find the control directory or
913
run into the root. If there isn't one, raises NotBranchError.
914
If there is one and it is either an unrecognised format or an unsupported
915
format, UnknownFormatError or UnsupportedFormatError are raised.
916
If there is one, it is returned, along with the unused portion of url.
918
:return: The BzrDir that contains the path, and a Unicode path
919
for the rest of the URL.
921
# this gets the normalised url back. I.e. '.' -> the full path.
922
url = a_transport.base
925
result = BzrDir.open_from_transport(a_transport)
926
return result, urlutils.unescape(a_transport.relpath(url))
927
except errors.NotBranchError, e:
930
new_t = a_transport.clone('..')
931
except errors.InvalidURLJoin:
932
# reached the root, whatever that may be
933
raise errors.NotBranchError(path=url)
934
if new_t.base == a_transport.base:
935
# reached the root, whatever that may be
936
raise errors.NotBranchError(path=url)
939
def _get_tree_branch(self):
940
"""Return the branch and tree, if any, for this bzrdir.
942
Return None for tree if not present or inaccessible.
943
Raise NotBranchError if no branch is present.
944
:return: (tree, branch)
947
tree = self.open_workingtree()
948
except (errors.NoWorkingTree, errors.NotLocalUrl):
950
branch = self.open_branch()
956
def open_tree_or_branch(klass, location):
957
"""Return the branch and working tree at a location.
959
If there is no tree at the location, tree will be None.
960
If there is no branch at the location, an exception will be
962
:return: (tree, branch)
964
bzrdir = klass.open(location)
965
return bzrdir._get_tree_branch()
968
def open_containing_tree_or_branch(klass, location):
969
"""Return the branch and working tree contained by a location.
971
Returns (tree, branch, relpath).
972
If there is no tree at containing the location, tree will be None.
973
If there is no branch containing the location, an exception will be
975
relpath is the portion of the path that is contained by the branch.
977
bzrdir, relpath = klass.open_containing(location)
978
tree, branch = bzrdir._get_tree_branch()
979
return tree, branch, relpath
982
def open_containing_tree_branch_or_repository(klass, location):
983
"""Return the working tree, branch and repo contained by a location.
985
Returns (tree, branch, repository, relpath).
986
If there is no tree containing the location, tree will be None.
987
If there is no branch containing the location, branch will be None.
988
If there is no repository containing the location, repository will be
990
relpath is the portion of the path that is contained by the innermost
993
If no tree, branch or repository is found, a NotBranchError is raised.
995
bzrdir, relpath = klass.open_containing(location)
997
tree, branch = bzrdir._get_tree_branch()
998
except errors.NotBranchError:
1000
repo = bzrdir.find_repository()
1001
return None, None, repo, relpath
1002
except (errors.NoRepositoryPresent):
1003
raise errors.NotBranchError(location)
1004
return tree, branch, branch.repository, relpath
1006
def open_repository(self, _unsupported=False):
1007
"""Open the repository object at this BzrDir if one is present.
1009
This will not follow the Branch object pointer - it's strictly a direct
1010
open facility. Most client code should use open_branch().repository to
1011
get at a repository.
1013
:param _unsupported: a private parameter, not part of the api.
1014
TODO: static convenience version of this?
1016
raise NotImplementedError(self.open_repository)
1018
def open_workingtree(self, _unsupported=False,
1019
recommend_upgrade=True, from_branch=None):
1020
"""Open the workingtree object at this BzrDir if one is present.
1022
:param recommend_upgrade: Optional keyword parameter, when True (the
1023
default), emit through the ui module a recommendation that the user
1024
upgrade the working tree when the workingtree being opened is old
1025
(but still fully supported).
1026
:param from_branch: override bzrdir branch (for lightweight checkouts)
1028
raise NotImplementedError(self.open_workingtree)
1030
def has_branch(self):
1031
"""Tell if this bzrdir contains a branch.
1033
Note: if you're going to open the branch, you should just go ahead
1034
and try, and not ask permission first. (This method just opens the
1035
branch and discards it, and that's somewhat expensive.)
1040
except errors.NotBranchError:
1043
def has_workingtree(self):
1044
"""Tell if this bzrdir contains a working tree.
1046
This will still raise an exception if the bzrdir has a workingtree that
1047
is remote & inaccessible.
1049
Note: if you're going to open the working tree, you should just go ahead
1050
and try, and not ask permission first. (This method just opens the
1051
workingtree and discards it, and that's somewhat expensive.)
1054
self.open_workingtree(recommend_upgrade=False)
1056
except errors.NoWorkingTree:
1059
669
def _cloning_metadir(self):
1060
670
"""Produce a metadir suitable for cloning with.
1119
729
format.require_stacking()
1122
def checkout_metadir(self):
1123
return self.cloning_metadir()
1125
def sprout(self, url, revision_id=None, force_new_repo=False,
1126
recurse='down', possible_transports=None,
1127
accelerator_tree=None, hardlink=False, stacked=False,
1128
source_branch=None, create_tree_if_local=True):
1129
"""Create a copy of this bzrdir prepared for use as a new line of
1132
If url's last component does not exist, it will be created.
1134
Attributes related to the identity of the source branch like
1135
branch nickname will be cleaned, a working tree is created
1136
whether one existed before or not; and a local branch is always
1139
if revision_id is not None, then the clone operation may tune
1140
itself to download less data.
1141
:param accelerator_tree: A tree which can be used for retrieving file
1142
contents more quickly than the revision tree, i.e. a workingtree.
1143
The revision tree will be used for cases where accelerator_tree's
1144
content is different.
1145
:param hardlink: If true, hard-link files from accelerator_tree,
1147
:param stacked: If true, create a stacked branch referring to the
1148
location of this control directory.
1149
:param create_tree_if_local: If true, a working-tree will be created
1150
when working locally.
1152
target_transport = get_transport(url, possible_transports)
1153
target_transport.ensure_base()
1154
cloning_format = self.cloning_metadir(stacked)
1155
# Create/update the result branch
1156
result = cloning_format.initialize_on_transport(target_transport)
1157
# if a stacked branch wasn't requested, we don't create one
1158
# even if the origin was stacked
1159
stacked_branch_url = None
1160
if source_branch is not None:
1162
stacked_branch_url = self.root_transport.base
1163
source_repository = source_branch.repository
1166
source_branch = self.open_branch()
1167
source_repository = source_branch.repository
1169
stacked_branch_url = self.root_transport.base
1170
except errors.NotBranchError:
1171
source_branch = None
1173
source_repository = self.open_repository()
1174
except errors.NoRepositoryPresent:
1175
source_repository = None
1176
repository_policy = result.determine_repository_policy(
1177
force_new_repo, stacked_branch_url, require_stacking=stacked)
1178
result_repo, is_new_repo = repository_policy.acquire_repository()
1179
if is_new_repo and revision_id is not None and not stacked:
1180
fetch_spec = graph.PendingAncestryResult(
1181
[revision_id], source_repository)
1184
if source_repository is not None:
1185
# Fetch while stacked to prevent unstacked fetch from
1187
if fetch_spec is None:
1188
result_repo.fetch(source_repository, revision_id=revision_id)
1190
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1192
if source_branch is None:
1193
# this is for sprouting a bzrdir without a branch; is that
1195
# Not especially, but it's part of the contract.
1196
result_branch = result.create_branch()
1198
result_branch = source_branch.sprout(result,
1199
revision_id=revision_id, repository_policy=repository_policy)
1200
mutter("created new branch %r" % (result_branch,))
1202
# Create/update the result working tree
1203
if (create_tree_if_local and
1204
isinstance(target_transport, local.LocalTransport) and
1205
(result_repo is None or result_repo.make_working_trees())):
1206
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1210
if wt.path2id('') is None:
1212
wt.set_root_id(self.open_workingtree.get_root_id())
1213
except errors.NoWorkingTree:
1219
if recurse == 'down':
1221
basis = wt.basis_tree()
1223
subtrees = basis.iter_references()
1224
elif result_branch is not None:
1225
basis = result_branch.basis_tree()
1227
subtrees = basis.iter_references()
1228
elif source_branch is not None:
1229
basis = source_branch.basis_tree()
1231
subtrees = basis.iter_references()
1236
for path, file_id in subtrees:
1237
target = urlutils.join(url, urlutils.escape(path))
1238
sublocation = source_branch.reference_parent(file_id, path)
1239
sublocation.bzrdir.sprout(target,
1240
basis.get_reference_revision(file_id, path),
1241
force_new_repo=force_new_repo, recurse=recurse,
1244
if basis is not None:
1248
def push_branch(self, source, revision_id=None, overwrite=False,
1249
remember=False, create_prefix=False):
1250
"""Push the source branch into this BzrDir."""
1252
# If we can open a branch, use its direct repository, otherwise see
1253
# if there is a repository without a branch.
1255
br_to = self.open_branch()
1256
except errors.NotBranchError:
1257
# Didn't find a branch, can we find a repository?
1258
repository_to = self.find_repository()
1260
# Found a branch, so we must have found a repository
1261
repository_to = br_to.repository
1263
push_result = PushResult()
1264
push_result.source_branch = source
1266
# We have a repository but no branch, copy the revisions, and then
1268
repository_to.fetch(source.repository, revision_id=revision_id)
1269
br_to = source.clone(self, revision_id=revision_id)
1270
if source.get_push_location() is None or remember:
1271
source.set_push_location(br_to.base)
1272
push_result.stacked_on = None
1273
push_result.branch_push_result = None
1274
push_result.old_revno = None
1275
push_result.old_revid = _mod_revision.NULL_REVISION
1276
push_result.target_branch = br_to
1277
push_result.master_branch = None
1278
push_result.workingtree_updated = False
1280
# We have successfully opened the branch, remember if necessary:
1281
if source.get_push_location() is None or remember:
1282
source.set_push_location(br_to.base)
1284
tree_to = self.open_workingtree()
1285
except errors.NotLocalUrl:
1286
push_result.branch_push_result = source.push(br_to,
1287
overwrite, stop_revision=revision_id)
1288
push_result.workingtree_updated = False
1289
except errors.NoWorkingTree:
1290
push_result.branch_push_result = source.push(br_to,
1291
overwrite, stop_revision=revision_id)
1292
push_result.workingtree_updated = None # Not applicable
1294
tree_to.lock_write()
1296
push_result.branch_push_result = source.push(
1297
tree_to.branch, overwrite, stop_revision=revision_id)
1301
push_result.workingtree_updated = True
1302
push_result.old_revno = push_result.branch_push_result.old_revno
1303
push_result.old_revid = push_result.branch_push_result.old_revid
1304
push_result.target_branch = \
1305
push_result.branch_push_result.target_branch
1309
class BzrDirHooks(hooks.Hooks):
1310
"""Hooks for BzrDir operations."""
1313
"""Create the default hooks."""
1314
hooks.Hooks.__init__(self)
1315
self.create_hook(hooks.HookPoint('pre_open',
1316
"Invoked before attempting to open a BzrDir with the transport "
1317
"that the open will use.", (1, 14), None))
1319
# install the default hooks
1320
BzrDir.hooks = BzrDirHooks()
1323
class BzrDirPreSplitOut(BzrDir):
1324
"""A common class for the all-in-one formats."""
1326
def __init__(self, _transport, _format):
1327
"""See BzrDir.__init__."""
1328
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1329
self._control_files = lockable_files.LockableFiles(
1330
self.get_branch_transport(None),
1331
self._format._lock_file_name,
1332
self._format._lock_class)
1334
def break_lock(self):
1335
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1336
raise NotImplementedError(self.break_lock)
1338
def cloning_metadir(self, require_stacking=False):
1339
"""Produce a metadir suitable for cloning with."""
1340
if require_stacking:
1341
return format_registry.make_bzrdir('1.6')
1342
return self._format.__class__()
1344
def clone(self, url, revision_id=None, force_new_repo=False,
1345
preserve_stacking=False):
1346
"""See BzrDir.clone().
1348
force_new_repo has no effect, since this family of formats always
1349
require a new repository.
1350
preserve_stacking has no effect, since no source branch using this
1351
family of formats can be stacked, so there is no stacking to preserve.
1353
self._make_tail(url)
1354
result = self._format._initialize_for_clone(url)
1355
self.open_repository().clone(result, revision_id=revision_id)
1356
from_branch = self.open_branch()
1357
from_branch.clone(result, revision_id=revision_id)
1359
tree = self.open_workingtree()
1360
except errors.NotLocalUrl:
1361
# make a new one, this format always has to have one.
1362
result._init_workingtree()
1367
def create_branch(self):
1368
"""See BzrDir.create_branch."""
1369
return self._format.get_branch_format().initialize(self)
1371
def destroy_branch(self):
1372
"""See BzrDir.destroy_branch."""
1373
raise errors.UnsupportedOperation(self.destroy_branch, self)
1375
def create_repository(self, shared=False):
1376
"""See BzrDir.create_repository."""
1378
raise errors.IncompatibleFormat('shared repository', self._format)
1379
return self.open_repository()
1381
def destroy_repository(self):
1382
"""See BzrDir.destroy_repository."""
1383
raise errors.UnsupportedOperation(self.destroy_repository, self)
1385
def create_workingtree(self, revision_id=None, from_branch=None,
1386
accelerator_tree=None, hardlink=False):
1387
"""See BzrDir.create_workingtree."""
1388
# The workingtree is sometimes created when the bzrdir is created,
1389
# but not when cloning.
1391
# this looks buggy but is not -really-
1392
# because this format creates the workingtree when the bzrdir is
1394
# clone and sprout will have set the revision_id
1395
# and that will have set it for us, its only
1396
# specific uses of create_workingtree in isolation
1397
# that can do wonky stuff here, and that only
1398
# happens for creating checkouts, which cannot be
1399
# done on this format anyway. So - acceptable wart.
1401
warning("can't support hardlinked working trees in %r"
1404
result = self.open_workingtree(recommend_upgrade=False)
1405
except errors.NoSuchFile:
1406
result = self._init_workingtree()
1407
if revision_id is not None:
1408
if revision_id == _mod_revision.NULL_REVISION:
1409
result.set_parent_ids([])
1411
result.set_parent_ids([revision_id])
1414
def _init_workingtree(self):
1415
from bzrlib.workingtree import WorkingTreeFormat2
1417
return WorkingTreeFormat2().initialize(self)
1418
except errors.NotLocalUrl:
1419
# Even though we can't access the working tree, we need to
1420
# create its control files.
1421
return WorkingTreeFormat2()._stub_initialize_on_transport(
1422
self.transport, self._control_files._file_mode)
1424
def destroy_workingtree(self):
1425
"""See BzrDir.destroy_workingtree."""
1426
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1428
def destroy_workingtree_metadata(self):
1429
"""See BzrDir.destroy_workingtree_metadata."""
1430
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1433
def get_branch_transport(self, branch_format):
1434
"""See BzrDir.get_branch_transport()."""
1435
if branch_format is None:
1436
return self.transport
1438
branch_format.get_format_string()
1439
except NotImplementedError:
1440
return self.transport
1441
raise errors.IncompatibleFormat(branch_format, self._format)
732
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)
1443
745
def get_repository_transport(self, repository_format):
1444
"""See BzrDir.get_repository_transport()."""
1445
if repository_format is None:
1446
return self.transport
1448
repository_format.get_format_string()
1449
except NotImplementedError:
1450
return self.transport
1451
raise errors.IncompatibleFormat(repository_format, self._format)
1453
def get_workingtree_transport(self, workingtree_format):
1454
"""See BzrDir.get_workingtree_transport()."""
1455
if workingtree_format is None:
1456
return self.transport
1458
workingtree_format.get_format_string()
1459
except NotImplementedError:
1460
return self.transport
1461
raise errors.IncompatibleFormat(workingtree_format, self._format)
1463
def needs_format_conversion(self, format=None):
1464
"""See BzrDir.needs_format_conversion()."""
1465
# if the format is not the same as the system default,
1466
# an upgrade is needed.
1468
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1469
% 'needs_format_conversion(format=None)')
1470
format = BzrDirFormat.get_default_format()
1471
return not isinstance(self._format, format.__class__)
1473
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1474
"""See BzrDir.open_branch."""
1475
from bzrlib.branch import BzrBranchFormat4
1476
format = BzrBranchFormat4()
1477
self._check_supported(format, unsupported)
1478
return format.open(self, _found=True)
1480
def sprout(self, url, revision_id=None, force_new_repo=False,
1481
possible_transports=None, accelerator_tree=None,
1482
hardlink=False, stacked=False, create_tree_if_local=True,
1483
source_branch=None):
1484
"""See BzrDir.sprout()."""
1485
if source_branch is not None:
1486
my_branch = self.open_branch()
1487
if source_branch.base != my_branch.base:
1488
raise AssertionError(
1489
"source branch %r is not within %r with branch %r" %
1490
(source_branch, self, my_branch))
1492
raise errors.UnstackableBranchFormat(
1493
self._format, self.root_transport.base)
1494
if not create_tree_if_local:
1495
raise errors.MustHaveWorkingTree(
1496
self._format, self.root_transport.base)
1497
from bzrlib.workingtree import WorkingTreeFormat2
1498
self._make_tail(url)
1499
result = self._format._initialize_for_clone(url)
1501
self.open_repository().clone(result, revision_id=revision_id)
1502
except errors.NoRepositoryPresent:
1505
self.open_branch().sprout(result, revision_id=revision_id)
1506
except errors.NotBranchError:
1509
# we always want a working tree
1510
WorkingTreeFormat2().initialize(result,
1511
accelerator_tree=accelerator_tree,
1516
class BzrDir4(BzrDirPreSplitOut):
1517
"""A .bzr version 4 control object.
1519
This is a deprecated format and may be removed after sept 2006.
1522
def create_repository(self, shared=False):
1523
"""See BzrDir.create_repository."""
1524
return self._format.repository_format.initialize(self, shared)
1526
def needs_format_conversion(self, format=None):
1527
"""Format 4 dirs are always in need of conversion."""
1529
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1530
% 'needs_format_conversion(format=None)')
1533
def open_repository(self):
1534
"""See BzrDir.open_repository."""
1535
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1536
return RepositoryFormat4().open(self, _found=True)
1539
class BzrDir5(BzrDirPreSplitOut):
1540
"""A .bzr version 5 control object.
1542
This is a deprecated format and may be removed after sept 2006.
1545
def has_workingtree(self):
1546
"""See BzrDir.has_workingtree."""
1549
def open_repository(self):
1550
"""See BzrDir.open_repository."""
1551
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1552
return RepositoryFormat5().open(self, _found=True)
1554
def open_workingtree(self, _unsupported=False,
1555
recommend_upgrade=True):
1556
"""See BzrDir.create_workingtree."""
1557
from bzrlib.workingtree import WorkingTreeFormat2
1558
wt_format = WorkingTreeFormat2()
1559
# we don't warn here about upgrades; that ought to be handled for the
1561
return wt_format.open(self, _found=True)
1564
class BzrDir6(BzrDirPreSplitOut):
1565
"""A .bzr version 6 control object.
1567
This is a deprecated format and may be removed after sept 2006.
1570
def has_workingtree(self):
1571
"""See BzrDir.has_workingtree."""
1574
def open_repository(self):
1575
"""See BzrDir.open_repository."""
1576
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1577
return RepositoryFormat6().open(self, _found=True)
1579
def open_workingtree(self, _unsupported=False,
1580
recommend_upgrade=True):
1581
"""See BzrDir.create_workingtree."""
1582
# we don't warn here about upgrades; that ought to be handled for the
1584
from bzrlib.workingtree import WorkingTreeFormat2
1585
return WorkingTreeFormat2().open(self, _found=True)
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(base, format=format,
784
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()
1588
803
class BzrDirMeta1(BzrDir):
1774
1012
return config.TransportConfig(self.transport, 'control.conf')
1777
class BzrDirFormat(object):
1778
"""An encapsulation of the initialization and open routines for a format.
1780
Formats provide three things:
1781
* An initialization routine,
1015
class BzrDirMeta1Colo(BzrDirMeta1):
1016
"""BzrDirMeta1 with support for colocated branches.
1018
This format is experimental, and will eventually be merged back into
1022
def _get_branch_path(self, name):
1023
"""Obtain the branch path to use.
1025
This uses the API specified branch name first, and then falls back to
1026
the branch name specified in the URL. If neither of those is specified,
1027
it uses the default branch.
1029
:param name: Optional branch name to use
1030
:return: Relative path to branch
1034
return urlutils.join('branches', name.encode("utf-8"))
1036
def _read_branch_list(self):
1037
"""Read the branch list.
1039
:return: List of utf-8 encoded branch names.
1042
f = self.control_transport.get('branch-list')
1043
except errors.NoSuchFile:
1049
ret.append(name.rstrip("\n"))
1054
def _write_branch_list(self, branches):
1055
"""Write out the branch list.
1057
:param branches: List of utf-8 branch names to write
1059
self.transport.put_bytes('branch-list',
1060
"".join([name+"\n" for name in branches]))
1062
def destroy_branch(self, name=None):
1063
"""See BzrDir.create_branch."""
1065
name = self._get_selected_branch()
1066
path = self._get_branch_path(name)
1068
self.control_files.lock_write()
1070
branches = self._read_branch_list()
1072
branches.remove(name.encode("utf-8"))
1074
raise errors.NotBranchError(name)
1075
self._write_branch_list(branches)
1077
self.control_files.unlock()
1078
self.transport.delete_tree(path)
1080
def get_branches(self):
1081
"""See ControlDir.get_branches."""
1084
ret[""] = self.open_branch(name="")
1085
except (errors.NotBranchError, errors.NoRepositoryPresent):
1088
for name in self._read_branch_list():
1089
ret[name] = self.open_branch(name=name.decode('utf-8'))
1093
def get_branch_transport(self, branch_format, name=None):
1094
"""See BzrDir.get_branch_transport()."""
1096
name = self._get_selected_branch()
1097
path = self._get_branch_path(name)
1098
# XXX: this shouldn't implicitly create the directory if it's just
1099
# promising to get a transport -- mbp 20090727
1100
if branch_format is None:
1101
return self.transport.clone(path)
1103
branch_format.get_format_string()
1104
except NotImplementedError:
1105
raise errors.IncompatibleFormat(branch_format, self._format)
1108
self.transport.mkdir('branches', mode=self._get_mkdir_mode())
1109
except errors.FileExists:
1111
branches = self._read_branch_list()
1112
utf8_name = name.encode("utf-8")
1113
if not utf8_name in branches:
1114
self.control_files.lock_write()
1116
branches = self._read_branch_list()
1117
branches.append(utf8_name)
1118
self._write_branch_list(branches)
1120
self.control_files.unlock()
1122
self.transport.mkdir(path, mode=self._get_mkdir_mode())
1123
except errors.FileExists:
1125
return self.transport.clone(path)
1128
class BzrFormat(object):
1129
"""Base class for all formats of things living in metadirs.
1131
This class manages the format string that is stored in the 'format'
1132
or 'branch-format' file.
1134
All classes for (branch-, repository-, workingtree-) formats that
1135
live in meta directories and have their own 'format' file
1136
(i.e. different from .bzr/branch-format) derive from this class,
1137
as well as the relevant base class for their kind
1138
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1140
Each format is identified by a "format" or "branch-format" file with a
1141
single line containing the base format name and then an optional list of
1144
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1145
will render them inaccessible to older versions of bzr.
1147
:ivar features: Dictionary mapping feature names to their necessity
1150
_present_features = set()
1156
def register_feature(cls, name):
1157
"""Register a feature as being present.
1159
:param name: Name of the feature
1162
raise ValueError("spaces are not allowed in feature names")
1163
if name in cls._present_features:
1164
raise errors.FeatureAlreadyRegistered(name)
1165
cls._present_features.add(name)
1168
def unregister_feature(cls, name):
1169
"""Unregister a feature."""
1170
cls._present_features.remove(name)
1172
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1174
for name, necessity in self.features.iteritems():
1175
if name in self._present_features:
1177
if necessity == "optional":
1178
mutter("ignoring optional missing feature %s", name)
1180
elif necessity == "required":
1181
raise errors.MissingFeature(name)
1183
mutter("treating unknown necessity as require for %s",
1185
raise errors.MissingFeature(name)
1188
def get_format_string(cls):
1189
"""Return the ASCII format string that identifies this format."""
1190
raise NotImplementedError(cls.get_format_string)
1193
def from_string(cls, text):
1194
format_string = cls.get_format_string()
1195
if not text.startswith(format_string):
1196
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1197
lines = text[len(format_string):].splitlines()
1199
for lineno, line in enumerate(lines):
1201
(necessity, feature) = line.split(" ", 1)
1203
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1204
line=line, text=text)
1205
ret.features[feature] = necessity
1208
def as_string(self):
1209
"""Return the string representation of this format.
1211
lines = [self.get_format_string()]
1212
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1213
self.features.iteritems()])
1214
return "".join(lines)
1217
def _find_format(klass, registry, kind, format_string):
1219
first_line = format_string[:format_string.index("\n")+1]
1221
first_line = format_string
1223
cls = registry.get(first_line)
1225
raise errors.UnknownFormatError(format=first_line, kind=kind)
1226
return cls.from_string(format_string)
1228
def network_name(self):
1229
"""A simple byte string uniquely identifying this format for RPC calls.
1231
Metadir branch formats use their format string.
1233
return self.as_string()
1235
def __eq__(self, other):
1236
return (self.__class__ is other.__class__ and
1237
self.features == other.features)
1239
def _update_feature_flags(self, updated_flags):
1240
"""Update the feature flags in this format.
1242
:param updated_flags: Updated feature flags
1244
for name, necessity in updated_flags.iteritems():
1245
if necessity is None:
1247
del self.features[name]
1251
self.features[name] = necessity
1254
class BzrProber(controldir.Prober):
1255
"""Prober for formats that use a .bzr/ control directory."""
1257
formats = registry.FormatRegistry(controldir.network_format_registry)
1258
"""The known .bzr formats."""
1261
@deprecated_method(deprecated_in((2, 4, 0)))
1262
def register_bzrdir_format(klass, format):
1263
klass.formats.register(format.get_format_string(), format)
1266
@deprecated_method(deprecated_in((2, 4, 0)))
1267
def unregister_bzrdir_format(klass, format):
1268
klass.formats.remove(format.get_format_string())
1271
def probe_transport(klass, transport):
1272
"""Return the .bzrdir style format present in a directory."""
1274
format_string = transport.get_bytes(".bzr/branch-format")
1275
except errors.NoSuchFile:
1276
raise errors.NotBranchError(path=transport.base)
1278
first_line = format_string[:format_string.index("\n")+1]
1280
first_line = format_string
1282
cls = klass.formats.get(first_line)
1284
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1285
return cls.from_string(format_string)
1288
def known_formats(cls):
1290
for name, format in cls.formats.iteritems():
1291
if callable(format):
1297
controldir.ControlDirFormat.register_prober(BzrProber)
1300
class RemoteBzrProber(controldir.Prober):
1301
"""Prober for remote servers that provide a Bazaar smart server."""
1304
def probe_transport(klass, transport):
1305
"""Return a RemoteBzrDirFormat object if it looks possible."""
1307
medium = transport.get_smart_medium()
1308
except (NotImplementedError, AttributeError,
1309
errors.TransportNotPossible, errors.NoSmartMedium,
1310
errors.SmartProtocolError):
1311
# no smart server, so not a branch for this format type.
1312
raise errors.NotBranchError(path=transport.base)
1314
# Decline to open it if the server doesn't support our required
1315
# version (3) so that the VFS-based transport will do it.
1316
if medium.should_probe():
1318
server_version = medium.protocol_version()
1319
except errors.SmartProtocolError:
1320
# Apparently there's no usable smart server there, even though
1321
# the medium supports the smart protocol.
1322
raise errors.NotBranchError(path=transport.base)
1323
if server_version != '2':
1324
raise errors.NotBranchError(path=transport.base)
1325
from bzrlib.remote import RemoteBzrDirFormat
1326
return RemoteBzrDirFormat()
1329
def known_formats(cls):
1330
from bzrlib.remote import RemoteBzrDirFormat
1331
return set([RemoteBzrDirFormat()])
1334
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1335
"""ControlDirFormat base class for .bzr/ directories.
1785
1337
Formats are placed in a dict by their format string for reference
1786
1338
during bzrdir opening. These should be subclasses of BzrDirFormat
2149
1541
compatible with whatever sub formats are supported by self.
2154
def unregister_format(klass, format):
2155
del klass._formats[format.get_format_string()]
2158
def unregister_control_format(klass, format):
2159
klass._control_formats.remove(format)
2162
class BzrDirFormat4(BzrDirFormat):
2163
"""Bzr dir format 4.
2165
This format is a combined format for working tree, branch and repository.
2167
- Format 1 working trees [always]
2168
- Format 4 branches [always]
2169
- Format 4 repositories [always]
2171
This format is deprecated: it indexes texts using a text it which is
2172
removed in format 5; write support for this format has been removed.
2175
_lock_class = lockable_files.TransportLock
2177
def get_format_string(self):
2178
"""See BzrDirFormat.get_format_string()."""
2179
return "Bazaar-NG branch, format 0.0.4\n"
2181
def get_format_description(self):
2182
"""See BzrDirFormat.get_format_description()."""
2183
return "All-in-one format 4"
2185
def get_converter(self, format=None):
2186
"""See BzrDirFormat.get_converter()."""
2187
# there is one and only one upgrade path here.
2188
return ConvertBzrDir4To5()
2190
def initialize_on_transport(self, transport):
2191
"""Format 4 branches cannot be created."""
2192
raise errors.UninitializableFormat(self)
2194
def is_supported(self):
2195
"""Format 4 is not supported.
2197
It is not supported because the model changed from 4 to 5 and the
2198
conversion logic is expensive - so doing it on the fly was not
2203
def network_name(self):
2204
return self.get_format_string()
2206
def _open(self, transport):
2207
"""See BzrDirFormat._open."""
2208
return BzrDir4(transport, self)
2210
def __return_repository_format(self):
2211
"""Circular import protection."""
2212
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2213
return RepositoryFormat4()
2214
repository_format = property(__return_repository_format)
2217
class BzrDirFormatAllInOne(BzrDirFormat):
2218
"""Common class for formats before meta-dirs."""
2220
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2221
create_prefix=False, force_new_repo=False, stacked_on=None,
2222
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2224
"""See BzrDirFormat.initialize_on_transport_ex."""
2225
require_stacking = (stacked_on is not None)
2226
# Format 5 cannot stack, but we've been asked to - actually init
2228
if require_stacking:
2229
format = BzrDirMetaFormat1()
2230
return format.initialize_on_transport_ex(transport,
2231
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2232
force_new_repo=force_new_repo, stacked_on=stacked_on,
2233
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2234
make_working_trees=make_working_trees, shared_repo=shared_repo)
2235
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2236
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2237
force_new_repo=force_new_repo, stacked_on=stacked_on,
2238
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2239
make_working_trees=make_working_trees, shared_repo=shared_repo)
2242
class BzrDirFormat5(BzrDirFormatAllInOne):
2243
"""Bzr control format 5.
2245
This format is a combined format for working tree, branch and repository.
2247
- Format 2 working trees [always]
2248
- Format 4 branches [always]
2249
- Format 5 repositories [always]
2250
Unhashed stores in the repository.
2253
_lock_class = lockable_files.TransportLock
2255
def get_format_string(self):
2256
"""See BzrDirFormat.get_format_string()."""
2257
return "Bazaar-NG branch, format 5\n"
2259
def get_branch_format(self):
2260
from bzrlib import branch
2261
return branch.BzrBranchFormat4()
2263
def get_format_description(self):
2264
"""See BzrDirFormat.get_format_description()."""
2265
return "All-in-one format 5"
2267
def get_converter(self, format=None):
2268
"""See BzrDirFormat.get_converter()."""
2269
# there is one and only one upgrade path here.
2270
return ConvertBzrDir5To6()
2272
def _initialize_for_clone(self, url):
2273
return self.initialize_on_transport(get_transport(url), _cloning=True)
2275
def initialize_on_transport(self, transport, _cloning=False):
2276
"""Format 5 dirs always have working tree, branch and repository.
2278
Except when they are being cloned.
2280
from bzrlib.branch import BzrBranchFormat4
2281
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2282
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2283
RepositoryFormat5().initialize(result, _internal=True)
2285
branch = BzrBranchFormat4().initialize(result)
2286
result._init_workingtree()
2289
def network_name(self):
2290
return self.get_format_string()
2292
def _open(self, transport):
2293
"""See BzrDirFormat._open."""
2294
return BzrDir5(transport, self)
2296
def __return_repository_format(self):
2297
"""Circular import protection."""
2298
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2299
return RepositoryFormat5()
2300
repository_format = property(__return_repository_format)
2303
class BzrDirFormat6(BzrDirFormatAllInOne):
2304
"""Bzr control format 6.
2306
This format is a combined format for working tree, branch and repository.
2308
- Format 2 working trees [always]
2309
- Format 4 branches [always]
2310
- Format 6 repositories [always]
2313
_lock_class = lockable_files.TransportLock
2315
def get_format_string(self):
2316
"""See BzrDirFormat.get_format_string()."""
2317
return "Bazaar-NG branch, format 6\n"
2319
def get_format_description(self):
2320
"""See BzrDirFormat.get_format_description()."""
2321
return "All-in-one format 6"
2323
def get_branch_format(self):
2324
from bzrlib import branch
2325
return branch.BzrBranchFormat4()
2327
def get_converter(self, format=None):
2328
"""See BzrDirFormat.get_converter()."""
2329
# there is one and only one upgrade path here.
2330
return ConvertBzrDir6ToMeta()
2332
def _initialize_for_clone(self, url):
2333
return self.initialize_on_transport(get_transport(url), _cloning=True)
2335
def initialize_on_transport(self, transport, _cloning=False):
2336
"""Format 6 dirs always have working tree, branch and repository.
2338
Except when they are being cloned.
2340
from bzrlib.branch import BzrBranchFormat4
2341
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2342
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2343
RepositoryFormat6().initialize(result, _internal=True)
2345
branch = BzrBranchFormat4().initialize(result)
2346
result._init_workingtree()
2349
def network_name(self):
2350
return self.get_format_string()
2352
def _open(self, transport):
2353
"""See BzrDirFormat._open."""
2354
return BzrDir6(transport, self)
2356
def __return_repository_format(self):
2357
"""Circular import protection."""
2358
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2359
return RepositoryFormat6()
2360
repository_format = property(__return_repository_format)
1544
other_format.features = dict(self.features)
1546
def supports_transport(self, transport):
1547
# bzr formats can be opened over all known transports
1550
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1552
controldir.ControlDirFormat.check_support_status(self,
1553
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1555
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1556
recommend_upgrade=recommend_upgrade, basedir=basedir)
2363
1559
class BzrDirMetaFormat1(BzrDirFormat):
2555
1766
def __get_workingtree_format(self):
2556
1767
if self._workingtree_format is None:
2557
from bzrlib.workingtree import WorkingTreeFormat
2558
self._workingtree_format = WorkingTreeFormat.get_default_format()
1768
from bzrlib.workingtree import (
1769
format_registry as wt_format_registry,
1771
self._workingtree_format = wt_format_registry.get_default()
2559
1772
return self._workingtree_format
2561
1774
def __set_workingtree_format(self, wt_format):
2562
1775
self._workingtree_format = wt_format
1778
return "<%r>" % (self.__class__.__name__,)
2564
1780
workingtree_format = property(__get_workingtree_format,
2565
1781
__set_workingtree_format)
2568
network_format_registry = registry.FormatRegistry()
2569
"""Registry of formats indexed by their network name.
2571
The network name for a BzrDirFormat is an identifier that can be used when
2572
referring to formats with smart server operations. See
2573
BzrDirFormat.network_name() for more detail.
2577
# Register bzr control format
2578
BzrDirFormat.register_control_format(BzrDirFormat)
2580
1784
# Register bzr formats
2581
BzrDirFormat.register_format(BzrDirFormat4())
2582
BzrDirFormat.register_format(BzrDirFormat5())
2583
BzrDirFormat.register_format(BzrDirFormat6())
2584
__default_format = BzrDirMetaFormat1()
2585
BzrDirFormat.register_format(__default_format)
2586
BzrDirFormat._default_format = __default_format
2589
class Converter(object):
2590
"""Converts a disk format object from one format to another."""
2592
def convert(self, to_convert, pb):
2593
"""Perform the conversion of to_convert, giving feedback via pb.
2595
:param to_convert: The disk object to convert.
2596
:param pb: a progress bar to use for progress information.
2599
def step(self, message):
2600
"""Update the pb by a step."""
2602
self.pb.update(message, self.count, self.total)
2605
class ConvertBzrDir4To5(Converter):
2606
"""Converts format 4 bzr dirs to format 5."""
2609
super(ConvertBzrDir4To5, self).__init__()
2610
self.converted_revs = set()
2611
self.absent_revisions = set()
2615
def convert(self, to_convert, pb):
2616
"""See Converter.convert()."""
2617
self.bzrdir = to_convert
2619
warnings.warn("pb parameter to convert() is deprecated")
2620
self.pb = ui.ui_factory.nested_progress_bar()
2622
ui.ui_factory.note('starting upgrade from format 4 to 5')
2623
if isinstance(self.bzrdir.transport, local.LocalTransport):
2624
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2625
self._convert_to_weaves()
2626
return BzrDir.open(self.bzrdir.root_transport.base)
2630
def _convert_to_weaves(self):
2631
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2634
stat = self.bzrdir.transport.stat('weaves')
2635
if not S_ISDIR(stat.st_mode):
2636
self.bzrdir.transport.delete('weaves')
2637
self.bzrdir.transport.mkdir('weaves')
2638
except errors.NoSuchFile:
2639
self.bzrdir.transport.mkdir('weaves')
2640
# deliberately not a WeaveFile as we want to build it up slowly.
2641
self.inv_weave = Weave('inventory')
2642
# holds in-memory weaves for all files
2643
self.text_weaves = {}
2644
self.bzrdir.transport.delete('branch-format')
2645
self.branch = self.bzrdir.open_branch()
2646
self._convert_working_inv()
2647
rev_history = self.branch.revision_history()
2648
# to_read is a stack holding the revisions we still need to process;
2649
# appending to it adds new highest-priority revisions
2650
self.known_revisions = set(rev_history)
2651
self.to_read = rev_history[-1:]
2653
rev_id = self.to_read.pop()
2654
if (rev_id not in self.revisions
2655
and rev_id not in self.absent_revisions):
2656
self._load_one_rev(rev_id)
2658
to_import = self._make_order()
2659
for i, rev_id in enumerate(to_import):
2660
self.pb.update('converting revision', i, len(to_import))
2661
self._convert_one_rev(rev_id)
2663
self._write_all_weaves()
2664
self._write_all_revs()
2665
ui.ui_factory.note('upgraded to weaves:')
2666
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2667
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2668
ui.ui_factory.note(' %6d texts' % self.text_count)
2669
self._cleanup_spare_files_after_format4()
2670
self.branch._transport.put_bytes(
2672
BzrDirFormat5().get_format_string(),
2673
mode=self.bzrdir._get_file_mode())
2675
def _cleanup_spare_files_after_format4(self):
2676
# FIXME working tree upgrade foo.
2677
for n in 'merged-patches', 'pending-merged-patches':
2679
## assert os.path.getsize(p) == 0
2680
self.bzrdir.transport.delete(n)
2681
except errors.NoSuchFile:
2683
self.bzrdir.transport.delete_tree('inventory-store')
2684
self.bzrdir.transport.delete_tree('text-store')
2686
def _convert_working_inv(self):
2687
inv = xml4.serializer_v4.read_inventory(
2688
self.branch._transport.get('inventory'))
2689
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2690
self.branch._transport.put_bytes('inventory', new_inv_xml,
2691
mode=self.bzrdir._get_file_mode())
2693
def _write_all_weaves(self):
2694
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2695
weave_transport = self.bzrdir.transport.clone('weaves')
2696
weaves = WeaveStore(weave_transport, prefixed=False)
2697
transaction = WriteTransaction()
2701
for file_id, file_weave in self.text_weaves.items():
2702
self.pb.update('writing weave', i, len(self.text_weaves))
2703
weaves._put_weave(file_id, file_weave, transaction)
2705
self.pb.update('inventory', 0, 1)
2706
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2707
self.pb.update('inventory', 1, 1)
2711
def _write_all_revs(self):
2712
"""Write all revisions out in new form."""
2713
self.bzrdir.transport.delete_tree('revision-store')
2714
self.bzrdir.transport.mkdir('revision-store')
2715
revision_transport = self.bzrdir.transport.clone('revision-store')
2717
from bzrlib.xml5 import serializer_v5
2718
from bzrlib.repofmt.weaverepo import RevisionTextStore
2719
revision_store = RevisionTextStore(revision_transport,
2720
serializer_v5, False, versionedfile.PrefixMapper(),
2721
lambda:True, lambda:True)
2723
for i, rev_id in enumerate(self.converted_revs):
2724
self.pb.update('write revision', i, len(self.converted_revs))
2725
text = serializer_v5.write_revision_to_string(
2726
self.revisions[rev_id])
2728
revision_store.add_lines(key, None, osutils.split_lines(text))
2732
def _load_one_rev(self, rev_id):
2733
"""Load a revision object into memory.
2735
Any parents not either loaded or abandoned get queued to be
2737
self.pb.update('loading revision',
2738
len(self.revisions),
2739
len(self.known_revisions))
2740
if not self.branch.repository.has_revision(rev_id):
2742
ui.ui_factory.note('revision {%s} not present in branch; '
2743
'will be converted as a ghost' %
2745
self.absent_revisions.add(rev_id)
2747
rev = self.branch.repository.get_revision(rev_id)
2748
for parent_id in rev.parent_ids:
2749
self.known_revisions.add(parent_id)
2750
self.to_read.append(parent_id)
2751
self.revisions[rev_id] = rev
2753
def _load_old_inventory(self, rev_id):
2754
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2755
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2756
inv.revision_id = rev_id
2757
rev = self.revisions[rev_id]
2760
def _load_updated_inventory(self, rev_id):
2761
inv_xml = self.inv_weave.get_text(rev_id)
2762
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2765
def _convert_one_rev(self, rev_id):
2766
"""Convert revision and all referenced objects to new format."""
2767
rev = self.revisions[rev_id]
2768
inv = self._load_old_inventory(rev_id)
2769
present_parents = [p for p in rev.parent_ids
2770
if p not in self.absent_revisions]
2771
self._convert_revision_contents(rev, inv, present_parents)
2772
self._store_new_inv(rev, inv, present_parents)
2773
self.converted_revs.add(rev_id)
2775
def _store_new_inv(self, rev, inv, present_parents):
2776
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2777
new_inv_sha1 = sha_string(new_inv_xml)
2778
self.inv_weave.add_lines(rev.revision_id,
2780
new_inv_xml.splitlines(True))
2781
rev.inventory_sha1 = new_inv_sha1
2783
def _convert_revision_contents(self, rev, inv, present_parents):
2784
"""Convert all the files within a revision.
2786
Also upgrade the inventory to refer to the text revision ids."""
2787
rev_id = rev.revision_id
2788
mutter('converting texts of revision {%s}',
2790
parent_invs = map(self._load_updated_inventory, present_parents)
2791
entries = inv.iter_entries()
2793
for path, ie in entries:
2794
self._convert_file_version(rev, ie, parent_invs)
2796
def _convert_file_version(self, rev, ie, parent_invs):
2797
"""Convert one version of one file.
2799
The file needs to be added into the weave if it is a merge
2800
of >=2 parents or if it's changed from its parent.
2802
file_id = ie.file_id
2803
rev_id = rev.revision_id
2804
w = self.text_weaves.get(file_id)
2807
self.text_weaves[file_id] = w
2808
text_changed = False
2809
parent_candiate_entries = ie.parent_candidates(parent_invs)
2810
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2811
# XXX: Note that this is unordered - and this is tolerable because
2812
# the previous code was also unordered.
2813
previous_entries = dict((head, parent_candiate_entries[head]) for head
2815
self.snapshot_ie(previous_entries, ie, w, rev_id)
2818
def get_parent_map(self, revision_ids):
2819
"""See graph.StackedParentsProvider.get_parent_map"""
2820
return dict((revision_id, self.revisions[revision_id])
2821
for revision_id in revision_ids
2822
if revision_id in self.revisions)
2824
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2825
# TODO: convert this logic, which is ~= snapshot to
2826
# a call to:. This needs the path figured out. rather than a work_tree
2827
# a v4 revision_tree can be given, or something that looks enough like
2828
# one to give the file content to the entry if it needs it.
2829
# and we need something that looks like a weave store for snapshot to
2831
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2832
if len(previous_revisions) == 1:
2833
previous_ie = previous_revisions.values()[0]
2834
if ie._unchanged(previous_ie):
2835
ie.revision = previous_ie.revision
2838
text = self.branch.repository._text_store.get(ie.text_id)
2839
file_lines = text.readlines()
2840
w.add_lines(rev_id, previous_revisions, file_lines)
2841
self.text_count += 1
2843
w.add_lines(rev_id, previous_revisions, [])
2844
ie.revision = rev_id
2846
def _make_order(self):
2847
"""Return a suitable order for importing revisions.
2849
The order must be such that an revision is imported after all
2850
its (present) parents.
2852
todo = set(self.revisions.keys())
2853
done = self.absent_revisions.copy()
2856
# scan through looking for a revision whose parents
2858
for rev_id in sorted(list(todo)):
2859
rev = self.revisions[rev_id]
2860
parent_ids = set(rev.parent_ids)
2861
if parent_ids.issubset(done):
2862
# can take this one now
2863
order.append(rev_id)
2869
class ConvertBzrDir5To6(Converter):
2870
"""Converts format 5 bzr dirs to format 6."""
2872
def convert(self, to_convert, pb):
2873
"""See Converter.convert()."""
2874
self.bzrdir = to_convert
2875
pb = ui.ui_factory.nested_progress_bar()
2877
ui.ui_factory.note('starting upgrade from format 5 to 6')
2878
self._convert_to_prefixed()
2879
return BzrDir.open(self.bzrdir.root_transport.base)
2883
def _convert_to_prefixed(self):
2884
from bzrlib.store import TransportStore
2885
self.bzrdir.transport.delete('branch-format')
2886
for store_name in ["weaves", "revision-store"]:
2887
ui.ui_factory.note("adding prefixes to %s" % store_name)
2888
store_transport = self.bzrdir.transport.clone(store_name)
2889
store = TransportStore(store_transport, prefixed=True)
2890
for urlfilename in store_transport.list_dir('.'):
2891
filename = urlutils.unescape(urlfilename)
2892
if (filename.endswith(".weave") or
2893
filename.endswith(".gz") or
2894
filename.endswith(".sig")):
2895
file_id, suffix = os.path.splitext(filename)
2899
new_name = store._mapper.map((file_id,)) + suffix
2900
# FIXME keep track of the dirs made RBC 20060121
2902
store_transport.move(filename, new_name)
2903
except errors.NoSuchFile: # catches missing dirs strangely enough
2904
store_transport.mkdir(osutils.dirname(new_name))
2905
store_transport.move(filename, new_name)
2906
self.bzrdir.transport.put_bytes(
2908
BzrDirFormat6().get_format_string(),
2909
mode=self.bzrdir._get_file_mode())
2912
class ConvertBzrDir6ToMeta(Converter):
2913
"""Converts format 6 bzr dirs to metadirs."""
2915
def convert(self, to_convert, pb):
2916
"""See Converter.convert()."""
2917
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2918
from bzrlib.branch import BzrBranchFormat5
2919
self.bzrdir = to_convert
2920
self.pb = ui.ui_factory.nested_progress_bar()
2922
self.total = 20 # the steps we know about
2923
self.garbage_inventories = []
2924
self.dir_mode = self.bzrdir._get_dir_mode()
2925
self.file_mode = self.bzrdir._get_file_mode()
2927
ui.ui_factory.note('starting upgrade from format 6 to metadir')
2928
self.bzrdir.transport.put_bytes(
2930
"Converting to format 6",
2931
mode=self.file_mode)
2932
# its faster to move specific files around than to open and use the apis...
2933
# first off, nuke ancestry.weave, it was never used.
2935
self.step('Removing ancestry.weave')
2936
self.bzrdir.transport.delete('ancestry.weave')
2937
except errors.NoSuchFile:
2939
# find out whats there
2940
self.step('Finding branch files')
2941
last_revision = self.bzrdir.open_branch().last_revision()
2942
bzrcontents = self.bzrdir.transport.list_dir('.')
2943
for name in bzrcontents:
2944
if name.startswith('basis-inventory.'):
2945
self.garbage_inventories.append(name)
2946
# create new directories for repository, working tree and branch
2947
repository_names = [('inventory.weave', True),
2948
('revision-store', True),
2950
self.step('Upgrading repository ')
2951
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2952
self.make_lock('repository')
2953
# we hard code the formats here because we are converting into
2954
# the meta format. The meta format upgrader can take this to a
2955
# future format within each component.
2956
self.put_format('repository', RepositoryFormat7())
2957
for entry in repository_names:
2958
self.move_entry('repository', entry)
2960
self.step('Upgrading branch ')
2961
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2962
self.make_lock('branch')
2963
self.put_format('branch', BzrBranchFormat5())
2964
branch_files = [('revision-history', True),
2965
('branch-name', True),
2967
for entry in branch_files:
2968
self.move_entry('branch', entry)
2970
checkout_files = [('pending-merges', True),
2971
('inventory', True),
2972
('stat-cache', False)]
2973
# If a mandatory checkout file is not present, the branch does not have
2974
# a functional checkout. Do not create a checkout in the converted
2976
for name, mandatory in checkout_files:
2977
if mandatory and name not in bzrcontents:
2978
has_checkout = False
2982
if not has_checkout:
2983
ui.ui_factory.note('No working tree.')
2984
# If some checkout files are there, we may as well get rid of them.
2985
for name, mandatory in checkout_files:
2986
if name in bzrcontents:
2987
self.bzrdir.transport.delete(name)
2989
from bzrlib.workingtree import WorkingTreeFormat3
2990
self.step('Upgrading working tree')
2991
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2992
self.make_lock('checkout')
2994
'checkout', WorkingTreeFormat3())
2995
self.bzrdir.transport.delete_multi(
2996
self.garbage_inventories, self.pb)
2997
for entry in checkout_files:
2998
self.move_entry('checkout', entry)
2999
if last_revision is not None:
3000
self.bzrdir.transport.put_bytes(
3001
'checkout/last-revision', last_revision)
3002
self.bzrdir.transport.put_bytes(
3004
BzrDirMetaFormat1().get_format_string(),
3005
mode=self.file_mode)
3007
return BzrDir.open(self.bzrdir.root_transport.base)
3009
def make_lock(self, name):
3010
"""Make a lock for the new control dir name."""
3011
self.step('Make %s lock' % name)
3012
ld = lockdir.LockDir(self.bzrdir.transport,
3014
file_modebits=self.file_mode,
3015
dir_modebits=self.dir_mode)
3018
def move_entry(self, new_dir, entry):
3019
"""Move then entry name into new_dir."""
3021
mandatory = entry[1]
3022
self.step('Moving %s' % name)
3024
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3025
except errors.NoSuchFile:
3029
def put_format(self, dirname, format):
3030
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3031
format.get_format_string(),
3035
class ConvertMetaToMeta(Converter):
1785
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1787
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1790
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1791
"""BzrDirMeta1 format with support for colocated branches."""
1793
colocated_branches = True
1796
def get_format_string(cls):
1797
"""See BzrDirFormat.get_format_string()."""
1798
return "Bazaar meta directory, format 1 (with colocated branches)\n"
1800
def get_format_description(self):
1801
"""See BzrDirFormat.get_format_description()."""
1802
return "Meta directory format 1 with support for colocated branches"
1804
def _open(self, transport):
1805
"""See BzrDirFormat._open."""
1806
# Create a new format instance because otherwise initialisation of new
1807
# metadirs share the global default format object leading to alias
1809
format = BzrDirMetaFormat1Colo()
1810
self._supply_sub_formats_to(format)
1811
return BzrDirMeta1Colo(transport, format)
1814
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1815
BzrDirMetaFormat1Colo)
1818
class ConvertMetaToMeta(controldir.Converter):
3036
1819
"""Converts the components of metadirs."""
3038
1821
def __init__(self, target_format):
3111
1893
return to_convert
3114
# This is not in remote.py because it's relatively small, and needs to be
3115
# registered. Putting it in remote.py creates a circular import problem.
3116
# we can make it a lazy object if the control formats is turned into something
3118
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3119
"""Format representing bzrdirs accessed via a smart server"""
3122
BzrDirMetaFormat1.__init__(self)
3123
# XXX: It's a bit ugly that the network name is here, because we'd
3124
# like to believe that format objects are stateless or at least
3125
# immutable, However, we do at least avoid mutating the name after
3126
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3127
self._network_name = None
3130
return "%s(_network_name=%r)" % (self.__class__.__name__,
3133
def get_format_description(self):
3134
if self._network_name:
3135
real_format = network_format_registry.get(self._network_name)
3136
return 'Remote: ' + real_format.get_format_description()
3137
return 'bzr remote bzrdir'
3139
def get_format_string(self):
3140
raise NotImplementedError(self.get_format_string)
3142
def network_name(self):
3143
if self._network_name:
3144
return self._network_name
3146
raise AssertionError("No network name set.")
3149
def probe_transport(klass, transport):
3150
"""Return a RemoteBzrDirFormat object if it looks possible."""
3152
medium = transport.get_smart_medium()
3153
except (NotImplementedError, AttributeError,
3154
errors.TransportNotPossible, errors.NoSmartMedium,
3155
errors.SmartProtocolError):
3156
# no smart server, so not a branch for this format type.
3157
raise errors.NotBranchError(path=transport.base)
3159
# Decline to open it if the server doesn't support our required
3160
# version (3) so that the VFS-based transport will do it.
3161
if medium.should_probe():
3163
server_version = medium.protocol_version()
3164
except errors.SmartProtocolError:
3165
# Apparently there's no usable smart server there, even though
3166
# the medium supports the smart protocol.
3167
raise errors.NotBranchError(path=transport.base)
3168
if server_version != '2':
3169
raise errors.NotBranchError(path=transport.base)
3172
def initialize_on_transport(self, transport):
3174
# hand off the request to the smart server
3175
client_medium = transport.get_smart_medium()
3176
except errors.NoSmartMedium:
3177
# TODO: lookup the local format from a server hint.
3178
local_dir_format = BzrDirMetaFormat1()
3179
return local_dir_format.initialize_on_transport(transport)
3180
client = _SmartClient(client_medium)
3181
path = client.remote_path_from_transport(transport)
3183
response = client.call('BzrDirFormat.initialize', path)
3184
except errors.ErrorFromSmartServer, err:
3185
remote._translate_error(err, path=path)
3186
if response[0] != 'ok':
3187
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3188
format = RemoteBzrDirFormat()
3189
self._supply_sub_formats_to(format)
3190
return remote.RemoteBzrDir(transport, format)
3192
def parse_NoneTrueFalse(self, arg):
3199
raise AssertionError("invalid arg %r" % arg)
3201
def _serialize_NoneTrueFalse(self, arg):
3208
def _serialize_NoneString(self, arg):
3211
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3212
create_prefix=False, force_new_repo=False, stacked_on=None,
3213
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3216
# hand off the request to the smart server
3217
client_medium = transport.get_smart_medium()
3218
except errors.NoSmartMedium:
3221
# Decline to open it if the server doesn't support our required
3222
# version (3) so that the VFS-based transport will do it.
3223
if client_medium.should_probe():
3225
server_version = client_medium.protocol_version()
3226
if server_version != '2':
3230
except errors.SmartProtocolError:
3231
# Apparently there's no usable smart server there, even though
3232
# the medium supports the smart protocol.
3237
client = _SmartClient(client_medium)
3238
path = client.remote_path_from_transport(transport)
3239
if client_medium._is_remote_before((1, 16)):
3242
# TODO: lookup the local format from a server hint.
3243
local_dir_format = BzrDirMetaFormat1()
3244
self._supply_sub_formats_to(local_dir_format)
3245
return local_dir_format.initialize_on_transport_ex(transport,
3246
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3247
force_new_repo=force_new_repo, stacked_on=stacked_on,
3248
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3249
make_working_trees=make_working_trees, shared_repo=shared_repo,
3251
return self._initialize_on_transport_ex_rpc(client, path, transport,
3252
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3253
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3255
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3256
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3257
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3259
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3260
args.append(self._serialize_NoneTrueFalse(create_prefix))
3261
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3262
args.append(self._serialize_NoneString(stacked_on))
3263
# stack_on_pwd is often/usually our transport
3266
stack_on_pwd = transport.relpath(stack_on_pwd)
3267
if not stack_on_pwd:
3269
except errors.PathNotChild:
3271
args.append(self._serialize_NoneString(stack_on_pwd))
3272
args.append(self._serialize_NoneString(repo_format_name))
3273
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3274
args.append(self._serialize_NoneTrueFalse(shared_repo))
3275
request_network_name = self._network_name or \
3276
BzrDirFormat.get_default_format().network_name()
3278
response = client.call('BzrDirFormat.initialize_ex_1.16',
3279
request_network_name, path, *args)
3280
except errors.UnknownSmartMethod:
3281
client._medium._remember_remote_is_before((1,16))
3282
local_dir_format = BzrDirMetaFormat1()
3283
self._supply_sub_formats_to(local_dir_format)
3284
return local_dir_format.initialize_on_transport_ex(transport,
3285
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3286
force_new_repo=force_new_repo, stacked_on=stacked_on,
3287
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3288
make_working_trees=make_working_trees, shared_repo=shared_repo,
3290
except errors.ErrorFromSmartServer, err:
3291
remote._translate_error(err, path=path)
3292
repo_path = response[0]
3293
bzrdir_name = response[6]
3294
require_stacking = response[7]
3295
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3296
format = RemoteBzrDirFormat()
3297
format._network_name = bzrdir_name
3298
self._supply_sub_formats_to(format)
3299
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3301
repo_format = remote.response_tuple_to_repo_format(response[1:])
3302
if repo_path == '.':
3305
repo_bzrdir_format = RemoteBzrDirFormat()
3306
repo_bzrdir_format._network_name = response[5]
3307
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3311
final_stack = response[8] or None
3312
final_stack_pwd = response[9] or None
3314
final_stack_pwd = urlutils.join(
3315
transport.base, final_stack_pwd)
3316
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3317
if len(response) > 10:
3318
# Updated server verb that locks remotely.
3319
repo_lock_token = response[10] or None
3320
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3322
remote_repo.dont_leave_lock_in_place()
3324
remote_repo.lock_write()
3325
policy = UseExistingRepository(remote_repo, final_stack,
3326
final_stack_pwd, require_stacking)
3327
policy.acquire_repository()
3331
bzrdir._format.set_branch_format(self.get_branch_format())
3332
if require_stacking:
3333
# The repo has already been created, but we need to make sure that
3334
# we'll make a stackable branch.
3335
bzrdir._format.require_stacking(_skip_repo=True)
3336
return remote_repo, bzrdir, require_stacking, policy
3338
def _open(self, transport):
3339
return remote.RemoteBzrDir(transport, self)
3341
def __eq__(self, other):
3342
if not isinstance(other, RemoteBzrDirFormat):
3344
return self.get_format_description() == other.get_format_description()
3346
def __return_repository_format(self):
3347
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3348
# repository format has been asked for, tell the RemoteRepositoryFormat
3349
# that it should use that for init() etc.
3350
result = remote.RemoteRepositoryFormat()
3351
custom_format = getattr(self, '_repository_format', None)
3353
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3354
return custom_format
3356
# We will use the custom format to create repositories over the
3357
# wire; expose its details like rich_root_data for code to
3359
result._custom_format = custom_format
3362
def get_branch_format(self):
3363
result = BzrDirMetaFormat1.get_branch_format(self)
3364
if not isinstance(result, remote.RemoteBranchFormat):
3365
new_result = remote.RemoteBranchFormat()
3366
new_result._custom_format = result
3368
self.set_branch_format(new_result)
3372
repository_format = property(__return_repository_format,
3373
BzrDirMetaFormat1._set_repository_format) #.im_func)
3376
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3379
class BzrDirFormatInfo(object):
3381
def __init__(self, native, deprecated, hidden, experimental):
3382
self.deprecated = deprecated
3383
self.native = native
3384
self.hidden = hidden
3385
self.experimental = experimental
3388
class BzrDirFormatRegistry(registry.Registry):
3389
"""Registry of user-selectable BzrDir subformats.
3391
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3392
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3396
"""Create a BzrDirFormatRegistry."""
3397
self._aliases = set()
3398
self._registration_order = list()
3399
super(BzrDirFormatRegistry, self).__init__()
3402
"""Return a set of the format names which are aliases."""
3403
return frozenset(self._aliases)
3405
def register_metadir(self, key,
3406
repository_format, help, native=True, deprecated=False,
3412
"""Register a metadir subformat.
3414
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3415
by the Repository/Branch/WorkingTreeformats.
3417
:param repository_format: The fully-qualified repository format class
3419
:param branch_format: Fully-qualified branch format class name as
3421
:param tree_format: Fully-qualified tree format class name as
3424
# This should be expanded to support setting WorkingTree and Branch
3425
# formats, once BzrDirMetaFormat1 supports that.
3426
def _load(full_name):
3427
mod_name, factory_name = full_name.rsplit('.', 1)
3429
mod = __import__(mod_name, globals(), locals(),
3431
except ImportError, e:
3432
raise ImportError('failed to load %s: %s' % (full_name, e))
3434
factory = getattr(mod, factory_name)
3435
except AttributeError:
3436
raise AttributeError('no factory %s in module %r'
3441
bd = BzrDirMetaFormat1()
3442
if branch_format is not None:
3443
bd.set_branch_format(_load(branch_format))
3444
if tree_format is not None:
3445
bd.workingtree_format = _load(tree_format)
3446
if repository_format is not None:
3447
bd.repository_format = _load(repository_format)
3449
self.register(key, helper, help, native, deprecated, hidden,
3450
experimental, alias)
3452
def register(self, key, factory, help, native=True, deprecated=False,
3453
hidden=False, experimental=False, alias=False):
3454
"""Register a BzrDirFormat factory.
3456
The factory must be a callable that takes one parameter: the key.
3457
It must produce an instance of the BzrDirFormat when called.
3459
This function mainly exists to prevent the info object from being
3462
registry.Registry.register(self, key, factory, help,
3463
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3465
self._aliases.add(key)
3466
self._registration_order.append(key)
3468
def register_lazy(self, key, module_name, member_name, help, native=True,
3469
deprecated=False, hidden=False, experimental=False, alias=False):
3470
registry.Registry.register_lazy(self, key, module_name, member_name,
3471
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3473
self._aliases.add(key)
3474
self._registration_order.append(key)
3476
def set_default(self, key):
3477
"""Set the 'default' key to be a clone of the supplied key.
3479
This method must be called once and only once.
3481
registry.Registry.register(self, 'default', self.get(key),
3482
self.get_help(key), info=self.get_info(key))
3483
self._aliases.add('default')
3485
def set_default_repository(self, key):
3486
"""Set the FormatRegistry default and Repository default.
3488
This is a transitional method while Repository.set_default_format
3491
if 'default' in self:
3492
self.remove('default')
3493
self.set_default(key)
3494
format = self.get('default')()
3496
def make_bzrdir(self, key):
3497
return self.get(key)()
3499
def help_topic(self, topic):
3501
default_realkey = None
3502
default_help = self.get_help('default')
3504
for key in self._registration_order:
3505
if key == 'default':
3507
help = self.get_help(key)
3508
if help == default_help:
3509
default_realkey = key
3511
help_pairs.append((key, help))
3513
def wrapped(key, help, info):
3515
help = '(native) ' + help
3516
return ':%s:\n%s\n\n' % (key,
3517
textwrap.fill(help, initial_indent=' ',
3518
subsequent_indent=' ',
3519
break_long_words=False))
3520
if default_realkey is not None:
3521
output += wrapped(default_realkey, '(default) %s' % default_help,
3522
self.get_info('default'))
3523
deprecated_pairs = []
3524
experimental_pairs = []
3525
for key, help in help_pairs:
3526
info = self.get_info(key)
3529
elif info.deprecated:
3530
deprecated_pairs.append((key, help))
3531
elif info.experimental:
3532
experimental_pairs.append((key, help))
3534
output += wrapped(key, help, info)
3535
output += "\nSee :doc:`formats-help` for more about storage formats."
3537
if len(experimental_pairs) > 0:
3538
other_output += "Experimental formats are shown below.\n\n"
3539
for key, help in experimental_pairs:
3540
info = self.get_info(key)
3541
other_output += wrapped(key, help, info)
3544
"No experimental formats are available.\n\n"
3545
if len(deprecated_pairs) > 0:
3546
other_output += "\nDeprecated formats are shown below.\n\n"
3547
for key, help in deprecated_pairs:
3548
info = self.get_info(key)
3549
other_output += wrapped(key, help, info)
3552
"\nNo deprecated formats are available.\n\n"
3554
"\nSee :doc:`formats-help` for more about storage formats."
3556
if topic == 'other-formats':
1896
class ConvertMetaToColo(controldir.Converter):
1897
"""Add colocated branch support."""
1899
def __init__(self, target_format):
1900
"""Create a converter.that upgrades a metadir to the colo format.
1902
:param target_format: The final metadir format that is desired.
1904
self.target_format = target_format
1906
def convert(self, to_convert, pb):
1907
"""See Converter.convert()."""
1908
to_convert.transport.put_bytes('branch-format',
1909
self.target_format.as_string())
1910
return BzrDir.open_from_transport(to_convert.root_transport)
1913
class ConvertMetaRemoveColo(controldir.Converter):
1914
"""Remove colocated branch support from a bzrdir."""
1916
def __init__(self, target_format):
1917
"""Create a converter.that downgrades a colocated branch metadir
1918
to a regular metadir.
1920
:param target_format: The final metadir format that is desired.
1922
self.target_format = target_format
1924
def convert(self, to_convert, pb):
1925
"""See Converter.convert()."""
1926
to_convert.control_files.lock_write()
1928
branches = to_convert.list_branches()
1929
if len(branches) > 1:
1930
raise errors.BzrError("remove all but a single "
1931
"colocated branch when downgrading")
1933
to_convert.control_files.unlock()
1934
to_convert.transport.put_bytes('branch-format',
1935
self.target_format.as_string())
1936
return BzrDir.open_from_transport(to_convert.root_transport)
1939
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3562
1942
class RepositoryAcquisitionPolicy(object):
3706
2094
require_stacking)
3707
2095
self._repository = repository
3709
def acquire_repository(self, make_working_trees=None, shared=False):
2097
def acquire_repository(self, make_working_trees=None, shared=False,
2098
possible_transports=None):
3710
2099
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3712
2101
Returns an existing repository to use.
2103
if possible_transports is None:
2104
possible_transports = []
2106
possible_transports = list(possible_transports)
2107
possible_transports.append(self._repository.bzrdir.transport)
3714
2108
self._add_fallback(self._repository,
3715
possible_transports=[self._repository.bzrdir.transport])
2109
possible_transports=possible_transports)
3716
2110
return self._repository, False
3719
# Please register new formats after old formats so that formats
3720
# appear in chronological order and format descriptions can build
3722
format_registry = BzrDirFormatRegistry()
3723
# The pre-0.8 formats have their repository format network name registered in
3724
# repository.py. MetaDir formats have their repository format network name
3725
# inferred from their disk format string.
3726
format_registry.register('weave', BzrDirFormat6,
3727
'Pre-0.8 format. Slower than knit and does not'
3728
' support checkouts or shared repositories.',
3731
format_registry.register_metadir('metaweave',
3732
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3733
'Transitional format in 0.8. Slower than knit.',
3734
branch_format='bzrlib.branch.BzrBranchFormat5',
3735
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3738
format_registry.register_metadir('knit',
2113
def register_metadir(registry, key,
2114
repository_format, help, native=True, deprecated=False,
2119
alias=False, bzrdir_format=None):
2120
"""Register a metadir subformat.
2122
These all use a meta bzrdir, but can be parameterized by the
2123
Repository/Branch/WorkingTreeformats.
2125
:param repository_format: The fully-qualified repository format class
2127
:param branch_format: Fully-qualified branch format class name as
2129
:param tree_format: Fully-qualified tree format class name as
2132
if bzrdir_format is None:
2133
bzrdir_format = BzrDirMetaFormat1
2134
# This should be expanded to support setting WorkingTree and Branch
2135
# formats, once the API supports that.
2136
def _load(full_name):
2137
mod_name, factory_name = full_name.rsplit('.', 1)
2139
factory = pyutils.get_named_object(mod_name, factory_name)
2140
except ImportError, e:
2141
raise ImportError('failed to load %s: %s' % (full_name, e))
2142
except AttributeError:
2143
raise AttributeError('no factory %s in module %r'
2144
% (full_name, sys.modules[mod_name]))
2148
bd = bzrdir_format()
2149
if branch_format is not None:
2150
bd.set_branch_format(_load(branch_format))
2151
if tree_format is not None:
2152
bd.workingtree_format = _load(tree_format)
2153
if repository_format is not None:
2154
bd.repository_format = _load(repository_format)
2156
registry.register(key, helper, help, native, deprecated, hidden,
2157
experimental, alias)
2159
register_metadir(controldir.format_registry, 'knit',
3739
2160
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3740
2161
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3741
2162
branch_format='bzrlib.branch.BzrBranchFormat5',
3742
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2163
tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
3744
2165
deprecated=True)
3745
format_registry.register_metadir('dirstate',
2166
register_metadir(controldir.format_registry, 'dirstate',
3746
2167
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3747
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3748
'above when accessed over the network.',
2168
help='Format using dirstate for working trees. '
2169
'Compatible with bzr 0.8 and '
2170
'above when accessed over the network. Introduced in bzr 0.15.',
3749
2171
branch_format='bzrlib.branch.BzrBranchFormat5',
3750
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3751
# directly from workingtree_4 triggers a circular import.
3752
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2172
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3754
2174
deprecated=True)
3755
format_registry.register_metadir('dirstate-tags',
2175
register_metadir(controldir.format_registry, 'dirstate-tags',
3756
2176
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3757
help='New in 0.15: Fast local operations and improved scaling for '
3758
'network operations. Additionally adds support for tags.'
3759
' Incompatible with bzr < 0.15.',
2177
help='Variant of dirstate with support for tags. '
2178
'Introduced in bzr 0.15.',
3760
2179
branch_format='bzrlib.branch.BzrBranchFormat6',
3761
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2180
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3763
2182
deprecated=True)
3764
format_registry.register_metadir('rich-root',
2183
register_metadir(controldir.format_registry, 'rich-root',
3765
2184
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3766
help='New in 1.0. Better handling of tree roots. Incompatible with'
2185
help='Variant of dirstate with better handling of tree roots. '
2186
'Introduced in bzr 1.0',
3768
2187
branch_format='bzrlib.branch.BzrBranchFormat6',
3769
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2188
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3771
2190
deprecated=True)
3772
format_registry.register_metadir('dirstate-with-subtree',
2191
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3773
2192
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3774
help='New in 0.15: Fast local operations and improved scaling for '
3775
'network operations. Additionally adds support for versioning nested '
3776
'bzr branches. Incompatible with bzr < 0.15.',
3777
branch_format='bzrlib.branch.BzrBranchFormat6',
3778
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3782
format_registry.register_metadir('pack-0.92',
3783
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3784
help='New in 0.92: Pack-based format with data compatible with '
3785
'dirstate-tags format repositories. Interoperates with '
3786
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3788
branch_format='bzrlib.branch.BzrBranchFormat6',
3789
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3791
format_registry.register_metadir('pack-0.92-subtree',
3792
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3793
help='New in 0.92: Pack-based format with data compatible with '
3794
'dirstate-with-subtree format repositories. Interoperates with '
3795
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3797
branch_format='bzrlib.branch.BzrBranchFormat6',
3798
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3802
format_registry.register_metadir('rich-root-pack',
3803
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3804
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3805
'(needed for bzr-svn and bzr-git).',
3806
branch_format='bzrlib.branch.BzrBranchFormat6',
3807
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3810
format_registry.register_metadir('1.6',
3811
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2193
help='Variant of dirstate with support for nested trees. '
2194
'Introduced in 0.15.',
2195
branch_format='bzrlib.branch.BzrBranchFormat6',
2196
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2200
register_metadir(controldir.format_registry, 'pack-0.92',
2201
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2202
help='Pack-based format used in 1.x series. Introduced in 0.92. '
2203
'Interoperates with bzr repositories before 0.92 but cannot be '
2204
'read by bzr < 0.92. '
2206
branch_format='bzrlib.branch.BzrBranchFormat6',
2207
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2210
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2211
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2212
help='Pack-based format used in 1.x series, with subtree support. '
2213
'Introduced in 0.92. Interoperates with '
2214
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2216
branch_format='bzrlib.branch.BzrBranchFormat6',
2217
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2222
register_metadir(controldir.format_registry, 'rich-root-pack',
2223
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2224
help='A variant of pack-0.92 that supports rich-root data '
2225
'(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2226
branch_format='bzrlib.branch.BzrBranchFormat6',
2227
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2231
register_metadir(controldir.format_registry, '1.6',
2232
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
3812
2233
help='A format that allows a branch to indicate that there is another '
3813
2234
'(stacked) repository that should be used to access data that is '
3814
2235
'not present locally.',
3815
2236
branch_format='bzrlib.branch.BzrBranchFormat7',
3816
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2237
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3819
format_registry.register_metadir('1.6.1-rich-root',
3820
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2241
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2242
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
3821
2243
help='A variant of 1.6 that supports rich-root data '
3822
2244
'(needed for bzr-svn and bzr-git).',
3823
2245
branch_format='bzrlib.branch.BzrBranchFormat7',
3824
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2246
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3827
format_registry.register_metadir('1.9',
3828
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2250
register_metadir(controldir.format_registry, '1.9',
2251
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3829
2252
help='A repository format using B+tree indexes. These indexes '
3830
2253
'are smaller in size, have smarter caching and provide faster '
3831
2254
'performance for most operations.',
3832
2255
branch_format='bzrlib.branch.BzrBranchFormat7',
3833
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2256
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3836
format_registry.register_metadir('1.9-rich-root',
3837
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2260
register_metadir(controldir.format_registry, '1.9-rich-root',
2261
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3838
2262
help='A variant of 1.9 that supports rich-root data '
3839
2263
'(needed for bzr-svn and bzr-git).',
3840
2264
branch_format='bzrlib.branch.BzrBranchFormat7',
3841
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2265
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3844
format_registry.register_metadir('1.14',
3845
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2269
register_metadir(controldir.format_registry, '1.14',
2270
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3846
2271
help='A working-tree format that supports content filtering.',
3847
2272
branch_format='bzrlib.branch.BzrBranchFormat7',
3848
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2273
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3850
format_registry.register_metadir('1.14-rich-root',
3851
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2277
register_metadir(controldir.format_registry, '1.14-rich-root',
2278
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3852
2279
help='A variant of 1.14 that supports rich-root data '
3853
2280
'(needed for bzr-svn and bzr-git).',
3854
2281
branch_format='bzrlib.branch.BzrBranchFormat7',
3855
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2282
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3857
2286
# The following un-numbered 'development' formats should always just be aliases.
3858
format_registry.register_metadir('development-rich-root',
3859
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3860
help='Current development format. Supports rich roots. Can convert data '
3861
'to and from rich-root-pack (and anything compatible with '
3862
'rich-root-pack) format repositories. Repositories and branches in '
3863
'this format can only be read by bzr.dev. Please read '
3864
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3866
branch_format='bzrlib.branch.BzrBranchFormat7',
3867
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3872
format_registry.register_metadir('development-subtree',
3873
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2287
register_metadir(controldir.format_registry, 'development-subtree',
2288
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3874
2289
help='Current development format, subtree variant. Can convert data to and '
3875
2290
'from pack-0.92-subtree (and anything compatible with '
3876
2291
'pack-0.92-subtree) format repositories. Repositories and branches in '
3878
2293
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3880
2295
branch_format='bzrlib.branch.BzrBranchFormat7',
3881
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2296
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3882
2297
experimental=True,
3884
2299
alias=False, # Restore to being an alias when an actual development subtree format is added
3885
2300
# This current non-alias status is simply because we did not introduce a
3886
2301
# chk based subtree format.
2303
register_metadir(controldir.format_registry, 'development5-subtree',
2304
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2305
help='Development format, subtree variant. Can convert data to and '
2306
'from pack-0.92-subtree (and anything compatible with '
2307
'pack-0.92-subtree) format repositories. Repositories and branches in '
2308
'this format can only be read by bzr.dev. Please read '
2309
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2311
branch_format='bzrlib.branch.BzrBranchFormat7',
2312
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2318
register_metadir(controldir.format_registry, 'development-colo',
2319
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2320
help='The 2a format with experimental support for colocated branches.\n',
2321
branch_format='bzrlib.branch.BzrBranchFormat7',
2322
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2324
bzrdir_format=BzrDirMetaFormat1Colo,
3889
2328
# And the development formats above will have aliased one of the following:
3890
format_registry.register_metadir('development6-rich-root',
3891
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3892
help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3894
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3896
branch_format='bzrlib.branch.BzrBranchFormat7',
3897
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3902
format_registry.register_metadir('development7-rich-root',
3903
'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3904
help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3905
'rich roots. Please read '
3906
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3908
branch_format='bzrlib.branch.BzrBranchFormat7',
3909
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3914
format_registry.register_metadir('2a',
2330
# Finally, the current format.
2331
register_metadir(controldir.format_registry, '2a',
3915
2332
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3916
help='First format for bzr 2.0 series.\n'
2333
help='Format for the bzr 2.0 series.\n'
3917
2334
'Uses group-compress storage.\n'
3918
2335
'Provides rich roots which are a one-way transition.\n',
3919
2336
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3920
2337
# 'rich roots. Supported by bzr 1.16 and later.',
3921
2338
branch_format='bzrlib.branch.BzrBranchFormat7',
3922
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2339
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3926
2343
# The following format should be an alias for the rich root equivalent
3927
2344
# of the default format
3928
format_registry.register_metadir('default-rich-root',
2345
register_metadir(controldir.format_registry, 'default-rich-root',
3929
2346
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3930
2347
branch_format='bzrlib.branch.BzrBranchFormat7',
3931
tree_format='bzrlib.workingtree.WorkingTreeFormat6',
2348
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3934
2351
help='Same as 2a.')
3936
2353
# The current format that is made on 'bzr init'.
3937
format_registry.set_default('2a')
2354
format_name = config.GlobalStack().get('default_format')
2355
controldir.format_registry.set_default(format_name)
2357
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2358
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2359
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2360
format_registry = controldir.format_registry
added
removed
bzrlib/bzrdir.py
