← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-11-27 23:21:36 UTC
  • mfrom: (4585.1.19 foreign-tests-4)
  • Revision ID: pqm@pqm.ubuntu.com-20091127232136-bkm3vrye2wt4odbw
(Jelmer) Add basic tests for foreign repositories.

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
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
64
 
65
65
 
66
 
class Branch(bzrdir.ControlComponent):
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
67
79
    """Branch holding a history of revisions.
68
80
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
81
    base
 
82
        Base directory/url of the branch.
72
83
 
73
84
    hooks: An instance of BranchHooks.
74
85
    """
76
87
    # - RBC 20060112
77
88
    base = None
78
89
 
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
90
    def __init__(self, *ignored, **ignored_too):
88
91
        self.tags = self._format.make_tags(self)
89
92
        self._revision_history_cache = None
104
107
        """Activate the branch/repository from url as a fallback repository."""
105
108
        repo = self._get_fallback_repository(url)
106
109
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
164
167
        """
165
168
        control = bzrdir.BzrDir.open(base, _unsupported,
166
169
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
170
        return control.open_branch(_unsupported)
168
171
 
169
172
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
173
    def open_from_transport(transport, _unsupported=False):
171
174
        """Open the branch rooted at transport"""
172
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
176
        return control.open_branch(_unsupported)
174
177
 
175
178
    @staticmethod
176
179
    def open_containing(url, possible_transports=None):
214
217
    def _get_fallback_repository(self, url):
215
218
        """Get the repository we fallback to at url."""
216
219
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
218
221
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
222
        return a_bzrdir.open_branch().repository
220
223
 
221
224
    def _get_tags_bytes(self):
222
225
        """Get the bytes of a serialised tags dict.
417
420
            * 'include' - the stop revision is the last item in the result
418
421
            * 'with-merges' - include the stop revision and all of its
419
422
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
423
        :param direction: either 'reverse' or 'forward':
423
424
            * reverse means return the start_revision_id first, i.e.
424
425
              start at the most recent revision and go backwards in history
446
447
        # start_revision_id.
447
448
        if self._merge_sorted_revisions_cache is None:
448
449
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
451
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
454
                last_key)
453
455
        filtered = self._filter_merge_sorted_revisions(
454
456
            self._merge_sorted_revisions_cache, start_revision_id,
455
457
            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
458
        if direction == 'reverse':
460
459
            return filtered
461
460
        if direction == 'forward':
498
497
                       node.end_of_merge)
499
498
                if rev_id == stop_revision_id:
500
499
                    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
500
        elif stop_rule == 'with-merges':
514
501
            stop_rev = self.repository.get_revision(stop_revision_id)
515
502
            if stop_rev.parent_ids:
516
503
                left_parent = stop_rev.parent_ids[0]
517
504
            else:
518
505
                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
506
            for node in rev_iter:
524
507
                rev_id = node.key[-1]
525
508
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
509
                    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,
 
510
                yield (rev_id, node.merge_depth, node.revno,
531
511
                       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
512
        else:
539
513
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
514
 
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
515
    def leave_lock_in_place(self):
587
516
        """Tell this branch object not to release the physical lock when this
588
517
        object is unlocked.
605
534
        :param other: The branch to bind to
606
535
        :type other: Branch
607
536
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
 
537
        raise errors.UpgradeRequired(self.base)
609
538
 
610
539
    def set_append_revisions_only(self, enabled):
611
540
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
 
541
            raise errors.UpgradeRequired(self.base)
613
542
        if enabled:
614
543
            value = 'True'
615
544
        else:
663
592
    def get_old_bound_location(self):
664
593
        """Return the URL of the branch we used to be bound to
665
594
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
595
        raise errors.UpgradeRequired(self.base)
667
596
 
668
597
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
598
                           timezone=None, committer=None, revprops=None,
747
676
            stacking.
748
677
        """
749
678
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
679
            raise errors.UnstackableBranchFormat(self._format, self.base)
751
680
        # XXX: Changing from one fallback repository to another does not check
752
681
        # that all the data you need is present in the new fallback.
753
682
        # Possibly it should.
904
833
 
905
834
    def unbind(self):
906
835
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
836
        raise errors.UpgradeRequired(self.base)
908
837
 
909
838
    def last_revision(self):
910
839
        """Return last revision id, or NULL_REVISION."""
1070
999
        try:
1071
1000
            return urlutils.join(self.base[:-1], parent)
1072
1001
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1002
            raise errors.InaccessibleParent(parent, self.base)
1074
1003
 
1075
1004
    def _get_parent_location(self):
1076
1005
        raise NotImplementedError(self._get_parent_location)
1161
1090
        params = ChangeBranchTipParams(
1162
1091
            self, old_revno, new_revno, old_revid, new_revid)
1163
1092
        for hook in hooks:
1164
 
            hook(params)
 
1093
            try:
 
1094
                hook(params)
 
1095
            except errors.TipChangeRejected:
 
1096
                raise
 
1097
            except Exception:
 
1098
                exc_info = sys.exc_info()
 
1099
                hook_name = Branch.hooks.get_hook_name(hook)
 
1100
                raise errors.HookFailed(
 
1101
                    'pre_change_branch_tip', hook_name, exc_info)
1165
1102
 
1166
1103
    @needs_write_lock
1167
1104
    def update(self):
1348
1285
        # clone call. Or something. 20090224 RBC/spiv.
1349
1286
        if revision_id is None:
1350
1287
            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)
 
1288
        try:
 
1289
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1290
                revision_id=revision_id, stacked_on=stacked_on,
 
1291
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1292
        except errors.FileExists:
 
1293
            if not use_existing_dir:
 
1294
                raise
 
1295
        except errors.NoSuchFile:
 
1296
            if not create_prefix:
 
1297
                raise
1354
1298
        return dir_to.open_branch()
1355
1299
 
1356
1300
    def create_checkout(self, to_location, revision_id=None,
1375
1319
        if lightweight:
1376
1320
            format = self._get_checkout_format()
1377
1321
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1322
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1323
        else:
1381
1324
            format = self._get_checkout_format()
1382
1325
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1367
    def supports_tags(self):
1425
1368
        return self._format.supports_tags()
1426
1369
 
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
1370
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1371
                                         other_branch):
1441
1372
        """Ensure that revision_b is a descendant of revision_a.
1505
1436
        return not (self == other)
1506
1437
 
1507
1438
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1439
    def find_format(klass, a_bzrdir):
1509
1440
        """Return the format for the branch object in a_bzrdir."""
1510
1441
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1442
            transport = a_bzrdir.get_branch_transport(None)
 
1443
            format_string = transport.get("format").read()
1513
1444
            return klass._formats[format_string]
1514
1445
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1446
            raise errors.NotBranchError(path=transport.base)
1516
1447
        except KeyError:
1517
1448
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1449
 
1554
1485
        """Return the short format description for this format."""
1555
1486
        raise NotImplementedError(self.get_format_description)
1556
1487
 
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):
 
1488
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1489
                           set_format=True):
1567
1490
        """Initialize a branch in a bzrdir, with specified files
1568
1491
 
1569
1492
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1493
        :param utf8_files: The files to create as a list of
1571
1494
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1495
        :param set_format: If True, set the format with
1574
1496
            self.get_format_string.  (BzrBranch4 has its format set
1575
1497
            elsewhere)
1576
1498
        :return: a branch in this format
1577
1499
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1500
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1501
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1502
        lock_map = {
1581
1503
            'metadir': ('lock', lockdir.LockDir),
1582
1504
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1525
        finally:
1604
1526
            if lock_taken:
1605
1527
                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
 
1528
        return self.open(a_bzrdir, _found=True)
1609
1529
 
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
 
        """
 
1530
    def initialize(self, a_bzrdir):
 
1531
        """Create a branch of this format in a_bzrdir."""
1615
1532
        raise NotImplementedError(self.initialize)
1616
1533
 
1617
1534
    def is_supported(self):
1647
1564
        """
1648
1565
        raise NotImplementedError(self.network_name)
1649
1566
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1567
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1568
        """Return the branch object for a_bzrdir
1652
1569
 
1653
1570
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1571
        :param _found: a private parameter, do not use it. It is used to
1656
1572
            indicate if format probing has already be done.
1657
1573
        :param ignore_fallbacks: when set, no fallback branches will be opened
1765
1681
            "multiple hooks installed for transform_fallback_location, "
1766
1682
            "all are called with the url returned from the previous hook."
1767
1683
            "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
1684
 
1786
1685
 
1787
1686
# install the default hooks into the Branch class.
1826
1725
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1726
 
1828
1727
 
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
1728
class BzrBranchFormat4(BranchFormat):
1908
1729
    """Bzr branch format 4.
1909
1730
 
1916
1737
        """See BranchFormat.get_format_description()."""
1917
1738
        return "Branch format 4"
1918
1739
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1740
    def initialize(self, a_bzrdir):
1920
1741
        """Create a branch of this format in a_bzrdir."""
1921
1742
        utf8_files = [('revision-history', ''),
1922
1743
                      ('branch-name', ''),
1923
1744
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1745
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1746
                                       lock_type='branch4', set_format=False)
1926
1747
 
1927
1748
    def __init__(self):
1932
1753
        """The network name for this format is the control dirs disk label."""
1933
1754
        return self._matchingbzrdir.get_format_string()
1934
1755
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1756
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1757
        """See BranchFormat.open()."""
1937
1758
        if not _found:
1938
1759
            # we are being called directly and must probe.
1940
1761
        return BzrBranch(_format=self,
1941
1762
                         _control_files=a_bzrdir._control_files,
1942
1763
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1764
                         _repository=a_bzrdir.open_repository())
1945
1765
 
1946
1766
    def __str__(self):
1961
1781
        """
1962
1782
        return self.get_format_string()
1963
1783
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1784
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1785
        """See BranchFormat.open()."""
1966
1786
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1787
            format = BranchFormat.find_format(a_bzrdir)
1968
1788
            if format.__class__ != self.__class__:
1969
1789
                raise AssertionError("wrong format %r found for %r" %
1970
1790
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1791
        try:
 
1792
            transport = a_bzrdir.get_branch_transport(None)
1973
1793
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1794
                                                         lockdir.LockDir)
1975
1795
            return self._branch_class()(_format=self,
1976
1796
                              _control_files=control_files,
1977
 
                              name=name,
1978
1797
                              a_bzrdir=a_bzrdir,
1979
1798
                              _repository=a_bzrdir.find_repository(),
1980
1799
                              ignore_fallbacks=ignore_fallbacks)
1981
1800
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1801
            raise errors.NotBranchError(path=transport.base)
1983
1802
 
1984
1803
    def __init__(self):
1985
1804
        super(BranchFormatMetadir, self).__init__()
2014
1833
        """See BranchFormat.get_format_description()."""
2015
1834
        return "Branch format 5"
2016
1835
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1836
    def initialize(self, a_bzrdir):
2018
1837
        """Create a branch of this format in a_bzrdir."""
2019
1838
        utf8_files = [('revision-history', ''),
2020
1839
                      ('branch-name', ''),
2021
1840
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1841
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1842
 
2024
1843
    def supports_tags(self):
2025
1844
        return False
2047
1866
        """See BranchFormat.get_format_description()."""
2048
1867
        return "Branch format 6"
2049
1868
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1869
    def initialize(self, a_bzrdir):
2051
1870
        """Create a branch of this format in a_bzrdir."""
2052
1871
        utf8_files = [('last-revision', '0 null:\n'),
2053
1872
                      ('branch.conf', ''),
2054
1873
                      ('tags', ''),
2055
1874
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1875
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1876
 
2058
1877
    def make_tags(self, branch):
2059
1878
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
1896
        """See BranchFormat.get_format_description()."""
2078
1897
        return "Branch format 8"
2079
1898
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1899
    def initialize(self, a_bzrdir):
2081
1900
        """Create a branch of this format in a_bzrdir."""
2082
1901
        utf8_files = [('last-revision', '0 null:\n'),
2083
1902
                      ('branch.conf', ''),
2084
1903
                      ('tags', ''),
2085
1904
                      ('references', '')
2086
1905
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1906
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1907
 
2089
1908
    def __init__(self):
2090
1909
        super(BzrBranchFormat8, self).__init__()
2113
1932
    This format was introduced in bzr 1.6.
2114
1933
    """
2115
1934
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1935
    def initialize(self, a_bzrdir):
2117
1936
        """Create a branch of this format in a_bzrdir."""
2118
1937
        utf8_files = [('last-revision', '0 null:\n'),
2119
1938
                      ('branch.conf', ''),
2120
1939
                      ('tags', ''),
2121
1940
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1941
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1942
 
2124
1943
    def _branch_class(self):
2125
1944
        return BzrBranch7
2160
1979
    def get_reference(self, a_bzrdir):
2161
1980
        """See BranchFormat.get_reference()."""
2162
1981
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1982
        return transport.get('location').read()
2164
1983
 
2165
1984
    def set_reference(self, a_bzrdir, to_branch):
2166
1985
        """See BranchFormat.set_reference()."""
2167
1986
        transport = a_bzrdir.get_branch_transport(None)
2168
1987
        location = transport.put_bytes('location', to_branch.base)
2169
1988
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1989
    def initialize(self, a_bzrdir, target_branch=None):
2171
1990
        """Create a branch of this format in a_bzrdir."""
2172
1991
        if target_branch is None:
2173
1992
            # this format does not implement branch itself, thus the implicit
2174
1993
            # creation contract must see it as uninitializable
2175
1994
            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)
 
1995
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1996
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1997
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1998
            target_branch.bzrdir.root_transport.base)
2180
1999
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
2000
        return self.open(
 
2001
            a_bzrdir, _found=True,
2183
2002
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
2003
 
2187
2004
    def __init__(self):
2188
2005
        super(BranchReferenceFormat, self).__init__()
2194
2011
        def clone(to_bzrdir, revision_id=None,
2195
2012
            repository_policy=None):
2196
2013
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2014
            return format.initialize(to_bzrdir, a_branch)
2198
2015
            # cannot obey revision_id limits when cloning a reference ...
2199
2016
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
2017
            # emit some sort of warning/error to the caller ?!
2201
2018
        return clone
2202
2019
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2020
    def open(self, a_bzrdir, _found=False, location=None,
2204
2021
             possible_transports=None, ignore_fallbacks=False):
2205
2022
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2023
 
2207
2024
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
2025
        :param _found: a private parameter, do not use it. It is used to
2210
2026
            indicate if format probing has already be done.
2211
2027
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
2032
        :param possible_transports: An optional reusable transports list.
2217
2033
        """
2218
2034
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2035
            format = BranchFormat.find_format(a_bzrdir)
2220
2036
            if format.__class__ != self.__class__:
2221
2037
                raise AssertionError("wrong format %r found for %r" %
2222
2038
                    (format, self))
2224
2040
            location = self.get_reference(a_bzrdir)
2225
2041
        real_bzrdir = bzrdir.BzrDir.open(
2226
2042
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2043
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
2044
        # this changes the behaviour of result.clone to create a new reference
2230
2045
        # rather than a copy of the content of the branch.
2231
2046
        # I did not use a proxy object because that needs much more extensive
2277
2092
    :ivar repository: Repository for this branch.
2278
2093
    :ivar base: The url of the base directory for this branch; the one
2279
2094
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
2095
    """
2283
2096
 
2284
2097
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2098
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2099
                 ignore_fallbacks=False):
2287
2100
        """Create new branch object at a particular location."""
2288
2101
        if a_bzrdir is None:
2289
2102
            raise ValueError('a_bzrdir must be supplied')
2290
2103
        else:
2291
2104
            self.bzrdir = a_bzrdir
2292
2105
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2106
        # XXX: We should be able to just do
2295
2107
        #   self.base = self.bzrdir.root_transport.base
2296
2108
        # but this does not quite work yet -- mbp 20080522
2303
2115
        Branch.__init__(self)
2304
2116
 
2305
2117
    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)
 
2118
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2119
 
2312
2120
    __repr__ = __str__
2313
2121
 
2329
2137
        # All-in-one needs to always unlock/lock.
2330
2138
        repo_control = getattr(self.repository, 'control_files', None)
2331
2139
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2140
            self.repository.lock_write()
2334
2141
            took_lock = True
2335
2142
        else:
2347
2154
        # All-in-one needs to always unlock/lock.
2348
2155
        repo_control = getattr(self.repository, 'control_files', None)
2349
2156
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2157
            self.repository.lock_read()
2352
2158
            took_lock = True
2353
2159
        else:
2528
2334
        return result
2529
2335
 
2530
2336
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2337
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2338
 
2533
2339
    def set_push_location(self, location):
2534
2340
        """See Branch.set_push_location."""
2724
2530
        if _mod_revision.is_null(last_revision):
2725
2531
            return
2726
2532
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2533
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2534
 
2729
2535
    def _gen_revision_history(self):
2730
2536
        """Generate the revision history from last revision
2830
2636
        if branch_location is None:
2831
2637
            return Branch.reference_parent(self, file_id, path,
2832
2638
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2639
        branch_location = urlutils.join(self.base, branch_location)
2834
2640
        return Branch.open(branch_location,
2835
2641
                           possible_transports=possible_transports)
2836
2642
 
2882
2688
        return stacked_url
2883
2689
 
2884
2690
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2691
        value = self.get_config().get_user_option('append_revisions_only')
 
2692
        return value == 'True'
2887
2693
 
2888
2694
    @needs_write_lock
2889
2695
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2757
    """
2952
2758
 
2953
2759
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2760
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2761
 
2956
2762
 
2957
2763
######################################################################
3044
2850
        :param verbose: Requests more detailed display of what was checked,
3045
2851
            if any.
3046
2852
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
 
2853
        note('checked branch %s format %s', self.branch.base,
3048
2854
            self.branch._format)
3049
2855
        for error in self.errors:
3050
2856
            note('found error:%s', error)
3379
3185
        if local and not bound_location:
3380
3186
            raise errors.LocalRequiresBoundBranch()
3381
3187
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3188
        if not local and bound_location and self.source.base != bound_location:
3383
3189
            # not pulling from master, so we need to update master.
3384
3190
            master_branch = self.target.get_master_branch(possible_transports)
3385
3191
            master_branch.lock_write()