← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2009-08-21 02:37:18 UTC
  • mto: This revision was merged to the branch mainline in revision 4636.
  • Revision ID: mbp@sourcefrog.net-20090821023718-sk686pzgg12m7p8t
Add test for CannotBindAddress

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.
283
285
        new_history.reverse()
284
286
        return new_history
285
287
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
288
    def lock_write(self):
293
289
        raise NotImplementedError(self.lock_write)
294
290
 
295
291
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
292
        raise NotImplementedError(self.lock_read)
302
293
 
303
294
    def unlock(self):
428
419
            * 'include' - the stop revision is the last item in the result
429
420
            * 'with-merges' - include the stop revision and all of its
430
421
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
422
        :param direction: either 'reverse' or 'forward':
434
423
            * reverse means return the start_revision_id first, i.e.
435
424
              start at the most recent revision and go backwards in history
457
446
        # start_revision_id.
458
447
        if self._merge_sorted_revisions_cache is None:
459
448
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
 
449
            last_key = (last_revision,)
 
450
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
451
                [last_key])
462
452
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
453
                last_key)
464
454
        filtered = self._filter_merge_sorted_revisions(
465
455
            self._merge_sorted_revisions_cache, start_revision_id,
466
456
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
457
        if direction == 'reverse':
471
458
            return filtered
472
459
        if direction == 'forward':
509
496
                       node.end_of_merge)
510
497
                if rev_id == stop_revision_id:
511
498
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
499
        elif stop_rule == 'with-merges':
525
500
            stop_rev = self.repository.get_revision(stop_revision_id)
526
501
            if stop_rev.parent_ids:
527
502
                left_parent = stop_rev.parent_ids[0]
528
503
            else:
529
504
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
505
            for node in rev_iter:
535
506
                rev_id = node.key[-1]
536
507
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
508
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
 
509
                yield (rev_id, node.merge_depth, node.revno,
542
510
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
549
511
        else:
550
512
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
513
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
514
    def leave_lock_in_place(self):
598
515
        """Tell this branch object not to release the physical lock when this
599
516
        object is unlocked.
616
533
        :param other: The branch to bind to
617
534
        :type other: Branch
618
535
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
536
        raise errors.UpgradeRequired(self.base)
620
537
 
621
538
    def set_append_revisions_only(self, enabled):
622
539
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
540
            raise errors.UpgradeRequired(self.base)
624
541
        if enabled:
625
542
            value = 'True'
626
543
        else:
674
591
    def get_old_bound_location(self):
675
592
        """Return the URL of the branch we used to be bound to
676
593
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
594
        raise errors.UpgradeRequired(self.base)
678
595
 
679
596
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
597
                           timezone=None, committer=None, revprops=None,
758
675
            stacking.
759
676
        """
760
677
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
678
            raise errors.UnstackableBranchFormat(self._format, self.base)
762
679
        # XXX: Changing from one fallback repository to another does not check
763
680
        # that all the data you need is present in the new fallback.
764
681
        # Possibly it should.
915
832
 
916
833
    def unbind(self):
917
834
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
835
        raise errors.UpgradeRequired(self.base)
919
836
 
920
837
    def last_revision(self):
921
838
        """Return last revision id, or NULL_REVISION."""
1081
998
        try:
1082
999
            return urlutils.join(self.base[:-1], parent)
1083
1000
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1001
            raise errors.InaccessibleParent(parent, self.base)
1085
1002
 
1086
1003
    def _get_parent_location(self):
1087
1004
        raise NotImplementedError(self._get_parent_location)
1172
1089
        params = ChangeBranchTipParams(
1173
1090
            self, old_revno, new_revno, old_revid, new_revid)
1174
1091
        for hook in hooks:
1175
 
            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)
1176
1101
 
1177
1102
    @needs_write_lock
1178
1103
    def update(self):
1359
1284
        # clone call. Or something. 20090224 RBC/spiv.
1360
1285
        if revision_id is None:
1361
1286
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            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
1365
1297
        return dir_to.open_branch()
1366
1298
 
1367
1299
    def create_checkout(self, to_location, revision_id=None,
1386
1318
        if lightweight:
1387
1319
            format = self._get_checkout_format()
1388
1320
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1321
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1322
        else:
1392
1323
            format = self._get_checkout_format()
1393
1324
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1366
    def supports_tags(self):
1436
1367
        return self._format.supports_tags()
1437
1368
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1369
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1370
                                         other_branch):
1452
1371
        """Ensure that revision_b is a descendant of revision_a.
1516
1435
        return not (self == other)
1517
1436
 
1518
1437
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1438
    def find_format(klass, a_bzrdir):
1520
1439
        """Return the format for the branch object in a_bzrdir."""
1521
1440
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1441
            transport = a_bzrdir.get_branch_transport(None)
 
1442
            format_string = transport.get("format").read()
1524
1443
            return klass._formats[format_string]
1525
1444
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1445
            raise errors.NotBranchError(path=transport.base)
1527
1446
        except KeyError:
1528
1447
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1448
 
1565
1484
        """Return the short format description for this format."""
1566
1485
        raise NotImplementedError(self.get_format_description)
1567
1486
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1487
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1488
                           set_format=True):
1578
1489
        """Initialize a branch in a bzrdir, with specified files
1579
1490
 
1580
1491
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1492
        :param utf8_files: The files to create as a list of
1582
1493
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1494
        :param set_format: If True, set the format with
1585
1495
            self.get_format_string.  (BzrBranch4 has its format set
1586
1496
            elsewhere)
1587
1497
        :return: a branch in this format
1588
1498
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        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)
1591
1501
        lock_map = {
1592
1502
            'metadir': ('lock', lockdir.LockDir),
1593
1503
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1524
        finally:
1615
1525
            if lock_taken:
1616
1526
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1527
        return self.open(a_bzrdir, _found=True)
1620
1528
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1529
    def initialize(self, a_bzrdir):
 
1530
        """Create a branch of this format in a_bzrdir."""
1626
1531
        raise NotImplementedError(self.initialize)
1627
1532
 
1628
1533
    def is_supported(self):
1658
1563
        """
1659
1564
        raise NotImplementedError(self.network_name)
1660
1565
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1566
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1567
        """Return the branch object for a_bzrdir
1663
1568
 
1664
1569
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1570
        :param _found: a private parameter, do not use it. It is used to
1667
1571
            indicate if format probing has already be done.
1668
1572
        :param ignore_fallbacks: when set, no fallback branches will be opened
1776
1680
            "multiple hooks installed for transform_fallback_location, "
1777
1681
            "all are called with the url returned from the previous hook."
1778
1682
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1683
 
1797
1684
 
1798
1685
# install the default hooks into the Branch class.
1837
1724
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1725
 
1839
1726
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1727
class BzrBranchFormat4(BranchFormat):
1919
1728
    """Bzr branch format 4.
1920
1729
 
1927
1736
        """See BranchFormat.get_format_description()."""
1928
1737
        return "Branch format 4"
1929
1738
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1739
    def initialize(self, a_bzrdir):
1931
1740
        """Create a branch of this format in a_bzrdir."""
1932
1741
        utf8_files = [('revision-history', ''),
1933
1742
                      ('branch-name', ''),
1934
1743
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1744
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1745
                                       lock_type='branch4', set_format=False)
1937
1746
 
1938
1747
    def __init__(self):
1943
1752
        """The network name for this format is the control dirs disk label."""
1944
1753
        return self._matchingbzrdir.get_format_string()
1945
1754
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1755
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1756
        """See BranchFormat.open()."""
1948
1757
        if not _found:
1949
1758
            # we are being called directly and must probe.
1951
1760
        return BzrBranch(_format=self,
1952
1761
                         _control_files=a_bzrdir._control_files,
1953
1762
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1763
                         _repository=a_bzrdir.open_repository())
1956
1764
 
1957
1765
    def __str__(self):
1972
1780
        """
1973
1781
        return self.get_format_string()
1974
1782
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1783
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1784
        """See BranchFormat.open()."""
1977
1785
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1786
            format = BranchFormat.find_format(a_bzrdir)
1979
1787
            if format.__class__ != self.__class__:
1980
1788
                raise AssertionError("wrong format %r found for %r" %
1981
1789
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1790
        try:
 
1791
            transport = a_bzrdir.get_branch_transport(None)
1984
1792
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1793
                                                         lockdir.LockDir)
1986
1794
            return self._branch_class()(_format=self,
1987
1795
                              _control_files=control_files,
1988
 
                              name=name,
1989
1796
                              a_bzrdir=a_bzrdir,
1990
1797
                              _repository=a_bzrdir.find_repository(),
1991
1798
                              ignore_fallbacks=ignore_fallbacks)
1992
1799
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1800
            raise errors.NotBranchError(path=transport.base)
1994
1801
 
1995
1802
    def __init__(self):
1996
1803
        super(BranchFormatMetadir, self).__init__()
2025
1832
        """See BranchFormat.get_format_description()."""
2026
1833
        return "Branch format 5"
2027
1834
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1835
    def initialize(self, a_bzrdir):
2029
1836
        """Create a branch of this format in a_bzrdir."""
2030
1837
        utf8_files = [('revision-history', ''),
2031
1838
                      ('branch-name', ''),
2032
1839
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1840
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1841
 
2035
1842
    def supports_tags(self):
2036
1843
        return False
2058
1865
        """See BranchFormat.get_format_description()."""
2059
1866
        return "Branch format 6"
2060
1867
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1868
    def initialize(self, a_bzrdir):
2062
1869
        """Create a branch of this format in a_bzrdir."""
2063
1870
        utf8_files = [('last-revision', '0 null:\n'),
2064
1871
                      ('branch.conf', ''),
2065
1872
                      ('tags', ''),
2066
1873
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1874
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1875
 
2069
1876
    def make_tags(self, branch):
2070
1877
        """See bzrlib.branch.BranchFormat.make_tags()."""
2088
1895
        """See BranchFormat.get_format_description()."""
2089
1896
        return "Branch format 8"
2090
1897
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1898
    def initialize(self, a_bzrdir):
2092
1899
        """Create a branch of this format in a_bzrdir."""
2093
1900
        utf8_files = [('last-revision', '0 null:\n'),
2094
1901
                      ('branch.conf', ''),
2095
1902
                      ('tags', ''),
2096
1903
                      ('references', '')
2097
1904
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1905
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1906
 
2100
1907
    def __init__(self):
2101
1908
        super(BzrBranchFormat8, self).__init__()
2124
1931
    This format was introduced in bzr 1.6.
2125
1932
    """
2126
1933
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1934
    def initialize(self, a_bzrdir):
2128
1935
        """Create a branch of this format in a_bzrdir."""
2129
1936
        utf8_files = [('last-revision', '0 null:\n'),
2130
1937
                      ('branch.conf', ''),
2131
1938
                      ('tags', ''),
2132
1939
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1940
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1941
 
2135
1942
    def _branch_class(self):
2136
1943
        return BzrBranch7
2171
1978
    def get_reference(self, a_bzrdir):
2172
1979
        """See BranchFormat.get_reference()."""
2173
1980
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1981
        return transport.get('location').read()
2175
1982
 
2176
1983
    def set_reference(self, a_bzrdir, to_branch):
2177
1984
        """See BranchFormat.set_reference()."""
2178
1985
        transport = a_bzrdir.get_branch_transport(None)
2179
1986
        location = transport.put_bytes('location', to_branch.base)
2180
1987
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1988
    def initialize(self, a_bzrdir, target_branch=None):
2182
1989
        """Create a branch of this format in a_bzrdir."""
2183
1990
        if target_branch is None:
2184
1991
            # this format does not implement branch itself, thus the implicit
2185
1992
            # creation contract must see it as uninitializable
2186
1993
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        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)
2189
1996
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1997
            target_branch.bzrdir.root_transport.base)
2191
1998
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1999
        return self.open(
 
2000
            a_bzrdir, _found=True,
2194
2001
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
2002
 
2198
2003
    def __init__(self):
2199
2004
        super(BranchReferenceFormat, self).__init__()
2205
2010
        def clone(to_bzrdir, revision_id=None,
2206
2011
            repository_policy=None):
2207
2012
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2013
            return format.initialize(to_bzrdir, a_branch)
2209
2014
            # cannot obey revision_id limits when cloning a reference ...
2210
2015
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
2016
            # emit some sort of warning/error to the caller ?!
2212
2017
        return clone
2213
2018
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2019
    def open(self, a_bzrdir, _found=False, location=None,
2215
2020
             possible_transports=None, ignore_fallbacks=False):
2216
2021
        """Return the branch that the branch reference in a_bzrdir points at.
2217
2022
 
2218
2023
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
2024
        :param _found: a private parameter, do not use it. It is used to
2221
2025
            indicate if format probing has already be done.
2222
2026
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
2031
        :param possible_transports: An optional reusable transports list.
2228
2032
        """
2229
2033
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2034
            format = BranchFormat.find_format(a_bzrdir)
2231
2035
            if format.__class__ != self.__class__:
2232
2036
                raise AssertionError("wrong format %r found for %r" %
2233
2037
                    (format, self))
2235
2039
            location = self.get_reference(a_bzrdir)
2236
2040
        real_bzrdir = bzrdir.BzrDir.open(
2237
2041
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
2042
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2043
        # this changes the behaviour of result.clone to create a new reference
2241
2044
        # rather than a copy of the content of the branch.
2242
2045
        # I did not use a proxy object because that needs much more extensive
2276
2079
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2080
 
2278
2081
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
    def __str__(self):
2292
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
 
            self.unlock)
2294
 
 
2295
 
 
2296
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2082
class BzrBranch(Branch):
2297
2083
    """A branch stored in the actual filesystem.
2298
2084
 
2299
2085
    Note that it's "local" in the context of the filesystem; it doesn't
2305
2091
    :ivar repository: Repository for this branch.
2306
2092
    :ivar base: The url of the base directory for this branch; the one
2307
2093
        containing the .bzr directory.
2308
 
    :ivar name: Optional colocated branch name as it exists in the control
2309
 
        directory.
2310
2094
    """
2311
2095
 
2312
2096
    def __init__(self, _format=None,
2313
 
                 _control_files=None, a_bzrdir=None, name=None,
2314
 
                 _repository=None, ignore_fallbacks=False):
 
2097
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2098
                 ignore_fallbacks=False):
2315
2099
        """Create new branch object at a particular location."""
2316
2100
        if a_bzrdir is None:
2317
2101
            raise ValueError('a_bzrdir must be supplied')
2318
2102
        else:
2319
2103
            self.bzrdir = a_bzrdir
2320
2104
        self._base = self.bzrdir.transport.clone('..').base
2321
 
        self.name = name
2322
2105
        # XXX: We should be able to just do
2323
2106
        #   self.base = self.bzrdir.root_transport.base
2324
2107
        # but this does not quite work yet -- mbp 20080522
2331
2114
        Branch.__init__(self)
2332
2115
 
2333
2116
    def __str__(self):
2334
 
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
 
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
2117
        return '%s(%r)' % (self.__class__.__name__, self.base)
2339
2118
 
2340
2119
    __repr__ = __str__
2341
2120
 
2352
2131
        return self.control_files.is_locked()
2353
2132
 
2354
2133
    def lock_write(self, token=None):
2355
 
        """Lock the branch for write operations.
2356
 
 
2357
 
        :param token: A token to permit reacquiring a previously held and
2358
 
            preserved lock.
2359
 
        :return: A BranchWriteLockResult.
2360
 
        """
2361
 
        if not self.is_locked():
2362
 
            self._note_lock('w')
2363
2134
        # All-in-one needs to always unlock/lock.
2364
2135
        repo_control = getattr(self.repository, 'control_files', None)
2365
2136
        if self.control_files == repo_control or not self.is_locked():
2366
 
            self.repository._warn_if_deprecated(self)
2367
2137
            self.repository.lock_write()
2368
2138
            took_lock = True
2369
2139
        else:
2370
2140
            took_lock = False
2371
2141
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
2142
            return self.control_files.lock_write(token=token)
2374
2143
        except:
2375
2144
            if took_lock:
2376
2145
                self.repository.unlock()
2377
2146
            raise
2378
2147
 
2379
2148
    def lock_read(self):
2380
 
        """Lock the branch for read operations.
2381
 
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
2384
 
        """
2385
 
        if not self.is_locked():
2386
 
            self._note_lock('r')
2387
2149
        # All-in-one needs to always unlock/lock.
2388
2150
        repo_control = getattr(self.repository, 'control_files', None)
2389
2151
        if self.control_files == repo_control or not self.is_locked():
2390
 
            self.repository._warn_if_deprecated(self)
2391
2152
            self.repository.lock_read()
2392
2153
            took_lock = True
2393
2154
        else:
2394
2155
            took_lock = False
2395
2156
        try:
2396
2157
            self.control_files.lock_read()
2397
 
            return self
2398
2158
        except:
2399
2159
            if took_lock:
2400
2160
                self.repository.unlock()
2401
2161
            raise
2402
2162
 
2403
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2404
2163
    def unlock(self):
2405
2164
        try:
2406
2165
            self.control_files.unlock()
2569
2328
        return result
2570
2329
 
2571
2330
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2331
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2332
 
2574
2333
    def set_push_location(self, location):
2575
2334
        """See Branch.set_push_location."""
2765
2524
        if _mod_revision.is_null(last_revision):
2766
2525
            return
2767
2526
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2527
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2528
 
2770
2529
    def _gen_revision_history(self):
2771
2530
        """Generate the revision history from last revision
2871
2630
        if branch_location is None:
2872
2631
            return Branch.reference_parent(self, file_id, path,
2873
2632
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2633
        branch_location = urlutils.join(self.base, branch_location)
2875
2634
        return Branch.open(branch_location,
2876
2635
                           possible_transports=possible_transports)
2877
2636
 
2923
2682
        return stacked_url
2924
2683
 
2925
2684
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2685
        value = self.get_config().get_user_option('append_revisions_only')
 
2686
        return value == 'True'
2928
2687
 
2929
2688
    @needs_write_lock
2930
2689
    def generate_revision_history(self, revision_id, last_rev=None,
2992
2751
    """
2993
2752
 
2994
2753
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2754
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2755
 
2997
2756
 
2998
2757
######################################################################
3085
2844
        :param verbose: Requests more detailed display of what was checked,
3086
2845
            if any.
3087
2846
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
 
2847
        note('checked branch %s format %s', self.branch.base,
3089
2848
            self.branch._format)
3090
2849
        for error in self.errors:
3091
2850
            note('found error:%s', error)
3420
3179
        if local and not bound_location:
3421
3180
            raise errors.LocalRequiresBoundBranch()
3422
3181
        master_branch = None
3423
 
        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:
3424
3183
            # not pulling from master, so we need to update master.
3425
3184
            master_branch = self.target.get_master_branch(possible_transports)
3426
3185
            master_branch.lock_write()