1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
91
class ControlComponent(object):
92
"""Abstract base class for control directory components.
94
This provides interfaces that are common across bzrdirs,
95
repositories, branches, and workingtree control directories.
97
They all expose two urls and transports: the *user* URL is the
98
one that stops above the control directory (eg .bzr) and that
99
should normally be used in messages, and the *control* URL is
100
under that in eg .bzr/checkout and is used to read the control
103
This can be used as a mixin and is intended to fit with
108
def control_transport(self):
109
raise NotImplementedError
112
def control_url(self):
113
return self.control_transport.base
116
def user_transport(self):
117
raise NotImplementedError
121
return self.user_transport.base
124
class BzrDir(ControlComponent):
125
91
"""A .bzr control diretory.
127
93
BzrDir instances let you create or open any of the things that can be
294
260
# copied, and finally if we are copying up to a specific
295
261
# revision_id then we can use the pending-ancestry-result which
296
262
# does not require traversing all of history to describe it.
297
if (result_repo.user_url == result.user_url
298
and not require_stacking and
263
if (result_repo.bzrdir.root_transport.base ==
264
result.root_transport.base and not require_stacking and
299
265
revision_id is not None):
300
266
fetch_spec = graph.PendingAncestryResult(
301
267
[revision_id], local_repo)
388
354
for subdir in sorted(subdirs, reverse=True):
389
355
pending.append(current_transport.clone(subdir))
391
def list_branches(self):
392
"""Return a sequence of all branches local to this control directory.
396
return [self.open_branch()]
397
except errors.NotBranchError:
401
358
def find_branches(transport):
402
359
"""Find all branches under a transport.
414
371
except errors.NoRepositoryPresent:
417
return False, ([], repository)
418
return True, (bzrdir.list_branches(), None)
420
for branches, repo in BzrDir.find_bzrdirs(transport,
374
return False, (None, repository)
376
branch = bzrdir.open_branch()
377
except errors.NotBranchError:
378
return True, (None, None)
380
return True, (branch, None)
382
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
383
if repo is not None:
423
ret.extend(repo.find_branches())
424
if branches is not None:
384
branches.extend(repo.find_branches())
385
if branch is not None:
386
branches.append(branch)
428
389
def destroy_repository(self):
429
390
"""Destroy the repository in this BzrDir"""
430
391
raise NotImplementedError(self.destroy_repository)
432
def create_branch(self, name=None):
393
def create_branch(self):
433
394
"""Create a branch in this BzrDir.
435
:param name: Name of the colocated branch to create, None for
438
396
The bzrdir's format will control what branch format is created.
439
397
For more control see BranchFormatXX.create(a_bzrdir).
441
399
raise NotImplementedError(self.create_branch)
443
def destroy_branch(self, name=None):
444
"""Destroy a branch in this BzrDir.
446
:param name: Name of the branch to destroy, None for the default
401
def destroy_branch(self):
402
"""Destroy the branch in this BzrDir"""
449
403
raise NotImplementedError(self.destroy_branch)
499
453
except errors.NoRepositoryPresent:
500
454
repository = None
502
if (found_bzrdir.user_url != self.user_url
503
and not repository.is_shared()):
456
if ((found_bzrdir.root_transport.base !=
457
self.root_transport.base) and not repository.is_shared()):
504
458
# Don't look higher, can't use a higher shared repo.
505
459
repository = None
621
575
:return: Tuple with old path name and new path name
623
def name_gen(base='backup.bzr'):
625
name = "%s.~%d~" % (base, counter)
626
while self.root_transport.has(name):
628
name = "%s.~%d~" % (base, counter)
631
backup_dir=name_gen()
632
577
pb = ui.ui_factory.nested_progress_bar()
634
579
# FIXME: bug 300001 -- the backup fails if the backup directory
635
580
# already exists, but it should instead either remove it or make
636
581
# a new backup directory.
583
# FIXME: bug 262450 -- the backup directory should have the same
584
# permissions as the .bzr directory (probably a bug in copy_tree)
638
585
old_path = self.root_transport.abspath('.bzr')
639
new_path = self.root_transport.abspath(backup_dir)
586
new_path = self.root_transport.abspath('backup.bzr')
640
587
ui.ui_factory.note('making backup of %s\n to %s' % (old_path, new_path,))
641
self.root_transport.copy_tree('.bzr', backup_dir)
588
self.root_transport.copy_tree('.bzr', 'backup.bzr')
642
589
return (old_path, new_path)
704
651
next_transport = found_bzrdir.root_transport.clone('..')
705
if (found_bzrdir.user_url == next_transport.base):
652
if (found_bzrdir.root_transport.base == next_transport.base):
706
653
# top of the file system
708
655
# find the next containing bzrdir
725
672
repository = found_bzrdir.open_repository()
726
673
except errors.NoRepositoryPresent:
727
674
return None, False
728
if found_bzrdir.user_url == self.user_url:
675
if found_bzrdir.root_transport.base == self.root_transport.base:
729
676
return repository, True
730
677
elif repository.is_shared():
731
678
return repository, True
749
def get_branch_transport(self, branch_format, name=None):
696
def get_branch_transport(self, branch_format):
750
697
"""Get the transport for use by branch format in this BzrDir.
752
699
Note that bzr dirs that do not support format strings will raise
847
794
:param _transport: the transport this dir is based at.
849
796
self._format = _format
850
# these are also under the more standard names of
851
# control_transport and user_transport
852
797
self.transport = _transport.clone('.bzr')
853
798
self.root_transport = _transport
854
799
self._mode_check_done = False
857
def user_transport(self):
858
return self.root_transport
861
def control_transport(self):
862
return self.transport
864
801
def is_control_filename(self, filename):
865
802
"""True if filename is the name of a path which is reserved for bzrdir's.
940
877
BzrDir._check_supported(format, _unsupported)
941
878
return format.open(transport, _found=True)
943
def open_branch(self, name=None, unsupported=False,
944
ignore_fallbacks=False):
880
def open_branch(self, unsupported=False, ignore_fallbacks=False):
945
881
"""Open the branch object at this BzrDir if one is present.
947
883
If unsupported is True, then no longer supported branch formats can
1086
1022
raise NotImplementedError(self.open_workingtree)
1088
def has_branch(self, name=None):
1024
def has_branch(self):
1089
1025
"""Tell if this bzrdir contains a branch.
1091
1027
Note: if you're going to open the branch, you should just go ahead
1373
1309
self.create_hook(hooks.HookPoint('pre_open',
1374
1310
"Invoked before attempting to open a BzrDir with the transport "
1375
1311
"that the open will use.", (1, 14), None))
1376
self.create_hook(hooks.HookPoint('post_repo_init',
1377
"Invoked after a repository has been initialized. "
1378
"post_repo_init is called with a "
1379
"bzrlib.bzrdir.RepoInitHookParams.",
1382
1313
# install the default hooks
1383
1314
BzrDir.hooks = BzrDirHooks()
1386
class RepoInitHookParams(object):
1387
"""Object holding parameters passed to *_repo_init hooks.
1389
There are 4 fields that hooks may wish to access:
1391
:ivar repository: Repository created
1392
:ivar format: Repository format
1393
:ivar bzrdir: The bzrdir for the repository
1394
:ivar shared: The repository is shared
1397
def __init__(self, repository, format, a_bzrdir, shared):
1398
"""Create a group of RepoInitHook parameters.
1400
:param repository: Repository created
1401
:param format: Repository format
1402
:param bzrdir: The bzrdir for the repository
1403
:param shared: The repository is shared
1405
self.repository = repository
1406
self.format = format
1407
self.bzrdir = a_bzrdir
1408
self.shared = shared
1410
def __eq__(self, other):
1411
return self.__dict__ == other.__dict__
1415
return "<%s for %s>" % (self.__class__.__name__,
1418
return "<%s for %s>" % (self.__class__.__name__,
1422
1317
class BzrDirPreSplitOut(BzrDir):
1423
1318
"""A common class for the all-in-one formats."""
1463
1358
tree.clone(result)
1466
def create_branch(self, name=None):
1361
def create_branch(self):
1467
1362
"""See BzrDir.create_branch."""
1468
return self._format.get_branch_format().initialize(self, name=name)
1363
return self._format.get_branch_format().initialize(self)
1470
def destroy_branch(self, name=None):
1365
def destroy_branch(self):
1471
1366
"""See BzrDir.destroy_branch."""
1472
1367
raise errors.UnsupportedOperation(self.destroy_branch, self)
1529
1424
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1532
def get_branch_transport(self, branch_format, name=None):
1427
def get_branch_transport(self, branch_format):
1533
1428
"""See BzrDir.get_branch_transport()."""
1534
if name is not None:
1535
raise errors.NoColocatedBranchSupport(self)
1536
1429
if branch_format is None:
1537
1430
return self.transport
1571
1464
format = BzrDirFormat.get_default_format()
1572
1465
return not isinstance(self._format, format.__class__)
1574
def open_branch(self, name=None, unsupported=False,
1575
ignore_fallbacks=False):
1467
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1576
1468
"""See BzrDir.open_branch."""
1577
1469
from bzrlib.branch import BzrBranchFormat4
1578
1470
format = BzrBranchFormat4()
1579
1471
self._check_supported(format, unsupported)
1580
return format.open(self, name, _found=True)
1472
return format.open(self, _found=True)
1582
1474
def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1475
possible_transports=None, accelerator_tree=None,
1700
1592
"""See BzrDir.can_convert_format()."""
1703
def create_branch(self, name=None):
1595
def create_branch(self):
1704
1596
"""See BzrDir.create_branch."""
1705
return self._format.get_branch_format().initialize(self, name=name)
1597
return self._format.get_branch_format().initialize(self)
1707
def destroy_branch(self, name=None):
1599
def destroy_branch(self):
1708
1600
"""See BzrDir.create_branch."""
1709
if name is not None:
1710
raise errors.NoColocatedBranchSupport(self)
1711
1601
self.transport.delete_tree('branch')
1713
1603
def create_repository(self, shared=False):
1756
1646
format = BranchFormat.find_format(self)
1757
1647
return format.get_reference(self)
1759
def get_branch_transport(self, branch_format, name=None):
1649
def get_branch_transport(self, branch_format):
1760
1650
"""See BzrDir.get_branch_transport()."""
1761
if name is not None:
1762
raise errors.NoColocatedBranchSupport(self)
1763
1651
# XXX: this shouldn't implicitly create the directory if it's just
1764
1652
# promising to get a transport -- mbp 20090727
1765
1653
if branch_format is None:
1837
1725
except errors.NoRepositoryPresent:
1839
for branch in self.list_branches():
1840
if not isinstance(branch._format,
1728
if not isinstance(self.open_branch()._format,
1841
1729
format.get_branch_format().__class__):
1842
1730
# the branch needs an upgrade.
1732
except errors.NotBranchError:
1845
1735
my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1736
if not isinstance(my_wt._format,
1854
def open_branch(self, name=None, unsupported=False,
1855
ignore_fallbacks=False):
1744
def open_branch(self, unsupported=False, ignore_fallbacks=False):
1856
1745
"""See BzrDir.open_branch."""
1857
1746
format = self.find_branch_format()
1858
1747
self._check_supported(format, unsupported)
1859
return format.open(self, name=name,
1860
_found=True, ignore_fallbacks=ignore_fallbacks)
1748
return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1862
1750
def open_repository(self, unsupported=False):
1863
1751
"""See BzrDir.open_repository."""
1895
1783
Once a format is deprecated, just deprecate the initialize and open
1896
1784
methods on the format class. Do not deprecate the object, as the
1897
1785
object will be created every system load.
1899
:cvar colocated_branches: Whether this formats supports colocated branches.
1902
1788
_default_format = None
1920
1806
_lock_file_name = 'branch-lock'
1922
colocated_branches = False
1923
"""Whether co-located branches are supported for this control dir format.
1926
1808
# _lock_class must be set in subclasses to the lock type, typ.
1927
1809
# TransportLock or LockDir
2727
2609
def convert(self, to_convert, pb):
2728
2610
"""See Converter.convert()."""
2729
2611
self.bzrdir = to_convert
2731
warnings.warn("pb parameter to convert() is deprecated")
2732
self.pb = ui.ui_factory.nested_progress_bar()
2734
ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
self._convert_to_weaves()
2738
return BzrDir.open(self.bzrdir.user_url)
2613
ui.ui_factory.note('starting upgrade from format 4 to 5')
2614
if isinstance(self.bzrdir.transport, local.LocalTransport):
2615
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2616
self._convert_to_weaves()
2617
return BzrDir.open(self.bzrdir.root_transport.base)
2742
2619
def _convert_to_weaves(self):
2743
2620
ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2984
2861
def convert(self, to_convert, pb):
2985
2862
"""See Converter.convert()."""
2986
2863
self.bzrdir = to_convert
2987
pb = ui.ui_factory.nested_progress_bar()
2989
ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
self._convert_to_prefixed()
2991
return BzrDir.open(self.bzrdir.user_url)
2865
ui.ui_factory.note('starting upgrade from format 5 to 6')
2866
self._convert_to_prefixed()
2867
return BzrDir.open(self.bzrdir.root_transport.base)
2995
2869
def _convert_to_prefixed(self):
2996
2870
from bzrlib.store import TransportStore
3029
2903
from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2904
from bzrlib.branch import BzrBranchFormat5
3031
2905
self.bzrdir = to_convert
3032
self.pb = ui.ui_factory.nested_progress_bar()
3034
2908
self.total = 20 # the steps we know about
3035
2909
self.garbage_inventories = []
3115
2989
'branch-format',
3116
2990
BzrDirMetaFormat1().get_format_string(),
3117
2991
mode=self.file_mode)
3119
return BzrDir.open(self.bzrdir.user_url)
2992
return BzrDir.open(self.bzrdir.root_transport.base)
3121
2994
def make_lock(self, name):
3122
2995
"""Make a lock for the new control dir name."""
3157
3030
def convert(self, to_convert, pb):
3158
3031
"""See Converter.convert()."""
3159
3032
self.bzrdir = to_convert
3160
self.pb = ui.ui_factory.nested_progress_bar()
3163
3036
self.step('checking repository format')
3171
3044
ui.ui_factory.note('starting repository conversion')
3172
3045
converter = CopyConverter(self.target_format.repository_format)
3173
3046
converter.convert(repo, pb)
3174
for branch in self.bzrdir.list_branches():
3048
branch = self.bzrdir.open_branch()
3049
except errors.NotBranchError:
3175
3052
# TODO: conversions of Branch and Tree should be done by
3176
3053
# InterXFormat lookups/some sort of registry.
3177
3054
# Avoid circular imports
3704
3580
stack_on = urlutils.rebase_url(self._stack_on,
3705
3581
self._stack_on_pwd,
3582
branch.bzrdir.root_transport.base)
3707
3583
except errors.InvalidRebaseURLs:
3708
3584
stack_on = self._get_full_stack_on()
added
removed
bzrlib/bzrdir.py
