118
116
thing_to_unlock.break_lock()
120
def can_convert_format(self):
121
"""Return true if this bzrdir is one whose format we can convert from."""
124
118
def check_conversion_target(self, target_format):
119
"""Check that a bzrdir as a whole can be converted to a new format."""
120
# The only current restriction is that the repository content can be
121
# fetched compatibly with the target.
125
122
target_repo_format = target_format.repository_format
126
source_repo_format = self._format.repository_format
127
source_repo_format.check_conversion_target(target_repo_format)
130
def _check_supported(format, allow_unsupported,
131
recommend_upgrade=True,
133
"""Give an error or warning on old formats.
135
:param format: may be any kind of format - workingtree, branch,
138
:param allow_unsupported: If true, allow opening
139
formats that are strongly deprecated, and which may
140
have limited functionality.
142
:param recommend_upgrade: If true (default), warn
143
the user through the ui object that they may wish
144
to upgrade the object.
146
# TODO: perhaps move this into a base Format class; it's not BzrDir
147
# specific. mbp 20070323
148
if not allow_unsupported and not format.is_supported():
149
# see open_downlevel to open legacy branches.
150
raise errors.UnsupportedFormatError(format=format)
151
if recommend_upgrade \
152
and getattr(format, 'upgrade_recommended', False):
153
ui.ui_factory.recommend_upgrade(
154
format.get_format_description(),
157
def clone(self, url, revision_id=None, force_new_repo=False):
158
"""Clone this bzrdir and its contents to url verbatim.
160
If url's last component does not exist, it will be created.
162
if revision_id is not None, then the clone operation may tune
163
itself to download less data.
164
:param force_new_repo: Do not use a shared repository for the target
165
even if one is available.
167
return self.clone_on_transport(get_transport(url),
168
revision_id=revision_id,
169
force_new_repo=force_new_repo)
124
self.open_repository()._format.check_conversion_target(
126
except errors.NoRepositoryPresent:
127
# No repo, no problem.
171
130
def clone_on_transport(self, transport, revision_id=None,
172
force_new_repo=False):
131
force_new_repo=False, preserve_stacking=False, stacked_on=None,
132
create_prefix=False, use_existing_dir=True, no_tree=False):
173
133
"""Clone this bzrdir and its contents to transport verbatim.
175
If the target directory does not exist, it will be created.
177
if revision_id is not None, then the clone operation may tune
135
:param transport: The transport for the location to produce the clone
136
at. If the target directory does not exist, it will be created.
137
:param revision_id: The tip revision-id to use for any branch or
138
working tree. If not None, then the clone operation may tune
178
139
itself to download less data.
179
:param force_new_repo: Do not use a shared repository for the target
140
:param force_new_repo: Do not use a shared repository for the target,
180
141
even if one is available.
142
:param preserve_stacking: When cloning a stacked branch, stack the
143
new branch on top of the other branch's stacked-on branch.
144
:param create_prefix: Create any missing directories leading up to
146
:param use_existing_dir: Use an existing directory if one exists.
147
:param no_tree: If set to true prevents creation of a working tree.
182
transport.ensure_base()
183
result = self._format.initialize_on_transport(transport)
149
# Overview: put together a broad description of what we want to end up
150
# with; then make as few api calls as possible to do it.
152
# We may want to create a repo/branch/tree, if we do so what format
153
# would we want for each:
154
require_stacking = (stacked_on is not None)
155
format = self.cloning_metadir(require_stacking)
157
# Figure out what objects we want:
185
159
local_repo = self.find_repository()
186
160
except errors.NoRepositoryPresent:
187
161
local_repo = None
163
local_branch = self.open_branch()
164
except errors.NotBranchError:
167
# enable fallbacks when branch is not a branch reference
168
if local_branch.repository.has_same_location(local_repo):
169
local_repo = local_branch.repository
170
if preserve_stacking:
172
stacked_on = local_branch.get_stacked_on_url()
173
except (errors.UnstackableBranchFormat,
174
errors.UnstackableRepositoryFormat,
177
# Bug: We create a metadir without knowing if it can support stacking,
178
# we should look up the policy needs first, or just use it as a hint,
189
# may need to copy content in
191
result_repo = local_repo.clone(
193
revision_id=revision_id)
194
result_repo.set_make_working_trees(local_repo.make_working_trees())
197
result_repo = result.find_repository()
198
# fetch content this dir needs.
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)
199
211
result_repo.fetch(local_repo, revision_id=revision_id)
200
except errors.NoRepositoryPresent:
201
# needed to make one anyway.
202
result_repo = local_repo.clone(
204
revision_id=revision_id)
205
result_repo.set_make_working_trees(local_repo.make_working_trees())
215
if result_repo is not None:
216
raise AssertionError('result_repo not None(%r)' % result_repo)
206
217
# 1 if there is a branch present
207
218
# make sure its content is available in the target repository
220
if local_branch is not None:
221
result_branch = local_branch.clone(result, revision_id=revision_id,
222
repository_policy=repository_policy)
210
self.open_branch().clone(result, revision_id=revision_id)
211
except errors.NotBranchError:
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):
214
result_repo = result.find_repository()
215
except errors.NoRepositoryPresent:
217
if result_repo is None or result_repo.make_working_trees():
219
self.open_workingtree().clone(result)
220
except (errors.NoWorkingTree, errors.NotLocalUrl):
224
233
# TODO: This should be given a Transport, and should chdir up; otherwise
225
234
# this will open a new connection.
226
235
def _make_tail(self, url):
227
t = get_transport(url)
231
def create(cls, base, format=None, possible_transports=None):
232
"""Create a new BzrDir at the url 'base'.
234
:param format: If supplied, the format of branch to create. If not
235
supplied, the default is used.
236
:param possible_transports: If supplied, a list of transports that
237
can be reused to share a remote connection.
239
if cls is not BzrDir:
240
raise AssertionError("BzrDir.create always creates the default"
241
" format, not one of %r" % cls)
242
t = get_transport(base, possible_transports)
245
format = BzrDirFormat.get_default_format()
246
return format.initialize_on_transport(t)
248
def destroy_repository(self):
249
"""Destroy the repository in this BzrDir"""
250
raise NotImplementedError(self.destroy_repository)
252
def create_branch(self):
253
"""Create a branch in this BzrDir.
255
The bzrdir's format will control what branch format is created.
256
For more control see BranchFormatXX.create(a_bzrdir).
258
raise NotImplementedError(self.create_branch)
260
def destroy_branch(self):
261
"""Destroy the branch in this BzrDir"""
262
raise NotImplementedError(self.destroy_branch)
265
def create_branch_and_repo(base, force_new_repo=False, format=None):
266
"""Create a new BzrDir, Branch and Repository at the url 'base'.
268
This will use the current default BzrDirFormat unless one is
269
specified, and use whatever
270
repository format that that uses via bzrdir.create_branch and
271
create_repository. If a shared repository is available that is used
274
The created Branch object is returned.
276
:param base: The URL to create the branch at.
277
:param force_new_repo: If True a new repository is always created.
278
:param format: If supplied, the format of branch to create. If not
279
supplied, the default is used.
281
bzrdir = BzrDir.create(base, format)
282
bzrdir._find_or_create_repository(force_new_repo)
283
return bzrdir.create_branch()
236
t = _mod_transport.get_transport(url)
239
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
stack_on_pwd=None, require_stacking=False):
241
"""Return an object representing a policy to use.
243
This controls whether a new repository is created, and the format of
244
that repository, or some existing shared repository used instead.
246
If stack_on is supplied, will not seek a containing shared repo.
248
:param force_new_repo: If True, require a new repository to be created.
249
:param stack_on: If supplied, the location to stack on. If not
250
supplied, a default_stack_on location may be used.
251
:param stack_on_pwd: If stack_on is relative, the location it is
254
def repository_policy(found_bzrdir):
257
config = found_bzrdir.get_config()
259
stack_on = config.get_default_stack_on()
260
if stack_on is not None:
261
stack_on_pwd = found_bzrdir.user_url
263
# does it have a repository ?
265
repository = found_bzrdir.open_repository()
266
except errors.NoRepositoryPresent:
269
if (found_bzrdir.user_url != self.user_url
270
and not repository.is_shared()):
271
# Don't look higher, can't use a higher shared repo.
279
return UseExistingRepository(repository, stack_on,
280
stack_on_pwd, require_stacking=require_stacking), True
282
return CreateRepository(self, stack_on, stack_on_pwd,
283
require_stacking=require_stacking), True
285
if not force_new_repo:
287
policy = self._find_containing(repository_policy)
288
if policy is not None:
292
return UseExistingRepository(self.open_repository(),
293
stack_on, stack_on_pwd,
294
require_stacking=require_stacking)
295
except errors.NoRepositoryPresent:
297
return CreateRepository(self, stack_on, stack_on_pwd,
298
require_stacking=require_stacking)
285
300
def _find_or_create_repository(self, force_new_repo):
286
301
"""Create a new repository if needed, returning the repository."""
288
return self.create_repository()
290
return self.find_repository()
291
except errors.NoRepositoryPresent:
292
return self.create_repository()
302
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.
295
def create_branch_convenience(base, force_new_repo=False,
296
force_new_tree=None, format=None,
297
possible_transports=None):
298
"""Create a new BzrDir, Branch and Repository at the url 'base'.
300
This is a convenience function - it will use an existing repository
301
if possible, can be told explicitly whether to create a working tree or
304
This will use the current default BzrDirFormat unless one is
305
specified, and use whatever
306
repository format that that uses via bzrdir.create_branch and
307
create_repository. If a shared repository is available that is used
308
preferentially. Whatever repository is used, its tree creation policy
311
The created Branch object is returned.
312
If a working tree cannot be made due to base not being a file:// url,
313
no error is raised unless force_new_tree is True, in which case no
314
data is created on disk and NotLocalUrl is raised.
316
:param base: The URL to create the branch at.
317
:param force_new_repo: If True a new repository is always created.
318
:param force_new_tree: If True or False force creation of a tree or
319
prevent such creation respectively.
320
:param format: Override for the bzrdir format to create.
321
:param possible_transports: An optional reusable transports list.
324
# check for non local urls
325
t = get_transport(base, possible_transports)
326
if not isinstance(t, LocalTransport):
327
raise errors.NotLocalUrl(base)
328
bzrdir = BzrDir.create(base, format, possible_transports)
329
repo = bzrdir._find_or_create_repository(force_new_repo)
330
result = bzrdir.create_branch()
331
if force_new_tree or (repo.make_working_trees() and
332
force_new_tree is None):
334
bzrdir.create_workingtree()
335
except errors.NotLocalUrl:
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.
349
:param accelerator_tree: A tree which can be used for retrieving file
350
contents more quickly than the revision tree, i.e. a workingtree.
351
The revision tree will be used for cases where accelerator_tree's
352
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,
340
@deprecated_function(zero_ninetyone)
341
def create_repository(base, shared=False, format=None):
342
"""Create a new BzrDir and Repository at the url 'base'.
344
If no format is supplied, this will default to the current default
345
BzrDirFormat by default, and use whatever repository format that that
346
uses for bzrdirformat.create_repository.
348
:param shared: Create a shared repository rather than a standalone
350
The Repository object is returned.
352
This must be overridden as an instance method in child classes, where
353
it should take no parameters and construct whatever repository format
354
that child class desires.
356
This method is deprecated, please call create_repository on a bzrdir
359
bzrdir = BzrDir.create(base, format)
360
return bzrdir.create_repository(shared)
363
def create_standalone_workingtree(base, format=None):
364
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
366
'base' must be a local path or a file:// url.
368
This will use the current default BzrDirFormat unless one is
369
specified, and use whatever
370
repository format that that uses for bzrdirformat.create_workingtree,
371
create_branch and create_repository.
373
:param format: Override for the bzrdir format to create.
374
:return: The WorkingTree object.
376
t = get_transport(base)
377
if not isinstance(t, LocalTransport):
378
raise errors.NotLocalUrl(base)
379
bzrdir = BzrDir.create_branch_and_repo(base,
381
format=format).bzrdir
382
return bzrdir.create_workingtree()
384
def create_workingtree(self, revision_id=None, from_branch=None):
385
"""Create a working tree at this BzrDir.
387
:param revision_id: create it as of this revision id.
388
:param from_branch: override bzrdir branch (for lightweight checkouts)
390
raise NotImplementedError(self.create_workingtree)
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)
392
495
def retire_bzrdir(self, limit=10000):
393
496
"""Permanently disable the bzrdir.
524
633
:param _transport: the transport this dir is based at.
526
635
self._format = _format
636
# these are also under the more standard names of
637
# control_transport and user_transport
527
638
self.transport = _transport.clone('.bzr')
528
639
self.root_transport = _transport
640
self._mode_check_done = False
643
def user_transport(self):
644
return self.root_transport
647
def control_transport(self):
648
return self.transport
530
650
def is_control_filename(self, filename):
531
651
"""True if filename is the name of a path which is reserved for bzrdir's.
533
653
:param filename: A filename within the root transport of this bzrdir.
535
655
This is true IF and ONLY IF the filename is part of the namespace reserved
536
656
for bzr control dirs. Currently this is the '.bzr' directory in the root
537
of the root_transport. it is expected that plugins will need to extend
538
this in the future - for instance to make bzr talk with svn working
657
of the root_transport.
541
# this might be better on the BzrDirFormat class because it refers to
542
# all the possible bzrdir disk formats.
543
# This method is tested via the workingtree is_control_filename tests-
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-
544
662
# it was extracted from WorkingTree.is_control_filename. If the method's
545
663
# contract is extended beyond the current trivial implementation, please
546
664
# add new tests for it to the appropriate place.
547
665
return filename == '.bzr' or filename.startswith('.bzr/')
549
def needs_format_conversion(self, format=None):
550
"""Return true if this bzrdir needs convert_format run on it.
552
For instance, if the repository format is out of date but the
553
branch and working tree are not, this should return True.
555
:param format: Optional parameter indicating a specific desired
556
format we plan to arrive at.
558
raise NotImplementedError(self.needs_format_conversion)
561
def open_unsupported(base):
562
"""Open a branch which is not supported."""
563
return BzrDir.open(base, _unsupported=True)
566
def open(base, _unsupported=False, possible_transports=None):
567
"""Open an existing bzrdir, rooted at 'base' (url).
569
:param _unsupported: a private parameter to the BzrDir class.
571
t = get_transport(base, possible_transports=possible_transports)
572
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
575
def open_from_transport(transport, _unsupported=False,
576
_server_formats=True):
577
"""Open a bzrdir within a particular directory.
579
:param transport: Transport containing the bzrdir.
580
:param _unsupported: private.
582
base = transport.base
584
def find_format(transport):
585
return transport, BzrDirFormat.find_format(
586
transport, _server_formats=_server_formats)
588
def redirected(transport, e, redirection_notice):
589
qualified_source = e.get_source_url()
590
relpath = transport.relpath(qualified_source)
591
if not e.target.endswith(relpath):
592
# Not redirected to a branch-format, not a branch
593
raise errors.NotBranchError(path=e.target)
594
target = e.target[:-len(relpath)]
595
note('%s is%s redirected to %s',
596
transport.base, e.permanently, target)
597
# Let's try with a new transport
598
# FIXME: If 'transport' has a qualifier, this should
599
# be applied again to the new transport *iff* the
600
# schemes used are the same. Uncomment this code
601
# once the function (and tests) exist.
603
#target = urlutils.copy_url_qualifiers(original, target)
604
return get_transport(target)
607
transport, format = do_catching_redirections(find_format,
610
except errors.TooManyRedirections:
611
raise errors.NotBranchError(base)
613
BzrDir._check_supported(format, _unsupported)
614
return format.open(transport, _found=True)
616
def open_branch(self, unsupported=False):
617
"""Open the branch object at this BzrDir if one is present.
619
If unsupported is True, then no longer supported branch formats can
622
TODO: static convenience version of this?
624
raise NotImplementedError(self.open_branch)
627
def open_containing(url, possible_transports=None):
628
"""Open an existing branch which contains url.
630
:param url: url to search from.
631
See open_containing_from_transport for more detail.
633
transport = get_transport(url, possible_transports)
634
return BzrDir.open_containing_from_transport(transport)
637
def open_containing_from_transport(a_transport):
638
"""Open an existing branch which contains a_transport.base.
640
This probes for a branch at a_transport, and searches upwards from there.
642
Basically we keep looking up until we find the control directory or
643
run into the root. If there isn't one, raises NotBranchError.
644
If there is one and it is either an unrecognised format or an unsupported
645
format, UnknownFormatError or UnsupportedFormatError are raised.
646
If there is one, it is returned, along with the unused portion of url.
648
:return: The BzrDir that contains the path, and a Unicode path
649
for the rest of the URL.
651
# this gets the normalised url back. I.e. '.' -> the full path.
652
url = a_transport.base
655
result = BzrDir.open_from_transport(a_transport)
656
return result, urlutils.unescape(a_transport.relpath(url))
657
except errors.NotBranchError, e:
660
new_t = a_transport.clone('..')
661
except errors.InvalidURLJoin:
662
# reached the root, whatever that may be
663
raise errors.NotBranchError(path=url)
664
if new_t.base == a_transport.base:
665
# reached the root, whatever that may be
666
raise errors.NotBranchError(path=url)
670
def open_containing_tree_or_branch(klass, location):
671
"""Return the branch and working tree contained by a location.
673
Returns (tree, branch, relpath).
674
If there is no tree at containing the location, tree will be None.
675
If there is no branch containing the location, an exception will be
677
relpath is the portion of the path that is contained by the branch.
679
bzrdir, relpath = klass.open_containing(location)
681
tree = bzrdir.open_workingtree()
682
except (errors.NoWorkingTree, errors.NotLocalUrl):
684
branch = bzrdir.open_branch()
687
return tree, branch, relpath
689
def open_repository(self, _unsupported=False):
690
"""Open the repository object at this BzrDir if one is present.
692
This will not follow the Branch object pointer - it's strictly a direct
693
open facility. Most client code should use open_branch().repository to
696
:param _unsupported: a private parameter, not part of the api.
697
TODO: static convenience version of this?
699
raise NotImplementedError(self.open_repository)
701
def open_workingtree(self, _unsupported=False,
702
recommend_upgrade=True, from_branch=None):
703
"""Open the workingtree object at this BzrDir if one is present.
705
:param recommend_upgrade: Optional keyword parameter, when True (the
706
default), emit through the ui module a recommendation that the user
707
upgrade the working tree when the workingtree being opened is old
708
(but still fully supported).
709
:param from_branch: override bzrdir branch (for lightweight checkouts)
711
raise NotImplementedError(self.open_workingtree)
713
def has_branch(self):
714
"""Tell if this bzrdir contains a branch.
716
Note: if you're going to open the branch, you should just go ahead
717
and try, and not ask permission first. (This method just opens the
718
branch and discards it, and that's somewhat expensive.)
723
except errors.NotBranchError:
726
def has_workingtree(self):
727
"""Tell if this bzrdir contains a working tree.
729
This will still raise an exception if the bzrdir has a workingtree that
730
is remote & inaccessible.
732
Note: if you're going to open the working tree, you should just go ahead
733
and try, and not ask permission first. (This method just opens the
734
workingtree and discards it, and that's somewhat expensive.)
737
self.open_workingtree(recommend_upgrade=False)
739
except errors.NoWorkingTree:
742
667
def _cloning_metadir(self):
743
"""Produce a metadir suitable for cloning with."""
668
"""Produce a metadir suitable for cloning with.
670
:returns: (destination_bzrdir_format, source_repository)
744
672
result_format = self._format.__class__()
747
branch = self.open_branch()
675
branch = self.open_branch(ignore_fallbacks=True)
748
676
source_repository = branch.repository
677
result_format._branch_format = branch._format
749
678
except errors.NotBranchError:
750
679
source_branch = None
751
680
source_repository = self.open_repository()
769
700
result_format.workingtree_format = tree._format.__class__()
770
701
return result_format, source_repository
772
def cloning_metadir(self):
703
def cloning_metadir(self, require_stacking=False):
773
704
"""Produce a metadir suitable for cloning or sprouting with.
775
706
These operations may produce workingtrees (yes, even though they're
776
707
"cloning" something that doesn't have a tree), so a viable workingtree
777
708
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
779
716
format, repository = self._cloning_metadir()
780
717
if format._workingtree_format is None:
781
719
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).
783
724
tree_format = repository._format._matchingbzrdir.workingtree_format
784
725
format.workingtree_format = tree_format.__class__()
727
format.require_stacking()
787
def checkout_metadir(self):
788
return self.cloning_metadir()
790
def sprout(self, url, revision_id=None, force_new_repo=False,
791
recurse='down', possible_transports=None):
792
"""Create a copy of this bzrdir prepared for use as a new line of
795
If url's last component does not exist, it will be created.
797
Attributes related to the identity of the source branch like
798
branch nickname will be cleaned, a working tree is created
799
whether one existed before or not; and a local branch is always
802
if revision_id is not None, then the clone operation may tune
803
itself to download less data.
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.
805
target_transport = get_transport(url, possible_transports)
806
target_transport.ensure_base()
807
cloning_format = self.cloning_metadir()
808
result = cloning_format.initialize_on_transport(target_transport)
810
source_branch = self.open_branch()
811
source_repository = source_branch.repository
812
except errors.NotBranchError:
815
source_repository = self.open_repository()
816
except errors.NoRepositoryPresent:
817
source_repository = None
822
result_repo = result.find_repository()
823
except errors.NoRepositoryPresent:
825
if source_repository is None and result_repo is not None:
827
elif source_repository is None and result_repo is None:
828
# no repo available, make a new one
829
result.create_repository()
830
elif source_repository is not None and result_repo is None:
831
# have source, and want to make a new target repo
832
result_repo = source_repository.sprout(result,
833
revision_id=revision_id)
835
# fetch needed content into target.
836
if source_repository is not None:
838
# source_repository.copy_content_into(result_repo,
839
# revision_id=revision_id)
840
# so we can override the copy method
841
result_repo.fetch(source_repository, revision_id=revision_id)
842
if source_branch is not None:
843
source_branch.sprout(result, revision_id=revision_id)
845
result.create_branch()
846
if isinstance(target_transport, LocalTransport) and (
847
result_repo is None or result_repo.make_working_trees()):
848
wt = result.create_workingtree()
851
if wt.path2id('') is None:
853
wt.set_root_id(self.open_workingtree.get_root_id())
854
except errors.NoWorkingTree:
860
if recurse == 'down':
862
basis = wt.basis_tree()
864
subtrees = basis.iter_references()
865
recurse_branch = wt.branch
866
elif source_branch is not None:
867
basis = source_branch.basis_tree()
869
subtrees = basis.iter_references()
870
recurse_branch = source_branch
875
for path, file_id in subtrees:
876
target = urlutils.join(url, urlutils.escape(path))
877
sublocation = source_branch.reference_parent(file_id, path)
878
sublocation.bzrdir.sprout(target,
879
basis.get_reference_revision(file_id, path),
880
force_new_repo=force_new_repo, recurse=recurse)
882
if basis is not None:
887
class BzrDirPreSplitOut(BzrDir):
888
"""A common class for the all-in-one formats."""
890
def __init__(self, _transport, _format):
891
"""See BzrDir.__init__."""
892
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
893
assert self._format._lock_class == lockable_files.TransportLock
894
assert self._format._lock_file_name == 'branch-lock'
895
self._control_files = lockable_files.LockableFiles(
896
self.get_branch_transport(None),
897
self._format._lock_file_name,
898
self._format._lock_class)
900
def break_lock(self):
901
"""Pre-splitout bzrdirs do not suffer from stale locks."""
902
raise NotImplementedError(self.break_lock)
904
def clone(self, url, revision_id=None, force_new_repo=False):
905
"""See BzrDir.clone()."""
906
from bzrlib.workingtree import WorkingTreeFormat2
908
result = self._format._initialize_for_clone(url)
909
self.open_repository().clone(result, revision_id=revision_id)
910
from_branch = self.open_branch()
911
from_branch.clone(result, revision_id=revision_id)
913
self.open_workingtree().clone(result)
914
except errors.NotLocalUrl:
915
# make a new one, this format always has to have one.
917
WorkingTreeFormat2().initialize(result)
918
except errors.NotLocalUrl:
919
# but we cannot do it for remote trees.
920
to_branch = result.open_branch()
921
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
924
def create_branch(self):
925
"""See BzrDir.create_branch."""
926
return self.open_branch()
928
def destroy_branch(self):
929
"""See BzrDir.destroy_branch."""
930
raise errors.UnsupportedOperation(self.destroy_branch, self)
932
def create_repository(self, shared=False):
933
"""See BzrDir.create_repository."""
935
raise errors.IncompatibleFormat('shared repository', self._format)
936
return self.open_repository()
938
def destroy_repository(self):
939
"""See BzrDir.destroy_repository."""
940
raise errors.UnsupportedOperation(self.destroy_repository, self)
942
def create_workingtree(self, revision_id=None, from_branch=None):
943
"""See BzrDir.create_workingtree."""
944
# this looks buggy but is not -really-
945
# because this format creates the workingtree when the bzrdir is
947
# clone and sprout will have set the revision_id
948
# and that will have set it for us, its only
949
# specific uses of create_workingtree in isolation
950
# that can do wonky stuff here, and that only
951
# happens for creating checkouts, which cannot be
952
# done on this format anyway. So - acceptable wart.
953
result = self.open_workingtree(recommend_upgrade=False)
954
if revision_id is not None:
955
if revision_id == _mod_revision.NULL_REVISION:
956
result.set_parent_ids([])
958
result.set_parent_ids([revision_id])
961
def destroy_workingtree(self):
962
"""See BzrDir.destroy_workingtree."""
963
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
965
def destroy_workingtree_metadata(self):
966
"""See BzrDir.destroy_workingtree_metadata."""
967
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
970
def get_branch_transport(self, branch_format):
971
"""See BzrDir.get_branch_transport()."""
972
if branch_format is None:
973
return self.transport
975
branch_format.get_format_string()
976
except NotImplementedError:
977
return self.transport
978
raise errors.IncompatibleFormat(branch_format, self._format)
741
raise NotImplementedError(self.get_branch_transport)
980
743
def get_repository_transport(self, repository_format):
981
"""See BzrDir.get_repository_transport()."""
982
if repository_format is None:
983
return self.transport
985
repository_format.get_format_string()
986
except NotImplementedError:
987
return self.transport
988
raise errors.IncompatibleFormat(repository_format, self._format)
990
def get_workingtree_transport(self, workingtree_format):
991
"""See BzrDir.get_workingtree_transport()."""
992
if workingtree_format is None:
993
return self.transport
995
workingtree_format.get_format_string()
996
except NotImplementedError:
997
return self.transport
998
raise errors.IncompatibleFormat(workingtree_format, self._format)
1000
def needs_format_conversion(self, format=None):
1001
"""See BzrDir.needs_format_conversion()."""
1002
# if the format is not the same as the system default,
1003
# an upgrade is needed.
1005
format = BzrDirFormat.get_default_format()
1006
return not isinstance(self._format, format.__class__)
1008
def open_branch(self, unsupported=False):
1009
"""See BzrDir.open_branch."""
1010
from bzrlib.branch import BzrBranchFormat4
1011
format = BzrBranchFormat4()
1012
self._check_supported(format, unsupported)
1013
return format.open(self, _found=True)
1015
def sprout(self, url, revision_id=None, force_new_repo=False,
1016
possible_transports=None):
1017
"""See BzrDir.sprout()."""
1018
from bzrlib.workingtree import WorkingTreeFormat2
1019
self._make_tail(url)
1020
result = self._format._initialize_for_clone(url)
1022
self.open_repository().clone(result, revision_id=revision_id)
1023
except errors.NoRepositoryPresent:
1026
self.open_branch().sprout(result, revision_id=revision_id)
1027
except errors.NotBranchError:
1029
# we always want a working tree
1030
WorkingTreeFormat2().initialize(result)
1034
class BzrDir4(BzrDirPreSplitOut):
1035
"""A .bzr version 4 control object.
1037
This is a deprecated format and may be removed after sept 2006.
1040
def create_repository(self, shared=False):
1041
"""See BzrDir.create_repository."""
1042
return self._format.repository_format.initialize(self, shared)
1044
def needs_format_conversion(self, format=None):
1045
"""Format 4 dirs are always in need of conversion."""
1048
def open_repository(self):
1049
"""See BzrDir.open_repository."""
1050
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1051
return RepositoryFormat4().open(self, _found=True)
1054
class BzrDir5(BzrDirPreSplitOut):
1055
"""A .bzr version 5 control object.
1057
This is a deprecated format and may be removed after sept 2006.
1060
def open_repository(self):
1061
"""See BzrDir.open_repository."""
1062
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1063
return RepositoryFormat5().open(self, _found=True)
1065
def open_workingtree(self, _unsupported=False,
1066
recommend_upgrade=True):
1067
"""See BzrDir.create_workingtree."""
1068
from bzrlib.workingtree import WorkingTreeFormat2
1069
wt_format = WorkingTreeFormat2()
1070
# we don't warn here about upgrades; that ought to be handled for the
1072
return wt_format.open(self, _found=True)
1075
class BzrDir6(BzrDirPreSplitOut):
1076
"""A .bzr version 6 control object.
1078
This is a deprecated format and may be removed after sept 2006.
1081
def open_repository(self):
1082
"""See BzrDir.open_repository."""
1083
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1084
return RepositoryFormat6().open(self, _found=True)
1086
def open_workingtree(self, _unsupported=False,
1087
recommend_upgrade=True):
1088
"""See BzrDir.create_workingtree."""
1089
# we don't warn here about upgrades; that ought to be handled for the
1091
from bzrlib.workingtree import WorkingTreeFormat2
1092
return WorkingTreeFormat2().open(self, _found=True)
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()
1095
801
class BzrDirMeta1(BzrDir):
1096
802
"""A .bzr meta version 1 control object.
1098
This is the first control object where the
804
This is the first control object where the
1099
805
individual aspects are really split out: there are separate repository,
1100
806
workingtree and branch subdirectories and any subset of the three can be
1101
807
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)
1104
856
def can_convert_format(self):
1105
857
"""See BzrDir.can_convert_format()."""
1108
def create_branch(self):
1109
"""See BzrDir.create_branch."""
1110
return self._format.get_branch_format().initialize(self)
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)
1112
def destroy_branch(self):
1113
"""See BzrDir.create_branch."""
1114
self.transport.delete_tree('branch')
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,
1116
891
def create_repository(self, shared=False):
1117
892
"""See BzrDir.create_repository."""
1234
def open_branch(self, unsupported=False):
1235
"""See BzrDir.open_branch."""
1236
format = self.find_branch_format()
1237
self._check_supported(format, unsupported)
1238
return format.open(self, _found=True)
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)
1240
1081
def open_repository(self, unsupported=False):
1241
1082
"""See BzrDir.open_repository."""
1242
from bzrlib.repository import RepositoryFormat
1243
format = RepositoryFormat.find_format(self)
1244
self._check_supported(format, unsupported)
1083
from bzrlib.repository import RepositoryFormatMetaDir
1084
format = RepositoryFormatMetaDir.find_format(self)
1085
format.check_support_status(unsupported)
1245
1086
return format.open(self, _found=True)
1247
1088
def open_workingtree(self, unsupported=False,
1248
1089
recommend_upgrade=True):
1249
1090
"""See BzrDir.open_workingtree."""
1250
from bzrlib.workingtree import WorkingTreeFormat
1251
format = WorkingTreeFormat.find_format(self)
1252
self._check_supported(format, unsupported,
1091
from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
format = WorkingTreeFormatMetaDir.find_format(self)
1093
format.check_support_status(unsupported, recommend_upgrade,
1254
1094
basedir=self.root_transport.base)
1255
1095
return format.open(self, _found=True)
1258
class BzrDirFormat(object):
1259
"""An encapsulation of the initialization and open routines for a format.
1261
Formats provide three things:
1262
* An initialization routine,
1266
Formats are placed in a dict by their format string for reference
1097
def _get_config(self):
1098
return config.TransportConfig(self.transport, 'control.conf')
1101
class BzrFormat(object):
1102
"""Base class for all formats of things living in metadirs.
1104
This class manages the format string that is stored in the 'format'
1105
or 'branch-format' file.
1107
All classes for (branch-, repository-, workingtree-) formats that
1108
live in meta directories and have their own 'format' file
1109
(i.e. different from .bzr/branch-format) derive from this class,
1110
as well as the relevant base class for their kind
1111
(BranchFormat, WorkingTreeFormat, RepositoryFormat).
1113
Each format is identified by a "format" or "branch-format" file with a
1114
single line containing the base format name and then an optional list of
1117
Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1118
will render them inaccessible to older versions of bzr.
1120
:ivar features: Dictionary mapping feature names to their necessity
1123
_present_features = set()
1129
def register_feature(cls, name):
1130
"""Register a feature as being present.
1132
:param name: Name of the feature
1135
raise ValueError("spaces are not allowed in feature names")
1136
if name in cls._present_features:
1137
raise errors.FeatureAlreadyRegistered(name)
1138
cls._present_features.add(name)
1141
def unregister_feature(cls, name):
1142
"""Unregister a feature."""
1143
cls._present_features.remove(name)
1145
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1147
for name, necessity in self.features.iteritems():
1148
if name in self._present_features:
1150
if necessity == "optional":
1151
mutter("ignoring optional missing feature %s", name)
1153
elif necessity == "required":
1154
raise errors.MissingFeature(name)
1156
mutter("treating unknown necessity as require for %s",
1158
raise errors.MissingFeature(name)
1161
def get_format_string(cls):
1162
"""Return the ASCII format string that identifies this format."""
1163
raise NotImplementedError(cls.get_format_string)
1166
def from_string(cls, text):
1167
format_string = cls.get_format_string()
1168
if not text.startswith(format_string):
1169
raise AssertionError("Invalid format header %r for %r" % (text, cls))
1170
lines = text[len(format_string):].splitlines()
1172
for lineno, line in enumerate(lines):
1174
(necessity, feature) = line.split(" ", 1)
1176
raise errors.ParseFormatError(format=cls, lineno=lineno+2,
1177
line=line, text=text)
1178
ret.features[feature] = necessity
1181
def as_string(self):
1182
"""Return the string representation of this format.
1184
lines = [self.get_format_string()]
1185
lines.extend([("%s %s\n" % (item[1], item[0])) for item in
1186
self.features.iteritems()])
1187
return "".join(lines)
1190
def _find_format(klass, registry, kind, format_string):
1192
first_line = format_string[:format_string.index("\n")+1]
1194
first_line = format_string
1196
cls = registry.get(first_line)
1198
raise errors.UnknownFormatError(format=first_line, kind=kind)
1199
return cls.from_string(format_string)
1201
def network_name(self):
1202
"""A simple byte string uniquely identifying this format for RPC calls.
1204
Metadir branch formats use their format string.
1206
return self.as_string()
1208
def __eq__(self, other):
1209
return (self.__class__ is other.__class__ and
1210
self.features == other.features)
1212
def _update_feature_flags(self, updated_flags):
1213
"""Update the feature flags in this format.
1215
:param updated_flags: Updated feature flags
1217
for name, necessity in updated_flags.iteritems():
1218
if necessity is None:
1220
del self.features[name]
1224
self.features[name] = necessity
1227
class BzrProber(controldir.Prober):
1228
"""Prober for formats that use a .bzr/ control directory."""
1230
formats = registry.FormatRegistry(controldir.network_format_registry)
1231
"""The known .bzr formats."""
1234
def probe_transport(klass, transport):
1235
"""Return the .bzrdir style format present in a directory."""
1237
format_string = transport.get_bytes(".bzr/branch-format")
1238
except errors.NoSuchFile:
1239
raise errors.NotBranchError(path=transport.base)
1241
first_line = format_string[:format_string.index("\n")+1]
1243
first_line = format_string
1245
cls = klass.formats.get(first_line)
1247
raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
return cls.from_string(format_string)
1251
def known_formats(cls):
1253
for name, format in cls.formats.iteritems():
1254
if callable(format):
1260
controldir.ControlDirFormat.register_prober(BzrProber)
1263
class RemoteBzrProber(controldir.Prober):
1264
"""Prober for remote servers that provide a Bazaar smart server."""
1267
def probe_transport(klass, transport):
1268
"""Return a RemoteBzrDirFormat object if it looks possible."""
1270
medium = transport.get_smart_medium()
1271
except (NotImplementedError, AttributeError,
1272
errors.TransportNotPossible, errors.NoSmartMedium,
1273
errors.SmartProtocolError):
1274
# no smart server, so not a branch for this format type.
1275
raise errors.NotBranchError(path=transport.base)
1277
# Decline to open it if the server doesn't support our required
1278
# version (3) so that the VFS-based transport will do it.
1279
if medium.should_probe():
1281
server_version = medium.protocol_version()
1282
except errors.SmartProtocolError:
1283
# Apparently there's no usable smart server there, even though
1284
# the medium supports the smart protocol.
1285
raise errors.NotBranchError(path=transport.base)
1286
if server_version != '2':
1287
raise errors.NotBranchError(path=transport.base)
1288
from bzrlib.remote import RemoteBzrDirFormat
1289
return RemoteBzrDirFormat()
1292
def known_formats(cls):
1293
from bzrlib.remote import RemoteBzrDirFormat
1294
return set([RemoteBzrDirFormat()])
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1298
"""ControlDirFormat base class for .bzr/ directories.
1300
Formats are placed in a dict by their format string for reference
1267
1301
during bzrdir opening. These should be subclasses of BzrDirFormat
1268
1302
for consistency.
1270
1304
Once a format is deprecated, just deprecate the initialize and open
1271
methods on the format class. Do not deprecate the object, as the
1305
methods on the format class. Do not deprecate the object, as the
1272
1306
object will be created every system load.
1275
_default_format = None
1276
"""The default format used for new .bzr dirs."""
1279
"""The known formats."""
1281
_control_formats = []
1282
"""The registered control formats - .bzr, ....
1284
This is a list of BzrDirFormat objects.
1287
_control_server_formats = []
1288
"""The registered control server formats, e.g. RemoteBzrDirs.
1290
This is a list of BzrDirFormat objects.
1293
1309
_lock_file_name = 'branch-lock'
1295
1311
# _lock_class must be set in subclasses to the lock type, typ.
1296
1312
# TransportLock or LockDir
1299
def find_format(klass, transport, _server_formats=True):
1300
"""Return the format present at transport."""
1302
formats = klass._control_server_formats + klass._control_formats
1304
formats = klass._control_formats
1305
for format in formats:
1307
return format.probe_transport(transport)
1308
except errors.NotBranchError:
1309
# this format does not find a control dir here.
1311
raise errors.NotBranchError(path=transport.base)
1314
def probe_transport(klass, transport):
1315
"""Return the .bzrdir style format present in a directory."""
1317
format_string = transport.get(".bzr/branch-format").read()
1318
except errors.NoSuchFile:
1319
raise errors.NotBranchError(path=transport.base)
1322
return klass._formats[format_string]
1324
raise errors.UnknownFormatError(format=format_string)
1327
def get_default_format(klass):
1328
"""Return the current default format."""
1329
return klass._default_format
1331
def get_format_string(self):
1332
"""Return the ASCII format string that identifies this format."""
1333
raise NotImplementedError(self.get_format_string)
1335
def get_format_description(self):
1336
"""Return the short description for this format."""
1337
raise NotImplementedError(self.get_format_description)
1339
def get_converter(self, format=None):
1340
"""Return the converter to use to convert bzrdirs needing converts.
1342
This returns a bzrlib.bzrdir.Converter object.
1344
This should return the best upgrader to step this format towards the
1345
current default format. In the case of plugins we can/should provide
1346
some means for them to extend the range of returnable converters.
1348
:param format: Optional format to override the default format of the
1351
raise NotImplementedError(self.get_converter)
1353
def initialize(self, url, possible_transports=None):
1354
"""Create a bzr control dir at this url and return an opened copy.
1356
Subclasses should typically override initialize_on_transport
1357
instead of this method.
1359
return self.initialize_on_transport(get_transport(url,
1360
possible_transports))
1362
1314
def initialize_on_transport(self, transport):
1363
1315
"""Initialize a new bzrdir in the base directory of a Transport."""
1364
# Since we don't have a .bzr directory, inherit the
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
1365
1438
# mode from the root directory
1366
1439
temp_control = lockable_files.LockableFiles(transport,
1367
1440
'', lockable_files.TransportLock)
1368
temp_control._transport.mkdir('.bzr',
1369
# FIXME: RBC 20060121 don't peek under
1371
mode=temp_control._dir_mode)
1372
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
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):
1373
1449
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1374
1450
file_mode = temp_control._file_mode
1375
1451
del temp_control
1376
mutter('created control directory in ' + transport.base)
1377
control = transport.clone('.bzr')
1378
utf8_files = [('README',
1379
"This is a Bazaar-NG control directory.\n"
1380
"Do not change any files in this directory.\n"),
1381
('branch-format', self.get_format_string()),
1452
bzrdir_transport = transport.clone('.bzr')
1453
utf8_files = [('README',
1454
"This is a Bazaar control directory.\n"
1455
"Do not change any files in this directory.\n"
1456
"See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1457
('branch-format', self.as_string()),
1383
1459
# NB: no need to escape relative paths that are url safe.
1384
control_files = lockable_files.LockableFiles(control,
1385
self._lock_file_name, self._lock_class)
1460
control_files = lockable_files.LockableFiles(bzrdir_transport,
1461
self._lock_file_name, self._lock_class)
1386
1462
control_files.create_lock()
1387
1463
control_files.lock_write()
1389
for file, content in utf8_files:
1390
control_files.put_utf8(file, content)
1465
for (filename, content) in utf8_files:
1466
bzrdir_transport.put_bytes(filename, content,
1392
1469
control_files.unlock()
1393
1470
return self.open(transport, _found=True)
1395
def is_supported(self):
1396
"""Is this format supported?
1398
Supported formats must be initializable and openable.
1399
Unsupported formats may not support initialization or committing or
1400
some other features depending on the reason for not being supported.
1404
def same_model(self, target_format):
1405
return (self.repository_format.rich_root_data ==
1406
target_format.rich_root_data)
1409
def known_formats(klass):
1410
"""Return all the known formats.
1412
Concrete formats should override _known_formats.
1414
# There is double indirection here to make sure that control
1415
# formats used by more than one dir format will only be probed
1416
# once. This can otherwise be quite expensive for remote connections.
1418
for format in klass._control_formats:
1419
result.update(format._known_formats())
1423
def _known_formats(klass):
1424
"""Return the known format instances for this control format."""
1425
return set(klass._formats.values())
1427
1472
def open(self, transport, _found=False):
1428
1473
"""Return an instance of this format for the dir transport points at.
1430
1475
_found is a private parameter, do not use it.
1433
found_format = BzrDirFormat.find_format(transport)
1478
found_format = controldir.ControlDirFormat.find_format(transport)
1434
1479
if not isinstance(found_format, self.__class__):
1435
1480
raise AssertionError("%s was asked to open %s, but it seems to need "
1437
1482
% (self, transport, found_format))
1483
# Allow subclasses - use the found format.
1484
self._supply_sub_formats_to(found_format)
1485
return found_format._open(transport)
1438
1486
return self._open(transport)
1440
1488
def _open(self, transport):
1446
1494
raise NotImplementedError(self._open)
1449
def register_format(klass, format):
1450
klass._formats[format.get_format_string()] = format
1453
def register_control_format(klass, format):
1454
"""Register a format that does not use '.bzr' for its control dir.
1456
TODO: This should be pulled up into a 'ControlDirFormat' base class
1457
which BzrDirFormat can inherit from, and renamed to register_format
1458
there. It has been done without that for now for simplicity of
1461
klass._control_formats.append(format)
1464
def register_control_server_format(klass, format):
1465
"""Register a control format for client-server environments.
1467
These formats will be tried before ones registered with
1468
register_control_format. This gives implementations that decide to the
1469
chance to grab it before anything looks at the contents of the format
1472
klass._control_server_formats.append(format)
1475
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1476
def set_default_format(klass, format):
1477
klass._set_default_format(format)
1480
def _set_default_format(klass, format):
1481
"""Set default format (for testing behavior of defaults only)"""
1482
klass._default_format = format
1486
return self.get_format_string().rstrip()
1489
def unregister_format(klass, format):
1490
assert klass._formats[format.get_format_string()] is format
1491
del klass._formats[format.get_format_string()]
1494
def unregister_control_format(klass, format):
1495
klass._control_formats.remove(format)
1498
class BzrDirFormat4(BzrDirFormat):
1499
"""Bzr dir format 4.
1501
This format is a combined format for working tree, branch and repository.
1503
- Format 1 working trees [always]
1504
- Format 4 branches [always]
1505
- Format 4 repositories [always]
1507
This format is deprecated: it indexes texts using a text it which is
1508
removed in format 5; write support for this format has been removed.
1511
_lock_class = lockable_files.TransportLock
1513
def get_format_string(self):
1514
"""See BzrDirFormat.get_format_string()."""
1515
return "Bazaar-NG branch, format 0.0.4\n"
1517
def get_format_description(self):
1518
"""See BzrDirFormat.get_format_description()."""
1519
return "All-in-one format 4"
1521
def get_converter(self, format=None):
1522
"""See BzrDirFormat.get_converter()."""
1523
# there is one and only one upgrade path here.
1524
return ConvertBzrDir4To5()
1526
def initialize_on_transport(self, transport):
1527
"""Format 4 branches cannot be created."""
1528
raise errors.UninitializableFormat(self)
1530
def is_supported(self):
1531
"""Format 4 is not supported.
1533
It is not supported because the model changed from 4 to 5 and the
1534
conversion logic is expensive - so doing it on the fly was not
1539
def _open(self, transport):
1540
"""See BzrDirFormat._open."""
1541
return BzrDir4(transport, self)
1543
def __return_repository_format(self):
1544
"""Circular import protection."""
1545
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1546
return RepositoryFormat4()
1547
repository_format = property(__return_repository_format)
1550
class BzrDirFormat5(BzrDirFormat):
1551
"""Bzr control format 5.
1553
This format is a combined format for working tree, branch and repository.
1555
- Format 2 working trees [always]
1556
- Format 4 branches [always]
1557
- Format 5 repositories [always]
1558
Unhashed stores in the repository.
1561
_lock_class = lockable_files.TransportLock
1563
def get_format_string(self):
1564
"""See BzrDirFormat.get_format_string()."""
1565
return "Bazaar-NG branch, format 5\n"
1567
def get_format_description(self):
1568
"""See BzrDirFormat.get_format_description()."""
1569
return "All-in-one format 5"
1571
def get_converter(self, format=None):
1572
"""See BzrDirFormat.get_converter()."""
1573
# there is one and only one upgrade path here.
1574
return ConvertBzrDir5To6()
1576
def _initialize_for_clone(self, url):
1577
return self.initialize_on_transport(get_transport(url), _cloning=True)
1579
def initialize_on_transport(self, transport, _cloning=False):
1580
"""Format 5 dirs always have working tree, branch and repository.
1582
Except when they are being cloned.
1584
from bzrlib.branch import BzrBranchFormat4
1585
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1586
from bzrlib.workingtree import WorkingTreeFormat2
1587
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1588
RepositoryFormat5().initialize(result, _internal=True)
1590
branch = BzrBranchFormat4().initialize(result)
1592
WorkingTreeFormat2().initialize(result)
1593
except errors.NotLocalUrl:
1594
# Even though we can't access the working tree, we need to
1595
# create its control files.
1596
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1599
def _open(self, transport):
1600
"""See BzrDirFormat._open."""
1601
return BzrDir5(transport, self)
1603
def __return_repository_format(self):
1604
"""Circular import protection."""
1605
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1606
return RepositoryFormat5()
1607
repository_format = property(__return_repository_format)
1610
class BzrDirFormat6(BzrDirFormat):
1611
"""Bzr control format 6.
1613
This format is a combined format for working tree, branch and repository.
1615
- Format 2 working trees [always]
1616
- Format 4 branches [always]
1617
- Format 6 repositories [always]
1620
_lock_class = lockable_files.TransportLock
1622
def get_format_string(self):
1623
"""See BzrDirFormat.get_format_string()."""
1624
return "Bazaar-NG branch, format 6\n"
1626
def get_format_description(self):
1627
"""See BzrDirFormat.get_format_description()."""
1628
return "All-in-one format 6"
1630
def get_converter(self, format=None):
1631
"""See BzrDirFormat.get_converter()."""
1632
# there is one and only one upgrade path here.
1633
return ConvertBzrDir6ToMeta()
1635
def _initialize_for_clone(self, url):
1636
return self.initialize_on_transport(get_transport(url), _cloning=True)
1638
def initialize_on_transport(self, transport, _cloning=False):
1639
"""Format 6 dirs always have working tree, branch and repository.
1641
Except when they are being cloned.
1643
from bzrlib.branch import BzrBranchFormat4
1644
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1645
from bzrlib.workingtree import WorkingTreeFormat2
1646
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1647
RepositoryFormat6().initialize(result, _internal=True)
1649
branch = BzrBranchFormat4().initialize(result)
1651
WorkingTreeFormat2().initialize(result)
1652
except errors.NotLocalUrl:
1653
# Even though we can't access the working tree, we need to
1654
# create its control files.
1655
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1658
def _open(self, transport):
1659
"""See BzrDirFormat._open."""
1660
return BzrDir6(transport, self)
1662
def __return_repository_format(self):
1663
"""Circular import protection."""
1664
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1665
return RepositoryFormat6()
1666
repository_format = property(__return_repository_format)
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)
1669
1522
class BzrDirMetaFormat1(BzrDirFormat):
1724
1687
def _open(self, transport):
1725
1688
"""See BzrDirFormat._open."""
1726
return BzrDirMeta1(transport, self)
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)
1728
1696
def __return_repository_format(self):
1729
1697
"""Circular import protection."""
1730
if getattr(self, '_repository_format', None):
1698
if self._repository_format:
1731
1699
return self._repository_format
1732
from bzrlib.repository import RepositoryFormat
1733
return RepositoryFormat.get_default_format()
1700
from bzrlib.repository import format_registry
1701
return format_registry.get_default()
1735
def __set_repository_format(self, value):
1703
def _set_repository_format(self, value):
1736
1704
"""Allow changing the repository format for metadir formats."""
1737
1705
self._repository_format = value
1739
repository_format = property(__return_repository_format, __set_repository_format)
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
1741
1729
def __get_workingtree_format(self):
1742
1730
if self._workingtree_format is None:
1743
from bzrlib.workingtree import WorkingTreeFormat
1744
self._workingtree_format = WorkingTreeFormat.get_default_format()
1731
from bzrlib.workingtree import (
1732
format_registry as wt_format_registry,
1734
self._workingtree_format = wt_format_registry.get_default()
1745
1735
return self._workingtree_format
1747
1737
def __set_workingtree_format(self, wt_format):
1748
1738
self._workingtree_format = wt_format
1741
return "<%r>" % (self.__class__.__name__,)
1750
1743
workingtree_format = property(__get_workingtree_format,
1751
1744
__set_workingtree_format)
1754
# Register bzr control format
1755
BzrDirFormat.register_control_format(BzrDirFormat)
1757
1747
# Register bzr formats
1758
BzrDirFormat.register_format(BzrDirFormat4())
1759
BzrDirFormat.register_format(BzrDirFormat5())
1760
BzrDirFormat.register_format(BzrDirFormat6())
1761
__default_format = BzrDirMetaFormat1()
1762
BzrDirFormat.register_format(__default_format)
1763
BzrDirFormat._default_format = __default_format
1766
class Converter(object):
1767
"""Converts a disk format object from one format to another."""
1769
def convert(self, to_convert, pb):
1770
"""Perform the conversion of to_convert, giving feedback via pb.
1772
:param to_convert: The disk object to convert.
1773
:param pb: a progress bar to use for progress information.
1776
def step(self, message):
1777
"""Update the pb by a step."""
1779
self.pb.update(message, self.count, self.total)
1782
class ConvertBzrDir4To5(Converter):
1783
"""Converts format 4 bzr dirs to format 5."""
1786
super(ConvertBzrDir4To5, self).__init__()
1787
self.converted_revs = set()
1788
self.absent_revisions = set()
1792
def convert(self, to_convert, pb):
1793
"""See Converter.convert()."""
1794
self.bzrdir = to_convert
1796
self.pb.note('starting upgrade from format 4 to 5')
1797
if isinstance(self.bzrdir.transport, LocalTransport):
1798
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1799
self._convert_to_weaves()
1800
return BzrDir.open(self.bzrdir.root_transport.base)
1802
def _convert_to_weaves(self):
1803
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1806
stat = self.bzrdir.transport.stat('weaves')
1807
if not S_ISDIR(stat.st_mode):
1808
self.bzrdir.transport.delete('weaves')
1809
self.bzrdir.transport.mkdir('weaves')
1810
except errors.NoSuchFile:
1811
self.bzrdir.transport.mkdir('weaves')
1812
# deliberately not a WeaveFile as we want to build it up slowly.
1813
self.inv_weave = Weave('inventory')
1814
# holds in-memory weaves for all files
1815
self.text_weaves = {}
1816
self.bzrdir.transport.delete('branch-format')
1817
self.branch = self.bzrdir.open_branch()
1818
self._convert_working_inv()
1819
rev_history = self.branch.revision_history()
1820
# to_read is a stack holding the revisions we still need to process;
1821
# appending to it adds new highest-priority revisions
1822
self.known_revisions = set(rev_history)
1823
self.to_read = rev_history[-1:]
1825
rev_id = self.to_read.pop()
1826
if (rev_id not in self.revisions
1827
and rev_id not in self.absent_revisions):
1828
self._load_one_rev(rev_id)
1830
to_import = self._make_order()
1831
for i, rev_id in enumerate(to_import):
1832
self.pb.update('converting revision', i, len(to_import))
1833
self._convert_one_rev(rev_id)
1835
self._write_all_weaves()
1836
self._write_all_revs()
1837
self.pb.note('upgraded to weaves:')
1838
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1839
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1840
self.pb.note(' %6d texts', self.text_count)
1841
self._cleanup_spare_files_after_format4()
1842
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1844
def _cleanup_spare_files_after_format4(self):
1845
# FIXME working tree upgrade foo.
1846
for n in 'merged-patches', 'pending-merged-patches':
1848
## assert os.path.getsize(p) == 0
1849
self.bzrdir.transport.delete(n)
1850
except errors.NoSuchFile:
1852
self.bzrdir.transport.delete_tree('inventory-store')
1853
self.bzrdir.transport.delete_tree('text-store')
1855
def _convert_working_inv(self):
1856
inv = xml4.serializer_v4.read_inventory(
1857
self.branch.control_files.get('inventory'))
1858
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1859
# FIXME inventory is a working tree change.
1860
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1862
def _write_all_weaves(self):
1863
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1864
weave_transport = self.bzrdir.transport.clone('weaves')
1865
weaves = WeaveStore(weave_transport, prefixed=False)
1866
transaction = WriteTransaction()
1870
for file_id, file_weave in self.text_weaves.items():
1871
self.pb.update('writing weave', i, len(self.text_weaves))
1872
weaves._put_weave(file_id, file_weave, transaction)
1874
self.pb.update('inventory', 0, 1)
1875
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1876
self.pb.update('inventory', 1, 1)
1880
def _write_all_revs(self):
1881
"""Write all revisions out in new form."""
1882
self.bzrdir.transport.delete_tree('revision-store')
1883
self.bzrdir.transport.mkdir('revision-store')
1884
revision_transport = self.bzrdir.transport.clone('revision-store')
1886
_revision_store = TextRevisionStore(TextStore(revision_transport,
1890
transaction = WriteTransaction()
1891
for i, rev_id in enumerate(self.converted_revs):
1892
self.pb.update('write revision', i, len(self.converted_revs))
1893
_revision_store.add_revision(self.revisions[rev_id], transaction)
1897
def _load_one_rev(self, rev_id):
1898
"""Load a revision object into memory.
1900
Any parents not either loaded or abandoned get queued to be
1902
self.pb.update('loading revision',
1903
len(self.revisions),
1904
len(self.known_revisions))
1905
if not self.branch.repository.has_revision(rev_id):
1907
self.pb.note('revision {%s} not present in branch; '
1908
'will be converted as a ghost',
1910
self.absent_revisions.add(rev_id)
1912
rev = self.branch.repository._revision_store.get_revision(rev_id,
1913
self.branch.repository.get_transaction())
1914
for parent_id in rev.parent_ids:
1915
self.known_revisions.add(parent_id)
1916
self.to_read.append(parent_id)
1917
self.revisions[rev_id] = rev
1919
def _load_old_inventory(self, rev_id):
1920
assert rev_id not in self.converted_revs
1921
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1922
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1923
inv.revision_id = rev_id
1924
rev = self.revisions[rev_id]
1925
if rev.inventory_sha1:
1926
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1927
'inventory sha mismatch for {%s}' % rev_id
1930
def _load_updated_inventory(self, rev_id):
1931
assert rev_id in self.converted_revs
1932
inv_xml = self.inv_weave.get_text(rev_id)
1933
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1936
def _convert_one_rev(self, rev_id):
1937
"""Convert revision and all referenced objects to new format."""
1938
rev = self.revisions[rev_id]
1939
inv = self._load_old_inventory(rev_id)
1940
present_parents = [p for p in rev.parent_ids
1941
if p not in self.absent_revisions]
1942
self._convert_revision_contents(rev, inv, present_parents)
1943
self._store_new_inv(rev, inv, present_parents)
1944
self.converted_revs.add(rev_id)
1946
def _store_new_inv(self, rev, inv, present_parents):
1947
# the XML is now updated with text versions
1949
entries = inv.iter_entries()
1951
for path, ie in entries:
1952
assert getattr(ie, 'revision', None) is not None, \
1953
'no revision on {%s} in {%s}' % \
1954
(file_id, rev.revision_id)
1955
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1956
new_inv_sha1 = sha_string(new_inv_xml)
1957
self.inv_weave.add_lines(rev.revision_id,
1959
new_inv_xml.splitlines(True))
1960
rev.inventory_sha1 = new_inv_sha1
1962
def _convert_revision_contents(self, rev, inv, present_parents):
1963
"""Convert all the files within a revision.
1965
Also upgrade the inventory to refer to the text revision ids."""
1966
rev_id = rev.revision_id
1967
mutter('converting texts of revision {%s}',
1969
parent_invs = map(self._load_updated_inventory, present_parents)
1970
entries = inv.iter_entries()
1972
for path, ie in entries:
1973
self._convert_file_version(rev, ie, parent_invs)
1975
def _convert_file_version(self, rev, ie, parent_invs):
1976
"""Convert one version of one file.
1978
The file needs to be added into the weave if it is a merge
1979
of >=2 parents or if it's changed from its parent.
1981
file_id = ie.file_id
1982
rev_id = rev.revision_id
1983
w = self.text_weaves.get(file_id)
1986
self.text_weaves[file_id] = w
1987
text_changed = False
1988
parent_candiate_entries = ie.parent_candidates(parent_invs)
1989
for old_revision in parent_candiate_entries.keys():
1990
# if this fails, its a ghost ?
1991
assert old_revision in self.converted_revs, \
1992
"Revision {%s} not in converted_revs" % old_revision
1993
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
1994
# XXX: Note that this is unordered - and this is tolerable because
1995
# the previous code was also unordered.
1996
previous_entries = dict((head, parent_candiate_entries[head]) for head
1998
self.snapshot_ie(previous_entries, ie, w, rev_id)
2000
assert getattr(ie, 'revision', None) is not None
2002
def get_parents(self, revision_ids):
2003
for revision_id in revision_ids:
2004
yield self.revisions[revision_id].parent_ids
2006
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2007
# TODO: convert this logic, which is ~= snapshot to
2008
# a call to:. This needs the path figured out. rather than a work_tree
2009
# a v4 revision_tree can be given, or something that looks enough like
2010
# one to give the file content to the entry if it needs it.
2011
# and we need something that looks like a weave store for snapshot to
2013
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2014
if len(previous_revisions) == 1:
2015
previous_ie = previous_revisions.values()[0]
2016
if ie._unchanged(previous_ie):
2017
ie.revision = previous_ie.revision
2020
text = self.branch.repository.weave_store.get(ie.text_id)
2021
file_lines = text.readlines()
2022
assert sha_strings(file_lines) == ie.text_sha1
2023
assert sum(map(len, file_lines)) == ie.text_size
2024
w.add_lines(rev_id, previous_revisions, file_lines)
2025
self.text_count += 1
2027
w.add_lines(rev_id, previous_revisions, [])
2028
ie.revision = rev_id
2030
def _make_order(self):
2031
"""Return a suitable order for importing revisions.
2033
The order must be such that an revision is imported after all
2034
its (present) parents.
2036
todo = set(self.revisions.keys())
2037
done = self.absent_revisions.copy()
2040
# scan through looking for a revision whose parents
2042
for rev_id in sorted(list(todo)):
2043
rev = self.revisions[rev_id]
2044
parent_ids = set(rev.parent_ids)
2045
if parent_ids.issubset(done):
2046
# can take this one now
2047
order.append(rev_id)
2053
class ConvertBzrDir5To6(Converter):
2054
"""Converts format 5 bzr dirs to format 6."""
2056
def convert(self, to_convert, pb):
2057
"""See Converter.convert()."""
2058
self.bzrdir = to_convert
2060
self.pb.note('starting upgrade from format 5 to 6')
2061
self._convert_to_prefixed()
2062
return BzrDir.open(self.bzrdir.root_transport.base)
2064
def _convert_to_prefixed(self):
2065
from bzrlib.store import TransportStore
2066
self.bzrdir.transport.delete('branch-format')
2067
for store_name in ["weaves", "revision-store"]:
2068
self.pb.note("adding prefixes to %s" % store_name)
2069
store_transport = self.bzrdir.transport.clone(store_name)
2070
store = TransportStore(store_transport, prefixed=True)
2071
for urlfilename in store_transport.list_dir('.'):
2072
filename = urlutils.unescape(urlfilename)
2073
if (filename.endswith(".weave") or
2074
filename.endswith(".gz") or
2075
filename.endswith(".sig")):
2076
file_id = os.path.splitext(filename)[0]
2079
prefix_dir = store.hash_prefix(file_id)
2080
# FIXME keep track of the dirs made RBC 20060121
2082
store_transport.move(filename, prefix_dir + '/' + filename)
2083
except errors.NoSuchFile: # catches missing dirs strangely enough
2084
store_transport.mkdir(prefix_dir)
2085
store_transport.move(filename, prefix_dir + '/' + filename)
2086
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2089
class ConvertBzrDir6ToMeta(Converter):
2090
"""Converts format 6 bzr dirs to metadirs."""
2092
def convert(self, to_convert, pb):
2093
"""See Converter.convert()."""
2094
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2095
from bzrlib.branch import BzrBranchFormat5
2096
self.bzrdir = to_convert
2099
self.total = 20 # the steps we know about
2100
self.garbage_inventories = []
2102
self.pb.note('starting upgrade from format 6 to metadir')
2103
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2104
# its faster to move specific files around than to open and use the apis...
2105
# first off, nuke ancestry.weave, it was never used.
2107
self.step('Removing ancestry.weave')
2108
self.bzrdir.transport.delete('ancestry.weave')
2109
except errors.NoSuchFile:
2111
# find out whats there
2112
self.step('Finding branch files')
2113
last_revision = self.bzrdir.open_branch().last_revision()
2114
bzrcontents = self.bzrdir.transport.list_dir('.')
2115
for name in bzrcontents:
2116
if name.startswith('basis-inventory.'):
2117
self.garbage_inventories.append(name)
2118
# create new directories for repository, working tree and branch
2119
self.dir_mode = self.bzrdir._control_files._dir_mode
2120
self.file_mode = self.bzrdir._control_files._file_mode
2121
repository_names = [('inventory.weave', True),
2122
('revision-store', True),
2124
self.step('Upgrading repository ')
2125
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2126
self.make_lock('repository')
2127
# we hard code the formats here because we are converting into
2128
# the meta format. The meta format upgrader can take this to a
2129
# future format within each component.
2130
self.put_format('repository', RepositoryFormat7())
2131
for entry in repository_names:
2132
self.move_entry('repository', entry)
2134
self.step('Upgrading branch ')
2135
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2136
self.make_lock('branch')
2137
self.put_format('branch', BzrBranchFormat5())
2138
branch_files = [('revision-history', True),
2139
('branch-name', True),
2141
for entry in branch_files:
2142
self.move_entry('branch', entry)
2144
checkout_files = [('pending-merges', True),
2145
('inventory', True),
2146
('stat-cache', False)]
2147
# If a mandatory checkout file is not present, the branch does not have
2148
# a functional checkout. Do not create a checkout in the converted
2150
for name, mandatory in checkout_files:
2151
if mandatory and name not in bzrcontents:
2152
has_checkout = False
2156
if not has_checkout:
2157
self.pb.note('No working tree.')
2158
# If some checkout files are there, we may as well get rid of them.
2159
for name, mandatory in checkout_files:
2160
if name in bzrcontents:
2161
self.bzrdir.transport.delete(name)
2163
from bzrlib.workingtree import WorkingTreeFormat3
2164
self.step('Upgrading working tree')
2165
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2166
self.make_lock('checkout')
2168
'checkout', WorkingTreeFormat3())
2169
self.bzrdir.transport.delete_multi(
2170
self.garbage_inventories, self.pb)
2171
for entry in checkout_files:
2172
self.move_entry('checkout', entry)
2173
if last_revision is not None:
2174
self.bzrdir._control_files.put_utf8(
2175
'checkout/last-revision', last_revision)
2176
self.bzrdir._control_files.put_utf8(
2177
'branch-format', BzrDirMetaFormat1().get_format_string())
2178
return BzrDir.open(self.bzrdir.root_transport.base)
2180
def make_lock(self, name):
2181
"""Make a lock for the new control dir name."""
2182
self.step('Make %s lock' % name)
2183
ld = lockdir.LockDir(self.bzrdir.transport,
2185
file_modebits=self.file_mode,
2186
dir_modebits=self.dir_mode)
2189
def move_entry(self, new_dir, entry):
2190
"""Move then entry name into new_dir."""
2192
mandatory = entry[1]
2193
self.step('Moving %s' % name)
2195
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2196
except errors.NoSuchFile:
2200
def put_format(self, dirname, format):
2201
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2204
class ConvertMetaToMeta(Converter):
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):
2205
1782
"""Converts the components of metadirs."""
2207
1784
def __init__(self, target_format):
2250
1838
# TODO: conversions of Branch and Tree should be done by
2251
1839
# InterXFormat lookups
2252
if (isinstance(tree, workingtree.WorkingTree3) and
2253
not isinstance(tree, workingtree_4.WorkingTree4) and
1840
if (isinstance(tree, workingtree_3.WorkingTree3) and
1841
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2254
1842
isinstance(self.target_format.workingtree_format,
2255
workingtree_4.WorkingTreeFormat4)):
1843
workingtree_4.DirStateWorkingTreeFormat)):
2256
1844
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)
2257
1856
return to_convert
2260
# This is not in remote.py because it's small, and needs to be registered.
2261
# Putting it in remote.py creates a circular import problem.
2262
# we can make it a lazy object if the control formats is turned into something
2264
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2265
"""Format representing bzrdirs accessed via a smart server"""
2267
def get_format_description(self):
2268
return 'bzr remote bzrdir'
2271
def probe_transport(klass, transport):
2272
"""Return a RemoteBzrDirFormat object if it looks possible."""
2274
client = transport.get_smart_client()
2275
except (NotImplementedError, AttributeError,
2276
errors.TransportNotPossible):
2277
# no smart server, so not a branch for this format type.
2278
raise errors.NotBranchError(path=transport.base)
2280
# Send a 'hello' request in protocol version one, and decline to
2281
# open it if the server doesn't support our required version (2) so
2282
# that the VFS-based transport will do it.
2283
request = client.get_request()
2284
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2285
server_version = smart_protocol.query_version()
2286
if server_version != 2:
2287
raise errors.NotBranchError(path=transport.base)
2290
def initialize_on_transport(self, transport):
2292
# hand off the request to the smart server
2293
shared_medium = transport.get_shared_medium()
2294
except errors.NoSmartMedium:
2295
# TODO: lookup the local format from a server hint.
2296
local_dir_format = BzrDirMetaFormat1()
2297
return local_dir_format.initialize_on_transport(transport)
2298
client = _SmartClient(shared_medium)
2299
path = client.remote_path_from_transport(transport)
2300
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2302
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2303
return remote.RemoteBzrDir(transport)
2305
def _open(self, transport):
2306
return remote.RemoteBzrDir(transport)
2308
def __eq__(self, other):
2309
if not isinstance(other, RemoteBzrDirFormat):
2311
return self.get_format_description() == other.get_format_description()
2314
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2317
class BzrDirFormatInfo(object):
2319
def __init__(self, native, deprecated, hidden, experimental):
2320
self.deprecated = deprecated
2321
self.native = native
2322
self.hidden = hidden
2323
self.experimental = experimental
2326
class BzrDirFormatRegistry(registry.Registry):
2327
"""Registry of user-selectable BzrDir subformats.
2329
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2330
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2333
def register_metadir(self, key,
2334
repository_format, help, native=True, deprecated=False,
2338
experimental=False):
2339
"""Register a metadir subformat.
2341
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2342
by the Repository format.
2344
:param repository_format: The fully-qualified repository format class
2346
:param branch_format: Fully-qualified branch format class name as
2348
:param tree_format: Fully-qualified tree format class name as
2351
# This should be expanded to support setting WorkingTree and Branch
2352
# formats, once BzrDirMetaFormat1 supports that.
2353
def _load(full_name):
2354
mod_name, factory_name = full_name.rsplit('.', 1)
2356
mod = __import__(mod_name, globals(), locals(),
2358
except ImportError, e:
2359
raise ImportError('failed to load %s: %s' % (full_name, e))
2361
factory = getattr(mod, factory_name)
2362
except AttributeError:
2363
raise AttributeError('no factory %s in module %r'
2368
bd = BzrDirMetaFormat1()
2369
if branch_format is not None:
2370
bd.set_branch_format(_load(branch_format))
2371
if tree_format is not None:
2372
bd.workingtree_format = _load(tree_format)
2373
if repository_format is not None:
2374
bd.repository_format = _load(repository_format)
2376
self.register(key, helper, help, native, deprecated, hidden,
2379
def register(self, key, factory, help, native=True, deprecated=False,
2380
hidden=False, experimental=False):
2381
"""Register a BzrDirFormat factory.
2383
The factory must be a callable that takes one parameter: the key.
2384
It must produce an instance of the BzrDirFormat when called.
2386
This function mainly exists to prevent the info object from being
2389
registry.Registry.register(self, key, factory, help,
2390
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2392
def register_lazy(self, key, module_name, member_name, help, native=True,
2393
deprecated=False, hidden=False, experimental=False):
2394
registry.Registry.register_lazy(self, key, module_name, member_name,
2395
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2397
def set_default(self, key):
2398
"""Set the 'default' key to be a clone of the supplied key.
2400
This method must be called once and only once.
2402
registry.Registry.register(self, 'default', self.get(key),
2403
self.get_help(key), info=self.get_info(key))
2405
def set_default_repository(self, key):
2406
"""Set the FormatRegistry default and Repository default.
2408
This is a transitional method while Repository.set_default_format
2411
if 'default' in self:
2412
self.remove('default')
2413
self.set_default(key)
2414
format = self.get('default')()
2415
assert isinstance(format, BzrDirMetaFormat1)
2417
def make_bzrdir(self, key):
2418
return self.get(key)()
2420
def help_topic(self, topic):
2421
output = textwrap.dedent("""\
2422
These formats can be used for creating branches, working trees, and
2426
default_realkey = None
2427
default_help = self.get_help('default')
2429
for key in self.keys():
2430
if key == 'default':
2432
help = self.get_help(key)
2433
if help == default_help:
2434
default_realkey = key
2436
help_pairs.append((key, help))
2438
def wrapped(key, help, info):
2440
help = '(native) ' + help
2441
return ':%s:\n%s\n\n' % (key,
2442
textwrap.fill(help, initial_indent=' ',
2443
subsequent_indent=' '))
2444
if default_realkey is not None:
2445
output += wrapped(default_realkey, '(default) %s' % default_help,
2446
self.get_info('default'))
2447
deprecated_pairs = []
2448
experimental_pairs = []
2449
for key, help in help_pairs:
2450
info = self.get_info(key)
2453
elif info.deprecated:
2454
deprecated_pairs.append((key, help))
2455
elif info.experimental:
2456
experimental_pairs.append((key, help))
2458
output += wrapped(key, help, info)
2459
if len(experimental_pairs) > 0:
2460
output += "Experimental formats are shown below.\n\n"
2461
for key, help in experimental_pairs:
2462
info = self.get_info(key)
2463
output += wrapped(key, help, info)
2464
if len(deprecated_pairs) > 0:
2465
output += "Deprecated formats are shown below.\n\n"
2466
for key, help in deprecated_pairs:
2467
info = self.get_info(key)
2468
output += wrapped(key, help, info)
2473
format_registry = BzrDirFormatRegistry()
2474
format_registry.register('weave', BzrDirFormat6,
2475
'Pre-0.8 format. Slower than knit and does not'
2476
' support checkouts or shared repositories.',
2478
format_registry.register_metadir('knit',
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)
1897
class RepositoryAcquisitionPolicy(object):
1898
"""Abstract base class for repository acquisition policies.
1900
A repository acquisition policy decides how a BzrDir acquires a repository
1901
for a branch that is being created. The most basic policy decision is
1902
whether to create a new repository or use an existing one.
1904
def __init__(self, stack_on, stack_on_pwd, require_stacking):
1907
:param stack_on: A location to stack on
1908
:param stack_on_pwd: If stack_on is relative, the location it is
1910
:param require_stacking: If True, it is a failure to not stack.
1912
self._stack_on = stack_on
1913
self._stack_on_pwd = stack_on_pwd
1914
self._require_stacking = require_stacking
1916
def configure_branch(self, branch):
1917
"""Apply any configuration data from this policy to the branch.
1919
Default implementation sets repository stacking.
1921
if self._stack_on is None:
1923
if self._stack_on_pwd is None:
1924
stack_on = self._stack_on
1927
stack_on = urlutils.rebase_url(self._stack_on,
1930
except errors.InvalidRebaseURLs:
1931
stack_on = self._get_full_stack_on()
1933
branch.set_stacked_on_url(stack_on)
1934
except (errors.UnstackableBranchFormat,
1935
errors.UnstackableRepositoryFormat):
1936
if self._require_stacking:
1939
def requires_stacking(self):
1940
"""Return True if this policy requires stacking."""
1941
return self._stack_on is not None and self._require_stacking
1943
def _get_full_stack_on(self):
1944
"""Get a fully-qualified URL for the stack_on location."""
1945
if self._stack_on is None:
1947
if self._stack_on_pwd is None:
1948
return self._stack_on
1950
return urlutils.join(self._stack_on_pwd, self._stack_on)
1952
def _add_fallback(self, repository, possible_transports=None):
1953
"""Add a fallback to the supplied repository, if stacking is set."""
1954
stack_on = self._get_full_stack_on()
1955
if stack_on is None:
1958
stacked_dir = BzrDir.open(stack_on,
1959
possible_transports=possible_transports)
1960
except errors.JailBreak:
1961
# We keep the stacking details, but we are in the server code so
1962
# actually stacking is not needed.
1965
stacked_repo = stacked_dir.open_branch().repository
1966
except errors.NotBranchError:
1967
stacked_repo = stacked_dir.open_repository()
1969
repository.add_fallback_repository(stacked_repo)
1970
except errors.UnstackableRepositoryFormat:
1971
if self._require_stacking:
1974
self._require_stacking = True
1976
def acquire_repository(self, make_working_trees=None, shared=False,
1977
possible_transports=None):
1978
"""Acquire a repository for this bzrdir.
1980
Implementations may create a new repository or use a pre-exising
1983
:param make_working_trees: If creating a repository, set
1984
make_working_trees to this value (if non-None)
1985
:param shared: If creating a repository, make it shared if True
1986
:return: A repository, is_new_flag (True if the repository was
1989
raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
1992
class CreateRepository(RepositoryAcquisitionPolicy):
1993
"""A policy of creating a new repository"""
1995
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1996
require_stacking=False):
1999
:param bzrdir: The bzrdir to create the repository on.
2000
:param stack_on: A location to stack on
2001
:param stack_on_pwd: If stack_on is relative, the location it is
2004
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2006
self._bzrdir = bzrdir
2008
def acquire_repository(self, make_working_trees=None, shared=False,
2009
possible_transports=None):
2010
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2012
Creates the desired repository in the bzrdir we already have.
2014
if possible_transports is None:
2015
possible_transports = []
2017
possible_transports = list(possible_transports)
2018
possible_transports.append(self._bzrdir.root_transport)
2019
stack_on = self._get_full_stack_on()
2021
format = self._bzrdir._format
2022
format.require_stacking(stack_on=stack_on,
2023
possible_transports=possible_transports)
2024
if not self._require_stacking:
2025
# We have picked up automatic stacking somewhere.
2026
note(gettext('Using default stacking branch {0} at {1}').format(
2027
self._stack_on, self._stack_on_pwd))
2028
repository = self._bzrdir.create_repository(shared=shared)
2029
self._add_fallback(repository,
2030
possible_transports=possible_transports)
2031
if make_working_trees is not None:
2032
repository.set_make_working_trees(make_working_trees)
2033
return repository, True
2036
class UseExistingRepository(RepositoryAcquisitionPolicy):
2037
"""A policy of reusing an existing repository"""
2039
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
2040
require_stacking=False):
2043
:param repository: The repository to use.
2044
:param stack_on: A location to stack on
2045
:param stack_on_pwd: If stack_on is relative, the location it is
2048
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
2050
self._repository = repository
2052
def acquire_repository(self, make_working_trees=None, shared=False,
2053
possible_transports=None):
2054
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2056
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',
2479
2115
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2480
2116
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2481
branch_format='bzrlib.branch.BzrBranchFormat5',
2482
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2483
format_registry.register_metadir('metaweave',
2484
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2485
'Transitional format in 0.8. Slower than knit.',
2486
branch_format='bzrlib.branch.BzrBranchFormat5',
2487
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2489
format_registry.register_metadir('dirstate',
2490
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2491
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2492
'above when accessed over the network.',
2493
branch_format='bzrlib.branch.BzrBranchFormat5',
2494
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2495
# directly from workingtree_4 triggers a circular import.
2496
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2498
format_registry.register_metadir('dirstate-tags',
2499
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2500
help='New in 0.15: Fast local operations and improved scaling for '
2501
'network operations. Additionally adds support for tags.'
2502
' Incompatible with bzr < 0.15.',
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.',
2503
2134
branch_format='bzrlib.branch.BzrBranchFormat6',
2504
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2506
format_registry.register_metadir('rich-root',
2135
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
register_metadir(controldir.format_registry, 'rich-root',
2507
2139
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2508
help='New in 1.0. Better handling of tree roots. Incompatible with'
2140
help='Variant of dirstate with better handling of tree roots. '
2141
'Introduced in bzr 1.0',
2510
2142
branch_format='bzrlib.branch.BzrBranchFormat6',
2511
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2514
format_registry.register_metadir('dirstate-with-subtree',
2143
tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2515
2147
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2516
help='New in 0.15: Fast local operations and improved scaling for '
2517
'network operations. Additionally adds support for versioning nested '
2518
'bzr branches. Incompatible with bzr < 0.15.',
2519
branch_format='bzrlib.branch.BzrBranchFormat6',
2520
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2523
format_registry.register_metadir('pack-0.92',
2524
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2525
help='New in 0.92: Pack-based format with data compatible with '
2526
'dirstate-tags format repositories. Interoperates with '
2527
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2528
'Previously called knitpack-experimental. '
2529
'For more information, see '
2530
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2531
branch_format='bzrlib.branch.BzrBranchFormat6',
2532
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2535
format_registry.register_metadir('pack-0.92-subtree',
2536
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2537
help='New in 0.92: Pack-based format with data compatible with '
2538
'dirstate-with-subtree format repositories. Interoperates with '
2539
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2540
'Previously called knitpack-experimental. '
2541
'For more information, see '
2542
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2543
branch_format='bzrlib.branch.BzrBranchFormat6',
2544
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2548
format_registry.register_metadir('rich-root-pack',
2549
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2550
help='New in 1.0: Pack-based format with data compatible with '
2551
'rich-root format repositories. Interoperates with '
2552
'bzr repositories before 0.92 but cannot be read by bzr < 1.0. '
2553
'NOTE: This format is experimental. Before using it, please read '
2554
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2555
branch_format='bzrlib.branch.BzrBranchFormat6',
2556
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2560
format_registry.set_default('pack-0.92')
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',
2244
help='Current development format, subtree variant. Can convert data to and '
2245
'from pack-0.92-subtree (and anything compatible with '
2246
'pack-0.92-subtree) format repositories. Repositories and branches in '
2247
'this format can only be read by bzr.dev. Please read '
2248
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2250
branch_format='bzrlib.branch.BzrBranchFormat7',
2251
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2254
alias=False, # Restore to being an alias when an actual development subtree format is added
2255
# This current non-alias status is simply because we did not introduce a
2256
# chk based subtree format.
2258
register_metadir(controldir.format_registry, 'development5-subtree',
2259
'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
2260
help='Development format, subtree variant. Can convert data to and '
2261
'from pack-0.92-subtree (and anything compatible with '
2262
'pack-0.92-subtree) format repositories. Repositories and branches in '
2263
'this format can only be read by bzr.dev. Please read '
2264
'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
2266
branch_format='bzrlib.branch.BzrBranchFormat7',
2267
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2273
register_metadir(controldir.format_registry, 'development-colo',
2274
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2275
help='The 2a format with experimental support for colocated branches.\n',
2276
branch_format='bzrlib.branch.BzrBranchFormat7',
2277
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2279
bzrdir_format=BzrDirMetaFormat1Colo,
2283
# And the development formats above will have aliased one of the following:
2285
# Finally, the current format.
2286
register_metadir(controldir.format_registry, '2a',
2287
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
help='Format for the bzr 2.0 series.\n'
2289
'Uses group-compress storage.\n'
2290
'Provides rich roots which are a one-way transition.\n',
2291
# 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2292
# 'rich roots. Supported by bzr 1.16 and later.',
2293
branch_format='bzrlib.branch.BzrBranchFormat7',
2294
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2298
# The following format should be an alias for the rich root equivalent
2299
# of the default format
2300
register_metadir(controldir.format_registry, 'default-rich-root',
2301
'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2302
branch_format='bzrlib.branch.BzrBranchFormat7',
2303
tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
2308
# The current format that is made on 'bzr init'.
2309
format_name = config.GlobalStack().get('default_format')
2310
controldir.format_registry.set_default(format_name)
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
2314
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
2315
format_registry = controldir.format_registry
added
removed
bzrlib/bzrdir.py
