/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: David Roberts
  • Date: 2009-12-02 11:03:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4855.
  • Revision ID: smartgpx@gmail.com-20091202110335-0f0agsoclm64l5ke
Delete unnecessary PUSH of a CHECKOUT

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
49
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
53
53
from bzrlib import registry
54
54
from bzrlib.symbol_versioning import (
55
55
    deprecated_in,
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
64
 
65
65
 
66
 
class Branch(bzrdir.ControlComponent):
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
67
79
    """Branch holding a history of revisions.
68
80
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
81
    base
 
82
        Base directory/url of the branch.
72
83
 
73
84
    hooks: An instance of BranchHooks.
74
85
    """
76
87
    # - RBC 20060112
77
88
    base = None
78
89
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
90
    def __init__(self, *ignored, **ignored_too):
88
91
        self.tags = self._format.make_tags(self)
89
92
        self._revision_history_cache = None
104
107
        """Activate the branch/repository from url as a fallback repository."""
105
108
        repo = self._get_fallback_repository(url)
106
109
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
164
167
        """
165
168
        control = bzrdir.BzrDir.open(base, _unsupported,
166
169
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
170
        return control.open_branch(_unsupported)
168
171
 
169
172
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
173
    def open_from_transport(transport, _unsupported=False):
171
174
        """Open the branch rooted at transport"""
172
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
176
        return control.open_branch(_unsupported)
174
177
 
175
178
    @staticmethod
176
179
    def open_containing(url, possible_transports=None):
214
217
    def _get_fallback_repository(self, url):
215
218
        """Get the repository we fallback to at url."""
216
219
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
218
221
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
222
        return a_bzrdir.open_branch().repository
220
223
 
221
224
    def _get_tags_bytes(self):
222
225
        """Get the bytes of a serialised tags dict.
283
286
        new_history.reverse()
284
287
        return new_history
285
288
 
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
 
        """
 
289
    def lock_write(self):
293
290
        raise NotImplementedError(self.lock_write)
294
291
 
295
292
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
293
        raise NotImplementedError(self.lock_read)
301
294
 
302
295
    def unlock(self):
427
420
            * 'include' - the stop revision is the last item in the result
428
421
            * 'with-merges' - include the stop revision and all of its
429
422
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
423
        :param direction: either 'reverse' or 'forward':
433
424
            * reverse means return the start_revision_id first, i.e.
434
425
              start at the most recent revision and go backwards in history
456
447
        # start_revision_id.
457
448
        if self._merge_sorted_revisions_cache is None:
458
449
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
461
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                last_revision)
 
454
                last_key)
463
455
        filtered = self._filter_merge_sorted_revisions(
464
456
            self._merge_sorted_revisions_cache, start_revision_id,
465
457
            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
458
        if direction == 'reverse':
470
459
            return filtered
471
460
        if direction == 'forward':
508
497
                       node.end_of_merge)
509
498
                if rev_id == stop_revision_id:
510
499
                    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
500
        elif stop_rule == 'with-merges':
524
501
            stop_rev = self.repository.get_revision(stop_revision_id)
525
502
            if stop_rev.parent_ids:
526
503
                left_parent = stop_rev.parent_ids[0]
527
504
            else:
528
505
                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
506
            for node in rev_iter:
534
507
                rev_id = node.key[-1]
535
508
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
509
                    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,
 
510
                yield (rev_id, node.merge_depth, node.revno,
541
511
                       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
512
        else:
549
513
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
514
 
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
515
    def leave_lock_in_place(self):
597
516
        """Tell this branch object not to release the physical lock when this
598
517
        object is unlocked.
615
534
        :param other: The branch to bind to
616
535
        :type other: Branch
617
536
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
 
537
        raise errors.UpgradeRequired(self.base)
619
538
 
620
539
    def set_append_revisions_only(self, enabled):
621
540
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
 
541
            raise errors.UpgradeRequired(self.base)
623
542
        if enabled:
624
543
            value = 'True'
625
544
        else:
673
592
    def get_old_bound_location(self):
674
593
        """Return the URL of the branch we used to be bound to
675
594
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
595
        raise errors.UpgradeRequired(self.base)
677
596
 
678
597
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
598
                           timezone=None, committer=None, revprops=None,
757
676
            stacking.
758
677
        """
759
678
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
679
            raise errors.UnstackableBranchFormat(self._format, self.base)
761
680
        # XXX: Changing from one fallback repository to another does not check
762
681
        # that all the data you need is present in the new fallback.
763
682
        # Possibly it should.
914
833
 
915
834
    def unbind(self):
916
835
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
836
        raise errors.UpgradeRequired(self.base)
918
837
 
919
838
    def last_revision(self):
920
839
        """Return last revision id, or NULL_REVISION."""
1080
999
        try:
1081
1000
            return urlutils.join(self.base[:-1], parent)
1082
1001
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1002
            raise errors.InaccessibleParent(parent, self.base)
1084
1003
 
1085
1004
    def _get_parent_location(self):
1086
1005
        raise NotImplementedError(self._get_parent_location)
1171
1090
        params = ChangeBranchTipParams(
1172
1091
            self, old_revno, new_revno, old_revid, new_revid)
1173
1092
        for hook in hooks:
1174
 
            hook(params)
 
1093
            try:
 
1094
                hook(params)
 
1095
            except errors.TipChangeRejected:
 
1096
                raise
 
1097
            except Exception:
 
1098
                exc_info = sys.exc_info()
 
1099
                hook_name = Branch.hooks.get_hook_name(hook)
 
1100
                raise errors.HookFailed(
 
1101
                    'pre_change_branch_tip', hook_name, exc_info)
1175
1102
 
1176
1103
    @needs_write_lock
1177
1104
    def update(self):
1356
1283
        """
1357
1284
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1285
        # clone call. Or something. 20090224 RBC/spiv.
1359
 
        # XXX: Should this perhaps clone colocated branches as well, 
1360
 
        # rather than just the default branch? 20100319 JRV
1361
1286
        if revision_id is None:
1362
1287
            revision_id = self.last_revision()
1363
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
 
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1288
        try:
 
1289
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1290
                revision_id=revision_id, stacked_on=stacked_on,
 
1291
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1292
        except errors.FileExists:
 
1293
            if not use_existing_dir:
 
1294
                raise
 
1295
        except errors.NoSuchFile:
 
1296
            if not create_prefix:
 
1297
                raise
1366
1298
        return dir_to.open_branch()
1367
1299
 
1368
1300
    def create_checkout(self, to_location, revision_id=None,
1387
1319
        if lightweight:
1388
1320
            format = self._get_checkout_format()
1389
1321
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1322
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1392
1323
        else:
1393
1324
            format = self._get_checkout_format()
1394
1325
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1436
1367
    def supports_tags(self):
1437
1368
        return self._format.supports_tags()
1438
1369
 
1439
 
    def automatic_tag_name(self, revision_id):
1440
 
        """Try to automatically find the tag name for a revision.
1441
 
 
1442
 
        :param revision_id: Revision id of the revision.
1443
 
        :return: A tag name or None if no tag name could be determined.
1444
 
        """
1445
 
        for hook in Branch.hooks['automatic_tag_name']:
1446
 
            ret = hook(self, revision_id)
1447
 
            if ret is not None:
1448
 
                return ret
1449
 
        return None
1450
 
 
1451
1370
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1371
                                         other_branch):
1453
1372
        """Ensure that revision_b is a descendant of revision_a.
1517
1436
        return not (self == other)
1518
1437
 
1519
1438
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
 
1439
    def find_format(klass, a_bzrdir):
1521
1440
        """Return the format for the branch object in a_bzrdir."""
1522
1441
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
 
1442
            transport = a_bzrdir.get_branch_transport(None)
 
1443
            format_string = transport.get("format").read()
1525
1444
            return klass._formats[format_string]
1526
1445
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1446
            raise errors.NotBranchError(path=transport.base)
1528
1447
        except KeyError:
1529
1448
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1449
 
1533
1452
        """Return the current default format."""
1534
1453
        return klass._default_format
1535
1454
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1455
    def get_reference(self, a_bzrdir):
1537
1456
        """Get the target reference of the branch in a_bzrdir.
1538
1457
 
1539
1458
        format probing must have been completed before calling
1541
1460
        in a_bzrdir is correct.
1542
1461
 
1543
1462
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1463
        :return: None if the branch is not a reference branch.
1546
1464
        """
1547
1465
        return None
1548
1466
 
1549
1467
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1468
    def set_reference(self, a_bzrdir, to_branch):
1551
1469
        """Set the target reference of the branch in a_bzrdir.
1552
1470
 
1553
1471
        format probing must have been completed before calling
1555
1473
        in a_bzrdir is correct.
1556
1474
 
1557
1475
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1476
        :param to_branch: branch that the checkout is to reference
1560
1477
        """
1561
1478
        raise NotImplementedError(self.set_reference)
1568
1485
        """Return the short format description for this format."""
1569
1486
        raise NotImplementedError(self.get_format_description)
1570
1487
 
1571
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
 
        hooks = Branch.hooks['post_branch_init']
1573
 
        if not hooks:
1574
 
            return
1575
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
 
        for hook in hooks:
1577
 
            hook(params)
1578
 
 
1579
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
 
1488
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1489
                           set_format=True):
1581
1490
        """Initialize a branch in a bzrdir, with specified files
1582
1491
 
1583
1492
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1493
        :param utf8_files: The files to create as a list of
1585
1494
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
1495
        :param set_format: If True, set the format with
1588
1496
            self.get_format_string.  (BzrBranch4 has its format set
1589
1497
            elsewhere)
1590
1498
        :return: a branch in this format
1591
1499
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1500
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1501
        branch_transport = a_bzrdir.get_branch_transport(self)
1594
1502
        lock_map = {
1595
1503
            'metadir': ('lock', lockdir.LockDir),
1596
1504
            'branch4': ('branch-lock', lockable_files.TransportLock),
1617
1525
        finally:
1618
1526
            if lock_taken:
1619
1527
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
 
1528
        return self.open(a_bzrdir, _found=True)
1623
1529
 
1624
 
    def initialize(self, a_bzrdir, name=None):
1625
 
        """Create a branch of this format in a_bzrdir.
1626
 
        
1627
 
        :param name: Name of the colocated branch to create.
1628
 
        """
 
1530
    def initialize(self, a_bzrdir):
 
1531
        """Create a branch of this format in a_bzrdir."""
1629
1532
        raise NotImplementedError(self.initialize)
1630
1533
 
1631
1534
    def is_supported(self):
1661
1564
        """
1662
1565
        raise NotImplementedError(self.network_name)
1663
1566
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1567
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1665
1568
        """Return the branch object for a_bzrdir
1666
1569
 
1667
1570
        :param a_bzrdir: A BzrDir that contains a branch.
1668
 
        :param name: Name of colocated branch to open
1669
1571
        :param _found: a private parameter, do not use it. It is used to
1670
1572
            indicate if format probing has already be done.
1671
1573
        :param ignore_fallbacks: when set, no fallback branches will be opened
1779
1681
            "multiple hooks installed for transform_fallback_location, "
1780
1682
            "all are called with the url returned from the previous hook."
1781
1683
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
1784
 
            "automatic_tag_name is called with (branch, revision_id) and "
1785
 
            "should return a tag name or None if no tag name could be "
1786
 
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
1789
 
            "Called after new branch initialization completes. "
1790
 
            "post_branch_init is called with a "
1791
 
            "bzrlib.branch.BranchInitHookParams. "
1792
 
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
1795
 
            "Called after a checkout switches branch. "
1796
 
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
 
 
1799
1684
 
1800
1685
 
1801
1686
# install the default hooks into the Branch class.
1840
1725
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1726
 
1842
1727
 
1843
 
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
1845
 
 
1846
 
    There are 4 fields that hooks may wish to access:
1847
 
 
1848
 
    :ivar format: the branch format
1849
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
 
    :ivar name: name of colocated branch, if any (or None)
1851
 
    :ivar branch: the branch created
1852
 
 
1853
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
 
    the checkout, hence they are different from the corresponding fields in
1855
 
    branch, which refer to the original branch.
1856
 
    """
1857
 
 
1858
 
    def __init__(self, format, a_bzrdir, name, branch):
1859
 
        """Create a group of BranchInitHook parameters.
1860
 
 
1861
 
        :param format: the branch format
1862
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1863
 
            initialized
1864
 
        :param name: name of colocated branch, if any (or None)
1865
 
        :param branch: the branch created
1866
 
 
1867
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1868
 
        to the checkout, hence they are different from the corresponding fields
1869
 
        in branch, which refer to the original branch.
1870
 
        """
1871
 
        self.format = format
1872
 
        self.bzrdir = a_bzrdir
1873
 
        self.name = name
1874
 
        self.branch = branch
1875
 
 
1876
 
    def __eq__(self, other):
1877
 
        return self.__dict__ == other.__dict__
1878
 
 
1879
 
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
1886
 
 
1887
 
 
1888
 
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
1890
 
 
1891
 
    There are 4 fields that hooks may wish to access:
1892
 
 
1893
 
    :ivar control_dir: BzrDir of the checkout to change
1894
 
    :ivar to_branch: branch that the checkout is to reference
1895
 
    :ivar force: skip the check for local commits in a heavy checkout
1896
 
    :ivar revision_id: revision ID to switch to (or None)
1897
 
    """
1898
 
 
1899
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1900
 
        """Create a group of SwitchHook parameters.
1901
 
 
1902
 
        :param control_dir: BzrDir of the checkout to change
1903
 
        :param to_branch: branch that the checkout is to reference
1904
 
        :param force: skip the check for local commits in a heavy checkout
1905
 
        :param revision_id: revision ID to switch to (or None)
1906
 
        """
1907
 
        self.control_dir = control_dir
1908
 
        self.to_branch = to_branch
1909
 
        self.force = force
1910
 
        self.revision_id = revision_id
1911
 
 
1912
 
    def __eq__(self, other):
1913
 
        return self.__dict__ == other.__dict__
1914
 
 
1915
 
    def __repr__(self):
1916
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
 
            self.control_dir, self.to_branch,
1918
 
            self.revision_id)
1919
 
 
1920
 
 
1921
1728
class BzrBranchFormat4(BranchFormat):
1922
1729
    """Bzr branch format 4.
1923
1730
 
1930
1737
        """See BranchFormat.get_format_description()."""
1931
1738
        return "Branch format 4"
1932
1739
 
1933
 
    def initialize(self, a_bzrdir, name=None):
 
1740
    def initialize(self, a_bzrdir):
1934
1741
        """Create a branch of this format in a_bzrdir."""
1935
1742
        utf8_files = [('revision-history', ''),
1936
1743
                      ('branch-name', ''),
1937
1744
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1745
        return self._initialize_helper(a_bzrdir, utf8_files,
1939
1746
                                       lock_type='branch4', set_format=False)
1940
1747
 
1941
1748
    def __init__(self):
1946
1753
        """The network name for this format is the control dirs disk label."""
1947
1754
        return self._matchingbzrdir.get_format_string()
1948
1755
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1756
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1950
1757
        """See BranchFormat.open()."""
1951
1758
        if not _found:
1952
1759
            # we are being called directly and must probe.
1954
1761
        return BzrBranch(_format=self,
1955
1762
                         _control_files=a_bzrdir._control_files,
1956
1763
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
1764
                         _repository=a_bzrdir.open_repository())
1959
1765
 
1960
1766
    def __str__(self):
1975
1781
        """
1976
1782
        return self.get_format_string()
1977
1783
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1784
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1785
        """See BranchFormat.open()."""
1980
1786
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1787
            format = BranchFormat.find_format(a_bzrdir)
1982
1788
            if format.__class__ != self.__class__:
1983
1789
                raise AssertionError("wrong format %r found for %r" %
1984
1790
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1791
        try:
 
1792
            transport = a_bzrdir.get_branch_transport(None)
1987
1793
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1794
                                                         lockdir.LockDir)
1989
1795
            return self._branch_class()(_format=self,
1990
1796
                              _control_files=control_files,
1991
 
                              name=name,
1992
1797
                              a_bzrdir=a_bzrdir,
1993
1798
                              _repository=a_bzrdir.find_repository(),
1994
1799
                              ignore_fallbacks=ignore_fallbacks)
1995
1800
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1801
            raise errors.NotBranchError(path=transport.base)
1997
1802
 
1998
1803
    def __init__(self):
1999
1804
        super(BranchFormatMetadir, self).__init__()
2028
1833
        """See BranchFormat.get_format_description()."""
2029
1834
        return "Branch format 5"
2030
1835
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
1836
    def initialize(self, a_bzrdir):
2032
1837
        """Create a branch of this format in a_bzrdir."""
2033
1838
        utf8_files = [('revision-history', ''),
2034
1839
                      ('branch-name', ''),
2035
1840
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1841
        return self._initialize_helper(a_bzrdir, utf8_files)
2037
1842
 
2038
1843
    def supports_tags(self):
2039
1844
        return False
2061
1866
        """See BranchFormat.get_format_description()."""
2062
1867
        return "Branch format 6"
2063
1868
 
2064
 
    def initialize(self, a_bzrdir, name=None):
 
1869
    def initialize(self, a_bzrdir):
2065
1870
        """Create a branch of this format in a_bzrdir."""
2066
1871
        utf8_files = [('last-revision', '0 null:\n'),
2067
1872
                      ('branch.conf', ''),
2068
1873
                      ('tags', ''),
2069
1874
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1875
        return self._initialize_helper(a_bzrdir, utf8_files)
2071
1876
 
2072
1877
    def make_tags(self, branch):
2073
1878
        """See bzrlib.branch.BranchFormat.make_tags()."""
2091
1896
        """See BranchFormat.get_format_description()."""
2092
1897
        return "Branch format 8"
2093
1898
 
2094
 
    def initialize(self, a_bzrdir, name=None):
 
1899
    def initialize(self, a_bzrdir):
2095
1900
        """Create a branch of this format in a_bzrdir."""
2096
1901
        utf8_files = [('last-revision', '0 null:\n'),
2097
1902
                      ('branch.conf', ''),
2098
1903
                      ('tags', ''),
2099
1904
                      ('references', '')
2100
1905
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1906
        return self._initialize_helper(a_bzrdir, utf8_files)
2102
1907
 
2103
1908
    def __init__(self):
2104
1909
        super(BzrBranchFormat8, self).__init__()
2127
1932
    This format was introduced in bzr 1.6.
2128
1933
    """
2129
1934
 
2130
 
    def initialize(self, a_bzrdir, name=None):
 
1935
    def initialize(self, a_bzrdir):
2131
1936
        """Create a branch of this format in a_bzrdir."""
2132
1937
        utf8_files = [('last-revision', '0 null:\n'),
2133
1938
                      ('branch.conf', ''),
2134
1939
                      ('tags', ''),
2135
1940
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1941
        return self._initialize_helper(a_bzrdir, utf8_files)
2137
1942
 
2138
1943
    def _branch_class(self):
2139
1944
        return BzrBranch7
2171
1976
        """See BranchFormat.get_format_description()."""
2172
1977
        return "Checkout reference format 1"
2173
1978
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
1979
    def get_reference(self, a_bzrdir):
2175
1980
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
 
1981
        transport = a_bzrdir.get_branch_transport(None)
 
1982
        return transport.get('location').read()
2178
1983
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1984
    def set_reference(self, a_bzrdir, to_branch):
2180
1985
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1986
        transport = a_bzrdir.get_branch_transport(None)
2182
1987
        location = transport.put_bytes('location', to_branch.base)
2183
1988
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1989
    def initialize(self, a_bzrdir, target_branch=None):
2185
1990
        """Create a branch of this format in a_bzrdir."""
2186
1991
        if target_branch is None:
2187
1992
            # this format does not implement branch itself, thus the implicit
2188
1993
            # creation contract must see it as uninitializable
2189
1994
            raise errors.UninitializableFormat(self)
2190
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1995
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1996
        branch_transport = a_bzrdir.get_branch_transport(self)
2192
1997
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
1998
            target_branch.bzrdir.root_transport.base)
2194
1999
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
 
2000
        return self.open(
 
2001
            a_bzrdir, _found=True,
2197
2002
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
2003
 
2201
2004
    def __init__(self):
2202
2005
        super(BranchReferenceFormat, self).__init__()
2208
2011
        def clone(to_bzrdir, revision_id=None,
2209
2012
            repository_policy=None):
2210
2013
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2014
            return format.initialize(to_bzrdir, a_branch)
2212
2015
            # cannot obey revision_id limits when cloning a reference ...
2213
2016
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
2017
            # emit some sort of warning/error to the caller ?!
2215
2018
        return clone
2216
2019
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2020
    def open(self, a_bzrdir, _found=False, location=None,
2218
2021
             possible_transports=None, ignore_fallbacks=False):
2219
2022
        """Return the branch that the branch reference in a_bzrdir points at.
2220
2023
 
2221
2024
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
2025
        :param _found: a private parameter, do not use it. It is used to
2224
2026
            indicate if format probing has already be done.
2225
2027
        :param ignore_fallbacks: when set, no fallback branches will be opened
2230
2032
        :param possible_transports: An optional reusable transports list.
2231
2033
        """
2232
2034
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2035
            format = BranchFormat.find_format(a_bzrdir)
2234
2036
            if format.__class__ != self.__class__:
2235
2037
                raise AssertionError("wrong format %r found for %r" %
2236
2038
                    (format, self))
2237
2039
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
2040
            location = self.get_reference(a_bzrdir)
2239
2041
        real_bzrdir = bzrdir.BzrDir.open(
2240
2042
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
 
2043
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2243
2044
        # this changes the behaviour of result.clone to create a new reference
2244
2045
        # rather than a copy of the content of the branch.
2245
2046
        # I did not use a proxy object because that needs much more extensive
2279
2080
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
2081
 
2281
2082
 
2282
 
class BranchWriteLockResult(LogicalLockResult):
2283
 
    """The result of write locking a branch.
2284
 
 
2285
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2286
 
        None.
2287
 
    :ivar unlock: A callable which will unlock the lock.
2288
 
    """
2289
 
 
2290
 
    def __init__(self, unlock, branch_token):
2291
 
        LogicalLockResult.__init__(self, unlock)
2292
 
        self.branch_token = branch_token
2293
 
 
2294
 
    def __repr__(self):
2295
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
 
            self.unlock)
2297
 
 
2298
 
 
2299
2083
class BzrBranch(Branch, _RelockDebugMixin):
2300
2084
    """A branch stored in the actual filesystem.
2301
2085
 
2308
2092
    :ivar repository: Repository for this branch.
2309
2093
    :ivar base: The url of the base directory for this branch; the one
2310
2094
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
2095
    """
2314
2096
 
2315
2097
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
 
2098
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2099
                 ignore_fallbacks=False):
2318
2100
        """Create new branch object at a particular location."""
2319
2101
        if a_bzrdir is None:
2320
2102
            raise ValueError('a_bzrdir must be supplied')
2321
2103
        else:
2322
2104
            self.bzrdir = a_bzrdir
2323
2105
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
2106
        # XXX: We should be able to just do
2326
2107
        #   self.base = self.bzrdir.root_transport.base
2327
2108
        # but this does not quite work yet -- mbp 20080522
2334
2115
        Branch.__init__(self)
2335
2116
 
2336
2117
    def __str__(self):
2337
 
        if self.name is None:
2338
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2339
 
        else:
2340
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2341
 
                self.name)
 
2118
        return '%s(%r)' % (self.__class__.__name__, self.base)
2342
2119
 
2343
2120
    __repr__ = __str__
2344
2121
 
2355
2132
        return self.control_files.is_locked()
2356
2133
 
2357
2134
    def lock_write(self, token=None):
2358
 
        """Lock the branch for write operations.
2359
 
 
2360
 
        :param token: A token to permit reacquiring a previously held and
2361
 
            preserved lock.
2362
 
        :return: A BranchWriteLockResult.
2363
 
        """
2364
2135
        if not self.is_locked():
2365
2136
            self._note_lock('w')
2366
2137
        # All-in-one needs to always unlock/lock.
2367
2138
        repo_control = getattr(self.repository, 'control_files', None)
2368
2139
        if self.control_files == repo_control or not self.is_locked():
2369
 
            self.repository._warn_if_deprecated(self)
2370
2140
            self.repository.lock_write()
2371
2141
            took_lock = True
2372
2142
        else:
2373
2143
            took_lock = False
2374
2144
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
2145
            return self.control_files.lock_write(token=token)
2377
2146
        except:
2378
2147
            if took_lock:
2379
2148
                self.repository.unlock()
2380
2149
            raise
2381
2150
 
2382
2151
    def lock_read(self):
2383
 
        """Lock the branch for read operations.
2384
 
 
2385
 
        :return: A bzrlib.lock.LogicalLockResult.
2386
 
        """
2387
2152
        if not self.is_locked():
2388
2153
            self._note_lock('r')
2389
2154
        # All-in-one needs to always unlock/lock.
2390
2155
        repo_control = getattr(self.repository, 'control_files', None)
2391
2156
        if self.control_files == repo_control or not self.is_locked():
2392
 
            self.repository._warn_if_deprecated(self)
2393
2157
            self.repository.lock_read()
2394
2158
            took_lock = True
2395
2159
        else:
2396
2160
            took_lock = False
2397
2161
        try:
2398
2162
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
2163
        except:
2401
2164
            if took_lock:
2402
2165
                self.repository.unlock()
2571
2334
        return result
2572
2335
 
2573
2336
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2337
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2338
 
2576
2339
    def set_push_location(self, location):
2577
2340
        """See Branch.set_push_location."""
2767
2530
        if _mod_revision.is_null(last_revision):
2768
2531
            return
2769
2532
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2533
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2534
 
2772
2535
    def _gen_revision_history(self):
2773
2536
        """Generate the revision history from last revision
2873
2636
        if branch_location is None:
2874
2637
            return Branch.reference_parent(self, file_id, path,
2875
2638
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2639
        branch_location = urlutils.join(self.base, branch_location)
2877
2640
        return Branch.open(branch_location,
2878
2641
                           possible_transports=possible_transports)
2879
2642
 
2925
2688
        return stacked_url
2926
2689
 
2927
2690
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2691
        value = self.get_config().get_user_option('append_revisions_only')
 
2692
        return value == 'True'
2930
2693
 
2931
2694
    @needs_write_lock
2932
2695
    def generate_revision_history(self, revision_id, last_rev=None,
2994
2757
    """
2995
2758
 
2996
2759
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2760
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2761
 
2999
2762
 
3000
2763
######################################################################
3087
2850
        :param verbose: Requests more detailed display of what was checked,
3088
2851
            if any.
3089
2852
        """
3090
 
        note('checked branch %s format %s', self.branch.user_url,
 
2853
        note('checked branch %s format %s', self.branch.base,
3091
2854
            self.branch._format)
3092
2855
        for error in self.errors:
3093
2856
            note('found error:%s', error)
3422
3185
        if local and not bound_location:
3423
3186
            raise errors.LocalRequiresBoundBranch()
3424
3187
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3188
        if not local and bound_location and self.source.base != bound_location:
3426
3189
            # not pulling from master, so we need to update master.
3427
3190
            master_branch = self.target.get_master_branch(possible_transports)
3428
3191
            master_branch.lock_write()