/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-26 16:03:59 UTC
  • mto: (4634.6.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4660.
  • Revision ID: john@arbash-meinel.com-20090826160359-ge4mai928bi3a5g2
https://launchpad.net/bugs/419241
Fix bug #419241. If a graph had a mainline ghost
we could get a segfault during KnownGraph.merge_sort().

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