/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: Andrew Bennetts
  • Date: 2009-08-13 00:20:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4608.
  • Revision ID: andrew.bennetts@canonical.com-20090813002029-akc5x2mtxa8rq068
Raise InventoryDeltaErrors, not generic BzrErrors, from inventory_delta.py.

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])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
449
            graph = self.repository.get_graph()
 
450
            parent_map = dict(((key, value) for key, value in
 
451
                     graph.iter_ancestry([last_revision]) if value is not None))
 
452
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
453
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
454
                generate_revno=True)
 
455
            # Drop the sequence # before caching
 
456
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
457
 
453
458
        filtered = self._filter_merge_sorted_revisions(
454
459
            self._merge_sorted_revisions_cache, start_revision_id,
455
460
            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
461
        if direction == 'reverse':
460
462
            return filtered
461
463
        if direction == 'forward':
468
470
        """Iterate over an inclusive range of sorted revisions."""
469
471
        rev_iter = iter(merge_sorted_revisions)
470
472
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
473
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
474
                if rev_id != start_revision_id:
474
475
                    continue
475
476
                else:
476
477
                    # The decision to include the start or not
477
478
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
479
                    rev_iter = chain(
 
480
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
481
                        rev_iter)
480
482
                    break
481
483
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
484
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
485
                yield rev_id, depth, revno, end_of_merge
487
486
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
487
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
488
                if rev_id == stop_revision_id:
491
489
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
490
                yield rev_id, depth, revno, end_of_merge
494
491
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
492
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
493
                yield rev_id, depth, revno, end_of_merge
499
494
                if rev_id == stop_revision_id:
500
495
                    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
496
        elif stop_rule == 'with-merges':
514
497
            stop_rev = self.repository.get_revision(stop_revision_id)
515
498
            if stop_rev.parent_ids:
516
499
                left_parent = stop_rev.parent_ids[0]
517
500
            else:
518
501
                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
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
502
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
503
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
504
                    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,
531
 
                       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)
 
505
                yield rev_id, depth, revno, end_of_merge
538
506
        else:
539
507
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
508
 
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
509
    def leave_lock_in_place(self):
587
510
        """Tell this branch object not to release the physical lock when this
588
511
        object is unlocked.
605
528
        :param other: The branch to bind to
606
529
        :type other: Branch
607
530
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
 
531
        raise errors.UpgradeRequired(self.base)
609
532
 
610
533
    def set_append_revisions_only(self, enabled):
611
534
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
 
535
            raise errors.UpgradeRequired(self.base)
613
536
        if enabled:
614
537
            value = 'True'
615
538
        else:
663
586
    def get_old_bound_location(self):
664
587
        """Return the URL of the branch we used to be bound to
665
588
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
589
        raise errors.UpgradeRequired(self.base)
667
590
 
668
591
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
592
                           timezone=None, committer=None, revprops=None,
747
670
            stacking.
748
671
        """
749
672
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
673
            raise errors.UnstackableBranchFormat(self._format, self.base)
751
674
        # XXX: Changing from one fallback repository to another does not check
752
675
        # that all the data you need is present in the new fallback.
753
676
        # Possibly it should.
904
827
 
905
828
    def unbind(self):
906
829
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
830
        raise errors.UpgradeRequired(self.base)
908
831
 
909
832
    def last_revision(self):
910
833
        """Return last revision id, or NULL_REVISION."""
1070
993
        try:
1071
994
            return urlutils.join(self.base[:-1], parent)
1072
995
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
996
            raise errors.InaccessibleParent(parent, self.base)
1074
997
 
1075
998
    def _get_parent_location(self):
1076
999
        raise NotImplementedError(self._get_parent_location)
1161
1084
        params = ChangeBranchTipParams(
1162
1085
            self, old_revno, new_revno, old_revid, new_revid)
1163
1086
        for hook in hooks:
1164
 
            hook(params)
 
1087
            try:
 
1088
                hook(params)
 
1089
            except errors.TipChangeRejected:
 
1090
                raise
 
1091
            except Exception:
 
1092
                exc_info = sys.exc_info()
 
1093
                hook_name = Branch.hooks.get_hook_name(hook)
 
1094
                raise errors.HookFailed(
 
1095
                    'pre_change_branch_tip', hook_name, exc_info)
1165
1096
 
1166
1097
    @needs_write_lock
1167
1098
    def update(self):
1216
1147
        revision_id: if not None, the revision history in the new branch will
1217
1148
                     be truncated to end with revision_id.
1218
1149
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1150
        result = to_bzrdir.create_branch()
1223
1151
        result.lock_write()
1224
1152
        try:
1348
1276
        # clone call. Or something. 20090224 RBC/spiv.
1349
1277
        if revision_id is None:
1350
1278
            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)
 
1279
        try:
 
1280
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1281
                revision_id=revision_id, stacked_on=stacked_on,
 
1282
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1283
        except errors.FileExists:
 
1284
            if not use_existing_dir:
 
1285
                raise
 
1286
        except errors.NoSuchFile:
 
1287
            if not create_prefix:
 
1288
                raise
1354
1289
        return dir_to.open_branch()
1355
1290
 
1356
1291
    def create_checkout(self, to_location, revision_id=None,
1375
1310
        if lightweight:
1376
1311
            format = self._get_checkout_format()
1377
1312
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1313
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1314
        else:
1381
1315
            format = self._get_checkout_format()
1382
1316
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1358
    def supports_tags(self):
1425
1359
        return self._format.supports_tags()
1426
1360
 
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
1361
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1362
                                         other_branch):
1441
1363
        """Ensure that revision_b is a descendant of revision_a.
1505
1427
        return not (self == other)
1506
1428
 
1507
1429
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1430
    def find_format(klass, a_bzrdir):
1509
1431
        """Return the format for the branch object in a_bzrdir."""
1510
1432
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1433
            transport = a_bzrdir.get_branch_transport(None)
 
1434
            format_string = transport.get("format").read()
1513
1435
            return klass._formats[format_string]
1514
1436
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1437
            raise errors.NotBranchError(path=transport.base)
1516
1438
        except KeyError:
1517
1439
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1440
 
1554
1476
        """Return the short format description for this format."""
1555
1477
        raise NotImplementedError(self.get_format_description)
1556
1478
 
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):
 
1479
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1480
                           set_format=True):
1567
1481
        """Initialize a branch in a bzrdir, with specified files
1568
1482
 
1569
1483
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1484
        :param utf8_files: The files to create as a list of
1571
1485
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1486
        :param set_format: If True, set the format with
1574
1487
            self.get_format_string.  (BzrBranch4 has its format set
1575
1488
            elsewhere)
1576
1489
        :return: a branch in this format
1577
1490
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1491
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1492
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1493
        lock_map = {
1581
1494
            'metadir': ('lock', lockdir.LockDir),
1582
1495
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1516
        finally:
1604
1517
            if lock_taken:
1605
1518
                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
 
1519
        return self.open(a_bzrdir, _found=True)
1609
1520
 
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
 
        """
 
1521
    def initialize(self, a_bzrdir):
 
1522
        """Create a branch of this format in a_bzrdir."""
1615
1523
        raise NotImplementedError(self.initialize)
1616
1524
 
1617
1525
    def is_supported(self):
1647
1555
        """
1648
1556
        raise NotImplementedError(self.network_name)
1649
1557
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1558
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1559
        """Return the branch object for a_bzrdir
1652
1560
 
1653
1561
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1562
        :param _found: a private parameter, do not use it. It is used to
1656
1563
            indicate if format probing has already be done.
1657
1564
        :param ignore_fallbacks: when set, no fallback branches will be opened
1765
1672
            "multiple hooks installed for transform_fallback_location, "
1766
1673
            "all are called with the url returned from the previous hook."
1767
1674
            "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
1675
 
1786
1676
 
1787
1677
# install the default hooks into the Branch class.
1826
1716
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1717
 
1828
1718
 
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
1719
class BzrBranchFormat4(BranchFormat):
1908
1720
    """Bzr branch format 4.
1909
1721
 
1916
1728
        """See BranchFormat.get_format_description()."""
1917
1729
        return "Branch format 4"
1918
1730
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1731
    def initialize(self, a_bzrdir):
1920
1732
        """Create a branch of this format in a_bzrdir."""
1921
1733
        utf8_files = [('revision-history', ''),
1922
1734
                      ('branch-name', ''),
1923
1735
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1736
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1737
                                       lock_type='branch4', set_format=False)
1926
1738
 
1927
1739
    def __init__(self):
1932
1744
        """The network name for this format is the control dirs disk label."""
1933
1745
        return self._matchingbzrdir.get_format_string()
1934
1746
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1747
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1748
        """See BranchFormat.open()."""
1937
1749
        if not _found:
1938
1750
            # we are being called directly and must probe.
1940
1752
        return BzrBranch(_format=self,
1941
1753
                         _control_files=a_bzrdir._control_files,
1942
1754
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1755
                         _repository=a_bzrdir.open_repository())
1945
1756
 
1946
1757
    def __str__(self):
1961
1772
        """
1962
1773
        return self.get_format_string()
1963
1774
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1775
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1776
        """See BranchFormat.open()."""
1966
1777
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1778
            format = BranchFormat.find_format(a_bzrdir)
1968
1779
            if format.__class__ != self.__class__:
1969
1780
                raise AssertionError("wrong format %r found for %r" %
1970
1781
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1782
        try:
 
1783
            transport = a_bzrdir.get_branch_transport(None)
1973
1784
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1785
                                                         lockdir.LockDir)
1975
1786
            return self._branch_class()(_format=self,
1976
1787
                              _control_files=control_files,
1977
 
                              name=name,
1978
1788
                              a_bzrdir=a_bzrdir,
1979
1789
                              _repository=a_bzrdir.find_repository(),
1980
1790
                              ignore_fallbacks=ignore_fallbacks)
1981
1791
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1792
            raise errors.NotBranchError(path=transport.base)
1983
1793
 
1984
1794
    def __init__(self):
1985
1795
        super(BranchFormatMetadir, self).__init__()
2014
1824
        """See BranchFormat.get_format_description()."""
2015
1825
        return "Branch format 5"
2016
1826
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1827
    def initialize(self, a_bzrdir):
2018
1828
        """Create a branch of this format in a_bzrdir."""
2019
1829
        utf8_files = [('revision-history', ''),
2020
1830
                      ('branch-name', ''),
2021
1831
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1832
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1833
 
2024
1834
    def supports_tags(self):
2025
1835
        return False
2047
1857
        """See BranchFormat.get_format_description()."""
2048
1858
        return "Branch format 6"
2049
1859
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1860
    def initialize(self, a_bzrdir):
2051
1861
        """Create a branch of this format in a_bzrdir."""
2052
1862
        utf8_files = [('last-revision', '0 null:\n'),
2053
1863
                      ('branch.conf', ''),
2054
1864
                      ('tags', ''),
2055
1865
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1866
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1867
 
2058
1868
    def make_tags(self, branch):
2059
1869
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
1887
        """See BranchFormat.get_format_description()."""
2078
1888
        return "Branch format 8"
2079
1889
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1890
    def initialize(self, a_bzrdir):
2081
1891
        """Create a branch of this format in a_bzrdir."""
2082
1892
        utf8_files = [('last-revision', '0 null:\n'),
2083
1893
                      ('branch.conf', ''),
2084
1894
                      ('tags', ''),
2085
1895
                      ('references', '')
2086
1896
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1897
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1898
 
2089
1899
    def __init__(self):
2090
1900
        super(BzrBranchFormat8, self).__init__()
2113
1923
    This format was introduced in bzr 1.6.
2114
1924
    """
2115
1925
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1926
    def initialize(self, a_bzrdir):
2117
1927
        """Create a branch of this format in a_bzrdir."""
2118
1928
        utf8_files = [('last-revision', '0 null:\n'),
2119
1929
                      ('branch.conf', ''),
2120
1930
                      ('tags', ''),
2121
1931
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1932
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1933
 
2124
1934
    def _branch_class(self):
2125
1935
        return BzrBranch7
2160
1970
    def get_reference(self, a_bzrdir):
2161
1971
        """See BranchFormat.get_reference()."""
2162
1972
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1973
        return transport.get('location').read()
2164
1974
 
2165
1975
    def set_reference(self, a_bzrdir, to_branch):
2166
1976
        """See BranchFormat.set_reference()."""
2167
1977
        transport = a_bzrdir.get_branch_transport(None)
2168
1978
        location = transport.put_bytes('location', to_branch.base)
2169
1979
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1980
    def initialize(self, a_bzrdir, target_branch=None):
2171
1981
        """Create a branch of this format in a_bzrdir."""
2172
1982
        if target_branch is None:
2173
1983
            # this format does not implement branch itself, thus the implicit
2174
1984
            # creation contract must see it as uninitializable
2175
1985
            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)
 
1986
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1987
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1988
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1989
            target_branch.bzrdir.root_transport.base)
2180
1990
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1991
        return self.open(
 
1992
            a_bzrdir, _found=True,
2183
1993
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1994
 
2187
1995
    def __init__(self):
2188
1996
        super(BranchReferenceFormat, self).__init__()
2194
2002
        def clone(to_bzrdir, revision_id=None,
2195
2003
            repository_policy=None):
2196
2004
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2005
            return format.initialize(to_bzrdir, a_branch)
2198
2006
            # cannot obey revision_id limits when cloning a reference ...
2199
2007
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
2008
            # emit some sort of warning/error to the caller ?!
2201
2009
        return clone
2202
2010
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2011
    def open(self, a_bzrdir, _found=False, location=None,
2204
2012
             possible_transports=None, ignore_fallbacks=False):
2205
2013
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2014
 
2207
2015
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
2016
        :param _found: a private parameter, do not use it. It is used to
2210
2017
            indicate if format probing has already be done.
2211
2018
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
2023
        :param possible_transports: An optional reusable transports list.
2217
2024
        """
2218
2025
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2026
            format = BranchFormat.find_format(a_bzrdir)
2220
2027
            if format.__class__ != self.__class__:
2221
2028
                raise AssertionError("wrong format %r found for %r" %
2222
2029
                    (format, self))
2224
2031
            location = self.get_reference(a_bzrdir)
2225
2032
        real_bzrdir = bzrdir.BzrDir.open(
2226
2033
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2034
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
2035
        # this changes the behaviour of result.clone to create a new reference
2230
2036
        # rather than a copy of the content of the branch.
2231
2037
        # I did not use a proxy object because that needs much more extensive
2258
2064
BranchFormat.register_format(__format6)
2259
2065
BranchFormat.register_format(__format7)
2260
2066
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
2067
BranchFormat.set_default_format(__format6)
2262
2068
_legacy_formats = [BzrBranchFormat4(),
2263
2069
    ]
2264
2070
network_format_registry.register(
2265
2071
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2072
 
2267
2073
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2074
class BzrBranch(Branch):
2269
2075
    """A branch stored in the actual filesystem.
2270
2076
 
2271
2077
    Note that it's "local" in the context of the filesystem; it doesn't
2277
2083
    :ivar repository: Repository for this branch.
2278
2084
    :ivar base: The url of the base directory for this branch; the one
2279
2085
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
2086
    """
2283
2087
 
2284
2088
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2089
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2090
                 ignore_fallbacks=False):
2287
2091
        """Create new branch object at a particular location."""
2288
2092
        if a_bzrdir is None:
2289
2093
            raise ValueError('a_bzrdir must be supplied')
2290
2094
        else:
2291
2095
            self.bzrdir = a_bzrdir
2292
2096
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2097
        # XXX: We should be able to just do
2295
2098
        #   self.base = self.bzrdir.root_transport.base
2296
2099
        # but this does not quite work yet -- mbp 20080522
2303
2106
        Branch.__init__(self)
2304
2107
 
2305
2108
    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)
 
2109
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2110
 
2312
2111
    __repr__ = __str__
2313
2112
 
2324
2123
        return self.control_files.is_locked()
2325
2124
 
2326
2125
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2126
        # All-in-one needs to always unlock/lock.
2330
2127
        repo_control = getattr(self.repository, 'control_files', None)
2331
2128
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2129
            self.repository.lock_write()
2334
2130
            took_lock = True
2335
2131
        else:
2342
2138
            raise
2343
2139
 
2344
2140
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2141
        # All-in-one needs to always unlock/lock.
2348
2142
        repo_control = getattr(self.repository, 'control_files', None)
2349
2143
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2144
            self.repository.lock_read()
2352
2145
            took_lock = True
2353
2146
        else:
2359
2152
                self.repository.unlock()
2360
2153
            raise
2361
2154
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2155
    def unlock(self):
2364
2156
        try:
2365
2157
            self.control_files.unlock()
2528
2320
        return result
2529
2321
 
2530
2322
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2323
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2324
 
2533
2325
    def set_push_location(self, location):
2534
2326
        """See Branch.set_push_location."""
2724
2516
        if _mod_revision.is_null(last_revision):
2725
2517
            return
2726
2518
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2519
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2520
 
2729
2521
    def _gen_revision_history(self):
2730
2522
        """Generate the revision history from last revision
2830
2622
        if branch_location is None:
2831
2623
            return Branch.reference_parent(self, file_id, path,
2832
2624
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2625
        branch_location = urlutils.join(self.base, branch_location)
2834
2626
        return Branch.open(branch_location,
2835
2627
                           possible_transports=possible_transports)
2836
2628
 
2882
2674
        return stacked_url
2883
2675
 
2884
2676
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2677
        value = self.get_config().get_user_option('append_revisions_only')
 
2678
        return value == 'True'
2887
2679
 
2888
2680
    @needs_write_lock
2889
2681
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2743
    """
2952
2744
 
2953
2745
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2746
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2747
 
2956
2748
 
2957
2749
######################################################################
3044
2836
        :param verbose: Requests more detailed display of what was checked,
3045
2837
            if any.
3046
2838
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
 
2839
        note('checked branch %s format %s', self.branch.base,
3048
2840
            self.branch._format)
3049
2841
        for error in self.errors:
3050
2842
            note('found error:%s', error)
3379
3171
        if local and not bound_location:
3380
3172
            raise errors.LocalRequiresBoundBranch()
3381
3173
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3174
        if not local and bound_location and self.source.base != bound_location:
3383
3175
            # not pulling from master, so we need to update master.
3384
3176
            master_branch = self.target.get_master_branch(possible_transports)
3385
3177
            master_branch.lock_write()