/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-17 22:11:06 UTC
  • mto: This revision was merged to the branch mainline in revision 4629.
  • Revision ID: john@arbash-meinel.com-20090817221106-snef4s9g2f7zue60
Finish implementation tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
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
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
104
106
        """Activate the branch/repository from url as a fallback repository."""
105
107
        repo = self._get_fallback_repository(url)
106
108
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
108
110
        self.repository.add_fallback_repository(repo)
109
111
 
110
112
    def break_lock(self):
164
166
        """
165
167
        control = bzrdir.BzrDir.open(base, _unsupported,
166
168
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
169
        return control.open_branch(_unsupported)
168
170
 
169
171
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
172
    def open_from_transport(transport, _unsupported=False):
171
173
        """Open the branch rooted at transport"""
172
174
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
175
        return control.open_branch(_unsupported)
174
176
 
175
177
    @staticmethod
176
178
    def open_containing(url, possible_transports=None):
214
216
    def _get_fallback_repository(self, url):
215
217
        """Get the repository we fallback to at url."""
216
218
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
219
        a_bzrdir = bzrdir.BzrDir.open(url,
218
220
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
221
        return a_bzrdir.open_branch().repository
220
222
 
221
223
    def _get_tags_bytes(self):
222
224
        """Get the bytes of a serialised tags dict.
417
419
            * 'include' - the stop revision is the last item in the result
418
420
            * 'with-merges' - include the stop revision and all of its
419
421
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
422
        :param direction: either 'reverse' or 'forward':
423
423
            * reverse means return the start_revision_id first, i.e.
424
424
              start at the most recent revision and go backwards in history
446
446
        # start_revision_id.
447
447
        if self._merge_sorted_revisions_cache is None:
448
448
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
 
449
            last_key = (last_revision,)
 
450
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
451
                [last_key])
451
452
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
453
                last_key)
453
454
        filtered = self._filter_merge_sorted_revisions(
454
455
            self._merge_sorted_revisions_cache, start_revision_id,
455
456
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
457
        if direction == 'reverse':
460
458
            return filtered
461
459
        if direction == 'forward':
498
496
                       node.end_of_merge)
499
497
                if rev_id == stop_revision_id:
500
498
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
499
        elif stop_rule == 'with-merges':
514
500
            stop_rev = self.repository.get_revision(stop_revision_id)
515
501
            if stop_rev.parent_ids:
516
502
                left_parent = stop_rev.parent_ids[0]
517
503
            else:
518
504
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
505
            for node in rev_iter:
524
506
                rev_id = node.key[-1]
525
507
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
508
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
 
509
                yield (rev_id, node.merge_depth, node.revno,
531
510
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
538
511
        else:
539
512
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
513
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
514
    def leave_lock_in_place(self):
587
515
        """Tell this branch object not to release the physical lock when this
588
516
        object is unlocked.
605
533
        :param other: The branch to bind to
606
534
        :type other: Branch
607
535
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
 
536
        raise errors.UpgradeRequired(self.base)
609
537
 
610
538
    def set_append_revisions_only(self, enabled):
611
539
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
 
540
            raise errors.UpgradeRequired(self.base)
613
541
        if enabled:
614
542
            value = 'True'
615
543
        else:
663
591
    def get_old_bound_location(self):
664
592
        """Return the URL of the branch we used to be bound to
665
593
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
594
        raise errors.UpgradeRequired(self.base)
667
595
 
668
596
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
597
                           timezone=None, committer=None, revprops=None,
747
675
            stacking.
748
676
        """
749
677
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
678
            raise errors.UnstackableBranchFormat(self._format, self.base)
751
679
        # XXX: Changing from one fallback repository to another does not check
752
680
        # that all the data you need is present in the new fallback.
753
681
        # Possibly it should.
904
832
 
905
833
    def unbind(self):
906
834
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
835
        raise errors.UpgradeRequired(self.base)
908
836
 
909
837
    def last_revision(self):
910
838
        """Return last revision id, or NULL_REVISION."""
1070
998
        try:
1071
999
            return urlutils.join(self.base[:-1], parent)
1072
1000
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1001
            raise errors.InaccessibleParent(parent, self.base)
1074
1002
 
1075
1003
    def _get_parent_location(self):
1076
1004
        raise NotImplementedError(self._get_parent_location)
1161
1089
        params = ChangeBranchTipParams(
1162
1090
            self, old_revno, new_revno, old_revid, new_revid)
1163
1091
        for hook in hooks:
1164
 
            hook(params)
 
1092
            try:
 
1093
                hook(params)
 
1094
            except errors.TipChangeRejected:
 
1095
                raise
 
1096
            except Exception:
 
1097
                exc_info = sys.exc_info()
 
1098
                hook_name = Branch.hooks.get_hook_name(hook)
 
1099
                raise errors.HookFailed(
 
1100
                    'pre_change_branch_tip', hook_name, exc_info)
1165
1101
 
1166
1102
    @needs_write_lock
1167
1103
    def update(self):
1216
1152
        revision_id: if not None, the revision history in the new branch will
1217
1153
                     be truncated to end with revision_id.
1218
1154
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1155
        result = to_bzrdir.create_branch()
1223
1156
        result.lock_write()
1224
1157
        try:
1348
1281
        # clone call. Or something. 20090224 RBC/spiv.
1349
1282
        if revision_id is None:
1350
1283
            revision_id = self.last_revision()
1351
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1284
        try:
 
1285
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1286
                revision_id=revision_id, stacked_on=stacked_on,
 
1287
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1288
        except errors.FileExists:
 
1289
            if not use_existing_dir:
 
1290
                raise
 
1291
        except errors.NoSuchFile:
 
1292
            if not create_prefix:
 
1293
                raise
1354
1294
        return dir_to.open_branch()
1355
1295
 
1356
1296
    def create_checkout(self, to_location, revision_id=None,
1375
1315
        if lightweight:
1376
1316
            format = self._get_checkout_format()
1377
1317
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1318
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1319
        else:
1381
1320
            format = self._get_checkout_format()
1382
1321
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1363
    def supports_tags(self):
1425
1364
        return self._format.supports_tags()
1426
1365
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1366
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1367
                                         other_branch):
1441
1368
        """Ensure that revision_b is a descendant of revision_a.
1505
1432
        return not (self == other)
1506
1433
 
1507
1434
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1435
    def find_format(klass, a_bzrdir):
1509
1436
        """Return the format for the branch object in a_bzrdir."""
1510
1437
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1438
            transport = a_bzrdir.get_branch_transport(None)
 
1439
            format_string = transport.get("format").read()
1513
1440
            return klass._formats[format_string]
1514
1441
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1442
            raise errors.NotBranchError(path=transport.base)
1516
1443
        except KeyError:
1517
1444
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1445
 
1554
1481
        """Return the short format description for this format."""
1555
1482
        raise NotImplementedError(self.get_format_description)
1556
1483
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1484
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1485
                           set_format=True):
1567
1486
        """Initialize a branch in a bzrdir, with specified files
1568
1487
 
1569
1488
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1489
        :param utf8_files: The files to create as a list of
1571
1490
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1491
        :param set_format: If True, set the format with
1574
1492
            self.get_format_string.  (BzrBranch4 has its format set
1575
1493
            elsewhere)
1576
1494
        :return: a branch in this format
1577
1495
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1496
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1497
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1498
        lock_map = {
1581
1499
            'metadir': ('lock', lockdir.LockDir),
1582
1500
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1521
        finally:
1604
1522
            if lock_taken:
1605
1523
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1524
        return self.open(a_bzrdir, _found=True)
1609
1525
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1526
    def initialize(self, a_bzrdir):
 
1527
        """Create a branch of this format in a_bzrdir."""
1615
1528
        raise NotImplementedError(self.initialize)
1616
1529
 
1617
1530
    def is_supported(self):
1647
1560
        """
1648
1561
        raise NotImplementedError(self.network_name)
1649
1562
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1563
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1564
        """Return the branch object for a_bzrdir
1652
1565
 
1653
1566
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1567
        :param _found: a private parameter, do not use it. It is used to
1656
1568
            indicate if format probing has already be done.
1657
1569
        :param ignore_fallbacks: when set, no fallback branches will be opened
1765
1677
            "multiple hooks installed for transform_fallback_location, "
1766
1678
            "all are called with the url returned from the previous hook."
1767
1679
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
1785
1680
 
1786
1681
 
1787
1682
# install the default hooks into the Branch class.
1826
1721
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1722
 
1828
1723
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1724
class BzrBranchFormat4(BranchFormat):
1908
1725
    """Bzr branch format 4.
1909
1726
 
1916
1733
        """See BranchFormat.get_format_description()."""
1917
1734
        return "Branch format 4"
1918
1735
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1736
    def initialize(self, a_bzrdir):
1920
1737
        """Create a branch of this format in a_bzrdir."""
1921
1738
        utf8_files = [('revision-history', ''),
1922
1739
                      ('branch-name', ''),
1923
1740
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1741
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1742
                                       lock_type='branch4', set_format=False)
1926
1743
 
1927
1744
    def __init__(self):
1932
1749
        """The network name for this format is the control dirs disk label."""
1933
1750
        return self._matchingbzrdir.get_format_string()
1934
1751
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1752
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1753
        """See BranchFormat.open()."""
1937
1754
        if not _found:
1938
1755
            # we are being called directly and must probe.
1940
1757
        return BzrBranch(_format=self,
1941
1758
                         _control_files=a_bzrdir._control_files,
1942
1759
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1760
                         _repository=a_bzrdir.open_repository())
1945
1761
 
1946
1762
    def __str__(self):
1961
1777
        """
1962
1778
        return self.get_format_string()
1963
1779
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1780
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1781
        """See BranchFormat.open()."""
1966
1782
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1783
            format = BranchFormat.find_format(a_bzrdir)
1968
1784
            if format.__class__ != self.__class__:
1969
1785
                raise AssertionError("wrong format %r found for %r" %
1970
1786
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1787
        try:
 
1788
            transport = a_bzrdir.get_branch_transport(None)
1973
1789
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1790
                                                         lockdir.LockDir)
1975
1791
            return self._branch_class()(_format=self,
1976
1792
                              _control_files=control_files,
1977
 
                              name=name,
1978
1793
                              a_bzrdir=a_bzrdir,
1979
1794
                              _repository=a_bzrdir.find_repository(),
1980
1795
                              ignore_fallbacks=ignore_fallbacks)
1981
1796
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1797
            raise errors.NotBranchError(path=transport.base)
1983
1798
 
1984
1799
    def __init__(self):
1985
1800
        super(BranchFormatMetadir, self).__init__()
2014
1829
        """See BranchFormat.get_format_description()."""
2015
1830
        return "Branch format 5"
2016
1831
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1832
    def initialize(self, a_bzrdir):
2018
1833
        """Create a branch of this format in a_bzrdir."""
2019
1834
        utf8_files = [('revision-history', ''),
2020
1835
                      ('branch-name', ''),
2021
1836
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1837
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1838
 
2024
1839
    def supports_tags(self):
2025
1840
        return False
2047
1862
        """See BranchFormat.get_format_description()."""
2048
1863
        return "Branch format 6"
2049
1864
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1865
    def initialize(self, a_bzrdir):
2051
1866
        """Create a branch of this format in a_bzrdir."""
2052
1867
        utf8_files = [('last-revision', '0 null:\n'),
2053
1868
                      ('branch.conf', ''),
2054
1869
                      ('tags', ''),
2055
1870
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1871
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1872
 
2058
1873
    def make_tags(self, branch):
2059
1874
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
1892
        """See BranchFormat.get_format_description()."""
2078
1893
        return "Branch format 8"
2079
1894
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1895
    def initialize(self, a_bzrdir):
2081
1896
        """Create a branch of this format in a_bzrdir."""
2082
1897
        utf8_files = [('last-revision', '0 null:\n'),
2083
1898
                      ('branch.conf', ''),
2084
1899
                      ('tags', ''),
2085
1900
                      ('references', '')
2086
1901
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1902
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1903
 
2089
1904
    def __init__(self):
2090
1905
        super(BzrBranchFormat8, self).__init__()
2113
1928
    This format was introduced in bzr 1.6.
2114
1929
    """
2115
1930
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1931
    def initialize(self, a_bzrdir):
2117
1932
        """Create a branch of this format in a_bzrdir."""
2118
1933
        utf8_files = [('last-revision', '0 null:\n'),
2119
1934
                      ('branch.conf', ''),
2120
1935
                      ('tags', ''),
2121
1936
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1937
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1938
 
2124
1939
    def _branch_class(self):
2125
1940
        return BzrBranch7
2160
1975
    def get_reference(self, a_bzrdir):
2161
1976
        """See BranchFormat.get_reference()."""
2162
1977
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1978
        return transport.get('location').read()
2164
1979
 
2165
1980
    def set_reference(self, a_bzrdir, to_branch):
2166
1981
        """See BranchFormat.set_reference()."""
2167
1982
        transport = a_bzrdir.get_branch_transport(None)
2168
1983
        location = transport.put_bytes('location', to_branch.base)
2169
1984
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1985
    def initialize(self, a_bzrdir, target_branch=None):
2171
1986
        """Create a branch of this format in a_bzrdir."""
2172
1987
        if target_branch is None:
2173
1988
            # this format does not implement branch itself, thus the implicit
2174
1989
            # creation contract must see it as uninitializable
2175
1990
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1991
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1992
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1993
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1994
            target_branch.bzrdir.root_transport.base)
2180
1995
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1996
        return self.open(
 
1997
            a_bzrdir, _found=True,
2183
1998
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1999
 
2187
2000
    def __init__(self):
2188
2001
        super(BranchReferenceFormat, self).__init__()
2194
2007
        def clone(to_bzrdir, revision_id=None,
2195
2008
            repository_policy=None):
2196
2009
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2010
            return format.initialize(to_bzrdir, a_branch)
2198
2011
            # cannot obey revision_id limits when cloning a reference ...
2199
2012
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
2013
            # emit some sort of warning/error to the caller ?!
2201
2014
        return clone
2202
2015
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2016
    def open(self, a_bzrdir, _found=False, location=None,
2204
2017
             possible_transports=None, ignore_fallbacks=False):
2205
2018
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2019
 
2207
2020
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
2021
        :param _found: a private parameter, do not use it. It is used to
2210
2022
            indicate if format probing has already be done.
2211
2023
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
2028
        :param possible_transports: An optional reusable transports list.
2217
2029
        """
2218
2030
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2031
            format = BranchFormat.find_format(a_bzrdir)
2220
2032
            if format.__class__ != self.__class__:
2221
2033
                raise AssertionError("wrong format %r found for %r" %
2222
2034
                    (format, self))
2224
2036
            location = self.get_reference(a_bzrdir)
2225
2037
        real_bzrdir = bzrdir.BzrDir.open(
2226
2038
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2039
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
2040
        # this changes the behaviour of result.clone to create a new reference
2230
2041
        # rather than a copy of the content of the branch.
2231
2042
        # I did not use a proxy object because that needs much more extensive
2258
2069
BranchFormat.register_format(__format6)
2259
2070
BranchFormat.register_format(__format7)
2260
2071
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
2072
BranchFormat.set_default_format(__format6)
2262
2073
_legacy_formats = [BzrBranchFormat4(),
2263
2074
    ]
2264
2075
network_format_registry.register(
2265
2076
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2077
 
2267
2078
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2079
class BzrBranch(Branch):
2269
2080
    """A branch stored in the actual filesystem.
2270
2081
 
2271
2082
    Note that it's "local" in the context of the filesystem; it doesn't
2277
2088
    :ivar repository: Repository for this branch.
2278
2089
    :ivar base: The url of the base directory for this branch; the one
2279
2090
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
2091
    """
2283
2092
 
2284
2093
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2094
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2095
                 ignore_fallbacks=False):
2287
2096
        """Create new branch object at a particular location."""
2288
2097
        if a_bzrdir is None:
2289
2098
            raise ValueError('a_bzrdir must be supplied')
2290
2099
        else:
2291
2100
            self.bzrdir = a_bzrdir
2292
2101
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2102
        # XXX: We should be able to just do
2295
2103
        #   self.base = self.bzrdir.root_transport.base
2296
2104
        # but this does not quite work yet -- mbp 20080522
2303
2111
        Branch.__init__(self)
2304
2112
 
2305
2113
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
2114
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2115
 
2312
2116
    __repr__ = __str__
2313
2117
 
2324
2128
        return self.control_files.is_locked()
2325
2129
 
2326
2130
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2131
        # All-in-one needs to always unlock/lock.
2330
2132
        repo_control = getattr(self.repository, 'control_files', None)
2331
2133
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2134
            self.repository.lock_write()
2334
2135
            took_lock = True
2335
2136
        else:
2342
2143
            raise
2343
2144
 
2344
2145
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2146
        # All-in-one needs to always unlock/lock.
2348
2147
        repo_control = getattr(self.repository, 'control_files', None)
2349
2148
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2149
            self.repository.lock_read()
2352
2150
            took_lock = True
2353
2151
        else:
2359
2157
                self.repository.unlock()
2360
2158
            raise
2361
2159
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2160
    def unlock(self):
2364
2161
        try:
2365
2162
            self.control_files.unlock()
2528
2325
        return result
2529
2326
 
2530
2327
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2328
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2329
 
2533
2330
    def set_push_location(self, location):
2534
2331
        """See Branch.set_push_location."""
2724
2521
        if _mod_revision.is_null(last_revision):
2725
2522
            return
2726
2523
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2524
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2525
 
2729
2526
    def _gen_revision_history(self):
2730
2527
        """Generate the revision history from last revision
2830
2627
        if branch_location is None:
2831
2628
            return Branch.reference_parent(self, file_id, path,
2832
2629
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2630
        branch_location = urlutils.join(self.base, branch_location)
2834
2631
        return Branch.open(branch_location,
2835
2632
                           possible_transports=possible_transports)
2836
2633
 
2882
2679
        return stacked_url
2883
2680
 
2884
2681
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2682
        value = self.get_config().get_user_option('append_revisions_only')
 
2683
        return value == 'True'
2887
2684
 
2888
2685
    @needs_write_lock
2889
2686
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2748
    """
2952
2749
 
2953
2750
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2751
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2752
 
2956
2753
 
2957
2754
######################################################################
3044
2841
        :param verbose: Requests more detailed display of what was checked,
3045
2842
            if any.
3046
2843
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
 
2844
        note('checked branch %s format %s', self.branch.base,
3048
2845
            self.branch._format)
3049
2846
        for error in self.errors:
3050
2847
            note('found error:%s', error)
3379
3176
        if local and not bound_location:
3380
3177
            raise errors.LocalRequiresBoundBranch()
3381
3178
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3179
        if not local and bound_location and self.source.base != bound_location:
3383
3180
            # not pulling from master, so we need to update master.
3384
3181
            master_branch = self.target.get_master_branch(possible_transports)
3385
3182
            master_branch.lock_write()