1187
895
format.require_stacking()
1190
def checkout_metadir(self):
1191
return self.cloning_metadir()
1193
def sprout(self, url, revision_id=None, force_new_repo=False,
1194
recurse='down', possible_transports=None,
1195
accelerator_tree=None, hardlink=False, stacked=False,
1196
source_branch=None, create_tree_if_local=True):
1197
"""Create a copy of this bzrdir prepared for use as a new line of
1200
If url's last component does not exist, it will be created.
1202
Attributes related to the identity of the source branch like
1203
branch nickname will be cleaned, a working tree is created
1204
whether one existed before or not; and a local branch is always
1207
if revision_id is not None, then the clone operation may tune
1208
itself to download less data.
1209
:param accelerator_tree: A tree which can be used for retrieving file
1210
contents more quickly than the revision tree, i.e. a workingtree.
1211
The revision tree will be used for cases where accelerator_tree's
1212
content is different.
1213
:param hardlink: If true, hard-link files from accelerator_tree,
1215
:param stacked: If true, create a stacked branch referring to the
1216
location of this control directory.
1217
:param create_tree_if_local: If true, a working-tree will be created
1218
when working locally.
1220
target_transport = get_transport(url, possible_transports)
1221
target_transport.ensure_base()
1222
cloning_format = self.cloning_metadir(stacked)
1223
# Create/update the result branch
1224
result = cloning_format.initialize_on_transport(target_transport)
1225
# if a stacked branch wasn't requested, we don't create one
1226
# even if the origin was stacked
1227
stacked_branch_url = None
1228
if source_branch is not None:
1230
stacked_branch_url = self.root_transport.base
1231
source_repository = source_branch.repository
1234
source_branch = self.open_branch()
1235
source_repository = source_branch.repository
1237
stacked_branch_url = self.root_transport.base
1238
except errors.NotBranchError:
1239
source_branch = None
1241
source_repository = self.open_repository()
1242
except errors.NoRepositoryPresent:
1243
source_repository = None
1244
repository_policy = result.determine_repository_policy(
1245
force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
result_repo, is_new_repo = repository_policy.acquire_repository()
1247
if is_new_repo and revision_id is not None and not stacked:
1248
fetch_spec = graph.PendingAncestryResult(
1249
[revision_id], source_repository)
1252
if source_repository is not None:
1253
# Fetch while stacked to prevent unstacked fetch from
1255
if fetch_spec is None:
1256
result_repo.fetch(source_repository, revision_id=revision_id)
1258
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1260
if source_branch is None:
1261
# this is for sprouting a bzrdir without a branch; is that
1263
# Not especially, but it's part of the contract.
1264
result_branch = result.create_branch()
1266
result_branch = source_branch.sprout(result,
1267
revision_id=revision_id, repository_policy=repository_policy)
1268
mutter("created new branch %r" % (result_branch,))
1270
# Create/update the result working tree
1271
if (create_tree_if_local and
1272
isinstance(target_transport, local.LocalTransport) and
1273
(result_repo is None or result_repo.make_working_trees())):
1274
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1278
if wt.path2id('') is None:
1280
wt.set_root_id(self.open_workingtree.get_root_id())
1281
except errors.NoWorkingTree:
1287
if recurse == 'down':
1289
basis = wt.basis_tree()
1291
subtrees = basis.iter_references()
1292
elif result_branch is not None:
1293
basis = result_branch.basis_tree()
1295
subtrees = basis.iter_references()
1296
elif source_branch is not None:
1297
basis = source_branch.basis_tree()
1299
subtrees = basis.iter_references()
1304
for path, file_id in subtrees:
1305
target = urlutils.join(url, urlutils.escape(path))
1306
sublocation = source_branch.reference_parent(file_id, path)
1307
sublocation.bzrdir.sprout(target,
1308
basis.get_reference_revision(file_id, path),
1309
force_new_repo=force_new_repo, recurse=recurse,
1312
if basis is not None:
1316
def push_branch(self, source, revision_id=None, overwrite=False,
1317
remember=False, create_prefix=False):
1318
"""Push the source branch into this BzrDir."""
1320
# If we can open a branch, use its direct repository, otherwise see
1321
# if there is a repository without a branch.
1323
br_to = self.open_branch()
1324
except errors.NotBranchError:
1325
# Didn't find a branch, can we find a repository?
1326
repository_to = self.find_repository()
1328
# Found a branch, so we must have found a repository
1329
repository_to = br_to.repository
1331
push_result = PushResult()
1332
push_result.source_branch = source
1334
# We have a repository but no branch, copy the revisions, and then
1336
repository_to.fetch(source.repository, revision_id=revision_id)
1337
br_to = source.clone(self, revision_id=revision_id)
1338
if source.get_push_location() is None or remember:
1339
source.set_push_location(br_to.base)
1340
push_result.stacked_on = None
1341
push_result.branch_push_result = None
1342
push_result.old_revno = None
1343
push_result.old_revid = _mod_revision.NULL_REVISION
1344
push_result.target_branch = br_to
1345
push_result.master_branch = None
1346
push_result.workingtree_updated = False
1348
# We have successfully opened the branch, remember if necessary:
1349
if source.get_push_location() is None or remember:
1350
source.set_push_location(br_to.base)
1352
tree_to = self.open_workingtree()
1353
except errors.NotLocalUrl:
1354
push_result.branch_push_result = source.push(br_to,
1355
overwrite, stop_revision=revision_id)
1356
push_result.workingtree_updated = False
1357
except errors.NoWorkingTree:
1358
push_result.branch_push_result = source.push(br_to,
1359
overwrite, stop_revision=revision_id)
1360
push_result.workingtree_updated = None # Not applicable
1362
tree_to.lock_write()
1364
push_result.branch_push_result = source.push(
1365
tree_to.branch, overwrite, stop_revision=revision_id)
1369
push_result.workingtree_updated = True
1370
push_result.old_revno = push_result.branch_push_result.old_revno
1371
push_result.old_revid = push_result.branch_push_result.old_revid
1372
push_result.target_branch = \
1373
push_result.branch_push_result.target_branch
899
def create(cls, base, format=None, possible_transports=None):
900
"""Create a new BzrDir at the url 'base'.
902
:param format: If supplied, the format of branch to create. If not
903
supplied, the default is used.
904
:param possible_transports: If supplied, a list of transports that
905
can be reused to share a remote connection.
907
if cls is not BzrDir:
908
raise AssertionError("BzrDir.create always creates the"
909
"default format, not one of %r" % cls)
910
t = _mod_transport.get_transport(base, possible_transports)
913
format = controldir.ControlDirFormat.get_default_format()
914
return format.initialize_on_transport(t)
916
def get_branch_transport(self, branch_format, name=None):
917
"""Get the transport for use by branch format in this BzrDir.
919
Note that bzr dirs that do not support format strings will raise
920
IncompatibleFormat if the branch format they are given has
921
a format string, and vice versa.
923
If branch_format is None, the transport is returned with no
924
checking. If it is not None, then the returned transport is
925
guaranteed to point to an existing directory ready for use.
927
raise NotImplementedError(self.get_branch_transport)
929
def get_repository_transport(self, repository_format):
930
"""Get the transport for use by repository format in this BzrDir.
932
Note that bzr dirs that do not support format strings will raise
933
IncompatibleFormat if the repository format they are given has
934
a format string, and vice versa.
936
If repository_format is None, the transport is returned with no
937
checking. If it is not None, then the returned transport is
938
guaranteed to point to an existing directory ready for use.
940
raise NotImplementedError(self.get_repository_transport)
942
def get_workingtree_transport(self, tree_format):
943
"""Get the transport for use by workingtree format in this BzrDir.
945
Note that bzr dirs that do not support format strings will raise
946
IncompatibleFormat if the workingtree format they are given has a
947
format string, and vice versa.
949
If workingtree_format is None, the transport is returned with no
950
checking. If it is not None, then the returned transport is
951
guaranteed to point to an existing directory ready for use.
953
raise NotImplementedError(self.get_workingtree_transport)
1377
956
class BzrDirHooks(hooks.Hooks):
1432
class BzrDirPreSplitOut(BzrDir):
1433
"""A common class for the all-in-one formats."""
1435
def __init__(self, _transport, _format):
1436
"""See BzrDir.__init__."""
1437
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1438
self._control_files = lockable_files.LockableFiles(
1439
self.get_branch_transport(None),
1440
self._format._lock_file_name,
1441
self._format._lock_class)
1443
def break_lock(self):
1444
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1445
raise NotImplementedError(self.break_lock)
1447
def cloning_metadir(self, require_stacking=False):
1448
"""Produce a metadir suitable for cloning with."""
1449
if require_stacking:
1450
return format_registry.make_bzrdir('1.6')
1451
return self._format.__class__()
1453
def clone(self, url, revision_id=None, force_new_repo=False,
1454
preserve_stacking=False):
1455
"""See BzrDir.clone().
1457
force_new_repo has no effect, since this family of formats always
1458
require a new repository.
1459
preserve_stacking has no effect, since no source branch using this
1460
family of formats can be stacked, so there is no stacking to preserve.
1462
self._make_tail(url)
1463
result = self._format._initialize_for_clone(url)
1464
self.open_repository().clone(result, revision_id=revision_id)
1465
from_branch = self.open_branch()
1466
from_branch.clone(result, revision_id=revision_id)
1468
tree = self.open_workingtree()
1469
except errors.NotLocalUrl:
1470
# make a new one, this format always has to have one.
1471
result._init_workingtree()
1476
def create_branch(self, name=None):
1477
"""See BzrDir.create_branch."""
1478
return self._format.get_branch_format().initialize(self, name=name)
1480
def destroy_branch(self, name=None):
1481
"""See BzrDir.destroy_branch."""
1482
raise errors.UnsupportedOperation(self.destroy_branch, self)
1484
def create_repository(self, shared=False):
1485
"""See BzrDir.create_repository."""
1487
raise errors.IncompatibleFormat('shared repository', self._format)
1488
return self.open_repository()
1490
def destroy_repository(self):
1491
"""See BzrDir.destroy_repository."""
1492
raise errors.UnsupportedOperation(self.destroy_repository, self)
1494
def create_workingtree(self, revision_id=None, from_branch=None,
1495
accelerator_tree=None, hardlink=False):
1496
"""See BzrDir.create_workingtree."""
1497
# The workingtree is sometimes created when the bzrdir is created,
1498
# but not when cloning.
1500
# this looks buggy but is not -really-
1501
# because this format creates the workingtree when the bzrdir is
1503
# clone and sprout will have set the revision_id
1504
# and that will have set it for us, its only
1505
# specific uses of create_workingtree in isolation
1506
# that can do wonky stuff here, and that only
1507
# happens for creating checkouts, which cannot be
1508
# done on this format anyway. So - acceptable wart.
1510
warning("can't support hardlinked working trees in %r"
1513
result = self.open_workingtree(recommend_upgrade=False)
1514
except errors.NoSuchFile:
1515
result = self._init_workingtree()
1516
if revision_id is not None:
1517
if revision_id == _mod_revision.NULL_REVISION:
1518
result.set_parent_ids([])
1520
result.set_parent_ids([revision_id])
1523
def _init_workingtree(self):
1524
from bzrlib.workingtree import WorkingTreeFormat2
1526
return WorkingTreeFormat2().initialize(self)
1527
except errors.NotLocalUrl:
1528
# Even though we can't access the working tree, we need to
1529
# create its control files.
1530
return WorkingTreeFormat2()._stub_initialize_on_transport(
1531
self.transport, self._control_files._file_mode)
1533
def destroy_workingtree(self):
1534
"""See BzrDir.destroy_workingtree."""
1535
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1537
def destroy_workingtree_metadata(self):
1538
"""See BzrDir.destroy_workingtree_metadata."""
1539
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1542
def get_branch_transport(self, branch_format, name=None):
1543
"""See BzrDir.get_branch_transport()."""
1544
if name is not None:
1545
raise errors.NoColocatedBranchSupport(self)
1546
if branch_format is None:
1547
return self.transport
1549
branch_format.get_format_string()
1550
except NotImplementedError:
1551
return self.transport
1552
raise errors.IncompatibleFormat(branch_format, self._format)
1554
def get_repository_transport(self, repository_format):
1555
"""See BzrDir.get_repository_transport()."""
1556
if repository_format is None:
1557
return self.transport
1559
repository_format.get_format_string()
1560
except NotImplementedError:
1561
return self.transport
1562
raise errors.IncompatibleFormat(repository_format, self._format)
1564
def get_workingtree_transport(self, workingtree_format):
1565
"""See BzrDir.get_workingtree_transport()."""
1566
if workingtree_format is None:
1567
return self.transport
1569
workingtree_format.get_format_string()
1570
except NotImplementedError:
1571
return self.transport
1572
raise errors.IncompatibleFormat(workingtree_format, self._format)
1574
def needs_format_conversion(self, format=None):
1575
"""See BzrDir.needs_format_conversion()."""
1576
# if the format is not the same as the system default,
1577
# an upgrade is needed.
1579
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
% 'needs_format_conversion(format=None)')
1581
format = BzrDirFormat.get_default_format()
1582
return not isinstance(self._format, format.__class__)
1584
def open_branch(self, name=None, unsupported=False,
1585
ignore_fallbacks=False):
1586
"""See BzrDir.open_branch."""
1587
from bzrlib.branch import BzrBranchFormat4
1588
format = BzrBranchFormat4()
1589
self._check_supported(format, unsupported)
1590
return format.open(self, name, _found=True)
1592
def sprout(self, url, revision_id=None, force_new_repo=False,
1593
possible_transports=None, accelerator_tree=None,
1594
hardlink=False, stacked=False, create_tree_if_local=True,
1595
source_branch=None):
1596
"""See BzrDir.sprout()."""
1597
if source_branch is not None:
1598
my_branch = self.open_branch()
1599
if source_branch.base != my_branch.base:
1600
raise AssertionError(
1601
"source branch %r is not within %r with branch %r" %
1602
(source_branch, self, my_branch))
1604
raise errors.UnstackableBranchFormat(
1605
self._format, self.root_transport.base)
1606
if not create_tree_if_local:
1607
raise errors.MustHaveWorkingTree(
1608
self._format, self.root_transport.base)
1609
from bzrlib.workingtree import WorkingTreeFormat2
1610
self._make_tail(url)
1611
result = self._format._initialize_for_clone(url)
1613
self.open_repository().clone(result, revision_id=revision_id)
1614
except errors.NoRepositoryPresent:
1617
self.open_branch().sprout(result, revision_id=revision_id)
1618
except errors.NotBranchError:
1621
# we always want a working tree
1622
WorkingTreeFormat2().initialize(result,
1623
accelerator_tree=accelerator_tree,
1628
class BzrDir4(BzrDirPreSplitOut):
1629
"""A .bzr version 4 control object.
1631
This is a deprecated format and may be removed after sept 2006.
1634
def create_repository(self, shared=False):
1635
"""See BzrDir.create_repository."""
1636
return self._format.repository_format.initialize(self, shared)
1638
def needs_format_conversion(self, format=None):
1639
"""Format 4 dirs are always in need of conversion."""
1641
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1642
% 'needs_format_conversion(format=None)')
1645
def open_repository(self):
1646
"""See BzrDir.open_repository."""
1647
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1648
return RepositoryFormat4().open(self, _found=True)
1651
class BzrDir5(BzrDirPreSplitOut):
1652
"""A .bzr version 5 control object.
1654
This is a deprecated format and may be removed after sept 2006.
1657
def has_workingtree(self):
1658
"""See BzrDir.has_workingtree."""
1661
def open_repository(self):
1662
"""See BzrDir.open_repository."""
1663
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1664
return RepositoryFormat5().open(self, _found=True)
1666
def open_workingtree(self, _unsupported=False,
1667
recommend_upgrade=True):
1668
"""See BzrDir.create_workingtree."""
1669
from bzrlib.workingtree import WorkingTreeFormat2
1670
wt_format = WorkingTreeFormat2()
1671
# we don't warn here about upgrades; that ought to be handled for the
1673
return wt_format.open(self, _found=True)
1676
class BzrDir6(BzrDirPreSplitOut):
1677
"""A .bzr version 6 control object.
1679
This is a deprecated format and may be removed after sept 2006.
1682
def has_workingtree(self):
1683
"""See BzrDir.has_workingtree."""
1686
def open_repository(self):
1687
"""See BzrDir.open_repository."""
1688
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1689
return RepositoryFormat6().open(self, _found=True)
1691
def open_workingtree(self, _unsupported=False,
1692
recommend_upgrade=True):
1693
"""See BzrDir.create_workingtree."""
1694
# we don't warn here about upgrades; that ought to be handled for the
1696
from bzrlib.workingtree import WorkingTreeFormat2
1697
return WorkingTreeFormat2().open(self, _found=True)
1700
1011
class BzrDirMeta1(BzrDir):
1701
1012
"""A .bzr meta version 1 control object.
2276
def unregister_format(klass, format):
2277
del klass._formats[format.get_format_string()]
2280
def unregister_control_format(klass, format):
2281
klass._control_formats.remove(format)
2284
class BzrDirFormat4(BzrDirFormat):
2285
"""Bzr dir format 4.
2287
This format is a combined format for working tree, branch and repository.
2289
- Format 1 working trees [always]
2290
- Format 4 branches [always]
2291
- Format 4 repositories [always]
2293
This format is deprecated: it indexes texts using a text it which is
2294
removed in format 5; write support for this format has been removed.
2297
_lock_class = lockable_files.TransportLock
2299
def get_format_string(self):
2300
"""See BzrDirFormat.get_format_string()."""
2301
return "Bazaar-NG branch, format 0.0.4\n"
2303
def get_format_description(self):
2304
"""See BzrDirFormat.get_format_description()."""
2305
return "All-in-one format 4"
2307
def get_converter(self, format=None):
2308
"""See BzrDirFormat.get_converter()."""
2309
# there is one and only one upgrade path here.
2310
return ConvertBzrDir4To5()
2312
def initialize_on_transport(self, transport):
2313
"""Format 4 branches cannot be created."""
2314
raise errors.UninitializableFormat(self)
2316
def is_supported(self):
2317
"""Format 4 is not supported.
2319
It is not supported because the model changed from 4 to 5 and the
2320
conversion logic is expensive - so doing it on the fly was not
2325
def network_name(self):
2326
return self.get_format_string()
2328
def _open(self, transport):
2329
"""See BzrDirFormat._open."""
2330
return BzrDir4(transport, self)
2332
def __return_repository_format(self):
2333
"""Circular import protection."""
2334
from bzrlib.repofmt.weaverepo import RepositoryFormat4
2335
return RepositoryFormat4()
2336
repository_format = property(__return_repository_format)
2339
class BzrDirFormatAllInOne(BzrDirFormat):
2340
"""Common class for formats before meta-dirs."""
2342
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2343
create_prefix=False, force_new_repo=False, stacked_on=None,
2344
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2346
"""See BzrDirFormat.initialize_on_transport_ex."""
2347
require_stacking = (stacked_on is not None)
2348
# Format 5 cannot stack, but we've been asked to - actually init
2350
if require_stacking:
2351
format = BzrDirMetaFormat1()
2352
return format.initialize_on_transport_ex(transport,
2353
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2354
force_new_repo=force_new_repo, stacked_on=stacked_on,
2355
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2356
make_working_trees=make_working_trees, shared_repo=shared_repo)
2357
return BzrDirFormat.initialize_on_transport_ex(self, transport,
2358
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2359
force_new_repo=force_new_repo, stacked_on=stacked_on,
2360
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2361
make_working_trees=make_working_trees, shared_repo=shared_repo)
2364
class BzrDirFormat5(BzrDirFormatAllInOne):
2365
"""Bzr control format 5.
2367
This format is a combined format for working tree, branch and repository.
2369
- Format 2 working trees [always]
2370
- Format 4 branches [always]
2371
- Format 5 repositories [always]
2372
Unhashed stores in the repository.
2375
_lock_class = lockable_files.TransportLock
2377
def get_format_string(self):
2378
"""See BzrDirFormat.get_format_string()."""
2379
return "Bazaar-NG branch, format 5\n"
2381
def get_branch_format(self):
2382
from bzrlib import branch
2383
return branch.BzrBranchFormat4()
2385
def get_format_description(self):
2386
"""See BzrDirFormat.get_format_description()."""
2387
return "All-in-one format 5"
2389
def get_converter(self, format=None):
2390
"""See BzrDirFormat.get_converter()."""
2391
# there is one and only one upgrade path here.
2392
return ConvertBzrDir5To6()
2394
def _initialize_for_clone(self, url):
2395
return self.initialize_on_transport(get_transport(url), _cloning=True)
2397
def initialize_on_transport(self, transport, _cloning=False):
2398
"""Format 5 dirs always have working tree, branch and repository.
2400
Except when they are being cloned.
2402
from bzrlib.branch import BzrBranchFormat4
2403
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2404
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2405
RepositoryFormat5().initialize(result, _internal=True)
2407
branch = BzrBranchFormat4().initialize(result)
2408
result._init_workingtree()
2411
def network_name(self):
2412
return self.get_format_string()
2414
def _open(self, transport):
2415
"""See BzrDirFormat._open."""
2416
return BzrDir5(transport, self)
2418
def __return_repository_format(self):
2419
"""Circular import protection."""
2420
from bzrlib.repofmt.weaverepo import RepositoryFormat5
2421
return RepositoryFormat5()
2422
repository_format = property(__return_repository_format)
2425
class BzrDirFormat6(BzrDirFormatAllInOne):
2426
"""Bzr control format 6.
2428
This format is a combined format for working tree, branch and repository.
2430
- Format 2 working trees [always]
2431
- Format 4 branches [always]
2432
- Format 6 repositories [always]
2435
_lock_class = lockable_files.TransportLock
2437
def get_format_string(self):
2438
"""See BzrDirFormat.get_format_string()."""
2439
return "Bazaar-NG branch, format 6\n"
2441
def get_format_description(self):
2442
"""See BzrDirFormat.get_format_description()."""
2443
return "All-in-one format 6"
2445
def get_branch_format(self):
2446
from bzrlib import branch
2447
return branch.BzrBranchFormat4()
2449
def get_converter(self, format=None):
2450
"""See BzrDirFormat.get_converter()."""
2451
# there is one and only one upgrade path here.
2452
return ConvertBzrDir6ToMeta()
2454
def _initialize_for_clone(self, url):
2455
return self.initialize_on_transport(get_transport(url), _cloning=True)
2457
def initialize_on_transport(self, transport, _cloning=False):
2458
"""Format 6 dirs always have working tree, branch and repository.
2460
Except when they are being cloned.
2462
from bzrlib.branch import BzrBranchFormat4
2463
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2464
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2465
RepositoryFormat6().initialize(result, _internal=True)
2467
branch = BzrBranchFormat4().initialize(result)
2468
result._init_workingtree()
2471
def network_name(self):
2472
return self.get_format_string()
2474
def _open(self, transport):
2475
"""See BzrDirFormat._open."""
2476
return BzrDir6(transport, self)
2478
def __return_repository_format(self):
2479
"""Circular import protection."""
2480
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2481
return RepositoryFormat6()
2482
repository_format = property(__return_repository_format)
2485
1492
class BzrDirMetaFormat1(BzrDirFormat):
2486
1493
"""Bzr meta control format 1
2687
1700
__set_workingtree_format)
2690
network_format_registry = registry.FormatRegistry()
2691
"""Registry of formats indexed by their network name.
2693
The network name for a BzrDirFormat is an identifier that can be used when
2694
referring to formats with smart server operations. See
2695
BzrDirFormat.network_name() for more detail.
2699
# Register bzr control format
2700
BzrDirFormat.register_control_format(BzrDirFormat)
2702
1703
# Register bzr formats
2703
BzrDirFormat.register_format(BzrDirFormat4())
2704
BzrDirFormat.register_format(BzrDirFormat5())
2705
BzrDirFormat.register_format(BzrDirFormat6())
2706
__default_format = BzrDirMetaFormat1()
2707
BzrDirFormat.register_format(__default_format)
2708
BzrDirFormat._default_format = __default_format
2711
class Converter(object):
2712
"""Converts a disk format object from one format to another."""
2714
def convert(self, to_convert, pb):
2715
"""Perform the conversion of to_convert, giving feedback via pb.
2717
:param to_convert: The disk object to convert.
2718
:param pb: a progress bar to use for progress information.
2721
def step(self, message):
2722
"""Update the pb by a step."""
2724
self.pb.update(message, self.count, self.total)
2727
class ConvertBzrDir4To5(Converter):
2728
"""Converts format 4 bzr dirs to format 5."""
2731
super(ConvertBzrDir4To5, self).__init__()
2732
self.converted_revs = set()
2733
self.absent_revisions = set()
2737
def convert(self, to_convert, pb):
2738
"""See Converter.convert()."""
2739
self.bzrdir = to_convert
2741
warnings.warn("pb parameter to convert() is deprecated")
2742
self.pb = ui.ui_factory.nested_progress_bar()
2744
ui.ui_factory.note('starting upgrade from format 4 to 5')
2745
if isinstance(self.bzrdir.transport, local.LocalTransport):
2746
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2747
self._convert_to_weaves()
2748
return BzrDir.open(self.bzrdir.user_url)
2752
def _convert_to_weaves(self):
2753
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2756
stat = self.bzrdir.transport.stat('weaves')
2757
if not S_ISDIR(stat.st_mode):
2758
self.bzrdir.transport.delete('weaves')
2759
self.bzrdir.transport.mkdir('weaves')
2760
except errors.NoSuchFile:
2761
self.bzrdir.transport.mkdir('weaves')
2762
# deliberately not a WeaveFile as we want to build it up slowly.
2763
self.inv_weave = Weave('inventory')
2764
# holds in-memory weaves for all files
2765
self.text_weaves = {}
2766
self.bzrdir.transport.delete('branch-format')
2767
self.branch = self.bzrdir.open_branch()
2768
self._convert_working_inv()
2769
rev_history = self.branch.revision_history()
2770
# to_read is a stack holding the revisions we still need to process;
2771
# appending to it adds new highest-priority revisions
2772
self.known_revisions = set(rev_history)
2773
self.to_read = rev_history[-1:]
2775
rev_id = self.to_read.pop()
2776
if (rev_id not in self.revisions
2777
and rev_id not in self.absent_revisions):
2778
self._load_one_rev(rev_id)
2780
to_import = self._make_order()
2781
for i, rev_id in enumerate(to_import):
2782
self.pb.update('converting revision', i, len(to_import))
2783
self._convert_one_rev(rev_id)
2785
self._write_all_weaves()
2786
self._write_all_revs()
2787
ui.ui_factory.note('upgraded to weaves:')
2788
ui.ui_factory.note(' %6d revisions and inventories' % len(self.revisions))
2789
ui.ui_factory.note(' %6d revisions not present' % len(self.absent_revisions))
2790
ui.ui_factory.note(' %6d texts' % self.text_count)
2791
self._cleanup_spare_files_after_format4()
2792
self.branch._transport.put_bytes(
2794
BzrDirFormat5().get_format_string(),
2795
mode=self.bzrdir._get_file_mode())
2797
def _cleanup_spare_files_after_format4(self):
2798
# FIXME working tree upgrade foo.
2799
for n in 'merged-patches', 'pending-merged-patches':
2801
## assert os.path.getsize(p) == 0
2802
self.bzrdir.transport.delete(n)
2803
except errors.NoSuchFile:
2805
self.bzrdir.transport.delete_tree('inventory-store')
2806
self.bzrdir.transport.delete_tree('text-store')
2808
def _convert_working_inv(self):
2809
inv = xml4.serializer_v4.read_inventory(
2810
self.branch._transport.get('inventory'))
2811
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2812
self.branch._transport.put_bytes('inventory', new_inv_xml,
2813
mode=self.bzrdir._get_file_mode())
2815
def _write_all_weaves(self):
2816
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2817
weave_transport = self.bzrdir.transport.clone('weaves')
2818
weaves = WeaveStore(weave_transport, prefixed=False)
2819
transaction = WriteTransaction()
2823
for file_id, file_weave in self.text_weaves.items():
2824
self.pb.update('writing weave', i, len(self.text_weaves))
2825
weaves._put_weave(file_id, file_weave, transaction)
2827
self.pb.update('inventory', 0, 1)
2828
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2829
self.pb.update('inventory', 1, 1)
2833
def _write_all_revs(self):
2834
"""Write all revisions out in new form."""
2835
self.bzrdir.transport.delete_tree('revision-store')
2836
self.bzrdir.transport.mkdir('revision-store')
2837
revision_transport = self.bzrdir.transport.clone('revision-store')
2839
from bzrlib.xml5 import serializer_v5
2840
from bzrlib.repofmt.weaverepo import RevisionTextStore
2841
revision_store = RevisionTextStore(revision_transport,
2842
serializer_v5, False, versionedfile.PrefixMapper(),
2843
lambda:True, lambda:True)
2845
for i, rev_id in enumerate(self.converted_revs):
2846
self.pb.update('write revision', i, len(self.converted_revs))
2847
text = serializer_v5.write_revision_to_string(
2848
self.revisions[rev_id])
2850
revision_store.add_lines(key, None, osutils.split_lines(text))
2854
def _load_one_rev(self, rev_id):
2855
"""Load a revision object into memory.
2857
Any parents not either loaded or abandoned get queued to be
2859
self.pb.update('loading revision',
2860
len(self.revisions),
2861
len(self.known_revisions))
2862
if not self.branch.repository.has_revision(rev_id):
2864
ui.ui_factory.note('revision {%s} not present in branch; '
2865
'will be converted as a ghost' %
2867
self.absent_revisions.add(rev_id)
2869
rev = self.branch.repository.get_revision(rev_id)
2870
for parent_id in rev.parent_ids:
2871
self.known_revisions.add(parent_id)
2872
self.to_read.append(parent_id)
2873
self.revisions[rev_id] = rev
2875
def _load_old_inventory(self, rev_id):
2876
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2877
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2878
inv.revision_id = rev_id
2879
rev = self.revisions[rev_id]
2882
def _load_updated_inventory(self, rev_id):
2883
inv_xml = self.inv_weave.get_text(rev_id)
2884
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2887
def _convert_one_rev(self, rev_id):
2888
"""Convert revision and all referenced objects to new format."""
2889
rev = self.revisions[rev_id]
2890
inv = self._load_old_inventory(rev_id)
2891
present_parents = [p for p in rev.parent_ids
2892
if p not in self.absent_revisions]
2893
self._convert_revision_contents(rev, inv, present_parents)
2894
self._store_new_inv(rev, inv, present_parents)
2895
self.converted_revs.add(rev_id)
2897
def _store_new_inv(self, rev, inv, present_parents):
2898
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2899
new_inv_sha1 = sha_string(new_inv_xml)
2900
self.inv_weave.add_lines(rev.revision_id,
2902
new_inv_xml.splitlines(True))
2903
rev.inventory_sha1 = new_inv_sha1
2905
def _convert_revision_contents(self, rev, inv, present_parents):
2906
"""Convert all the files within a revision.
2908
Also upgrade the inventory to refer to the text revision ids."""
2909
rev_id = rev.revision_id
2910
mutter('converting texts of revision {%s}',
2912
parent_invs = map(self._load_updated_inventory, present_parents)
2913
entries = inv.iter_entries()
2915
for path, ie in entries:
2916
self._convert_file_version(rev, ie, parent_invs)
2918
def _convert_file_version(self, rev, ie, parent_invs):
2919
"""Convert one version of one file.
2921
The file needs to be added into the weave if it is a merge
2922
of >=2 parents or if it's changed from its parent.
2924
file_id = ie.file_id
2925
rev_id = rev.revision_id
2926
w = self.text_weaves.get(file_id)
2929
self.text_weaves[file_id] = w
2930
text_changed = False
2931
parent_candiate_entries = ie.parent_candidates(parent_invs)
2932
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2933
# XXX: Note that this is unordered - and this is tolerable because
2934
# the previous code was also unordered.
2935
previous_entries = dict((head, parent_candiate_entries[head]) for head
2937
self.snapshot_ie(previous_entries, ie, w, rev_id)
2940
def get_parent_map(self, revision_ids):
2941
"""See graph.StackedParentsProvider.get_parent_map"""
2942
return dict((revision_id, self.revisions[revision_id])
2943
for revision_id in revision_ids
2944
if revision_id in self.revisions)
2946
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2947
# TODO: convert this logic, which is ~= snapshot to
2948
# a call to:. This needs the path figured out. rather than a work_tree
2949
# a v4 revision_tree can be given, or something that looks enough like
2950
# one to give the file content to the entry if it needs it.
2951
# and we need something that looks like a weave store for snapshot to
2953
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2954
if len(previous_revisions) == 1:
2955
previous_ie = previous_revisions.values()[0]
2956
if ie._unchanged(previous_ie):
2957
ie.revision = previous_ie.revision
2960
text = self.branch.repository._text_store.get(ie.text_id)
2961
file_lines = text.readlines()
2962
w.add_lines(rev_id, previous_revisions, file_lines)
2963
self.text_count += 1
2965
w.add_lines(rev_id, previous_revisions, [])
2966
ie.revision = rev_id
2968
def _make_order(self):
2969
"""Return a suitable order for importing revisions.
2971
The order must be such that an revision is imported after all
2972
its (present) parents.
2974
todo = set(self.revisions.keys())
2975
done = self.absent_revisions.copy()
2978
# scan through looking for a revision whose parents
2980
for rev_id in sorted(list(todo)):
2981
rev = self.revisions[rev_id]
2982
parent_ids = set(rev.parent_ids)
2983
if parent_ids.issubset(done):
2984
# can take this one now
2985
order.append(rev_id)
2991
class ConvertBzrDir5To6(Converter):
2992
"""Converts format 5 bzr dirs to format 6."""
2994
def convert(self, to_convert, pb):
2995
"""See Converter.convert()."""
2996
self.bzrdir = to_convert
2997
pb = ui.ui_factory.nested_progress_bar()
2999
ui.ui_factory.note('starting upgrade from format 5 to 6')
3000
self._convert_to_prefixed()
3001
return BzrDir.open(self.bzrdir.user_url)
3005
def _convert_to_prefixed(self):
3006
from bzrlib.store import TransportStore
3007
self.bzrdir.transport.delete('branch-format')
3008
for store_name in ["weaves", "revision-store"]:
3009
ui.ui_factory.note("adding prefixes to %s" % store_name)
3010
store_transport = self.bzrdir.transport.clone(store_name)
3011
store = TransportStore(store_transport, prefixed=True)
3012
for urlfilename in store_transport.list_dir('.'):
3013
filename = urlutils.unescape(urlfilename)
3014
if (filename.endswith(".weave") or
3015
filename.endswith(".gz") or
3016
filename.endswith(".sig")):
3017
file_id, suffix = os.path.splitext(filename)
3021
new_name = store._mapper.map((file_id,)) + suffix
3022
# FIXME keep track of the dirs made RBC 20060121
3024
store_transport.move(filename, new_name)
3025
except errors.NoSuchFile: # catches missing dirs strangely enough
3026
store_transport.mkdir(osutils.dirname(new_name))
3027
store_transport.move(filename, new_name)
3028
self.bzrdir.transport.put_bytes(
3030
BzrDirFormat6().get_format_string(),
3031
mode=self.bzrdir._get_file_mode())
3034
class ConvertBzrDir6ToMeta(Converter):
3035
"""Converts format 6 bzr dirs to metadirs."""
3037
def convert(self, to_convert, pb):
3038
"""See Converter.convert()."""
3039
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3040
from bzrlib.branch import BzrBranchFormat5
3041
self.bzrdir = to_convert
3042
self.pb = ui.ui_factory.nested_progress_bar()
3044
self.total = 20 # the steps we know about
3045
self.garbage_inventories = []
3046
self.dir_mode = self.bzrdir._get_dir_mode()
3047
self.file_mode = self.bzrdir._get_file_mode()
3049
ui.ui_factory.note('starting upgrade from format 6 to metadir')
3050
self.bzrdir.transport.put_bytes(
3052
"Converting to format 6",
3053
mode=self.file_mode)
3054
# its faster to move specific files around than to open and use the apis...
3055
# first off, nuke ancestry.weave, it was never used.
3057
self.step('Removing ancestry.weave')
3058
self.bzrdir.transport.delete('ancestry.weave')
3059
except errors.NoSuchFile:
3061
# find out whats there
3062
self.step('Finding branch files')
3063
last_revision = self.bzrdir.open_branch().last_revision()
3064
bzrcontents = self.bzrdir.transport.list_dir('.')
3065
for name in bzrcontents:
3066
if name.startswith('basis-inventory.'):
3067
self.garbage_inventories.append(name)
3068
# create new directories for repository, working tree and branch
3069
repository_names = [('inventory.weave', True),
3070
('revision-store', True),
3072
self.step('Upgrading repository ')
3073
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3074
self.make_lock('repository')
3075
# we hard code the formats here because we are converting into
3076
# the meta format. The meta format upgrader can take this to a
3077
# future format within each component.
3078
self.put_format('repository', RepositoryFormat7())
3079
for entry in repository_names:
3080
self.move_entry('repository', entry)
3082
self.step('Upgrading branch ')
3083
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
3084
self.make_lock('branch')
3085
self.put_format('branch', BzrBranchFormat5())
3086
branch_files = [('revision-history', True),
3087
('branch-name', True),
3089
for entry in branch_files:
3090
self.move_entry('branch', entry)
3092
checkout_files = [('pending-merges', True),
3093
('inventory', True),
3094
('stat-cache', False)]
3095
# If a mandatory checkout file is not present, the branch does not have
3096
# a functional checkout. Do not create a checkout in the converted
3098
for name, mandatory in checkout_files:
3099
if mandatory and name not in bzrcontents:
3100
has_checkout = False
3104
if not has_checkout:
3105
ui.ui_factory.note('No working tree.')
3106
# If some checkout files are there, we may as well get rid of them.
3107
for name, mandatory in checkout_files:
3108
if name in bzrcontents:
3109
self.bzrdir.transport.delete(name)
3111
from bzrlib.workingtree import WorkingTreeFormat3
3112
self.step('Upgrading working tree')
3113
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
3114
self.make_lock('checkout')
3116
'checkout', WorkingTreeFormat3())
3117
self.bzrdir.transport.delete_multi(
3118
self.garbage_inventories, self.pb)
3119
for entry in checkout_files:
3120
self.move_entry('checkout', entry)
3121
if last_revision is not None:
3122
self.bzrdir.transport.put_bytes(
3123
'checkout/last-revision', last_revision)
3124
self.bzrdir.transport.put_bytes(
3126
BzrDirMetaFormat1().get_format_string(),
3127
mode=self.file_mode)
3129
return BzrDir.open(self.bzrdir.user_url)
3131
def make_lock(self, name):
3132
"""Make a lock for the new control dir name."""
3133
self.step('Make %s lock' % name)
3134
ld = lockdir.LockDir(self.bzrdir.transport,
3136
file_modebits=self.file_mode,
3137
dir_modebits=self.dir_mode)
3140
def move_entry(self, new_dir, entry):
3141
"""Move then entry name into new_dir."""
3143
mandatory = entry[1]
3144
self.step('Moving %s' % name)
3146
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
3147
except errors.NoSuchFile:
3151
def put_format(self, dirname, format):
3152
self.bzrdir.transport.put_bytes('%s/format' % dirname,
3153
format.get_format_string(),
3157
class ConvertMetaToMeta(Converter):
1704
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1706
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1709
class ConvertMetaToMeta(controldir.Converter):
3158
1710
"""Converts the components of metadirs."""
3160
1712
def __init__(self, target_format):
3233
1785
return to_convert
3236
# This is not in remote.py because it's relatively small, and needs to be
3237
# registered. Putting it in remote.py creates a circular import problem.
3238
# we can make it a lazy object if the control formats is turned into something
3240
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
"""Format representing bzrdirs accessed via a smart server"""
3244
BzrDirMetaFormat1.__init__(self)
3245
# XXX: It's a bit ugly that the network name is here, because we'd
3246
# like to believe that format objects are stateless or at least
3247
# immutable, However, we do at least avoid mutating the name after
3248
# it's returned. See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
self._network_name = None
3252
return "%s(_network_name=%r)" % (self.__class__.__name__,
3255
def get_format_description(self):
3256
if self._network_name:
3257
real_format = network_format_registry.get(self._network_name)
3258
return 'Remote: ' + real_format.get_format_description()
3259
return 'bzr remote bzrdir'
3261
def get_format_string(self):
3262
raise NotImplementedError(self.get_format_string)
3264
def network_name(self):
3265
if self._network_name:
3266
return self._network_name
3268
raise AssertionError("No network name set.")
3271
def probe_transport(klass, transport):
3272
"""Return a RemoteBzrDirFormat object if it looks possible."""
3274
medium = transport.get_smart_medium()
3275
except (NotImplementedError, AttributeError,
3276
errors.TransportNotPossible, errors.NoSmartMedium,
3277
errors.SmartProtocolError):
3278
# no smart server, so not a branch for this format type.
3279
raise errors.NotBranchError(path=transport.base)
3281
# Decline to open it if the server doesn't support our required
3282
# version (3) so that the VFS-based transport will do it.
3283
if medium.should_probe():
3285
server_version = medium.protocol_version()
3286
except errors.SmartProtocolError:
3287
# Apparently there's no usable smart server there, even though
3288
# the medium supports the smart protocol.
3289
raise errors.NotBranchError(path=transport.base)
3290
if server_version != '2':
3291
raise errors.NotBranchError(path=transport.base)
3294
def initialize_on_transport(self, transport):
3296
# hand off the request to the smart server
3297
client_medium = transport.get_smart_medium()
3298
except errors.NoSmartMedium:
3299
# TODO: lookup the local format from a server hint.
3300
local_dir_format = BzrDirMetaFormat1()
3301
return local_dir_format.initialize_on_transport(transport)
3302
client = _SmartClient(client_medium)
3303
path = client.remote_path_from_transport(transport)
3305
response = client.call('BzrDirFormat.initialize', path)
3306
except errors.ErrorFromSmartServer, err:
3307
remote._translate_error(err, path=path)
3308
if response[0] != 'ok':
3309
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3310
format = RemoteBzrDirFormat()
3311
self._supply_sub_formats_to(format)
3312
return remote.RemoteBzrDir(transport, format)
3314
def parse_NoneTrueFalse(self, arg):
3321
raise AssertionError("invalid arg %r" % arg)
3323
def _serialize_NoneTrueFalse(self, arg):
3330
def _serialize_NoneString(self, arg):
3333
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3334
create_prefix=False, force_new_repo=False, stacked_on=None,
3335
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3338
# hand off the request to the smart server
3339
client_medium = transport.get_smart_medium()
3340
except errors.NoSmartMedium:
3343
# Decline to open it if the server doesn't support our required
3344
# version (3) so that the VFS-based transport will do it.
3345
if client_medium.should_probe():
3347
server_version = client_medium.protocol_version()
3348
if server_version != '2':
3352
except errors.SmartProtocolError:
3353
# Apparently there's no usable smart server there, even though
3354
# the medium supports the smart protocol.
3359
client = _SmartClient(client_medium)
3360
path = client.remote_path_from_transport(transport)
3361
if client_medium._is_remote_before((1, 16)):
3364
# TODO: lookup the local format from a server hint.
3365
local_dir_format = BzrDirMetaFormat1()
3366
self._supply_sub_formats_to(local_dir_format)
3367
return local_dir_format.initialize_on_transport_ex(transport,
3368
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3369
force_new_repo=force_new_repo, stacked_on=stacked_on,
3370
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3371
make_working_trees=make_working_trees, shared_repo=shared_repo,
3373
return self._initialize_on_transport_ex_rpc(client, path, transport,
3374
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3375
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3377
def _initialize_on_transport_ex_rpc(self, client, path, transport,
3378
use_existing_dir, create_prefix, force_new_repo, stacked_on,
3379
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3381
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3382
args.append(self._serialize_NoneTrueFalse(create_prefix))
3383
args.append(self._serialize_NoneTrueFalse(force_new_repo))
3384
args.append(self._serialize_NoneString(stacked_on))
3385
# stack_on_pwd is often/usually our transport
3388
stack_on_pwd = transport.relpath(stack_on_pwd)
3389
if not stack_on_pwd:
3391
except errors.PathNotChild:
3393
args.append(self._serialize_NoneString(stack_on_pwd))
3394
args.append(self._serialize_NoneString(repo_format_name))
3395
args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
request_network_name = self._network_name or \
3398
BzrDirFormat.get_default_format().network_name()
3400
response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
request_network_name, path, *args)
3402
except errors.UnknownSmartMethod:
3403
client._medium._remember_remote_is_before((1,16))
3404
local_dir_format = BzrDirMetaFormat1()
3405
self._supply_sub_formats_to(local_dir_format)
3406
return local_dir_format.initialize_on_transport_ex(transport,
3407
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3408
force_new_repo=force_new_repo, stacked_on=stacked_on,
3409
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3410
make_working_trees=make_working_trees, shared_repo=shared_repo,
3412
except errors.ErrorFromSmartServer, err:
3413
remote._translate_error(err, path=path)
3414
repo_path = response[0]
3415
bzrdir_name = response[6]
3416
require_stacking = response[7]
3417
require_stacking = self.parse_NoneTrueFalse(require_stacking)
3418
format = RemoteBzrDirFormat()
3419
format._network_name = bzrdir_name
3420
self._supply_sub_formats_to(format)
3421
bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3423
repo_format = remote.response_tuple_to_repo_format(response[1:])
3424
if repo_path == '.':
3427
repo_bzrdir_format = RemoteBzrDirFormat()
3428
repo_bzrdir_format._network_name = response[5]
3429
repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3433
final_stack = response[8] or None
3434
final_stack_pwd = response[9] or None
3436
final_stack_pwd = urlutils.join(
3437
transport.base, final_stack_pwd)
3438
remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3439
if len(response) > 10:
3440
# Updated server verb that locks remotely.
3441
repo_lock_token = response[10] or None
3442
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3444
remote_repo.dont_leave_lock_in_place()
3446
remote_repo.lock_write()
3447
policy = UseExistingRepository(remote_repo, final_stack,
3448
final_stack_pwd, require_stacking)
3449
policy.acquire_repository()
3453
bzrdir._format.set_branch_format(self.get_branch_format())
3454
if require_stacking:
3455
# The repo has already been created, but we need to make sure that
3456
# we'll make a stackable branch.
3457
bzrdir._format.require_stacking(_skip_repo=True)
3458
return remote_repo, bzrdir, require_stacking, policy
3460
def _open(self, transport):
3461
return remote.RemoteBzrDir(transport, self)
3463
def __eq__(self, other):
3464
if not isinstance(other, RemoteBzrDirFormat):
3466
return self.get_format_description() == other.get_format_description()
3468
def __return_repository_format(self):
3469
# Always return a RemoteRepositoryFormat object, but if a specific bzr
3470
# repository format has been asked for, tell the RemoteRepositoryFormat
3471
# that it should use that for init() etc.
3472
result = remote.RemoteRepositoryFormat()
3473
custom_format = getattr(self, '_repository_format', None)
3475
if isinstance(custom_format, remote.RemoteRepositoryFormat):
3476
return custom_format
3478
# We will use the custom format to create repositories over the
3479
# wire; expose its details like rich_root_data for code to
3481
result._custom_format = custom_format
3484
def get_branch_format(self):
3485
result = BzrDirMetaFormat1.get_branch_format(self)
3486
if not isinstance(result, remote.RemoteBranchFormat):
3487
new_result = remote.RemoteBranchFormat()
3488
new_result._custom_format = result
3490
self.set_branch_format(new_result)
3494
repository_format = property(__return_repository_format,
3495
BzrDirMetaFormat1._set_repository_format) #.im_func)
3498
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3501
class BzrDirFormatInfo(object):
3503
def __init__(self, native, deprecated, hidden, experimental):
3504
self.deprecated = deprecated
3505
self.native = native
3506
self.hidden = hidden
3507
self.experimental = experimental
3510
class BzrDirFormatRegistry(registry.Registry):
3511
"""Registry of user-selectable BzrDir subformats.
3513
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
3518
"""Create a BzrDirFormatRegistry."""
3519
self._aliases = set()
3520
self._registration_order = list()
3521
super(BzrDirFormatRegistry, self).__init__()
3524
"""Return a set of the format names which are aliases."""
3525
return frozenset(self._aliases)
3527
def register_metadir(self, key,
3528
repository_format, help, native=True, deprecated=False,
3534
"""Register a metadir subformat.
3536
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
by the Repository/Branch/WorkingTreeformats.
3539
:param repository_format: The fully-qualified repository format class
3541
:param branch_format: Fully-qualified branch format class name as
3543
:param tree_format: Fully-qualified tree format class name as
3546
# This should be expanded to support setting WorkingTree and Branch
3547
# formats, once BzrDirMetaFormat1 supports that.
3548
def _load(full_name):
3549
mod_name, factory_name = full_name.rsplit('.', 1)
3551
mod = __import__(mod_name, globals(), locals(),
3553
except ImportError, e:
3554
raise ImportError('failed to load %s: %s' % (full_name, e))
3556
factory = getattr(mod, factory_name)
3557
except AttributeError:
3558
raise AttributeError('no factory %s in module %r'
3563
bd = BzrDirMetaFormat1()
3564
if branch_format is not None:
3565
bd.set_branch_format(_load(branch_format))
3566
if tree_format is not None:
3567
bd.workingtree_format = _load(tree_format)
3568
if repository_format is not None:
3569
bd.repository_format = _load(repository_format)
3571
self.register(key, helper, help, native, deprecated, hidden,
3572
experimental, alias)
3574
def register(self, key, factory, help, native=True, deprecated=False,
3575
hidden=False, experimental=False, alias=False):
3576
"""Register a BzrDirFormat factory.
3578
The factory must be a callable that takes one parameter: the key.
3579
It must produce an instance of the BzrDirFormat when called.
3581
This function mainly exists to prevent the info object from being
3584
registry.Registry.register(self, key, factory, help,
3585
BzrDirFormatInfo(native, deprecated, hidden, experimental))
3587
self._aliases.add(key)
3588
self._registration_order.append(key)
3590
def register_lazy(self, key, module_name, member_name, help, native=True,
3591
deprecated=False, hidden=False, experimental=False, alias=False):
3592
registry.Registry.register_lazy(self, key, module_name, member_name,
3593
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3595
self._aliases.add(key)
3596
self._registration_order.append(key)
3598
def set_default(self, key):
3599
"""Set the 'default' key to be a clone of the supplied key.
3601
This method must be called once and only once.
3603
registry.Registry.register(self, 'default', self.get(key),
3604
self.get_help(key), info=self.get_info(key))
3605
self._aliases.add('default')
3607
def set_default_repository(self, key):
3608
"""Set the FormatRegistry default and Repository default.
3610
This is a transitional method while Repository.set_default_format
3613
if 'default' in self:
3614
self.remove('default')
3615
self.set_default(key)
3616
format = self.get('default')()
3618
def make_bzrdir(self, key):
3619
return self.get(key)()
3621
def help_topic(self, topic):
3623
default_realkey = None
3624
default_help = self.get_help('default')
3626
for key in self._registration_order:
3627
if key == 'default':
3629
help = self.get_help(key)
3630
if help == default_help:
3631
default_realkey = key
3633
help_pairs.append((key, help))
3635
def wrapped(key, help, info):
3637
help = '(native) ' + help
3638
return ':%s:\n%s\n\n' % (key,
3639
textwrap.fill(help, initial_indent=' ',
3640
subsequent_indent=' ',
3641
break_long_words=False))
3642
if default_realkey is not None:
3643
output += wrapped(default_realkey, '(default) %s' % default_help,
3644
self.get_info('default'))
3645
deprecated_pairs = []
3646
experimental_pairs = []
3647
for key, help in help_pairs:
3648
info = self.get_info(key)
3651
elif info.deprecated:
3652
deprecated_pairs.append((key, help))
3653
elif info.experimental:
3654
experimental_pairs.append((key, help))
3656
output += wrapped(key, help, info)
3657
output += "\nSee :doc:`formats-help` for more about storage formats."
3659
if len(experimental_pairs) > 0:
3660
other_output += "Experimental formats are shown below.\n\n"
3661
for key, help in experimental_pairs:
3662
info = self.get_info(key)
3663
other_output += wrapped(key, help, info)
3666
"No experimental formats are available.\n\n"
3667
if len(deprecated_pairs) > 0:
3668
other_output += "\nDeprecated formats are shown below.\n\n"
3669
for key, help in deprecated_pairs:
3670
info = self.get_info(key)
3671
other_output += wrapped(key, help, info)
3674
"\nNo deprecated formats are available.\n\n"
3676
"\nSee :doc:`formats-help` for more about storage formats."
3678
if topic == 'other-formats':
1788
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3684
1791
class RepositoryAcquisitionPolicy(object):
added
removed
bzrlib/bzrdir.py
