← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Brian de Alwis
  • Date: 2009-09-24 19:51:37 UTC
  • mto: (4715.4.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4727.
  • Revision ID: bsd@acm.org-20090924195137-wubyeqv515mkigi8
Introduce new mailer to support MacOS X's Mail.app

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):
1348
1284
        # clone call. Or something. 20090224 RBC/spiv.
1349
1285
        if revision_id is None:
1350
1286
            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)
 
1287
        try:
 
1288
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1289
                revision_id=revision_id, stacked_on=stacked_on,
 
1290
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1291
        except errors.FileExists:
 
1292
            if not use_existing_dir:
 
1293
                raise
 
1294
        except errors.NoSuchFile:
 
1295
            if not create_prefix:
 
1296
                raise
1354
1297
        return dir_to.open_branch()
1355
1298
 
1356
1299
    def create_checkout(self, to_location, revision_id=None,
1375
1318
        if lightweight:
1376
1319
            format = self._get_checkout_format()
1377
1320
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1321
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1322
        else:
1381
1323
            format = self._get_checkout_format()
1382
1324
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1366
    def supports_tags(self):
1425
1367
        return self._format.supports_tags()
1426
1368
 
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
1369
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1370
                                         other_branch):
1441
1371
        """Ensure that revision_b is a descendant of revision_a.
1505
1435
        return not (self == other)
1506
1436
 
1507
1437
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1438
    def find_format(klass, a_bzrdir):
1509
1439
        """Return the format for the branch object in a_bzrdir."""
1510
1440
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1441
            transport = a_bzrdir.get_branch_transport(None)
 
1442
            format_string = transport.get("format").read()
1513
1443
            return klass._formats[format_string]
1514
1444
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1445
            raise errors.NotBranchError(path=transport.base)
1516
1446
        except KeyError:
1517
1447
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1448
 
1554
1484
        """Return the short format description for this format."""
1555
1485
        raise NotImplementedError(self.get_format_description)
1556
1486
 
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):
 
1487
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1488
                           set_format=True):
1567
1489
        """Initialize a branch in a bzrdir, with specified files
1568
1490
 
1569
1491
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1492
        :param utf8_files: The files to create as a list of
1571
1493
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1494
        :param set_format: If True, set the format with
1574
1495
            self.get_format_string.  (BzrBranch4 has its format set
1575
1496
            elsewhere)
1576
1497
        :return: a branch in this format
1577
1498
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1499
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1500
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1501
        lock_map = {
1581
1502
            'metadir': ('lock', lockdir.LockDir),
1582
1503
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1524
        finally:
1604
1525
            if lock_taken:
1605
1526
                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
 
1527
        return self.open(a_bzrdir, _found=True)
1609
1528
 
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
 
        """
 
1529
    def initialize(self, a_bzrdir):
 
1530
        """Create a branch of this format in a_bzrdir."""
1615
1531
        raise NotImplementedError(self.initialize)
1616
1532
 
1617
1533
    def is_supported(self):
1647
1563
        """
1648
1564
        raise NotImplementedError(self.network_name)
1649
1565
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1566
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1567
        """Return the branch object for a_bzrdir
1652
1568
 
1653
1569
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1570
        :param _found: a private parameter, do not use it. It is used to
1656
1571
            indicate if format probing has already be done.
1657
1572
        :param ignore_fallbacks: when set, no fallback branches will be opened
1765
1680
            "multiple hooks installed for transform_fallback_location, "
1766
1681
            "all are called with the url returned from the previous hook."
1767
1682
            "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
1683
 
1786
1684
 
1787
1685
# install the default hooks into the Branch class.
1826
1724
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1725
 
1828
1726
 
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
1727
class BzrBranchFormat4(BranchFormat):
1908
1728
    """Bzr branch format 4.
1909
1729
 
1916
1736
        """See BranchFormat.get_format_description()."""
1917
1737
        return "Branch format 4"
1918
1738
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1739
    def initialize(self, a_bzrdir):
1920
1740
        """Create a branch of this format in a_bzrdir."""
1921
1741
        utf8_files = [('revision-history', ''),
1922
1742
                      ('branch-name', ''),
1923
1743
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1744
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1745
                                       lock_type='branch4', set_format=False)
1926
1746
 
1927
1747
    def __init__(self):
1932
1752
        """The network name for this format is the control dirs disk label."""
1933
1753
        return self._matchingbzrdir.get_format_string()
1934
1754
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1755
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1756
        """See BranchFormat.open()."""
1937
1757
        if not _found:
1938
1758
            # we are being called directly and must probe.
1940
1760
        return BzrBranch(_format=self,
1941
1761
                         _control_files=a_bzrdir._control_files,
1942
1762
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1763
                         _repository=a_bzrdir.open_repository())
1945
1764
 
1946
1765
    def __str__(self):
1961
1780
        """
1962
1781
        return self.get_format_string()
1963
1782
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1783
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1784
        """See BranchFormat.open()."""
1966
1785
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1786
            format = BranchFormat.find_format(a_bzrdir)
1968
1787
            if format.__class__ != self.__class__:
1969
1788
                raise AssertionError("wrong format %r found for %r" %
1970
1789
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1790
        try:
 
1791
            transport = a_bzrdir.get_branch_transport(None)
1973
1792
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1793
                                                         lockdir.LockDir)
1975
1794
            return self._branch_class()(_format=self,
1976
1795
                              _control_files=control_files,
1977
 
                              name=name,
1978
1796
                              a_bzrdir=a_bzrdir,
1979
1797
                              _repository=a_bzrdir.find_repository(),
1980
1798
                              ignore_fallbacks=ignore_fallbacks)
1981
1799
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1800
            raise errors.NotBranchError(path=transport.base)
1983
1801
 
1984
1802
    def __init__(self):
1985
1803
        super(BranchFormatMetadir, self).__init__()
2014
1832
        """See BranchFormat.get_format_description()."""
2015
1833
        return "Branch format 5"
2016
1834
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1835
    def initialize(self, a_bzrdir):
2018
1836
        """Create a branch of this format in a_bzrdir."""
2019
1837
        utf8_files = [('revision-history', ''),
2020
1838
                      ('branch-name', ''),
2021
1839
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1840
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1841
 
2024
1842
    def supports_tags(self):
2025
1843
        return False
2047
1865
        """See BranchFormat.get_format_description()."""
2048
1866
        return "Branch format 6"
2049
1867
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1868
    def initialize(self, a_bzrdir):
2051
1869
        """Create a branch of this format in a_bzrdir."""
2052
1870
        utf8_files = [('last-revision', '0 null:\n'),
2053
1871
                      ('branch.conf', ''),
2054
1872
                      ('tags', ''),
2055
1873
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1874
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1875
 
2058
1876
    def make_tags(self, branch):
2059
1877
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
1895
        """See BranchFormat.get_format_description()."""
2078
1896
        return "Branch format 8"
2079
1897
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1898
    def initialize(self, a_bzrdir):
2081
1899
        """Create a branch of this format in a_bzrdir."""
2082
1900
        utf8_files = [('last-revision', '0 null:\n'),
2083
1901
                      ('branch.conf', ''),
2084
1902
                      ('tags', ''),
2085
1903
                      ('references', '')
2086
1904
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1905
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1906
 
2089
1907
    def __init__(self):
2090
1908
        super(BzrBranchFormat8, self).__init__()
2113
1931
    This format was introduced in bzr 1.6.
2114
1932
    """
2115
1933
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1934
    def initialize(self, a_bzrdir):
2117
1935
        """Create a branch of this format in a_bzrdir."""
2118
1936
        utf8_files = [('last-revision', '0 null:\n'),
2119
1937
                      ('branch.conf', ''),
2120
1938
                      ('tags', ''),
2121
1939
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1940
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1941
 
2124
1942
    def _branch_class(self):
2125
1943
        return BzrBranch7
2160
1978
    def get_reference(self, a_bzrdir):
2161
1979
        """See BranchFormat.get_reference()."""
2162
1980
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1981
        return transport.get('location').read()
2164
1982
 
2165
1983
    def set_reference(self, a_bzrdir, to_branch):
2166
1984
        """See BranchFormat.set_reference()."""
2167
1985
        transport = a_bzrdir.get_branch_transport(None)
2168
1986
        location = transport.put_bytes('location', to_branch.base)
2169
1987
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1988
    def initialize(self, a_bzrdir, target_branch=None):
2171
1989
        """Create a branch of this format in a_bzrdir."""
2172
1990
        if target_branch is None:
2173
1991
            # this format does not implement branch itself, thus the implicit
2174
1992
            # creation contract must see it as uninitializable
2175
1993
            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)
 
1994
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1995
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1996
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1997
            target_branch.bzrdir.root_transport.base)
2180
1998
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1999
        return self.open(
 
2000
            a_bzrdir, _found=True,
2183
2001
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
2002
 
2187
2003
    def __init__(self):
2188
2004
        super(BranchReferenceFormat, self).__init__()
2194
2010
        def clone(to_bzrdir, revision_id=None,
2195
2011
            repository_policy=None):
2196
2012
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2013
            return format.initialize(to_bzrdir, a_branch)
2198
2014
            # cannot obey revision_id limits when cloning a reference ...
2199
2015
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
2016
            # emit some sort of warning/error to the caller ?!
2201
2017
        return clone
2202
2018
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2019
    def open(self, a_bzrdir, _found=False, location=None,
2204
2020
             possible_transports=None, ignore_fallbacks=False):
2205
2021
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2022
 
2207
2023
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
2024
        :param _found: a private parameter, do not use it. It is used to
2210
2025
            indicate if format probing has already be done.
2211
2026
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
2031
        :param possible_transports: An optional reusable transports list.
2217
2032
        """
2218
2033
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2034
            format = BranchFormat.find_format(a_bzrdir)
2220
2035
            if format.__class__ != self.__class__:
2221
2036
                raise AssertionError("wrong format %r found for %r" %
2222
2037
                    (format, self))
2224
2039
            location = self.get_reference(a_bzrdir)
2225
2040
        real_bzrdir = bzrdir.BzrDir.open(
2226
2041
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2042
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
2043
        # this changes the behaviour of result.clone to create a new reference
2230
2044
        # rather than a copy of the content of the branch.
2231
2045
        # I did not use a proxy object because that needs much more extensive
2265
2079
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2080
 
2267
2081
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2082
class BzrBranch(Branch):
2269
2083
    """A branch stored in the actual filesystem.
2270
2084
 
2271
2085
    Note that it's "local" in the context of the filesystem; it doesn't
2277
2091
    :ivar repository: Repository for this branch.
2278
2092
    :ivar base: The url of the base directory for this branch; the one
2279
2093
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
2094
    """
2283
2095
 
2284
2096
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2097
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2098
                 ignore_fallbacks=False):
2287
2099
        """Create new branch object at a particular location."""
2288
2100
        if a_bzrdir is None:
2289
2101
            raise ValueError('a_bzrdir must be supplied')
2290
2102
        else:
2291
2103
            self.bzrdir = a_bzrdir
2292
2104
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2105
        # XXX: We should be able to just do
2295
2106
        #   self.base = self.bzrdir.root_transport.base
2296
2107
        # but this does not quite work yet -- mbp 20080522
2303
2114
        Branch.__init__(self)
2304
2115
 
2305
2116
    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)
 
2117
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2118
 
2312
2119
    __repr__ = __str__
2313
2120
 
2324
2131
        return self.control_files.is_locked()
2325
2132
 
2326
2133
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2134
        # All-in-one needs to always unlock/lock.
2330
2135
        repo_control = getattr(self.repository, 'control_files', None)
2331
2136
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2137
            self.repository.lock_write()
2334
2138
            took_lock = True
2335
2139
        else:
2342
2146
            raise
2343
2147
 
2344
2148
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2149
        # All-in-one needs to always unlock/lock.
2348
2150
        repo_control = getattr(self.repository, 'control_files', None)
2349
2151
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2152
            self.repository.lock_read()
2352
2153
            took_lock = True
2353
2154
        else:
2359
2160
                self.repository.unlock()
2360
2161
            raise
2361
2162
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2163
    def unlock(self):
2364
2164
        try:
2365
2165
            self.control_files.unlock()
2528
2328
        return result
2529
2329
 
2530
2330
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2331
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2332
 
2533
2333
    def set_push_location(self, location):
2534
2334
        """See Branch.set_push_location."""
2724
2524
        if _mod_revision.is_null(last_revision):
2725
2525
            return
2726
2526
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2527
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2528
 
2729
2529
    def _gen_revision_history(self):
2730
2530
        """Generate the revision history from last revision
2830
2630
        if branch_location is None:
2831
2631
            return Branch.reference_parent(self, file_id, path,
2832
2632
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2633
        branch_location = urlutils.join(self.base, branch_location)
2834
2634
        return Branch.open(branch_location,
2835
2635
                           possible_transports=possible_transports)
2836
2636
 
2882
2682
        return stacked_url
2883
2683
 
2884
2684
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2685
        value = self.get_config().get_user_option('append_revisions_only')
 
2686
        return value == 'True'
2887
2687
 
2888
2688
    @needs_write_lock
2889
2689
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2751
    """
2952
2752
 
2953
2753
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2754
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2755
 
2956
2756
 
2957
2757
######################################################################
3044
2844
        :param verbose: Requests more detailed display of what was checked,
3045
2845
            if any.
3046
2846
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
 
2847
        note('checked branch %s format %s', self.branch.base,
3048
2848
            self.branch._format)
3049
2849
        for error in self.errors:
3050
2850
            note('found error:%s', error)
3379
3179
        if local and not bound_location:
3380
3180
            raise errors.LocalRequiresBoundBranch()
3381
3181
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3182
        if not local and bound_location and self.source.base != bound_location:
3383
3183
            # not pulling from master, so we need to update master.
3384
3184
            master_branch = self.target.get_master_branch(possible_transports)
3385
3185
            master_branch.lock_write()