169
208
local_repo = local_branch.repository
170
209
if preserve_stacking:
172
stacked_on = local_branch.get_stacked_on_url()
211
stack_on = local_branch.get_stacked_on_url()
173
212
except (errors.UnstackableBranchFormat,
174
213
errors.UnstackableRepositoryFormat,
175
214
errors.NotStacked):
177
# Bug: We create a metadir without knowing if it can support stacking,
178
# we should look up the policy needs first, or just use it as a hint,
181
make_working_trees = local_repo.make_working_trees() and not no_tree
182
want_shared = local_repo.is_shared()
183
repo_format_name = format.repository_format.network_name()
185
make_working_trees = False
187
repo_format_name = None
189
result_repo, result, require_stacking, repository_policy = \
190
format.initialize_on_transport_ex(transport,
191
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
192
force_new_repo=force_new_repo, stacked_on=stacked_on,
193
stack_on_pwd=self.root_transport.base,
194
repo_format_name=repo_format_name,
195
make_working_trees=make_working_trees, shared_repo=want_shared)
198
# If the result repository is in the same place as the
199
# resulting bzr dir, it will have no content, further if the
200
# result is not stacked then we know all content should be
201
# copied, and finally if we are copying up to a specific
202
# revision_id then we can use the pending-ancestry-result which
203
# does not require traversing all of history to describe it.
204
if (result_repo.user_url == result.user_url
205
and not require_stacking and
206
revision_id is not None):
207
fetch_spec = vf_search.PendingAncestryResult(
208
[revision_id], local_repo)
209
result_repo.fetch(local_repo, fetch_spec=fetch_spec)
211
result_repo.fetch(local_repo, revision_id=revision_id)
215
if result_repo is not None:
216
raise AssertionError('result_repo not None(%r)' % result_repo)
218
# may need to copy content in
219
repository_policy = result.determine_repository_policy(
220
force_new_repo, stack_on, self.root_transport.base)
221
make_working_trees = local_repo.make_working_trees()
222
result_repo = repository_policy.acquire_repository(
223
make_working_trees, local_repo.is_shared())
224
result_repo.fetch(local_repo, revision_id=revision_id)
217
227
# 1 if there is a branch present
218
228
# make sure its content is available in the target repository
220
230
if local_branch is not None:
221
result_branch = local_branch.clone(result, revision_id=revision_id,
222
repository_policy=repository_policy)
224
# Cheaper to check if the target is not local, than to try making
226
result.root_transport.local_abspath('.')
227
if result_repo is None or result_repo.make_working_trees():
228
self.open_workingtree().clone(result, revision_id=revision_id)
229
except (errors.NoWorkingTree, errors.NotLocalUrl):
231
result_branch = local_branch.clone(result, revision_id=revision_id)
232
if repository_policy is not None:
233
repository_policy.configure_branch(result_branch)
234
if result_repo is None or result_repo.make_working_trees():
236
self.open_workingtree().clone(result)
237
except (errors.NoWorkingTree, errors.NotLocalUrl):
233
241
# TODO: This should be given a Transport, and should chdir up; otherwise
234
242
# this will open a new connection.
235
243
def _make_tail(self, url):
236
t = _mod_transport.get_transport(url)
244
t = get_transport(url)
248
def create(cls, base, format=None, possible_transports=None):
249
"""Create a new BzrDir at the url 'base'.
251
:param format: If supplied, the format of branch to create. If not
252
supplied, the default is used.
253
:param possible_transports: If supplied, a list of transports that
254
can be reused to share a remote connection.
256
if cls is not BzrDir:
257
raise AssertionError("BzrDir.create always creates the default"
258
" format, not one of %r" % cls)
259
t = get_transport(base, possible_transports)
262
format = BzrDirFormat.get_default_format()
263
return format.initialize_on_transport(t)
266
def find_bzrdirs(transport, evaluate=None, list_current=None):
267
"""Find bzrdirs recursively from current location.
269
This is intended primarily as a building block for more sophisticated
270
functionality, like finding trees under a directory, or finding
271
branches that use a given repository.
272
:param evaluate: An optional callable that yields recurse, value,
273
where recurse controls whether this bzrdir is recursed into
274
and value is the value to yield. By default, all bzrdirs
275
are recursed into, and the return value is the bzrdir.
276
:param list_current: if supplied, use this function to list the current
277
directory, instead of Transport.list_dir
278
:return: a generator of found bzrdirs, or whatever evaluate returns.
280
if list_current is None:
281
def list_current(transport):
282
return transport.list_dir('')
284
def evaluate(bzrdir):
287
pending = [transport]
288
while len(pending) > 0:
289
current_transport = pending.pop()
292
bzrdir = BzrDir.open_from_transport(current_transport)
293
except errors.NotBranchError:
296
recurse, value = evaluate(bzrdir)
299
subdirs = list_current(current_transport)
300
except errors.NoSuchFile:
303
for subdir in sorted(subdirs, reverse=True):
304
pending.append(current_transport.clone(subdir))
307
def find_branches(transport):
308
"""Find all branches under a transport.
310
This will find all branches below the transport, including branches
311
inside other branches. Where possible, it will use
312
Repository.find_branches.
314
To list all the branches that use a particular Repository, see
315
Repository.find_branches
317
def evaluate(bzrdir):
319
repository = bzrdir.open_repository()
320
except errors.NoRepositoryPresent:
323
return False, (None, repository)
325
branch = bzrdir.open_branch()
326
except errors.NotBranchError:
327
return True, (None, None)
329
return True, (branch, None)
331
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
333
branches.extend(repo.find_branches())
334
if branch is not None:
335
branches.append(branch)
338
def destroy_repository(self):
339
"""Destroy the repository in this BzrDir"""
340
raise NotImplementedError(self.destroy_repository)
342
def create_branch(self):
343
"""Create a branch in this BzrDir.
345
The bzrdir's format will control what branch format is created.
346
For more control see BranchFormatXX.create(a_bzrdir).
348
raise NotImplementedError(self.create_branch)
350
def destroy_branch(self):
351
"""Destroy the branch in this BzrDir"""
352
raise NotImplementedError(self.destroy_branch)
355
def create_branch_and_repo(base, force_new_repo=False, format=None):
356
"""Create a new BzrDir, Branch and Repository at the url 'base'.
358
This will use the current default BzrDirFormat unless one is
359
specified, and use whatever
360
repository format that that uses via bzrdir.create_branch and
361
create_repository. If a shared repository is available that is used
364
The created Branch object is returned.
366
:param base: The URL to create the branch at.
367
:param force_new_repo: If True a new repository is always created.
368
:param format: If supplied, the format of branch to create. If not
369
supplied, the default is used.
371
bzrdir = BzrDir.create(base, format)
372
bzrdir._find_or_create_repository(force_new_repo)
373
return bzrdir.create_branch()
239
375
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
376
stack_on_pwd=None, require_stacking=False):
241
377
"""Return an object representing a policy to use.
243
This controls whether a new repository is created, and the format of
244
that repository, or some existing shared repository used instead.
379
This controls whether a new repository is created, or a shared
380
repository used instead.
246
382
If stack_on is supplied, will not seek a containing shared repo.
300
437
def _find_or_create_repository(self, force_new_repo):
301
438
"""Create a new repository if needed, returning the repository."""
302
439
policy = self.determine_repository_policy(force_new_repo)
303
return policy.acquire_repository()[0]
305
def _find_source_repo(self, add_cleanup, source_branch):
306
"""Find the source branch and repo for a sprout operation.
440
return policy.acquire_repository()
443
def create_branch_convenience(base, force_new_repo=False,
444
force_new_tree=None, format=None,
445
possible_transports=None):
446
"""Create a new BzrDir, Branch and Repository at the url 'base'.
448
This is a convenience function - it will use an existing repository
449
if possible, can be told explicitly whether to create a working tree or
452
This will use the current default BzrDirFormat unless one is
453
specified, and use whatever
454
repository format that that uses via bzrdir.create_branch and
455
create_repository. If a shared repository is available that is used
456
preferentially. Whatever repository is used, its tree creation policy
459
The created Branch object is returned.
460
If a working tree cannot be made due to base not being a file:// url,
461
no error is raised unless force_new_tree is True, in which case no
462
data is created on disk and NotLocalUrl is raised.
464
:param base: The URL to create the branch at.
465
:param force_new_repo: If True a new repository is always created.
466
:param force_new_tree: If True or False force creation of a tree or
467
prevent such creation respectively.
468
:param format: Override for the bzrdir format to create.
469
:param possible_transports: An optional reusable transports list.
472
# check for non local urls
473
t = get_transport(base, possible_transports)
474
if not isinstance(t, LocalTransport):
475
raise errors.NotLocalUrl(base)
476
bzrdir = BzrDir.create(base, format, possible_transports)
477
repo = bzrdir._find_or_create_repository(force_new_repo)
478
result = bzrdir.create_branch()
479
if force_new_tree or (repo.make_working_trees() and
480
force_new_tree is None):
482
bzrdir.create_workingtree()
483
except errors.NotLocalUrl:
488
def create_standalone_workingtree(base, format=None):
489
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
491
'base' must be a local path or a file:// url.
493
This will use the current default BzrDirFormat unless one is
494
specified, and use whatever
495
repository format that that uses for bzrdirformat.create_workingtree,
496
create_branch and create_repository.
498
:param format: Override for the bzrdir format to create.
499
:return: The WorkingTree object.
501
t = get_transport(base)
502
if not isinstance(t, LocalTransport):
503
raise errors.NotLocalUrl(base)
504
bzrdir = BzrDir.create_branch_and_repo(base,
506
format=format).bzrdir
507
return bzrdir.create_workingtree()
509
def create_workingtree(self, revision_id=None, from_branch=None,
510
accelerator_tree=None, hardlink=False):
511
"""Create a working tree at this BzrDir.
308
This is helper intended for use by _sprout.
310
:returns: (source_branch, source_repository). Either or both may be
311
None. If not None, they will be read-locked (and their unlock(s)
312
scheduled via the add_cleanup param).
314
if source_branch is not None:
315
add_cleanup(source_branch.lock_read().unlock)
316
return source_branch, source_branch.repository
318
source_branch = self.open_branch()
319
source_repository = source_branch.repository
320
except errors.NotBranchError:
323
source_repository = self.open_repository()
324
except errors.NoRepositoryPresent:
325
source_repository = None
327
add_cleanup(source_repository.lock_read().unlock)
329
add_cleanup(source_branch.lock_read().unlock)
330
return source_branch, source_repository
332
def sprout(self, url, revision_id=None, force_new_repo=False,
333
recurse='down', possible_transports=None,
334
accelerator_tree=None, hardlink=False, stacked=False,
335
source_branch=None, create_tree_if_local=True):
336
"""Create a copy of this controldir prepared for use as a new line of
339
If url's last component does not exist, it will be created.
341
Attributes related to the identity of the source branch like
342
branch nickname will be cleaned, a working tree is created
343
whether one existed before or not; and a local branch is always
346
if revision_id is not None, then the clone operation may tune
347
itself to download less data.
513
:param revision_id: create it as of this revision id.
514
:param from_branch: override bzrdir branch (for lightweight checkouts)
349
515
:param accelerator_tree: A tree which can be used for retrieving file
350
516
contents more quickly than the revision tree, i.e. a workingtree.
351
517
The revision tree will be used for cases where accelerator_tree's
352
518
content is different.
353
:param hardlink: If true, hard-link files from accelerator_tree,
355
:param stacked: If true, create a stacked branch referring to the
356
location of this control directory.
357
:param create_tree_if_local: If true, a working-tree will be created
358
when working locally.
359
:return: The created control directory
361
operation = cleanup.OperationWithCleanups(self._sprout)
362
return operation.run(url, revision_id=revision_id,
363
force_new_repo=force_new_repo, recurse=recurse,
364
possible_transports=possible_transports,
365
accelerator_tree=accelerator_tree, hardlink=hardlink,
366
stacked=stacked, source_branch=source_branch,
367
create_tree_if_local=create_tree_if_local)
369
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
370
recurse='down', possible_transports=None,
371
accelerator_tree=None, hardlink=False, stacked=False,
372
source_branch=None, create_tree_if_local=True):
373
add_cleanup = op.add_cleanup
374
fetch_spec_factory = fetch.FetchSpecFactory()
375
if revision_id is not None:
376
fetch_spec_factory.add_revision_ids([revision_id])
377
fetch_spec_factory.source_branch_stop_revision_id = revision_id
378
if possible_transports is None:
379
possible_transports = []
381
possible_transports = list(possible_transports) + [
383
target_transport = _mod_transport.get_transport(url,
385
target_transport.ensure_base()
386
cloning_format = self.cloning_metadir(stacked)
387
# Create/update the result branch
389
result = controldir.ControlDir.open_from_transport(target_transport)
390
except errors.NotBranchError:
391
result = cloning_format.initialize_on_transport(target_transport)
392
source_branch, source_repository = self._find_source_repo(
393
add_cleanup, source_branch)
394
fetch_spec_factory.source_branch = source_branch
395
# if a stacked branch wasn't requested, we don't create one
396
# even if the origin was stacked
397
if stacked and source_branch is not None:
398
stacked_branch_url = self.root_transport.base
400
stacked_branch_url = None
401
repository_policy = result.determine_repository_policy(
402
force_new_repo, stacked_branch_url, require_stacking=stacked)
403
result_repo, is_new_repo = repository_policy.acquire_repository(
404
possible_transports=possible_transports)
405
add_cleanup(result_repo.lock_write().unlock)
406
fetch_spec_factory.source_repo = source_repository
407
fetch_spec_factory.target_repo = result_repo
408
if stacked or (len(result_repo._fallback_repositories) != 0):
409
target_repo_kind = fetch.TargetRepoKinds.STACKED
411
target_repo_kind = fetch.TargetRepoKinds.EMPTY
413
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
414
fetch_spec_factory.target_repo_kind = target_repo_kind
415
if source_repository is not None:
416
fetch_spec = fetch_spec_factory.make_fetch_spec()
417
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
419
if source_branch is None:
420
# this is for sprouting a controldir without a branch; is that
422
# Not especially, but it's part of the contract.
423
result_branch = result.create_branch()
425
result_branch = source_branch.sprout(result,
426
revision_id=revision_id, repository_policy=repository_policy,
427
repository=result_repo)
428
mutter("created new branch %r" % (result_branch,))
430
# Create/update the result working tree
431
if (create_tree_if_local and not result.has_workingtree() and
432
isinstance(target_transport, local.LocalTransport) and
433
(result_repo is None or result_repo.make_working_trees())):
434
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
435
hardlink=hardlink, from_branch=result_branch)
438
if wt.path2id('') is None:
440
wt.set_root_id(self.open_workingtree.get_root_id())
441
except errors.NoWorkingTree:
447
if recurse == 'down':
450
basis = wt.basis_tree()
451
elif result_branch is not None:
452
basis = result_branch.basis_tree()
453
elif source_branch is not None:
454
basis = source_branch.basis_tree()
455
if basis is not None:
456
add_cleanup(basis.lock_read().unlock)
457
subtrees = basis.iter_references()
460
for path, file_id in subtrees:
461
target = urlutils.join(url, urlutils.escape(path))
462
sublocation = source_branch.reference_parent(file_id, path)
463
sublocation.bzrdir.sprout(target,
464
basis.get_reference_revision(file_id, path),
465
force_new_repo=force_new_repo, recurse=recurse,
469
def _available_backup_name(self, base):
470
"""Find a non-existing backup file name based on base.
472
See bzrlib.osutils.available_backup_name about race conditions.
474
return osutils.available_backup_name(base, self.root_transport.has)
476
def backup_bzrdir(self):
477
"""Backup this bzr control directory.
479
:return: Tuple with old path name and new path name
482
pb = ui.ui_factory.nested_progress_bar()
484
old_path = self.root_transport.abspath('.bzr')
485
backup_dir = self._available_backup_name('backup.bzr')
486
new_path = self.root_transport.abspath(backup_dir)
487
ui.ui_factory.note(gettext('making backup of {0}\n to {1}').format(
488
urlutils.unescape_for_display(old_path, 'utf-8'),
489
urlutils.unescape_for_display(new_path, 'utf-8')))
490
self.root_transport.copy_tree('.bzr', backup_dir)
491
return (old_path, new_path)
520
raise NotImplementedError(self.create_workingtree)
495
522
def retire_bzrdir(self, limit=10000):
496
523
"""Permanently disable the bzrdir.
633
715
:param _transport: the transport this dir is based at.
635
717
self._format = _format
636
# these are also under the more standard names of
637
# control_transport and user_transport
638
718
self.transport = _transport.clone('.bzr')
639
719
self.root_transport = _transport
640
720
self._mode_check_done = False
643
def user_transport(self):
644
return self.root_transport
647
def control_transport(self):
648
return self.transport
650
722
def is_control_filename(self, filename):
651
723
"""True if filename is the name of a path which is reserved for bzrdir's.
653
725
:param filename: A filename within the root transport of this bzrdir.
655
727
This is true IF and ONLY IF the filename is part of the namespace reserved
656
728
for bzr control dirs. Currently this is the '.bzr' directory in the root
657
of the root_transport.
729
of the root_transport. it is expected that plugins will need to extend
730
this in the future - for instance to make bzr talk with svn working
659
# this might be better on the BzrDirFormat class because it refers to
660
# all the possible bzrdir disk formats.
661
# This method is tested via the workingtree is_control_filename tests-
733
# this might be better on the BzrDirFormat class because it refers to
734
# all the possible bzrdir disk formats.
735
# This method is tested via the workingtree is_control_filename tests-
662
736
# it was extracted from WorkingTree.is_control_filename. If the method's
663
737
# contract is extended beyond the current trivial implementation, please
664
738
# add new tests for it to the appropriate place.
665
739
return filename == '.bzr' or filename.startswith('.bzr/')
741
def needs_format_conversion(self, format=None):
742
"""Return true if this bzrdir needs convert_format run on it.
744
For instance, if the repository format is out of date but the
745
branch and working tree are not, this should return True.
747
:param format: Optional parameter indicating a specific desired
748
format we plan to arrive at.
750
raise NotImplementedError(self.needs_format_conversion)
753
def open_unsupported(base):
754
"""Open a branch which is not supported."""
755
return BzrDir.open(base, _unsupported=True)
758
def open(base, _unsupported=False, possible_transports=None):
759
"""Open an existing bzrdir, rooted at 'base' (url).
761
:param _unsupported: a private parameter to the BzrDir class.
763
t = get_transport(base, possible_transports=possible_transports)
764
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
767
def open_from_transport(transport, _unsupported=False,
768
_server_formats=True):
769
"""Open a bzrdir within a particular directory.
771
:param transport: Transport containing the bzrdir.
772
:param _unsupported: private.
774
base = transport.base
776
def find_format(transport):
777
return transport, BzrDirFormat.find_format(
778
transport, _server_formats=_server_formats)
780
def redirected(transport, e, redirection_notice):
781
qualified_source = e.get_source_url()
782
relpath = transport.relpath(qualified_source)
783
if not e.target.endswith(relpath):
784
# Not redirected to a branch-format, not a branch
785
raise errors.NotBranchError(path=e.target)
786
target = e.target[:-len(relpath)]
787
note('%s is%s redirected to %s',
788
transport.base, e.permanently, target)
789
# Let's try with a new transport
790
# FIXME: If 'transport' has a qualifier, this should
791
# be applied again to the new transport *iff* the
792
# schemes used are the same. Uncomment this code
793
# once the function (and tests) exist.
795
#target = urlutils.copy_url_qualifiers(original, target)
796
return get_transport(target)
799
transport, format = do_catching_redirections(find_format,
802
except errors.TooManyRedirections:
803
raise errors.NotBranchError(base)
805
BzrDir._check_supported(format, _unsupported)
806
return format.open(transport, _found=True)
808
def open_branch(self, unsupported=False):
809
"""Open the branch object at this BzrDir if one is present.
811
If unsupported is True, then no longer supported branch formats can
814
TODO: static convenience version of this?
816
raise NotImplementedError(self.open_branch)
819
def open_containing(url, possible_transports=None):
820
"""Open an existing branch which contains url.
822
:param url: url to search from.
823
See open_containing_from_transport for more detail.
825
transport = get_transport(url, possible_transports)
826
return BzrDir.open_containing_from_transport(transport)
829
def open_containing_from_transport(a_transport):
830
"""Open an existing branch which contains a_transport.base.
832
This probes for a branch at a_transport, and searches upwards from there.
834
Basically we keep looking up until we find the control directory or
835
run into the root. If there isn't one, raises NotBranchError.
836
If there is one and it is either an unrecognised format or an unsupported
837
format, UnknownFormatError or UnsupportedFormatError are raised.
838
If there is one, it is returned, along with the unused portion of url.
840
:return: The BzrDir that contains the path, and a Unicode path
841
for the rest of the URL.
843
# this gets the normalised url back. I.e. '.' -> the full path.
844
url = a_transport.base
847
result = BzrDir.open_from_transport(a_transport)
848
return result, urlutils.unescape(a_transport.relpath(url))
849
except errors.NotBranchError, e:
852
new_t = a_transport.clone('..')
853
except errors.InvalidURLJoin:
854
# reached the root, whatever that may be
855
raise errors.NotBranchError(path=url)
856
if new_t.base == a_transport.base:
857
# reached the root, whatever that may be
858
raise errors.NotBranchError(path=url)
861
def _get_tree_branch(self):
862
"""Return the branch and tree, if any, for this bzrdir.
864
Return None for tree if not present or inaccessible.
865
Raise NotBranchError if no branch is present.
866
:return: (tree, branch)
869
tree = self.open_workingtree()
870
except (errors.NoWorkingTree, errors.NotLocalUrl):
872
branch = self.open_branch()
878
def open_tree_or_branch(klass, location):
879
"""Return the branch and working tree at a location.
881
If there is no tree at the location, tree will be None.
882
If there is no branch at the location, an exception will be
884
:return: (tree, branch)
886
bzrdir = klass.open(location)
887
return bzrdir._get_tree_branch()
890
def open_containing_tree_or_branch(klass, location):
891
"""Return the branch and working tree contained by a location.
893
Returns (tree, branch, relpath).
894
If there is no tree at containing the location, tree will be None.
895
If there is no branch containing the location, an exception will be
897
relpath is the portion of the path that is contained by the branch.
899
bzrdir, relpath = klass.open_containing(location)
900
tree, branch = bzrdir._get_tree_branch()
901
return tree, branch, relpath
904
def open_containing_tree_branch_or_repository(klass, location):
905
"""Return the working tree, branch and repo contained by a location.
907
Returns (tree, branch, repository, relpath).
908
If there is no tree containing the location, tree will be None.
909
If there is no branch containing the location, branch will be None.
910
If there is no repository containing the location, repository will be
912
relpath is the portion of the path that is contained by the innermost
915
If no tree, branch or repository is found, a NotBranchError is raised.
917
bzrdir, relpath = klass.open_containing(location)
919
tree, branch = bzrdir._get_tree_branch()
920
except errors.NotBranchError:
922
repo = bzrdir.find_repository()
923
return None, None, repo, relpath
924
except (errors.NoRepositoryPresent):
925
raise errors.NotBranchError(location)
926
return tree, branch, branch.repository, relpath
928
def open_repository(self, _unsupported=False):
929
"""Open the repository object at this BzrDir if one is present.
931
This will not follow the Branch object pointer - it's strictly a direct
932
open facility. Most client code should use open_branch().repository to
935
:param _unsupported: a private parameter, not part of the api.
936
TODO: static convenience version of this?
938
raise NotImplementedError(self.open_repository)
940
def open_workingtree(self, _unsupported=False,
941
recommend_upgrade=True, from_branch=None):
942
"""Open the workingtree object at this BzrDir if one is present.
944
:param recommend_upgrade: Optional keyword parameter, when True (the
945
default), emit through the ui module a recommendation that the user
946
upgrade the working tree when the workingtree being opened is old
947
(but still fully supported).
948
:param from_branch: override bzrdir branch (for lightweight checkouts)
950
raise NotImplementedError(self.open_workingtree)
952
def has_branch(self):
953
"""Tell if this bzrdir contains a branch.
955
Note: if you're going to open the branch, you should just go ahead
956
and try, and not ask permission first. (This method just opens the
957
branch and discards it, and that's somewhat expensive.)
962
except errors.NotBranchError:
965
def has_workingtree(self):
966
"""Tell if this bzrdir contains a working tree.
968
This will still raise an exception if the bzrdir has a workingtree that
969
is remote & inaccessible.
971
Note: if you're going to open the working tree, you should just go ahead
972
and try, and not ask permission first. (This method just opens the
973
workingtree and discards it, and that's somewhat expensive.)
976
self.open_workingtree(recommend_upgrade=False)
978
except errors.NoWorkingTree:
667
981
def _cloning_metadir(self):
668
982
"""Produce a metadir suitable for cloning with.
670
984
:returns: (destination_bzrdir_format, source_repository)
672
986
result_format = self._format.__class__()
675
branch = self.open_branch(ignore_fallbacks=True)
989
branch = self.open_branch()
676
990
source_repository = branch.repository
677
result_format._branch_format = branch._format
678
991
except errors.NotBranchError:
679
992
source_branch = None
680
993
source_repository = self.open_repository()
700
1011
result_format.workingtree_format = tree._format.__class__()
701
1012
return result_format, source_repository
703
def cloning_metadir(self, require_stacking=False):
1014
def cloning_metadir(self):
704
1015
"""Produce a metadir suitable for cloning or sprouting with.
706
1017
These operations may produce workingtrees (yes, even though they're
707
1018
"cloning" something that doesn't have a tree), so a viable workingtree
708
1019
format must be selected.
710
:require_stacking: If True, non-stackable formats will be upgraded
711
to similar stackable formats.
712
:returns: a ControlDirFormat with all component formats either set
713
appropriately or set to None if that component should not be
1021
:returns: a BzrDirFormat with all component formats either set
1022
appropriately or set to None if that component should not be
716
1025
format, repository = self._cloning_metadir()
717
1026
if format._workingtree_format is None:
719
1027
if repository is None:
720
# No repository either
722
# We have a repository, so set a working tree? (Why? This seems to
723
# contradict the stated return value in the docstring).
724
1029
tree_format = repository._format._matchingbzrdir.workingtree_format
725
1030
format.workingtree_format = tree_format.__class__()
727
format.require_stacking()
730
def get_branch_transport(self, branch_format, name=None):
731
"""Get the transport for use by branch format in this BzrDir.
733
Note that bzr dirs that do not support format strings will raise
734
IncompatibleFormat if the branch format they are given has
735
a format string, and vice versa.
737
If branch_format is None, the transport is returned with no
738
checking. If it is not None, then the returned transport is
739
guaranteed to point to an existing directory ready for use.
741
raise NotImplementedError(self.get_branch_transport)
1033
def checkout_metadir(self):
1034
return self.cloning_metadir()
1036
def sprout(self, url, revision_id=None, force_new_repo=False,
1037
recurse='down', possible_transports=None,
1038
accelerator_tree=None, hardlink=False, stacked=False):
1039
"""Create a copy of this bzrdir prepared for use as a new line of
1042
If url's last component does not exist, it will be created.
1044
Attributes related to the identity of the source branch like
1045
branch nickname will be cleaned, a working tree is created
1046
whether one existed before or not; and a local branch is always
1049
if revision_id is not None, then the clone operation may tune
1050
itself to download less data.
1051
:param accelerator_tree: A tree which can be used for retrieving file
1052
contents more quickly than the revision tree, i.e. a workingtree.
1053
The revision tree will be used for cases where accelerator_tree's
1054
content is different.
1055
:param hardlink: If true, hard-link files from accelerator_tree,
1057
:param stacked: If true, create a stacked branch referring to the
1058
location of this control directory.
1060
target_transport = get_transport(url, possible_transports)
1061
target_transport.ensure_base()
1062
cloning_format = self.cloning_metadir()
1063
result = cloning_format.initialize_on_transport(target_transport)
1065
source_branch = self.open_branch()
1066
source_repository = source_branch.repository
1068
stacked_branch_url = self.root_transport.base
1070
# if a stacked branch wasn't requested, we don't create one
1071
# even if the origin was stacked
1072
stacked_branch_url = None
1073
except errors.NotBranchError:
1074
source_branch = None
1076
source_repository = self.open_repository()
1077
except errors.NoRepositoryPresent:
1078
source_repository = None
1079
stacked_branch_url = None
1080
repository_policy = result.determine_repository_policy(
1081
force_new_repo, stacked_branch_url, require_stacking=stacked)
1082
result_repo = repository_policy.acquire_repository()
1083
if source_repository is not None:
1084
# XXX: Isn't this redundant with the copy_content_into used below
1085
# after creating the branch? -- mbp 20080724
1086
result_repo.fetch(source_repository, revision_id=revision_id)
1088
# Create/update the result branch
1089
format_forced = False
1091
or repository_policy._require_stacking
1092
or repository_policy._stack_on)
1093
and not result._format.get_branch_format().supports_stacking()):
1094
# We need to make a stacked branch, but the default format for the
1095
# target doesn't support stacking. So force a branch that *can*
1097
from bzrlib.branch import BzrBranchFormat7
1098
format = BzrBranchFormat7()
1099
result_branch = format.initialize(result)
1100
mutter("using %r for stacking" % (format,))
1101
format_forced = True
1102
elif source_branch is None:
1103
# this is for sprouting a bzrdir without a branch; is that
1105
result_branch = result.create_branch()
1107
result_branch = source_branch.sprout(
1108
result, revision_id=revision_id)
1109
mutter("created new branch %r" % (result_branch,))
1110
repository_policy.configure_branch(result_branch)
1111
if source_branch is not None and format_forced:
1112
# XXX: this duplicates Branch.sprout(); it probably belongs on an
1113
# InterBranch method? -- mbp 20080724
1114
source_branch.copy_content_into(result_branch,
1115
revision_id=revision_id)
1116
result_branch.set_parent(self.root_transport.base)
1118
# Create/update the result working tree
1119
if isinstance(target_transport, LocalTransport) and (
1120
result_repo is None or result_repo.make_working_trees()):
1121
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1125
if wt.path2id('') is None:
1127
wt.set_root_id(self.open_workingtree.get_root_id())
1128
except errors.NoWorkingTree:
1134
if recurse == 'down':
1136
basis = wt.basis_tree()
1138
subtrees = basis.iter_references()
1139
elif source_branch is not None:
1140
basis = source_branch.basis_tree()
1142
subtrees = basis.iter_references()
1147
for path, file_id in subtrees:
1148
target = urlutils.join(url, urlutils.escape(path))
1149
sublocation = source_branch.reference_parent(file_id, path)
1150
sublocation.bzrdir.sprout(target,
1151
basis.get_reference_revision(file_id, path),
1152
force_new_repo=force_new_repo, recurse=recurse,
1155
if basis is not None:
1160
class BzrDirPreSplitOut(BzrDir):
1161
"""A common class for the all-in-one formats."""
1163
def __init__(self, _transport, _format):
1164
"""See BzrDir.__init__."""
1165
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1166
self._control_files = lockable_files.LockableFiles(
1167
self.get_branch_transport(None),
1168
self._format._lock_file_name,
1169
self._format._lock_class)
1171
def break_lock(self):
1172
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1173
raise NotImplementedError(self.break_lock)
1175
def cloning_metadir(self):
1176
"""Produce a metadir suitable for cloning with."""
1177
return self._format.__class__()
1179
def clone(self, url, revision_id=None, force_new_repo=False,
1180
preserve_stacking=False):
1181
"""See BzrDir.clone().
1183
force_new_repo has no effect, since this family of formats always
1184
require a new repository.
1185
preserve_stacking has no effect, since no source branch using this
1186
family of formats can be stacked, so there is no stacking to preserve.
1188
from bzrlib.workingtree import WorkingTreeFormat2
1189
self._make_tail(url)
1190
result = self._format._initialize_for_clone(url)
1191
self.open_repository().clone(result, revision_id=revision_id)
1192
from_branch = self.open_branch()
1193
from_branch.clone(result, revision_id=revision_id)
1195
self.open_workingtree().clone(result)
1196
except errors.NotLocalUrl:
1197
# make a new one, this format always has to have one.
1199
WorkingTreeFormat2().initialize(result)
1200
except errors.NotLocalUrl:
1201
# but we cannot do it for remote trees.
1202
to_branch = result.open_branch()
1203
WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1206
def create_branch(self):
1207
"""See BzrDir.create_branch."""
1208
return self.open_branch()
1210
def destroy_branch(self):
1211
"""See BzrDir.destroy_branch."""
1212
raise errors.UnsupportedOperation(self.destroy_branch, self)
1214
def create_repository(self, shared=False):
1215
"""See BzrDir.create_repository."""
1217
raise errors.IncompatibleFormat('shared repository', self._format)
1218
return self.open_repository()
1220
def destroy_repository(self):
1221
"""See BzrDir.destroy_repository."""
1222
raise errors.UnsupportedOperation(self.destroy_repository, self)
1224
def create_workingtree(self, revision_id=None, from_branch=None,
1225
accelerator_tree=None, hardlink=False):
1226
"""See BzrDir.create_workingtree."""
1227
# this looks buggy but is not -really-
1228
# because this format creates the workingtree when the bzrdir is
1230
# clone and sprout will have set the revision_id
1231
# and that will have set it for us, its only
1232
# specific uses of create_workingtree in isolation
1233
# that can do wonky stuff here, and that only
1234
# happens for creating checkouts, which cannot be
1235
# done on this format anyway. So - acceptable wart.
1236
result = self.open_workingtree(recommend_upgrade=False)
1237
if revision_id is not None:
1238
if revision_id == _mod_revision.NULL_REVISION:
1239
result.set_parent_ids([])
1241
result.set_parent_ids([revision_id])
1244
def destroy_workingtree(self):
1245
"""See BzrDir.destroy_workingtree."""
1246
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1248
def destroy_workingtree_metadata(self):
1249
"""See BzrDir.destroy_workingtree_metadata."""
1250
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1253
def get_branch_transport(self, branch_format):
1254
"""See BzrDir.get_branch_transport()."""
1255
if branch_format is None:
1256
return self.transport
1258
branch_format.get_format_string()
1259
except NotImplementedError:
1260
return self.transport
1261
raise errors.IncompatibleFormat(branch_format, self._format)
743
1263
def get_repository_transport(self, repository_format):
744
"""Get the transport for use by repository format in this BzrDir.
746
Note that bzr dirs that do not support format strings will raise
747
IncompatibleFormat if the repository format they are given has
748
a format string, and vice versa.
750
If repository_format is None, the transport is returned with no
751
checking. If it is not None, then the returned transport is
752
guaranteed to point to an existing directory ready for use.
754
raise NotImplementedError(self.get_repository_transport)
756
def get_workingtree_transport(self, tree_format):
757
"""Get the transport for use by workingtree format in this BzrDir.
759
Note that bzr dirs that do not support format strings will raise
760
IncompatibleFormat if the workingtree format they are given has a
761
format string, and vice versa.
763
If workingtree_format is None, the transport is returned with no
764
checking. If it is not None, then the returned transport is
765
guaranteed to point to an existing directory ready for use.
767
raise NotImplementedError(self.get_workingtree_transport)
770
def create(cls, base, format=None, possible_transports=None):
771
"""Create a new BzrDir at the url 'base'.
773
:param format: If supplied, the format of branch to create. If not
774
supplied, the default is used.
775
:param possible_transports: If supplied, a list of transports that
776
can be reused to share a remote connection.
778
if cls is not BzrDir:
779
raise AssertionError("BzrDir.create always creates the "
780
"default format, not one of %r" % cls)
781
return controldir.ControlDir.create(base, format=format,
782
possible_transports=possible_transports)
785
return "<%s at %r>" % (self.__class__.__name__, self.user_url)
787
def update_feature_flags(self, updated_flags):
788
"""Update the features required by this bzrdir.
790
:param updated_flags: Dictionary mapping feature names to necessities
791
A necessity can be None to indicate the feature should be removed
793
self.control_files.lock_write()
795
self._format._update_feature_flags(updated_flags)
796
self.transport.put_bytes('branch-format', self._format.as_string())
798
self.control_files.unlock()
1264
"""See BzrDir.get_repository_transport()."""
1265
if repository_format is None:
1266
return self.transport
1268
repository_format.get_format_string()
1269
except NotImplementedError:
1270
return self.transport
1271
raise errors.IncompatibleFormat(repository_format, self._format)
1273
def get_workingtree_transport(self, workingtree_format):
1274
"""See BzrDir.get_workingtree_transport()."""
1275
if workingtree_format is None:
1276
return self.transport
1278
workingtree_format.get_format_string()
1279
except NotImplementedError:
1280
return self.transport
1281
raise errors.IncompatibleFormat(workingtree_format, self._format)
1283
def needs_format_conversion(self, format=None):
1284
"""See BzrDir.needs_format_conversion()."""
1285
# if the format is not the same as the system default,
1286
# an upgrade is needed.
1288
format = BzrDirFormat.get_default_format()
1289
return not isinstance(self._format, format.__class__)
1291
def open_branch(self, unsupported=False):
1292
"""See BzrDir.open_branch."""
1293
from bzrlib.branch import BzrBranchFormat4
1294
format = BzrBranchFormat4()
1295
self._check_supported(format, unsupported)
1296
return format.open(self, _found=True)
1298
def sprout(self, url, revision_id=None, force_new_repo=False,
1299
possible_transports=None, accelerator_tree=None,
1300
hardlink=False, stacked=False):
1301
"""See BzrDir.sprout()."""
1303
raise errors.UnstackableBranchFormat(
1304
self._format, self.root_transport.base)
1305
from bzrlib.workingtree import WorkingTreeFormat2
1306
self._make_tail(url)
1307
result = self._format._initialize_for_clone(url)
1309
self.open_repository().clone(result, revision_id=revision_id)
1310
except errors.NoRepositoryPresent:
1313
self.open_branch().sprout(result, revision_id=revision_id)
1314
except errors.NotBranchError:
1316
# we always want a working tree
1317
WorkingTreeFormat2().initialize(result,
1318
accelerator_tree=accelerator_tree,
1323
class BzrDir4(BzrDirPreSplitOut):
1324
"""A .bzr version 4 control object.
1326
This is a deprecated format and may be removed after sept 2006.
1329
def create_repository(self, shared=False):
1330
"""See BzrDir.create_repository."""
1331
return self._format.repository_format.initialize(self, shared)
1333
def needs_format_conversion(self, format=None):
1334
"""Format 4 dirs are always in need of conversion."""
1337
def open_repository(self):
1338
"""See BzrDir.open_repository."""
1339
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1340
return RepositoryFormat4().open(self, _found=True)
1343
class BzrDir5(BzrDirPreSplitOut):
1344
"""A .bzr version 5 control object.
1346
This is a deprecated format and may be removed after sept 2006.
1349
def open_repository(self):
1350
"""See BzrDir.open_repository."""
1351
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1352
return RepositoryFormat5().open(self, _found=True)
1354
def open_workingtree(self, _unsupported=False,
1355
recommend_upgrade=True):
1356
"""See BzrDir.create_workingtree."""
1357
from bzrlib.workingtree import WorkingTreeFormat2
1358
wt_format = WorkingTreeFormat2()
1359
# we don't warn here about upgrades; that ought to be handled for the
1361
return wt_format.open(self, _found=True)
1364
class BzrDir6(BzrDirPreSplitOut):
1365
"""A .bzr version 6 control object.
1367
This is a deprecated format and may be removed after sept 2006.
1370
def open_repository(self):
1371
"""See BzrDir.open_repository."""
1372
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1373
return RepositoryFormat6().open(self, _found=True)
1375
def open_workingtree(self, _unsupported=False,
1376
recommend_upgrade=True):
1377
"""See BzrDir.create_workingtree."""
1378
# we don't warn here about upgrades; that ought to be handled for the
1380
from bzrlib.workingtree import WorkingTreeFormat2
1381
return WorkingTreeFormat2().open(self, _found=True)
801
1384
class BzrDirMeta1(BzrDir):
802
1385
"""A .bzr meta version 1 control object.
804
This is the first control object where the
1387
This is the first control object where the
805
1388
individual aspects are really split out: there are separate repository,
806
1389
workingtree and branch subdirectories and any subset of the three can be
807
1390
present within a BzrDir.
810
def _get_branch_path(self, name):
811
"""Obtain the branch path to use.
813
This uses the API specified branch name first, and then falls back to
814
the branch name specified in the URL. If neither of those is specified,
815
it uses the default branch.
817
:param name: Optional branch name to use
818
:return: Relative path to branch
822
return urlutils.join('branches', name.encode("utf-8"))
824
def _read_branch_list(self):
825
"""Read the branch list.
827
:return: List of utf-8 encoded branch names.
830
f = self.control_transport.get('branch-list')
831
except errors.NoSuchFile:
837
ret.append(name.rstrip("\n"))
842
def _write_branch_list(self, branches):
843
"""Write out the branch list.
845
:param branches: List of utf-8 branch names to write
847
self.transport.put_bytes('branch-list',
848
"".join([name+"\n" for name in branches]))
850
def __init__(self, _transport, _format):
851
super(BzrDirMeta1, self).__init__(_transport, _format)
852
self.control_files = lockable_files.LockableFiles(
853
self.control_transport, self._format._lock_file_name,
854
self._format._lock_class)
856
1393
def can_convert_format(self):
857
1394
"""See BzrDir.can_convert_format()."""
860
def create_branch(self, name=None, repository=None,
861
append_revisions_only=None):
862
"""See ControlDir.create_branch."""
864
name = self._get_selected_branch()
865
return self._format.get_branch_format().initialize(self, name=name,
866
repository=repository,
867
append_revisions_only=append_revisions_only)
1397
def create_branch(self):
1398
"""See BzrDir.create_branch."""
1399
return self._format.get_branch_format().initialize(self)
869
def destroy_branch(self, name=None):
870
"""See ControlDir.destroy_branch."""
872
name = self._get_selected_branch()
873
path = self._get_branch_path(name)
875
self.control_files.lock_write()
877
branches = self._read_branch_list()
879
branches.remove(name.encode("utf-8"))
881
raise errors.NotBranchError(name)
882
self._write_branch_list(branches)
884
self.control_files.unlock()
886
self.transport.delete_tree(path)
887
except errors.NoSuchFile:
888
raise errors.NotBranchError(path=urlutils.join(self.transport.base,
1401
def destroy_branch(self):
1402
"""See BzrDir.create_branch."""
1403
self.transport.delete_tree('branch')
891
1405
def create_repository(self, shared=False):
892
1406
"""See BzrDir.create_repository."""
1070
def open_branch(self, name=None, unsupported=False,
1071
ignore_fallbacks=False, possible_transports=None):
1072
"""See ControlDir.open_branch."""
1074
name = self._get_selected_branch()
1075
format = self.find_branch_format(name=name)
1076
format.check_support_status(unsupported)
1077
return format.open(self, name=name,
1078
_found=True, ignore_fallbacks=ignore_fallbacks,
1079
possible_transports=possible_transports)
1525
def open_branch(self, unsupported=False):
1526
"""See BzrDir.open_branch."""
1527
format = self.find_branch_format()
1528
self._check_supported(format, unsupported)
1529
return format.open(self, _found=True)
1081
1531
def open_repository(self, unsupported=False):
1082
1532
"""See BzrDir.open_repository."""
1083
from bzrlib.repository import RepositoryFormatMetaDir
1084
format = RepositoryFormatMetaDir.find_format(self)
1085
format.check_support_status(unsupported)
1533
from bzrlib.repository import RepositoryFormat
1534
format = RepositoryFormat.find_format(self)
1535
self._check_supported(format, unsupported)
1086
1536
return format.open(self, _found=True)
1088
1538
def open_workingtree(self, unsupported=False,
1089
1539
recommend_upgrade=True):
1090
1540
"""See BzrDir.open_workingtree."""
1091
from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
format = WorkingTreeFormatMetaDir.find_format(self)
1093
format.check_support_status(unsupported, recommend_upgrade,
1541
from bzrlib.workingtree import WorkingTreeFormat
1542
format = WorkingTreeFormat.find_format(self)
1543
self._check_supported(format, unsupported,
1094
1545
basedir=self.root_transport.base)
1095
1546
return format.open(self, _found=True)
1097
1548
def _get_config(self):
1098
return config.TransportConfig(self.transport, 'control.conf')
1101
class BzrFormat(object):
1102
"""Base class for all formats of things living in metadirs.
1104
This class manages the format string that is stored in the 'format'
1105
or 'branch-format' file.
1107
All classes for (branch-, repository-, workingtree-) formats that
1108
live in meta directories and have their own 'format' file
1109
(i.e. different from .bzr/branch-format) derive from this class,
1110
as well as the relevant base class for their kind
1111
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1113
Each format is identified by a "format" or "branch-format" file with a
1114
single line containing the base format name and then an optional list of
1117
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1118
will render them inaccessible to older versions of bzr.
1120
:ivar features: Dictionary mapping feature names to their necessity
1123
_present_features = set()
1129
def register_feature(cls, name):
1130
"""Register a feature as being present.
1132
:param name: Name of the feature
1135
raise ValueError("spaces are not allowed in feature names")
1136
if name in cls._present_features:
1137
raise errors.FeatureAlreadyRegistered(name)
1138
cls._present_features.add(name)
1141
def unregister_feature(cls, name):
1142
"""Unregister a feature."""
1143
cls._present_features.remove(name)
1145
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1147
for name, necessity in self.features.iteritems():
1148
if name in self._present_features:
1150
if necessity == "optional":
1151
mutter("ignoring optional missing feature %s", name)
1153
elif necessity == "required":
1154
raise errors.MissingFeature(name)
1156
mutter("treating unknown necessity as require for %s",
1158
raise errors.MissingFeature(name)
1161
def get_format_string(cls):
1162
"""Return the ASCII format string that identifies this format."""
1163
raise NotImplementedError(cls.get_format_string)
1166
def from_string(cls, text):
1167
format_string = cls.get_format_string()
1168
if not text.startswith(format_string):
1169
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1170
lines = text[len(format_string):].splitlines()
1172
for lineno, line in enumerate(lines):
1174
(necessity, feature) = line.split(" ", 1)
1176
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1177
line=line, text=text)
1178
ret.features[feature] = necessity
1181
def as_string(self):
1182
"""Return the string representation of this format.
1184
lines = [self.get_format_string()]
1185
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1186
self.features.iteritems()])
1187
return "".join(lines)
1190
def _find_format(klass, registry, kind, format_string):
1192
first_line = format_string[:format_string.index("\n")+1]
1194
first_line = format_string
1196
cls = registry.get(first_line)
1198
raise errors.UnknownFormatError(format=first_line, kind=kind)
1199
return cls.from_string(format_string)
1201
def network_name(self):
1202
"""A simple byte string uniquely identifying this format for RPC calls.
1204
Metadir branch formats use their format string.
1206
return self.as_string()
1208
def __eq__(self, other):
1209
return (self.__class__ is other.__class__ and
1210
self.features == other.features)
1212
def _update_feature_flags(self, updated_flags):
1213
"""Update the feature flags in this format.
1215
:param updated_flags: Updated feature flags
1217
for name, necessity in updated_flags.iteritems():
1218
if necessity is None:
1220
del self.features[name]
1224
self.features[name] = necessity
1227
class BzrProber(controldir.Prober):
1228
"""Prober for formats that use a .bzr/ control directory."""
1230
formats = registry.FormatRegistry(controldir.network_format_registry)
1231
"""The known .bzr formats."""
1234
def probe_transport(klass, transport):
1235
"""Return the .bzrdir style format present in a directory."""
1237
format_string = transport.get_bytes(".bzr/branch-format")
1238
except errors.NoSuchFile:
1239
raise errors.NotBranchError(path=transport.base)
1241
first_line = format_string[:format_string.index("\n")+1]
1243
first_line = format_string
1245
cls = klass.formats.get(first_line)
1247
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
return cls.from_string(format_string)
1251
def known_formats(cls):
1253
for name, format in cls.formats.iteritems():
1254
if callable(format):
1260
controldir.ControlDirFormat.register_prober(BzrProber)
1263
class RemoteBzrProber(controldir.Prober):
1264
"""Prober for remote servers that provide a Bazaar smart server."""
1267
def probe_transport(klass, transport):
1268
"""Return a RemoteBzrDirFormat object if it looks possible."""
1270
medium = transport.get_smart_medium()
1271
except (NotImplementedError, AttributeError,
1272
errors.TransportNotPossible, errors.NoSmartMedium,
1273
errors.SmartProtocolError):
1274
# no smart server, so not a branch for this format type.
1275
raise errors.NotBranchError(path=transport.base)
1277
# Decline to open it if the server doesn't support our required
1278
# version (3) so that the VFS-based transport will do it.
1279
if medium.should_probe():
1281
server_version = medium.protocol_version()
1282
except errors.SmartProtocolError:
1283
# Apparently there's no usable smart server there, even though
1284
# the medium supports the smart protocol.
1285
raise errors.NotBranchError(path=transport.base)
1286
if server_version != '2':
1287
raise errors.NotBranchError(path=transport.base)
1288
from bzrlib.remote import RemoteBzrDirFormat
1289
return RemoteBzrDirFormat()
1292
def known_formats(cls):
1293
from bzrlib.remote import RemoteBzrDirFormat
1294
return set([RemoteBzrDirFormat()])
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1298
"""ControlDirFormat base class for .bzr/ directories.
1300
Formats are placed in a dict by their format string for reference
1549
return config.BzrDirConfig(self.transport)
1552
class BzrDirFormat(object):
1553
"""An encapsulation of the initialization and open routines for a format.
1555
Formats provide three things:
1556
* An initialization routine,
1560
Formats are placed in a dict by their format string for reference
1301
1561
during bzrdir opening. These should be subclasses of BzrDirFormat
1302
1562
for consistency.
1304
1564
Once a format is deprecated, just deprecate the initialize and open
1305
methods on the format class. Do not deprecate the object, as the
1565
methods on the format class. Do not deprecate the object, as the
1306
1566
object will be created every system load.
1569
_default_format = None
1570
"""The default format used for new .bzr dirs."""
1573
"""The known formats."""
1575
_control_formats = []
1576
"""The registered control formats - .bzr, ....
1578
This is a list of BzrDirFormat objects.
1581
_control_server_formats = []
1582
"""The registered control server formats, e.g. RemoteBzrDirs.
1584
This is a list of BzrDirFormat objects.
1309
1587
_lock_file_name = 'branch-lock'
1311
1589
# _lock_class must be set in subclasses to the lock type, typ.
1312
1590
# TransportLock or LockDir
1593
def find_format(klass, transport, _server_formats=True):
1594
"""Return the format present at transport."""
1596
formats = klass._control_server_formats + klass._control_formats
1598
formats = klass._control_formats
1599
for format in formats:
1601
return format.probe_transport(transport)
1602
except errors.NotBranchError:
1603
# this format does not find a control dir here.
1605
raise errors.NotBranchError(path=transport.base)
1608
def probe_transport(klass, transport):
1609
"""Return the .bzrdir style format present in a directory."""
1611
format_string = transport.get(".bzr/branch-format").read()
1612
except errors.NoSuchFile:
1613
raise errors.NotBranchError(path=transport.base)
1616
return klass._formats[format_string]
1618
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1621
def get_default_format(klass):
1622
"""Return the current default format."""
1623
return klass._default_format
1625
def get_format_string(self):
1626
"""Return the ASCII format string that identifies this format."""
1627
raise NotImplementedError(self.get_format_string)
1629
def get_format_description(self):
1630
"""Return the short description for this format."""
1631
raise NotImplementedError(self.get_format_description)
1633
def get_converter(self, format=None):
1634
"""Return the converter to use to convert bzrdirs needing converts.
1636
This returns a bzrlib.bzrdir.Converter object.
1638
This should return the best upgrader to step this format towards the
1639
current default format. In the case of plugins we can/should provide
1640
some means for them to extend the range of returnable converters.
1642
:param format: Optional format to override the default format of the
1645
raise NotImplementedError(self.get_converter)
1647
def initialize(self, url, possible_transports=None):
1648
"""Create a bzr control dir at this url and return an opened copy.
1650
Subclasses should typically override initialize_on_transport
1651
instead of this method.
1653
return self.initialize_on_transport(get_transport(url,
1654
possible_transports))
1314
1656
def initialize_on_transport(self, transport):
1315
1657
"""Initialize a new bzrdir in the base directory of a Transport."""
1317
# can we hand off the request to the smart server rather than using
1319
client_medium = transport.get_smart_medium()
1320
except errors.NoSmartMedium:
1321
return self._initialize_on_transport_vfs(transport)
1323
# Current RPC's only know how to create bzr metadir1 instances, so
1324
# we still delegate to vfs methods if the requested format is not a
1326
if type(self) != BzrDirMetaFormat1:
1327
return self._initialize_on_transport_vfs(transport)
1328
from bzrlib.remote import RemoteBzrDirFormat
1329
remote_format = RemoteBzrDirFormat()
1330
self._supply_sub_formats_to(remote_format)
1331
return remote_format.initialize_on_transport(transport)
1333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1334
create_prefix=False, force_new_repo=False, stacked_on=None,
1335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1336
shared_repo=False, vfs_only=False):
1337
"""Create this format on transport.
1339
The directory to initialize will be created.
1341
:param force_new_repo: Do not use a shared repository for the target,
1342
even if one is available.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1346
:param stacked_on: A url to stack any created branch on, None to follow
1347
any target stacking policy.
1348
:param stack_on_pwd: If stack_on is relative, the location it is
1350
:param repo_format_name: If non-None, a repository will be
1351
made-or-found. Should none be found, or if force_new_repo is True
1352
the repo_format_name is used to select the format of repository to
1354
:param make_working_trees: Control the setting of make_working_trees
1355
for a new shared repository when one is made. None to use whatever
1356
default the format has.
1357
:param shared_repo: Control whether made repositories are shared or
1359
:param vfs_only: If True do not attempt to use a smart server
1360
:return: repo, controldir, require_stacking, repository_policy. repo is
1361
None if none was created or found, bzrdir is always valid.
1362
require_stacking is the result of examining the stacked_on
1363
parameter and any stacking policy found for the target.
1366
# Try to hand off to a smart server
1368
client_medium = transport.get_smart_medium()
1369
except errors.NoSmartMedium:
1372
from bzrlib.remote import RemoteBzrDirFormat
1373
# TODO: lookup the local format from a server hint.
1374
remote_dir_format = RemoteBzrDirFormat()
1375
remote_dir_format._network_name = self.network_name()
1376
self._supply_sub_formats_to(remote_dir_format)
1377
return remote_dir_format.initialize_on_transport_ex(transport,
1378
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1379
force_new_repo=force_new_repo, stacked_on=stacked_on,
1380
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1381
make_working_trees=make_working_trees, shared_repo=shared_repo)
1382
# XXX: Refactor the create_prefix/no_create_prefix code into a
1383
# common helper function
1384
# The destination may not exist - if so make it according to policy.
1385
def make_directory(transport):
1386
transport.mkdir('.')
1388
def redirected(transport, e, redirection_notice):
1389
note(redirection_notice)
1390
return transport._redirected_to(e.source, e.target)
1392
transport = do_catching_redirections(make_directory, transport,
1394
except errors.FileExists:
1395
if not use_existing_dir:
1397
except errors.NoSuchFile:
1398
if not create_prefix:
1400
transport.create_prefix()
1402
require_stacking = (stacked_on is not None)
1403
# Now the target directory exists, but doesn't have a .bzr
1404
# directory. So we need to create it, along with any work to create
1405
# all of the dependent branches, etc.
1407
result = self.initialize_on_transport(transport)
1408
if repo_format_name:
1410
# use a custom format
1411
result._format.repository_format = \
1412
repository.network_format_registry.get(repo_format_name)
1413
except AttributeError:
1414
# The format didn't permit it to be set.
1416
# A repository is desired, either in-place or shared.
1417
repository_policy = result.determine_repository_policy(
1418
force_new_repo, stacked_on, stack_on_pwd,
1419
require_stacking=require_stacking)
1420
result_repo, is_new_repo = repository_policy.acquire_repository(
1421
make_working_trees, shared_repo)
1422
if not require_stacking and repository_policy._require_stacking:
1423
require_stacking = True
1424
result._format.require_stacking()
1425
result_repo.lock_write()
1428
repository_policy = None
1429
return result_repo, result, require_stacking, repository_policy
1431
def _initialize_on_transport_vfs(self, transport):
1432
"""Initialize a new bzrdir using VFS calls.
1434
:param transport: The transport to create the .bzr directory in.
1437
# Since we are creating a .bzr directory, inherit the
1658
# Since we don't have a .bzr directory, inherit the
1438
1659
# mode from the root directory
1439
1660
temp_control = lockable_files.LockableFiles(transport,
1440
1661
'', lockable_files.TransportLock)
1442
temp_control._transport.mkdir('.bzr',
1443
# FIXME: RBC 20060121 don't peek under
1445
mode=temp_control._dir_mode)
1446
except errors.FileExists:
1447
raise errors.AlreadyControlDirError(transport.base)
1448
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1662
temp_control._transport.mkdir('.bzr',
1663
# FIXME: RBC 20060121 don't peek under
1665
mode=temp_control._dir_mode)
1666
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1449
1667
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1450
1668
file_mode = temp_control._file_mode
1451
1669
del temp_control
1494
1741
raise NotImplementedError(self._open)
1496
def _supply_sub_formats_to(self, other_format):
1497
"""Give other_format the same values for sub formats as this has.
1499
This method is expected to be used when parameterising a
1500
RemoteBzrDirFormat instance with the parameters from a
1501
BzrDirMetaFormat1 instance.
1503
:param other_format: other_format is a format which should be
1504
compatible with whatever sub formats are supported by self.
1507
other_format.features = dict(self.features)
1509
def supports_transport(self, transport):
1510
# bzr formats can be opened over all known transports
1513
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1515
controldir.ControlDirFormat.check_support_status(self,
1516
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1518
BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1519
recommend_upgrade=recommend_upgrade, basedir=basedir)
1744
def register_format(klass, format):
1745
klass._formats[format.get_format_string()] = format
1748
def register_control_format(klass, format):
1749
"""Register a format that does not use '.bzr' for its control dir.
1751
TODO: This should be pulled up into a 'ControlDirFormat' base class
1752
which BzrDirFormat can inherit from, and renamed to register_format
1753
there. It has been done without that for now for simplicity of
1756
klass._control_formats.append(format)
1759
def register_control_server_format(klass, format):
1760
"""Register a control format for client-server environments.
1762
These formats will be tried before ones registered with
1763
register_control_format. This gives implementations that decide to the
1764
chance to grab it before anything looks at the contents of the format
1767
klass._control_server_formats.append(format)
1770
def _set_default_format(klass, format):
1771
"""Set default format (for testing behavior of defaults only)"""
1772
klass._default_format = format
1776
return self.get_format_string().rstrip()
1779
def unregister_format(klass, format):
1780
del klass._formats[format.get_format_string()]
1783
def unregister_control_format(klass, format):
1784
klass._control_formats.remove(format)
1787
class BzrDirFormat4(BzrDirFormat):
1788
"""Bzr dir format 4.
1790
This format is a combined format for working tree, branch and repository.
1792
- Format 1 working trees [always]
1793
- Format 4 branches [always]
1794
- Format 4 repositories [always]
1796
This format is deprecated: it indexes texts using a text it which is
1797
removed in format 5; write support for this format has been removed.
1800
_lock_class = lockable_files.TransportLock
1802
def get_format_string(self):
1803
"""See BzrDirFormat.get_format_string()."""
1804
return "Bazaar-NG branch, format 0.0.4\n"
1806
def get_format_description(self):
1807
"""See BzrDirFormat.get_format_description()."""
1808
return "All-in-one format 4"
1810
def get_converter(self, format=None):
1811
"""See BzrDirFormat.get_converter()."""
1812
# there is one and only one upgrade path here.
1813
return ConvertBzrDir4To5()
1815
def initialize_on_transport(self, transport):
1816
"""Format 4 branches cannot be created."""
1817
raise errors.UninitializableFormat(self)
1819
def is_supported(self):
1820
"""Format 4 is not supported.
1822
It is not supported because the model changed from 4 to 5 and the
1823
conversion logic is expensive - so doing it on the fly was not
1828
def _open(self, transport):
1829
"""See BzrDirFormat._open."""
1830
return BzrDir4(transport, self)
1832
def __return_repository_format(self):
1833
"""Circular import protection."""
1834
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1835
return RepositoryFormat4()
1836
repository_format = property(__return_repository_format)
1839
class BzrDirFormat5(BzrDirFormat):
1840
"""Bzr control format 5.
1842
This format is a combined format for working tree, branch and repository.
1844
- Format 2 working trees [always]
1845
- Format 4 branches [always]
1846
- Format 5 repositories [always]
1847
Unhashed stores in the repository.
1850
_lock_class = lockable_files.TransportLock
1852
def get_format_string(self):
1853
"""See BzrDirFormat.get_format_string()."""
1854
return "Bazaar-NG branch, format 5\n"
1856
def get_format_description(self):
1857
"""See BzrDirFormat.get_format_description()."""
1858
return "All-in-one format 5"
1860
def get_converter(self, format=None):
1861
"""See BzrDirFormat.get_converter()."""
1862
# there is one and only one upgrade path here.
1863
return ConvertBzrDir5To6()
1865
def _initialize_for_clone(self, url):
1866
return self.initialize_on_transport(get_transport(url), _cloning=True)
1868
def initialize_on_transport(self, transport, _cloning=False):
1869
"""Format 5 dirs always have working tree, branch and repository.
1871
Except when they are being cloned.
1873
from bzrlib.branch import BzrBranchFormat4
1874
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1875
from bzrlib.workingtree import WorkingTreeFormat2
1876
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1877
RepositoryFormat5().initialize(result, _internal=True)
1879
branch = BzrBranchFormat4().initialize(result)
1881
WorkingTreeFormat2().initialize(result)
1882
except errors.NotLocalUrl:
1883
# Even though we can't access the working tree, we need to
1884
# create its control files.
1885
WorkingTreeFormat2()._stub_initialize_remote(branch)
1888
def _open(self, transport):
1889
"""See BzrDirFormat._open."""
1890
return BzrDir5(transport, self)
1892
def __return_repository_format(self):
1893
"""Circular import protection."""
1894
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1895
return RepositoryFormat5()
1896
repository_format = property(__return_repository_format)
1899
class BzrDirFormat6(BzrDirFormat):
1900
"""Bzr control format 6.
1902
This format is a combined format for working tree, branch and repository.
1904
- Format 2 working trees [always]
1905
- Format 4 branches [always]
1906
- Format 6 repositories [always]
1909
_lock_class = lockable_files.TransportLock
1911
def get_format_string(self):
1912
"""See BzrDirFormat.get_format_string()."""
1913
return "Bazaar-NG branch, format 6\n"
1915
def get_format_description(self):
1916
"""See BzrDirFormat.get_format_description()."""
1917
return "All-in-one format 6"
1919
def get_converter(self, format=None):
1920
"""See BzrDirFormat.get_converter()."""
1921
# there is one and only one upgrade path here.
1922
return ConvertBzrDir6ToMeta()
1924
def _initialize_for_clone(self, url):
1925
return self.initialize_on_transport(get_transport(url), _cloning=True)
1927
def initialize_on_transport(self, transport, _cloning=False):
1928
"""Format 6 dirs always have working tree, branch and repository.
1930
Except when they are being cloned.
1932
from bzrlib.branch import BzrBranchFormat4
1933
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1934
from bzrlib.workingtree import WorkingTreeFormat2
1935
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1936
RepositoryFormat6().initialize(result, _internal=True)
1938
branch = BzrBranchFormat4().initialize(result)
1940
WorkingTreeFormat2().initialize(result)
1941
except errors.NotLocalUrl:
1942
# Even though we can't access the working tree, we need to
1943
# create its control files.
1944
WorkingTreeFormat2()._stub_initialize_remote(branch)
1947
def _open(self, transport):
1948
"""See BzrDirFormat._open."""
1949
return BzrDir6(transport, self)
1951
def __return_repository_format(self):
1952
"""Circular import protection."""
1953
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1954
return RepositoryFormat6()
1955
repository_format = property(__return_repository_format)
1522
1958
class BzrDirMetaFormat1(BzrDirFormat):
1561
1987
def get_branch_format(self):
1562
1988
if self._branch_format is None:
1563
from bzrlib.branch import format_registry as branch_format_registry
1564
self._branch_format = branch_format_registry.get_default()
1989
from bzrlib.branch import BranchFormat
1990
self._branch_format = BranchFormat.get_default_format()
1565
1991
return self._branch_format
1567
1993
def set_branch_format(self, format):
1568
1994
self._branch_format = format
1570
def require_stacking(self, stack_on=None, possible_transports=None,
1572
"""We have a request to stack, try to ensure the formats support it.
1574
:param stack_on: If supplied, it is the URL to a branch that we want to
1575
stack on. Check to see if that format supports stacking before
1578
# Stacking is desired. requested by the target, but does the place it
1579
# points at support stacking? If it doesn't then we should
1580
# not implicitly upgrade. We check this here.
1581
new_repo_format = None
1582
new_branch_format = None
1584
# a bit of state for get_target_branch so that we don't try to open it
1585
# 2 times, for both repo *and* branch
1586
target = [None, False, None] # target_branch, checked, upgrade anyway
1587
def get_target_branch():
1589
# We've checked, don't check again
1591
if stack_on is None:
1592
# No target format, that means we want to force upgrading
1593
target[:] = [None, True, True]
1596
target_dir = BzrDir.open(stack_on,
1597
possible_transports=possible_transports)
1598
except errors.NotBranchError:
1599
# Nothing there, don't change formats
1600
target[:] = [None, True, False]
1602
except errors.JailBreak:
1603
# JailBreak, JFDI and upgrade anyway
1604
target[:] = [None, True, True]
1607
target_branch = target_dir.open_branch()
1608
except errors.NotBranchError:
1609
# No branch, don't upgrade formats
1610
target[:] = [None, True, False]
1612
target[:] = [target_branch, True, False]
1615
if (not _skip_repo and
1616
not self.repository_format.supports_external_lookups):
1617
# We need to upgrade the Repository.
1618
target_branch, _, do_upgrade = get_target_branch()
1619
if target_branch is None:
1620
# We don't have a target branch, should we upgrade anyway?
1622
# stack_on is inaccessible, JFDI.
1623
# TODO: bad monkey, hard-coded formats...
1624
if self.repository_format.rich_root_data:
1625
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
1627
new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
1629
# If the target already supports stacking, then we know the
1630
# project is already able to use stacking, so auto-upgrade
1632
new_repo_format = target_branch.repository._format
1633
if not new_repo_format.supports_external_lookups:
1634
# target doesn't, source doesn't, so don't auto upgrade
1636
new_repo_format = None
1637
if new_repo_format is not None:
1638
self.repository_format = new_repo_format
1639
note(gettext('Source repository format does not support stacking,'
1640
' using format:\n %s'),
1641
new_repo_format.get_format_description())
1643
if not self.get_branch_format().supports_stacking():
1644
# We just checked the repo, now lets check if we need to
1645
# upgrade the branch format
1646
target_branch, _, do_upgrade = get_target_branch()
1647
if target_branch is None:
1649
# TODO: bad monkey, hard-coded formats...
1650
from bzrlib.branch import BzrBranchFormat7
1651
new_branch_format = BzrBranchFormat7()
1653
new_branch_format = target_branch._format
1654
if not new_branch_format.supports_stacking():
1655
new_branch_format = None
1656
if new_branch_format is not None:
1657
# Does support stacking, use its format.
1658
self.set_branch_format(new_branch_format)
1659
note(gettext('Source branch format does not support stacking,'
1660
' using format:\n %s'),
1661
new_branch_format.get_format_description())
1663
1996
def get_converter(self, format=None):
1664
1997
"""See BzrDirFormat.get_converter()."""
1665
1998
if format is None:
1666
1999
format = BzrDirFormat.get_default_format()
1667
if (type(self) is BzrDirMetaFormat1 and
1668
type(format) is BzrDirMetaFormat1Colo):
1669
return ConvertMetaToColo(format)
1670
if (type(self) is BzrDirMetaFormat1Colo and
1671
type(format) is BzrDirMetaFormat1):
1672
return ConvertMetaToColo(format)
1673
2000
if not isinstance(self, format.__class__):
1674
2001
# converting away from metadir is not implemented
1675
2002
raise NotImplementedError(self.get_converter)
1676
2003
return ConvertMetaToMeta(format)
1679
def get_format_string(cls):
2005
def get_format_string(self):
1680
2006
"""See BzrDirFormat.get_format_string()."""
1681
2007
return "Bazaar-NG meta directory, format 1\n"
1687
2013
def _open(self, transport):
1688
2014
"""See BzrDirFormat._open."""
1689
# Create a new format instance because otherwise initialisation of new
1690
# metadirs share the global default format object leading to alias
1692
format = BzrDirMetaFormat1()
1693
self._supply_sub_formats_to(format)
1694
return BzrDirMeta1(transport, format)
2015
return BzrDirMeta1(transport, self)
1696
2017
def __return_repository_format(self):
1697
2018
"""Circular import protection."""
1698
if self._repository_format:
2019
if getattr(self, '_repository_format', None):
1699
2020
return self._repository_format
1700
from bzrlib.repository import format_registry
1701
return format_registry.get_default()
2021
from bzrlib.repository import RepositoryFormat
2022
return RepositoryFormat.get_default_format()
1703
def _set_repository_format(self, value):
2024
def __set_repository_format(self, value):
1704
2025
"""Allow changing the repository format for metadir formats."""
1705
2026
self._repository_format = value
1707
repository_format = property(__return_repository_format,
1708
_set_repository_format)
1710
def _supply_sub_formats_to(self, other_format):
1711
"""Give other_format the same values for sub formats as this has.
1713
This method is expected to be used when parameterising a
1714
RemoteBzrDirFormat instance with the parameters from a
1715
BzrDirMetaFormat1 instance.
1717
:param other_format: other_format is a format which should be
1718
compatible with whatever sub formats are supported by self.
1721
super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1722
if getattr(self, '_repository_format', None) is not None:
1723
other_format.repository_format = self.repository_format
1724
if self._branch_format is not None:
1725
other_format._branch_format = self._branch_format
1726
if self._workingtree_format is not None:
1727
other_format.workingtree_format = self.workingtree_format
2028
repository_format = property(__return_repository_format, __set_repository_format)
1729
2030
def __get_workingtree_format(self):
1730
2031
if self._workingtree_format is None:
1731
from bzrlib.workingtree import (
1732
format_registry as wt_format_registry,
1734
self._workingtree_format = wt_format_registry.get_default()
2032
from bzrlib.workingtree import WorkingTreeFormat
2033
self._workingtree_format = WorkingTreeFormat.get_default_format()
1735
2034
return self._workingtree_format
1737
2036
def __set_workingtree_format(self, wt_format):
1738
2037
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
1743
2039
workingtree_format = property(__get_workingtree_format,
1744
2040
__set_workingtree_format)
2043
# Register bzr control format
2044
BzrDirFormat.register_control_format(BzrDirFormat)
1747
2046
# Register bzr formats
1748
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1754
"""BzrDirMeta1 format with support for colocated branches."""
1756
colocated_branches = True
1759
def get_format_string(cls):
1760
"""See BzrDirFormat.get_format_string()."""
1761
return "Bazaar meta directory, format 1 (with colocated branches)\n"
1763
def get_format_description(self):
1764
"""See BzrDirFormat.get_format_description()."""
1765
return "Meta directory format 1 with support for colocated branches"
1767
def _open(self, transport):
1768
"""See BzrDirFormat._open."""
1769
# Create a new format instance because otherwise initialisation of new
1770
# metadirs share the global default format object leading to alias
1772
format = BzrDirMetaFormat1Colo()
1773
self._supply_sub_formats_to(format)
1774
return BzrDirMeta1(transport, format)
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
1778
BzrDirMetaFormat1Colo)
1781
class ConvertMetaToMeta(controldir.Converter):
2047
BzrDirFormat.register_format(BzrDirFormat4())
2048
BzrDirFormat.register_format(BzrDirFormat5())
2049
BzrDirFormat.register_format(BzrDirFormat6())
2050
__default_format = BzrDirMetaFormat1()
2051
BzrDirFormat.register_format(__default_format)
2052
BzrDirFormat._default_format = __default_format
2055
class Converter(object):
2056
"""Converts a disk format object from one format to another."""
2058
def convert(self, to_convert, pb):
2059
"""Perform the conversion of to_convert, giving feedback via pb.
2061
:param to_convert: The disk object to convert.
2062
:param pb: a progress bar to use for progress information.
2065
def step(self, message):
2066
"""Update the pb by a step."""
2068
self.pb.update(message, self.count, self.total)
2071
class ConvertBzrDir4To5(Converter):
2072
"""Converts format 4 bzr dirs to format 5."""
2075
super(ConvertBzrDir4To5, self).__init__()
2076
self.converted_revs = set()
2077
self.absent_revisions = set()
2081
def convert(self, to_convert, pb):
2082
"""See Converter.convert()."""
2083
self.bzrdir = to_convert
2085
self.pb.note('starting upgrade from format 4 to 5')
2086
if isinstance(self.bzrdir.transport, LocalTransport):
2087
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2088
self._convert_to_weaves()
2089
return BzrDir.open(self.bzrdir.root_transport.base)
2091
def _convert_to_weaves(self):
2092
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2095
stat = self.bzrdir.transport.stat('weaves')
2096
if not S_ISDIR(stat.st_mode):
2097
self.bzrdir.transport.delete('weaves')
2098
self.bzrdir.transport.mkdir('weaves')
2099
except errors.NoSuchFile:
2100
self.bzrdir.transport.mkdir('weaves')
2101
# deliberately not a WeaveFile as we want to build it up slowly.
2102
self.inv_weave = Weave('inventory')
2103
# holds in-memory weaves for all files
2104
self.text_weaves = {}
2105
self.bzrdir.transport.delete('branch-format')
2106
self.branch = self.bzrdir.open_branch()
2107
self._convert_working_inv()
2108
rev_history = self.branch.revision_history()
2109
# to_read is a stack holding the revisions we still need to process;
2110
# appending to it adds new highest-priority revisions
2111
self.known_revisions = set(rev_history)
2112
self.to_read = rev_history[-1:]
2114
rev_id = self.to_read.pop()
2115
if (rev_id not in self.revisions
2116
and rev_id not in self.absent_revisions):
2117
self._load_one_rev(rev_id)
2119
to_import = self._make_order()
2120
for i, rev_id in enumerate(to_import):
2121
self.pb.update('converting revision', i, len(to_import))
2122
self._convert_one_rev(rev_id)
2124
self._write_all_weaves()
2125
self._write_all_revs()
2126
self.pb.note('upgraded to weaves:')
2127
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2128
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2129
self.pb.note(' %6d texts', self.text_count)
2130
self._cleanup_spare_files_after_format4()
2131
self.branch._transport.put_bytes(
2133
BzrDirFormat5().get_format_string(),
2134
mode=self.bzrdir._get_file_mode())
2136
def _cleanup_spare_files_after_format4(self):
2137
# FIXME working tree upgrade foo.
2138
for n in 'merged-patches', 'pending-merged-patches':
2140
## assert os.path.getsize(p) == 0
2141
self.bzrdir.transport.delete(n)
2142
except errors.NoSuchFile:
2144
self.bzrdir.transport.delete_tree('inventory-store')
2145
self.bzrdir.transport.delete_tree('text-store')
2147
def _convert_working_inv(self):
2148
inv = xml4.serializer_v4.read_inventory(
2149
self.branch._transport.get('inventory'))
2150
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2151
self.branch._transport.put_bytes('inventory', new_inv_xml,
2152
mode=self.bzrdir._get_file_mode())
2154
def _write_all_weaves(self):
2155
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2156
weave_transport = self.bzrdir.transport.clone('weaves')
2157
weaves = WeaveStore(weave_transport, prefixed=False)
2158
transaction = WriteTransaction()
2162
for file_id, file_weave in self.text_weaves.items():
2163
self.pb.update('writing weave', i, len(self.text_weaves))
2164
weaves._put_weave(file_id, file_weave, transaction)
2166
self.pb.update('inventory', 0, 1)
2167
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2168
self.pb.update('inventory', 1, 1)
2172
def _write_all_revs(self):
2173
"""Write all revisions out in new form."""
2174
self.bzrdir.transport.delete_tree('revision-store')
2175
self.bzrdir.transport.mkdir('revision-store')
2176
revision_transport = self.bzrdir.transport.clone('revision-store')
2178
from bzrlib.xml5 import serializer_v5
2179
from bzrlib.repofmt.weaverepo import RevisionTextStore
2180
revision_store = RevisionTextStore(revision_transport,
2181
serializer_v5, False, versionedfile.PrefixMapper(),
2182
lambda:True, lambda:True)
2184
for i, rev_id in enumerate(self.converted_revs):
2185
self.pb.update('write revision', i, len(self.converted_revs))
2186
text = serializer_v5.write_revision_to_string(
2187
self.revisions[rev_id])
2189
revision_store.add_lines(key, None, osutils.split_lines(text))
2193
def _load_one_rev(self, rev_id):
2194
"""Load a revision object into memory.
2196
Any parents not either loaded or abandoned get queued to be
2198
self.pb.update('loading revision',
2199
len(self.revisions),
2200
len(self.known_revisions))
2201
if not self.branch.repository.has_revision(rev_id):
2203
self.pb.note('revision {%s} not present in branch; '
2204
'will be converted as a ghost',
2206
self.absent_revisions.add(rev_id)
2208
rev = self.branch.repository.get_revision(rev_id)
2209
for parent_id in rev.parent_ids:
2210
self.known_revisions.add(parent_id)
2211
self.to_read.append(parent_id)
2212
self.revisions[rev_id] = rev
2214
def _load_old_inventory(self, rev_id):
2215
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2216
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2217
inv.revision_id = rev_id
2218
rev = self.revisions[rev_id]
2221
def _load_updated_inventory(self, rev_id):
2222
inv_xml = self.inv_weave.get_text(rev_id)
2223
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2226
def _convert_one_rev(self, rev_id):
2227
"""Convert revision and all referenced objects to new format."""
2228
rev = self.revisions[rev_id]
2229
inv = self._load_old_inventory(rev_id)
2230
present_parents = [p for p in rev.parent_ids
2231
if p not in self.absent_revisions]
2232
self._convert_revision_contents(rev, inv, present_parents)
2233
self._store_new_inv(rev, inv, present_parents)
2234
self.converted_revs.add(rev_id)
2236
def _store_new_inv(self, rev, inv, present_parents):
2237
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2238
new_inv_sha1 = sha_string(new_inv_xml)
2239
self.inv_weave.add_lines(rev.revision_id,
2241
new_inv_xml.splitlines(True))
2242
rev.inventory_sha1 = new_inv_sha1
2244
def _convert_revision_contents(self, rev, inv, present_parents):
2245
"""Convert all the files within a revision.
2247
Also upgrade the inventory to refer to the text revision ids."""
2248
rev_id = rev.revision_id
2249
mutter('converting texts of revision {%s}',
2251
parent_invs = map(self._load_updated_inventory, present_parents)
2252
entries = inv.iter_entries()
2254
for path, ie in entries:
2255
self._convert_file_version(rev, ie, parent_invs)
2257
def _convert_file_version(self, rev, ie, parent_invs):
2258
"""Convert one version of one file.
2260
The file needs to be added into the weave if it is a merge
2261
of >=2 parents or if it's changed from its parent.
2263
file_id = ie.file_id
2264
rev_id = rev.revision_id
2265
w = self.text_weaves.get(file_id)
2268
self.text_weaves[file_id] = w
2269
text_changed = False
2270
parent_candiate_entries = ie.parent_candidates(parent_invs)
2271
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2272
# XXX: Note that this is unordered - and this is tolerable because
2273
# the previous code was also unordered.
2274
previous_entries = dict((head, parent_candiate_entries[head]) for head
2276
self.snapshot_ie(previous_entries, ie, w, rev_id)
2279
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2280
def get_parents(self, revision_ids):
2281
for revision_id in revision_ids:
2282
yield self.revisions[revision_id].parent_ids
2284
def get_parent_map(self, revision_ids):
2285
"""See graph._StackedParentsProvider.get_parent_map"""
2286
return dict((revision_id, self.revisions[revision_id])
2287
for revision_id in revision_ids
2288
if revision_id in self.revisions)
2290
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2291
# TODO: convert this logic, which is ~= snapshot to
2292
# a call to:. This needs the path figured out. rather than a work_tree
2293
# a v4 revision_tree can be given, or something that looks enough like
2294
# one to give the file content to the entry if it needs it.
2295
# and we need something that looks like a weave store for snapshot to
2297
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2298
if len(previous_revisions) == 1:
2299
previous_ie = previous_revisions.values()[0]
2300
if ie._unchanged(previous_ie):
2301
ie.revision = previous_ie.revision
2304
text = self.branch.repository._text_store.get(ie.text_id)
2305
file_lines = text.readlines()
2306
w.add_lines(rev_id, previous_revisions, file_lines)
2307
self.text_count += 1
2309
w.add_lines(rev_id, previous_revisions, [])
2310
ie.revision = rev_id
2312
def _make_order(self):
2313
"""Return a suitable order for importing revisions.
2315
The order must be such that an revision is imported after all
2316
its (present) parents.
2318
todo = set(self.revisions.keys())
2319
done = self.absent_revisions.copy()
2322
# scan through looking for a revision whose parents
2324
for rev_id in sorted(list(todo)):
2325
rev = self.revisions[rev_id]
2326
parent_ids = set(rev.parent_ids)
2327
if parent_ids.issubset(done):
2328
# can take this one now
2329
order.append(rev_id)
2335
class ConvertBzrDir5To6(Converter):
2336
"""Converts format 5 bzr dirs to format 6."""
2338
def convert(self, to_convert, pb):
2339
"""See Converter.convert()."""
2340
self.bzrdir = to_convert
2342
self.pb.note('starting upgrade from format 5 to 6')
2343
self._convert_to_prefixed()
2344
return BzrDir.open(self.bzrdir.root_transport.base)
2346
def _convert_to_prefixed(self):
2347
from bzrlib.store import TransportStore
2348
self.bzrdir.transport.delete('branch-format')
2349
for store_name in ["weaves", "revision-store"]:
2350
self.pb.note("adding prefixes to %s" % store_name)
2351
store_transport = self.bzrdir.transport.clone(store_name)
2352
store = TransportStore(store_transport, prefixed=True)
2353
for urlfilename in store_transport.list_dir('.'):
2354
filename = urlutils.unescape(urlfilename)
2355
if (filename.endswith(".weave") or
2356
filename.endswith(".gz") or
2357
filename.endswith(".sig")):
2358
file_id, suffix = os.path.splitext(filename)
2362
new_name = store._mapper.map((file_id,)) + suffix
2363
# FIXME keep track of the dirs made RBC 20060121
2365
store_transport.move(filename, new_name)
2366
except errors.NoSuchFile: # catches missing dirs strangely enough
2367
store_transport.mkdir(osutils.dirname(new_name))
2368
store_transport.move(filename, new_name)
2369
self.bzrdir.transport.put_bytes(
2371
BzrDirFormat6().get_format_string(),
2372
mode=self.bzrdir._get_file_mode())
2375
class ConvertBzrDir6ToMeta(Converter):
2376
"""Converts format 6 bzr dirs to metadirs."""
2378
def convert(self, to_convert, pb):
2379
"""See Converter.convert()."""
2380
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2381
from bzrlib.branch import BzrBranchFormat5
2382
self.bzrdir = to_convert
2385
self.total = 20 # the steps we know about
2386
self.garbage_inventories = []
2387
self.dir_mode = self.bzrdir._get_dir_mode()
2388
self.file_mode = self.bzrdir._get_file_mode()
2390
self.pb.note('starting upgrade from format 6 to metadir')
2391
self.bzrdir.transport.put_bytes(
2393
"Converting to format 6",
2394
mode=self.file_mode)
2395
# its faster to move specific files around than to open and use the apis...
2396
# first off, nuke ancestry.weave, it was never used.
2398
self.step('Removing ancestry.weave')
2399
self.bzrdir.transport.delete('ancestry.weave')
2400
except errors.NoSuchFile:
2402
# find out whats there
2403
self.step('Finding branch files')
2404
last_revision = self.bzrdir.open_branch().last_revision()
2405
bzrcontents = self.bzrdir.transport.list_dir('.')
2406
for name in bzrcontents:
2407
if name.startswith('basis-inventory.'):
2408
self.garbage_inventories.append(name)
2409
# create new directories for repository, working tree and branch
2410
repository_names = [('inventory.weave', True),
2411
('revision-store', True),
2413
self.step('Upgrading repository ')
2414
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2415
self.make_lock('repository')
2416
# we hard code the formats here because we are converting into
2417
# the meta format. The meta format upgrader can take this to a
2418
# future format within each component.
2419
self.put_format('repository', RepositoryFormat7())
2420
for entry in repository_names:
2421
self.move_entry('repository', entry)
2423
self.step('Upgrading branch ')
2424
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2425
self.make_lock('branch')
2426
self.put_format('branch', BzrBranchFormat5())
2427
branch_files = [('revision-history', True),
2428
('branch-name', True),
2430
for entry in branch_files:
2431
self.move_entry('branch', entry)
2433
checkout_files = [('pending-merges', True),
2434
('inventory', True),
2435
('stat-cache', False)]
2436
# If a mandatory checkout file is not present, the branch does not have
2437
# a functional checkout. Do not create a checkout in the converted
2439
for name, mandatory in checkout_files:
2440
if mandatory and name not in bzrcontents:
2441
has_checkout = False
2445
if not has_checkout:
2446
self.pb.note('No working tree.')
2447
# If some checkout files are there, we may as well get rid of them.
2448
for name, mandatory in checkout_files:
2449
if name in bzrcontents:
2450
self.bzrdir.transport.delete(name)
2452
from bzrlib.workingtree import WorkingTreeFormat3
2453
self.step('Upgrading working tree')
2454
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2455
self.make_lock('checkout')
2457
'checkout', WorkingTreeFormat3())
2458
self.bzrdir.transport.delete_multi(
2459
self.garbage_inventories, self.pb)
2460
for entry in checkout_files:
2461
self.move_entry('checkout', entry)
2462
if last_revision is not None:
2463
self.bzrdir.transport.put_bytes(
2464
'checkout/last-revision', last_revision)
2465
self.bzrdir.transport.put_bytes(
2467
BzrDirMetaFormat1().get_format_string(),
2468
mode=self.file_mode)
2469
return BzrDir.open(self.bzrdir.root_transport.base)
2471
def make_lock(self, name):
2472
"""Make a lock for the new control dir name."""
2473
self.step('Make %s lock' % name)
2474
ld = lockdir.LockDir(self.bzrdir.transport,
2476
file_modebits=self.file_mode,
2477
dir_modebits=self.dir_mode)
2480
def move_entry(self, new_dir, entry):
2481
"""Move then entry name into new_dir."""
2483
mandatory = entry[1]
2484
self.step('Moving %s' % name)
2486
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2487
except errors.NoSuchFile:
2491
def put_format(self, dirname, format):
2492
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2493
format.get_format_string(),
2497
class ConvertMetaToMeta(Converter):
1782
2498
"""Converts the components of metadirs."""
1784
2500
def __init__(self, target_format):
1838
2553
# TODO: conversions of Branch and Tree should be done by
1839
2554
# InterXFormat lookups
1840
if (isinstance(tree, workingtree_3.WorkingTree3) and
1841
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2555
if (isinstance(tree, workingtree.WorkingTree3) and
2556
not isinstance(tree, workingtree_4.WorkingTree4) and
1842
2557
isinstance(self.target_format.workingtree_format,
1843
workingtree_4.DirStateWorkingTreeFormat)):
2558
workingtree_4.WorkingTreeFormat4)):
1844
2559
workingtree_4.Converter3to4().convert(tree)
1845
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1846
not isinstance(tree, workingtree_4.WorkingTree5) and
1847
isinstance(self.target_format.workingtree_format,
1848
workingtree_4.WorkingTreeFormat5)):
1849
workingtree_4.Converter4to5().convert(tree)
1850
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
1851
not isinstance(tree, workingtree_4.WorkingTree6) and
1852
isinstance(self.target_format.workingtree_format,
1853
workingtree_4.WorkingTreeFormat6)):
1854
workingtree_4.Converter4or5to6().convert(tree)
1856
2560
return to_convert
1859
class ConvertMetaToColo(controldir.Converter):
1860
"""Add colocated branch support."""
1862
def __init__(self, target_format):
1863
"""Create a converter.that upgrades a metadir to the colo format.
1865
:param target_format: The final metadir format that is desired.
1867
self.target_format = target_format
1869
def convert(self, to_convert, pb):
1870
"""See Converter.convert()."""
1871
to_convert.transport.put_bytes('branch-format',
1872
self.target_format.as_string())
1873
return BzrDir.open_from_transport(to_convert.root_transport)
1876
class ConvertMetaToColo(controldir.Converter):
1877
"""Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1879
def __init__(self, target_format):
1880
"""Create a converter that converts a 'development-colo' metadir
1883
:param target_format: The final metadir format that is desired.
1885
self.target_format = target_format
1887
def convert(self, to_convert, pb):
1888
"""See Converter.convert()."""
1889
to_convert.transport.put_bytes('branch-format',
1890
self.target_format.as_string())
1891
return BzrDir.open_from_transport(to_convert.root_transport)
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
2563
# This is not in remote.py because it's small, and needs to be registered.
2564
# Putting it in remote.py creates a circular import problem.
2565
# we can make it a lazy object if the control formats is turned into something
2567
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2568
"""Format representing bzrdirs accessed via a smart server"""
2570
def get_format_description(self):
2571
return 'bzr remote bzrdir'
2574
def probe_transport(klass, transport):
2575
"""Return a RemoteBzrDirFormat object if it looks possible."""
2577
medium = transport.get_smart_medium()
2578
except (NotImplementedError, AttributeError,
2579
errors.TransportNotPossible, errors.NoSmartMedium,
2580
errors.SmartProtocolError):
2581
# no smart server, so not a branch for this format type.
2582
raise errors.NotBranchError(path=transport.base)
2584
# Decline to open it if the server doesn't support our required
2585
# version (3) so that the VFS-based transport will do it.
2586
if medium.should_probe():
2588
server_version = medium.protocol_version()
2589
except errors.SmartProtocolError:
2590
# Apparently there's no usable smart server there, even though
2591
# the medium supports the smart protocol.
2592
raise errors.NotBranchError(path=transport.base)
2593
if server_version != '2':
2594
raise errors.NotBranchError(path=transport.base)
2597
def initialize_on_transport(self, transport):
2599
# hand off the request to the smart server
2600
client_medium = transport.get_smart_medium()
2601
except errors.NoSmartMedium:
2602
# TODO: lookup the local format from a server hint.
2603
local_dir_format = BzrDirMetaFormat1()
2604
return local_dir_format.initialize_on_transport(transport)
2605
client = _SmartClient(client_medium)
2606
path = client.remote_path_from_transport(transport)
2607
response = client.call('BzrDirFormat.initialize', path)
2608
if response[0] != 'ok':
2609
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2610
return remote.RemoteBzrDir(transport)
2612
def _open(self, transport):
2613
return remote.RemoteBzrDir(transport)
2615
def __eq__(self, other):
2616
if not isinstance(other, RemoteBzrDirFormat):
2618
return self.get_format_description() == other.get_format_description()
2621
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2624
class BzrDirFormatInfo(object):
2626
def __init__(self, native, deprecated, hidden, experimental):
2627
self.deprecated = deprecated
2628
self.native = native
2629
self.hidden = hidden
2630
self.experimental = experimental
2633
class BzrDirFormatRegistry(registry.Registry):
2634
"""Registry of user-selectable BzrDir subformats.
2636
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2637
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2641
"""Create a BzrDirFormatRegistry."""
2642
self._aliases = set()
2643
super(BzrDirFormatRegistry, self).__init__()
2646
"""Return a set of the format names which are aliases."""
2647
return frozenset(self._aliases)
2649
def register_metadir(self, key,
2650
repository_format, help, native=True, deprecated=False,
2656
"""Register a metadir subformat.
2658
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2659
by the Repository format.
2661
:param repository_format: The fully-qualified repository format class
2663
:param branch_format: Fully-qualified branch format class name as
2665
:param tree_format: Fully-qualified tree format class name as
2668
# This should be expanded to support setting WorkingTree and Branch
2669
# formats, once BzrDirMetaFormat1 supports that.
2670
def _load(full_name):
2671
mod_name, factory_name = full_name.rsplit('.', 1)
2673
mod = __import__(mod_name, globals(), locals(),
2675
except ImportError, e:
2676
raise ImportError('failed to load %s: %s' % (full_name, e))
2678
factory = getattr(mod, factory_name)
2679
except AttributeError:
2680
raise AttributeError('no factory %s in module %r'
2685
bd = BzrDirMetaFormat1()
2686
if branch_format is not None:
2687
bd.set_branch_format(_load(branch_format))
2688
if tree_format is not None:
2689
bd.workingtree_format = _load(tree_format)
2690
if repository_format is not None:
2691
bd.repository_format = _load(repository_format)
2693
self.register(key, helper, help, native, deprecated, hidden,
2694
experimental, alias)
2696
def register(self, key, factory, help, native=True, deprecated=False,
2697
hidden=False, experimental=False, alias=False):
2698
"""Register a BzrDirFormat factory.
2700
The factory must be a callable that takes one parameter: the key.
2701
It must produce an instance of the BzrDirFormat when called.
2703
This function mainly exists to prevent the info object from being
2706
registry.Registry.register(self, key, factory, help,
2707
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2709
self._aliases.add(key)
2711
def register_lazy(self, key, module_name, member_name, help, native=True,
2712
deprecated=False, hidden=False, experimental=False, alias=False):
2713
registry.Registry.register_lazy(self, key, module_name, member_name,
2714
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2716
self._aliases.add(key)
2718
def set_default(self, key):
2719
"""Set the 'default' key to be a clone of the supplied key.
2721
This method must be called once and only once.
2723
registry.Registry.register(self, 'default', self.get(key),
2724
self.get_help(key), info=self.get_info(key))
2725
self._aliases.add('default')
2727
def set_default_repository(self, key):
2728
"""Set the FormatRegistry default and Repository default.
2730
This is a transitional method while Repository.set_default_format
2733
if 'default' in self:
2734
self.remove('default')
2735
self.set_default(key)
2736
format = self.get('default')()
2738
def make_bzrdir(self, key):
2739
return self.get(key)()
2741
def help_topic(self, topic):
2742
output = textwrap.dedent("""\
2743
These formats can be used for creating branches, working trees, and
2747
default_realkey = None
2748
default_help = self.get_help('default')
2750
for key in self.keys():
2751
if key == 'default':
2753
help = self.get_help(key)
2754
if help == default_help:
2755
default_realkey = key
2757
help_pairs.append((key, help))
2759
def wrapped(key, help, info):
2761
help = '(native) ' + help
2762
return ':%s:\n%s\n\n' % (key,
2763
textwrap.fill(help, initial_indent=' ',
2764
subsequent_indent=' '))
2765
if default_realkey is not None:
2766
output += wrapped(default_realkey, '(default) %s' % default_help,
2767
self.get_info('default'))
2768
deprecated_pairs = []
2769
experimental_pairs = []
2770
for key, help in help_pairs:
2771
info = self.get_info(key)
2774
elif info.deprecated:
2775
deprecated_pairs.append((key, help))
2776
elif info.experimental:
2777
experimental_pairs.append((key, help))
2779
output += wrapped(key, help, info)
2780
if len(experimental_pairs) > 0:
2781
output += "Experimental formats are shown below.\n\n"
2782
for key, help in experimental_pairs:
2783
info = self.get_info(key)
2784
output += wrapped(key, help, info)
2785
if len(deprecated_pairs) > 0:
2786
output += "Deprecated formats are shown below.\n\n"
2787
for key, help in deprecated_pairs:
2788
info = self.get_info(key)
2789
output += wrapped(key, help, info)
1897
2794
class RepositoryAcquisitionPolicy(object):
2049
2936
require_stacking)
2050
2937
self._repository = repository
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
2939
def acquire_repository(self, make_working_trees=None, shared=False):
2054
2940
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2056
Returns an existing repository to use.
2942
Returns an existing repository to use
2058
if possible_transports is None:
2059
possible_transports = []
2061
possible_transports = list(possible_transports)
2062
possible_transports.append(self._repository.bzrdir.transport)
2063
self._add_fallback(self._repository,
2064
possible_transports=possible_transports)
2065
return self._repository, False
2068
def register_metadir(registry, key,
2069
repository_format, help, native=True, deprecated=False,
2074
alias=False, bzrdir_format=None):
2075
"""Register a metadir subformat.
2077
These all use a meta bzrdir, but can be parameterized by the
2078
Repository/Branch/WorkingTreeformats.
2080
:param repository_format: The fully-qualified repository format class
2082
:param branch_format: Fully-qualified branch format class name as
2084
:param tree_format: Fully-qualified tree format class name as
2087
if bzrdir_format is None:
2088
bzrdir_format = BzrDirMetaFormat1
2089
# This should be expanded to support setting WorkingTree and Branch
2090
# formats, once the API supports that.
2091
def _load(full_name):
2092
mod_name, factory_name = full_name.rsplit('.', 1)
2094
factory = pyutils.get_named_object(mod_name, factory_name)
2095
except ImportError, e:
2096
raise ImportError('failed to load %s: %s' % (full_name, e))
2097
except AttributeError:
2098
raise AttributeError('no factory %s in module %r'
2099
% (full_name, sys.modules[mod_name]))
2103
bd = bzrdir_format()
2104
if branch_format is not None:
2105
bd.set_branch_format(_load(branch_format))
2106
if tree_format is not None:
2107
bd.workingtree_format = _load(tree_format)
2108
if repository_format is not None:
2109
bd.repository_format = _load(repository_format)
2111
registry.register(key, helper, help, native, deprecated, hidden,
2112
experimental, alias)
2114
register_metadir(controldir.format_registry, 'knit',
2944
self._add_fallback(self._repository)
2945
return self._repository
2948
format_registry = BzrDirFormatRegistry()
2949
format_registry.register('weave', BzrDirFormat6,
2950
'Pre-0.8 format. Slower than knit and does not'
2951
' support checkouts or shared repositories.',
2953
format_registry.register_metadir('knit',
2115
2954
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
2955
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2117
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2118
tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2121
register_metadir(controldir.format_registry, 'dirstate',
2122
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2123
help='Format using dirstate for working trees. '
2124
'Compatible with bzr 0.8 and '
2125
'above when accessed over the network. Introduced in bzr 0.15.',
2126
branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2127
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2131
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
help='Variant of dirstate with support for tags. '
2133
'Introduced in bzr 0.15.',
2956
branch_format='bzrlib.branch.BzrBranchFormat5',
2957
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2958
format_registry.register_metadir('metaweave',
2959
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2960
'Transitional format in 0.8. Slower than knit.',
2961
branch_format='bzrlib.branch.BzrBranchFormat5',
2962
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2964
format_registry.register_metadir('dirstate',
2965
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2966
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2967
'above when accessed over the network.',
2968
branch_format='bzrlib.branch.BzrBranchFormat5',
2969
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2970
# directly from workingtree_4 triggers a circular import.
2971
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2973
format_registry.register_metadir('dirstate-tags',
2974
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2975
help='New in 0.15: Fast local operations and improved scaling for '
2976
'network operations. Additionally adds support for tags.'
2977
' Incompatible with bzr < 0.15.',
2134
2978
branch_format='bzrlib.branch.BzrBranchFormat6',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
register_metadir(controldir.format_registry, 'rich-root',
2979
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2981
format_registry.register_metadir('rich-root',
2139
2982
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
2983
help='New in 1.0. Better handling of tree roots. Incompatible with'
2142
2985
branch_format='bzrlib.branch.BzrBranchFormat6',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2986
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2988
format_registry.register_metadir('dirstate-with-subtree',
2147
2989
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2148
help='Variant of dirstate with support for nested trees. '
2149
'Introduced in 0.15.',
2150
branch_format='bzrlib.branch.BzrBranchFormat6',
2151
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2155
register_metadir(controldir.format_registry, 'pack-0.92',
2156
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2157
help='Pack-based format used in 1.x series. Introduced in 0.92. '
2158
'Interoperates with bzr repositories before 0.92 but cannot be '
2159
'read by bzr < 0.92. '
2161
branch_format='bzrlib.branch.BzrBranchFormat6',
2162
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2167
help='Pack-based format used in 1.x series, with subtree support. '
2168
'Introduced in 0.92. Interoperates with '
2169
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2171
branch_format='bzrlib.branch.BzrBranchFormat6',
2172
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2179
help='A variant of pack-0.92 that supports rich-root data '
2180
'(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2181
branch_format='bzrlib.branch.BzrBranchFormat6',
2182
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2186
register_metadir(controldir.format_registry, '1.6',
2187
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2188
help='A format that allows a branch to indicate that there is another '
2189
'(stacked) repository that should be used to access data that is '
2190
'not present locally.',
2191
branch_format='bzrlib.branch.BzrBranchFormat7',
2192
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2198
help='A variant of 1.6 that supports rich-root data '
2199
'(needed for bzr-svn and bzr-git).',
2200
branch_format='bzrlib.branch.BzrBranchFormat7',
2201
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2205
register_metadir(controldir.format_registry, '1.9',
2206
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2207
help='A repository format using B+tree indexes. These indexes '
2208
'are smaller in size, have smarter caching and provide faster '
2209
'performance for most operations.',
2210
branch_format='bzrlib.branch.BzrBranchFormat7',
2211
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2217
help='A variant of 1.9 that supports rich-root data '
2218
'(needed for bzr-svn and bzr-git).',
2219
branch_format='bzrlib.branch.BzrBranchFormat7',
2220
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2224
register_metadir(controldir.format_registry, '1.14',
2225
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2226
help='A working-tree format that supports content filtering.',
2227
branch_format='bzrlib.branch.BzrBranchFormat7',
2228
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2234
help='A variant of 1.14 that supports rich-root data '
2235
'(needed for bzr-svn and bzr-git).',
2236
branch_format='bzrlib.branch.BzrBranchFormat7',
2237
tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2241
# The following un-numbered 'development' formats should always just be aliases.
2242
register_metadir(controldir.format_registry, 'development-subtree',
2243
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
2990
help='New in 0.15: Fast local operations and improved scaling for '
2991
'network operations. Additionally adds support for versioning nested '
2992
'bzr branches. Incompatible with bzr < 0.15.',
2993
branch_format='bzrlib.branch.BzrBranchFormat6',
2994
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2998
format_registry.register_metadir('pack-0.92',
2999
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3000
help='New in 0.92: Pack-based format with data compatible with '
3001
'dirstate-tags format repositories. Interoperates with '
3002
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3003
'Previously called knitpack-experimental. '
3004
'For more information, see '
3005
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3006
branch_format='bzrlib.branch.BzrBranchFormat6',
3007
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3009
format_registry.register_metadir('pack-0.92-subtree',
3010
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3011
help='New in 0.92: Pack-based format with data compatible with '
3012
'dirstate-with-subtree format repositories. Interoperates with '
3013
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3014
'Previously called knitpack-experimental. '
3015
'For more information, see '
3016
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3017
branch_format='bzrlib.branch.BzrBranchFormat6',
3018
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3022
format_registry.register_metadir('rich-root-pack',
3023
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3024
help='New in 1.0: Pack-based format with data compatible with '
3025
'rich-root format repositories. Incompatible with'
3027
branch_format='bzrlib.branch.BzrBranchFormat6',
3028
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3030
format_registry.register_metadir('1.6',
3031
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3032
help='A branch and pack based repository that supports stacking. ',
3033
branch_format='bzrlib.branch.BzrBranchFormat7',
3034
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3036
format_registry.register_metadir('1.6-rich-root',
3037
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3038
help='A branch and pack based repository that supports stacking '
3039
'and rich root data (needed for bzr-svn). ',
3040
branch_format='bzrlib.branch.BzrBranchFormat7',
3041
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3043
# The following two formats should always just be aliases.
3044
format_registry.register_metadir('development',
3045
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3046
help='Current development format. Can convert data to and from pack-0.92 '
3047
'(and anything compatible with pack-0.92) format repositories. '
3048
'Repositories and branches in this format can only be read by bzr.dev. '
3050
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3052
branch_format='bzrlib.branch.BzrBranchFormat7',
3053
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3057
format_registry.register_metadir('development-subtree',
3058
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
2244
3059
help='Current development format, subtree variant. Can convert data to and '
2245
3060
'from pack-0.92-subtree (and anything compatible with '
2246
3061
'pack-0.92-subtree) format repositories. Repositories and branches in '
2247
3062
'this format can only be read by bzr.dev. Please read '
2248
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2250
branch_format='bzrlib.branch.BzrBranchFormat7',
2251
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2254
alias=False, # Restore to being an alias when an actual development subtree format is added
2255
# This current non-alias status is simply because we did not introduce a
2256
# chk based subtree format.
2258
register_metadir(controldir.format_registry, 'development5-subtree',
2259
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2260
help='Development format, subtree variant. Can convert data to and '
2261
'from pack-0.92-subtree (and anything compatible with '
2262
'pack-0.92-subtree) format repositories. Repositories and branches in '
2263
'this format can only be read by bzr.dev. Please read '
2264
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2266
branch_format='bzrlib.branch.BzrBranchFormat7',
2267
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2273
register_metadir(controldir.format_registry, 'development-colo',
2274
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2275
help='The 2a format with experimental support for colocated branches.\n',
2276
branch_format='bzrlib.branch.BzrBranchFormat7',
2277
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2279
bzrdir_format=BzrDirMetaFormat1Colo,
2283
# And the development formats above will have aliased one of the following:
2285
# Finally, the current format.
2286
register_metadir(controldir.format_registry, '2a',
2287
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
help='Format for the bzr 2.0 series.\n'
2289
'Uses group-compress storage.\n'
2290
'Provides rich roots which are a one-way transition.\n',
2291
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2292
# 'rich roots. Supported by bzr 1.16 and later.',
2293
branch_format='bzrlib.branch.BzrBranchFormat7',
2294
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2298
# The following format should be an alias for the rich root equivalent
2299
# of the default format
2300
register_metadir(controldir.format_registry, 'default-rich-root',
2301
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2302
branch_format='bzrlib.branch.BzrBranchFormat7',
2303
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3063
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3065
branch_format='bzrlib.branch.BzrBranchFormat7',
3066
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3070
# And the development formats which the will have aliased one of follow:
3071
format_registry.register_metadir('development0',
3072
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
3073
help='Trivial rename of pack-0.92 to provide a development format. '
3075
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3077
branch_format='bzrlib.branch.BzrBranchFormat6',
3078
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3082
format_registry.register_metadir('development0-subtree',
3083
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
3084
help='Trivial rename of pack-0.92-subtree to provide a development format. '
3086
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3088
branch_format='bzrlib.branch.BzrBranchFormat6',
3089
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3093
format_registry.register_metadir('development1',
3094
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
3095
help='A branch and pack based repository that supports stacking. '
3097
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3099
branch_format='bzrlib.branch.BzrBranchFormat7',
3100
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3104
format_registry.register_metadir('development1-subtree',
3105
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3106
help='A branch and pack based repository that supports stacking. '
3108
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3110
branch_format='bzrlib.branch.BzrBranchFormat7',
3111
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2308
3115
# The current format that is made on 'bzr init'.
2309
format_name = config.GlobalStack().get('default_format')
2310
controldir.format_registry.set_default(format_name)
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2314
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2315
format_registry = controldir.format_registry
3116
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
