~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Pool
  • Date: 2010-02-25 06:17:27 UTC
  • mfrom: (5055 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5057.
  • Revision ID: mbp@sourcefrog.net-20100225061727-4sd9lt0qmdc6087t
merge news

Show diffs side-by-side

added added

removed removed

Lines of Context:
86
86
    registry,
87
87
    symbol_versioning,
88
88
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
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
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
89
 
 
90
 
 
91
class BzrDir(object):
125
92
    """A .bzr control diretory.
126
93
 
127
94
    BzrDir instances let you create or open any of the things that can be
294
261
                # copied, and finally if we are copying up to a specific
295
262
                # revision_id then we can use the pending-ancestry-result which
296
263
                # 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
 
264
                if (result_repo.bzrdir.root_transport.base ==
 
265
                    result.root_transport.base and not require_stacking and
299
266
                    revision_id is not None):
300
267
                    fetch_spec = graph.PendingAncestryResult(
301
268
                        [revision_id], local_repo)
429
396
        """Destroy the repository in this BzrDir"""
430
397
        raise NotImplementedError(self.destroy_repository)
431
398
 
432
 
    def create_branch(self, name=None):
 
399
    def create_branch(self):
433
400
        """Create a branch in this BzrDir.
434
401
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
402
        The bzrdir's format will control what branch format is created.
439
403
        For more control see BranchFormatXX.create(a_bzrdir).
440
404
        """
441
405
        raise NotImplementedError(self.create_branch)
442
406
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
 
407
    def destroy_branch(self):
 
408
        """Destroy the branch in this BzrDir"""
449
409
        raise NotImplementedError(self.destroy_branch)
450
410
 
451
411
    @staticmethod
491
451
            stop = False
492
452
            stack_on = config.get_default_stack_on()
493
453
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
 
454
                stack_on_pwd = found_bzrdir.root_transport.base
495
455
                stop = True
496
456
            # does it have a repository ?
497
457
            try:
499
459
            except errors.NoRepositoryPresent:
500
460
                repository = None
501
461
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
 
462
                if ((found_bzrdir.root_transport.base !=
 
463
                     self.root_transport.base) and not repository.is_shared()):
504
464
                    # Don't look higher, can't use a higher shared repo.
505
465
                    repository = None
506
466
                    stop = True
635
595
            # already exists, but it should instead either remove it or make
636
596
            # a new backup directory.
637
597
            #
 
598
            # FIXME: bug 262450 -- the backup directory should have the same
 
599
            # permissions as the .bzr directory (probably a bug in copy_tree)
638
600
            old_path = self.root_transport.abspath('.bzr')
639
601
            new_path = self.root_transport.abspath(backup_dir)
640
602
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
702
664
            if stop:
703
665
                return result
704
666
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
667
            if (found_bzrdir.root_transport.base == next_transport.base):
706
668
                # top of the file system
707
669
                return None
708
670
            # find the next containing bzrdir
725
687
                repository = found_bzrdir.open_repository()
726
688
            except errors.NoRepositoryPresent:
727
689
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
690
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
691
                return repository, True
730
692
            elif repository.is_shared():
731
693
                return repository, True
746
708
        """
747
709
        return None
748
710
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
711
    def get_branch_transport(self, branch_format):
750
712
        """Get the transport for use by branch format in this BzrDir.
751
713
 
752
714
        Note that bzr dirs that do not support format strings will raise
847
809
        :param _transport: the transport this dir is based at.
848
810
        """
849
811
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
812
        self.transport = _transport.clone('.bzr')
853
813
        self.root_transport = _transport
854
814
        self._mode_check_done = False
855
 
        
856
 
    @property 
857
 
    def user_transport(self):
858
 
        return self.root_transport
859
 
        
860
 
    @property
861
 
    def control_transport(self):
862
 
        return self.transport
863
815
 
864
816
    def is_control_filename(self, filename):
865
817
        """True if filename is the name of a path which is reserved for bzrdir's.
940
892
        BzrDir._check_supported(format, _unsupported)
941
893
        return format.open(transport, _found=True)
942
894
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
895
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
945
896
        """Open the branch object at this BzrDir if one is present.
946
897
 
947
898
        If unsupported is True, then no longer supported branch formats can
1085
1036
        """
1086
1037
        raise NotImplementedError(self.open_workingtree)
1087
1038
 
1088
 
    def has_branch(self, name=None):
 
1039
    def has_branch(self):
1089
1040
        """Tell if this bzrdir contains a branch.
1090
1041
 
1091
1042
        Note: if you're going to open the branch, you should just go ahead
1093
1044
        branch and discards it, and that's somewhat expensive.)
1094
1045
        """
1095
1046
        try:
1096
 
            self.open_branch(name)
 
1047
            self.open_branch()
1097
1048
            return True
1098
1049
        except errors.NotBranchError:
1099
1050
            return False
1373
1324
        self.create_hook(hooks.HookPoint('pre_open',
1374
1325
            "Invoked before attempting to open a BzrDir with the transport "
1375
1326
            "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.",
1380
 
            (2, 2), None))
1381
1327
 
1382
1328
# install the default hooks
1383
1329
BzrDir.hooks = BzrDirHooks()
1384
1330
 
1385
1331
 
1386
 
class RepoInitHookParams(object):
1387
 
    """Object holding parameters passed to *_repo_init hooks.
1388
 
 
1389
 
    There are 4 fields that hooks may wish to access:
1390
 
 
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
1395
 
    """
1396
 
 
1397
 
    def __init__(self, repository, format, a_bzrdir, shared):
1398
 
        """Create a group of RepoInitHook parameters.
1399
 
 
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
1404
 
        """
1405
 
        self.repository = repository
1406
 
        self.format = format
1407
 
        self.bzrdir = a_bzrdir
1408
 
        self.shared = shared
1409
 
 
1410
 
    def __eq__(self, other):
1411
 
        return self.__dict__ == other.__dict__
1412
 
 
1413
 
    def __repr__(self):
1414
 
        if self.repository:
1415
 
            return "<%s for %s>" % (self.__class__.__name__,
1416
 
                self.repository)
1417
 
        else:
1418
 
            return "<%s for %s>" % (self.__class__.__name__,
1419
 
                self.bzrdir)
1420
 
 
1421
 
 
1422
1332
class BzrDirPreSplitOut(BzrDir):
1423
1333
    """A common class for the all-in-one formats."""
1424
1334
 
1463
1373
            tree.clone(result)
1464
1374
        return result
1465
1375
 
1466
 
    def create_branch(self, name=None):
 
1376
    def create_branch(self):
1467
1377
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1378
        return self._format.get_branch_format().initialize(self)
1469
1379
 
1470
 
    def destroy_branch(self, name=None):
 
1380
    def destroy_branch(self):
1471
1381
        """See BzrDir.destroy_branch."""
1472
1382
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1383
 
1529
1439
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1530
1440
                                          self)
1531
1441
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1442
    def get_branch_transport(self, branch_format):
1533
1443
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1444
        if branch_format is None:
1537
1445
            return self.transport
1538
1446
        try:
1571
1479
            format = BzrDirFormat.get_default_format()
1572
1480
        return not isinstance(self._format, format.__class__)
1573
1481
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1482
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1576
1483
        """See BzrDir.open_branch."""
1577
1484
        from bzrlib.branch import BzrBranchFormat4
1578
1485
        format = BzrBranchFormat4()
1579
1486
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1487
        return format.open(self, _found=True)
1581
1488
 
1582
1489
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1490
               possible_transports=None, accelerator_tree=None,
1700
1607
        """See BzrDir.can_convert_format()."""
1701
1608
        return True
1702
1609
 
1703
 
    def create_branch(self, name=None):
 
1610
    def create_branch(self):
1704
1611
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1612
        return self._format.get_branch_format().initialize(self)
1706
1613
 
1707
 
    def destroy_branch(self, name=None):
 
1614
    def destroy_branch(self):
1708
1615
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1616
        self.transport.delete_tree('branch')
1712
1617
 
1713
1618
    def create_repository(self, shared=False):
1756
1661
        format = BranchFormat.find_format(self)
1757
1662
        return format.get_reference(self)
1758
1663
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1664
    def get_branch_transport(self, branch_format):
1760
1665
        """See BzrDir.get_branch_transport()."""
1761
 
        if name is not None:
1762
 
            raise errors.NoColocatedBranchSupport(self)
1763
1666
        # XXX: this shouldn't implicitly create the directory if it's just
1764
1667
        # promising to get a transport -- mbp 20090727
1765
1668
        if branch_format is None:
1836
1739
                return True
1837
1740
        except errors.NoRepositoryPresent:
1838
1741
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1742
        try:
 
1743
            if not isinstance(self.open_branch()._format,
1841
1744
                              format.get_branch_format().__class__):
1842
1745
                # the branch needs an upgrade.
1843
1746
                return True
 
1747
        except errors.NotBranchError:
 
1748
            pass
1844
1749
        try:
1845
1750
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1751
            if not isinstance(my_wt._format,
1851
1756
            pass
1852
1757
        return False
1853
1758
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1759
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1856
1760
        """See BzrDir.open_branch."""
1857
1761
        format = self.find_branch_format()
1858
1762
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1763
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1861
1764
 
1862
1765
    def open_repository(self, unsupported=False):
1863
1766
        """See BzrDir.open_repository."""
1895
1798
    Once a format is deprecated, just deprecate the initialize and open
1896
1799
    methods on the format class. Do not deprecate the object, as the
1897
1800
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1801
    """
1901
1802
 
1902
1803
    _default_format = None
1919
1820
 
1920
1821
    _lock_file_name = 'branch-lock'
1921
1822
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1823
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1824
    # TransportLock or LockDir
1928
1825
 
2735
2632
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
2633
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
2634
            self._convert_to_weaves()
2738
 
            return BzrDir.open(self.bzrdir.user_url)
 
2635
            return BzrDir.open(self.bzrdir.root_transport.base)
2739
2636
        finally:
2740
2637
            self.pb.finished()
2741
2638
 
2988
2885
        try:
2989
2886
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
2887
            self._convert_to_prefixed()
2991
 
            return BzrDir.open(self.bzrdir.user_url)
 
2888
            return BzrDir.open(self.bzrdir.root_transport.base)
2992
2889
        finally:
2993
2890
            pb.finished()
2994
2891
 
3116
3013
            BzrDirMetaFormat1().get_format_string(),
3117
3014
            mode=self.file_mode)
3118
3015
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
3016
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
3017
 
3121
3018
    def make_lock(self, name):
3122
3019
        """Make a lock for the new control dir name."""
3703
3600
            try:
3704
3601
                stack_on = urlutils.rebase_url(self._stack_on,
3705
3602
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
 
3603
                    branch.bzrdir.root_transport.base)
3707
3604
            except errors.InvalidRebaseURLs:
3708
3605
                stack_on = self._get_full_stack_on()
3709
3606
        try: