← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2010-06-02 05:03:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5279.
  • Revision ID: mbp@canonical.com-20100602050331-n2p1qt8hfsahspnv
Correct more sloppy use of the term 'Linux'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
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
53
from bzrlib import registry
53
54
from bzrlib.symbol_versioning import (
54
55
    deprecated_in,
62
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
63
64
 
64
65
 
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):
 
66
class Branch(bzrdir.ControlComponent):
78
67
    """Branch holding a history of revisions.
79
68
 
80
 
    base
81
 
        Base directory/url of the branch.
 
69
    :ivar base:
 
70
        Base directory/url of the branch; using control_url and
 
71
        control_transport is more standardized.
82
72
 
83
73
    hooks: An instance of BranchHooks.
84
74
    """
86
76
    # - RBC 20060112
87
77
    base = None
88
78
 
 
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
 
89
87
    def __init__(self, *ignored, **ignored_too):
90
88
        self.tags = self._format.make_tags(self)
91
89
        self._revision_history_cache = None
106
104
        """Activate the branch/repository from url as a fallback repository."""
107
105
        repo = self._get_fallback_repository(url)
108
106
        if repo.has_same_location(self.repository):
109
 
            raise errors.UnstackableLocationError(self.base, url)
 
107
            raise errors.UnstackableLocationError(self.user_url, url)
110
108
        self.repository.add_fallback_repository(repo)
111
109
 
112
110
    def break_lock(self):
166
164
        """
167
165
        control = bzrdir.BzrDir.open(base, _unsupported,
168
166
                                     possible_transports=possible_transports)
169
 
        return control.open_branch(_unsupported)
 
167
        return control.open_branch(unsupported=_unsupported)
170
168
 
171
169
    @staticmethod
172
 
    def open_from_transport(transport, _unsupported=False):
 
170
    def open_from_transport(transport, name=None, _unsupported=False):
173
171
        """Open the branch rooted at transport"""
174
172
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
 
        return control.open_branch(_unsupported)
 
173
        return control.open_branch(name=name, unsupported=_unsupported)
176
174
 
177
175
    @staticmethod
178
176
    def open_containing(url, possible_transports=None):
216
214
    def _get_fallback_repository(self, url):
217
215
        """Get the repository we fallback to at url."""
218
216
        url = urlutils.join(self.base, url)
219
 
        a_bzrdir = bzrdir.BzrDir.open(url,
 
217
        a_branch = Branch.open(url,
220
218
            possible_transports=[self.bzrdir.root_transport])
221
 
        return a_bzrdir.open_branch().repository
 
219
        return a_branch.repository
222
220
 
223
221
    def _get_tags_bytes(self):
224
222
        """Get the bytes of a serialised tags dict.
285
283
        new_history.reverse()
286
284
        return new_history
287
285
 
288
 
    def lock_write(self):
 
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
293
        raise NotImplementedError(self.lock_write)
290
294
 
291
295
    def lock_read(self):
 
296
        """Lock the branch for read operations.
 
297
 
 
298
        :return: A bzrlib.lock.LogicalLockResult.
 
299
        """
292
300
        raise NotImplementedError(self.lock_read)
293
301
 
294
302
    def unlock(self):
419
427
            * 'include' - the stop revision is the last item in the result
420
428
            * 'with-merges' - include the stop revision and all of its
421
429
              merged revisions in the result
 
430
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
431
              that are in both ancestries
422
432
        :param direction: either 'reverse' or 'forward':
423
433
            * reverse means return the start_revision_id first, i.e.
424
434
              start at the most recent revision and go backwards in history
446
456
        # start_revision_id.
447
457
        if self._merge_sorted_revisions_cache is None:
448
458
            last_revision = self.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
 
 
 
459
            known_graph = self.repository.get_known_graph_ancestry(
 
460
                [last_revision])
 
461
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
462
                last_revision)
458
463
        filtered = self._filter_merge_sorted_revisions(
459
464
            self._merge_sorted_revisions_cache, start_revision_id,
460
465
            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)
461
469
        if direction == 'reverse':
462
470
            return filtered
463
471
        if direction == 'forward':
470
478
        """Iterate over an inclusive range of sorted revisions."""
471
479
        rev_iter = iter(merge_sorted_revisions)
472
480
        if start_revision_id is not None:
473
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
481
            for node in rev_iter:
 
482
                rev_id = node.key[-1]
474
483
                if rev_id != start_revision_id:
475
484
                    continue
476
485
                else:
477
486
                    # The decision to include the start or not
478
487
                    # depends on the stop_rule if a stop is provided
479
 
                    rev_iter = chain(
480
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
481
 
                        rev_iter)
 
488
                    # so pop this node back into the iterator
 
489
                    rev_iter = chain(iter([node]), rev_iter)
482
490
                    break
483
491
        if stop_revision_id is None:
484
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
485
 
                yield rev_id, depth, revno, end_of_merge
 
492
            # Yield everything
 
493
            for node in rev_iter:
 
494
                rev_id = node.key[-1]
 
495
                yield (rev_id, node.merge_depth, node.revno,
 
496
                       node.end_of_merge)
486
497
        elif stop_rule == 'exclude':
487
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
498
            for node in rev_iter:
 
499
                rev_id = node.key[-1]
488
500
                if rev_id == stop_revision_id:
489
501
                    return
490
 
                yield rev_id, depth, revno, end_of_merge
 
502
                yield (rev_id, node.merge_depth, node.revno,
 
503
                       node.end_of_merge)
491
504
        elif stop_rule == 'include':
492
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
493
 
                yield rev_id, depth, revno, end_of_merge
 
505
            for node in rev_iter:
 
506
                rev_id = node.key[-1]
 
507
                yield (rev_id, node.merge_depth, node.revno,
 
508
                       node.end_of_merge)
494
509
                if rev_id == stop_revision_id:
495
510
                    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)
496
523
        elif stop_rule == 'with-merges':
497
524
            stop_rev = self.repository.get_revision(stop_revision_id)
498
525
            if stop_rev.parent_ids:
499
526
                left_parent = stop_rev.parent_ids[0]
500
527
            else:
501
528
                left_parent = _mod_revision.NULL_REVISION
502
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
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
            for node in rev_iter:
 
534
                rev_id = node.key[-1]
503
535
                if rev_id == left_parent:
 
536
                    # reached the left parent after the stop_revision
504
537
                    return
505
 
                yield rev_id, depth, revno, end_of_merge
 
538
                if (not reached_stop_revision_id or
 
539
                        rev_id in revision_id_whitelist):
 
540
                    yield (rev_id, node.merge_depth, node.revno,
 
541
                       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)
506
548
        else:
507
549
            raise ValueError('invalid stop_rule %r' % stop_rule)
508
550
 
 
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
 
509
596
    def leave_lock_in_place(self):
510
597
        """Tell this branch object not to release the physical lock when this
511
598
        object is unlocked.
528
615
        :param other: The branch to bind to
529
616
        :type other: Branch
530
617
        """
531
 
        raise errors.UpgradeRequired(self.base)
 
618
        raise errors.UpgradeRequired(self.user_url)
532
619
 
533
620
    def set_append_revisions_only(self, enabled):
534
621
        if not self._format.supports_set_append_revisions_only():
535
 
            raise errors.UpgradeRequired(self.base)
 
622
            raise errors.UpgradeRequired(self.user_url)
536
623
        if enabled:
537
624
            value = 'True'
538
625
        else:
586
673
    def get_old_bound_location(self):
587
674
        """Return the URL of the branch we used to be bound to
588
675
        """
589
 
        raise errors.UpgradeRequired(self.base)
 
676
        raise errors.UpgradeRequired(self.user_url)
590
677
 
591
678
    def get_commit_builder(self, parents, config=None, timestamp=None,
592
679
                           timezone=None, committer=None, revprops=None,
670
757
            stacking.
671
758
        """
672
759
        if not self._format.supports_stacking():
673
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
760
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
674
761
        # XXX: Changing from one fallback repository to another does not check
675
762
        # that all the data you need is present in the new fallback.
676
763
        # Possibly it should.
827
914
 
828
915
    def unbind(self):
829
916
        """Older format branches cannot bind or unbind."""
830
 
        raise errors.UpgradeRequired(self.base)
 
917
        raise errors.UpgradeRequired(self.user_url)
831
918
 
832
919
    def last_revision(self):
833
920
        """Return last revision id, or NULL_REVISION."""
993
1080
        try:
994
1081
            return urlutils.join(self.base[:-1], parent)
995
1082
        except errors.InvalidURLJoin, e:
996
 
            raise errors.InaccessibleParent(parent, self.base)
 
1083
            raise errors.InaccessibleParent(parent, self.user_url)
997
1084
 
998
1085
    def _get_parent_location(self):
999
1086
        raise NotImplementedError(self._get_parent_location)
1084
1171
        params = ChangeBranchTipParams(
1085
1172
            self, old_revno, new_revno, old_revid, new_revid)
1086
1173
        for hook in hooks:
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)
 
1174
            hook(params)
1096
1175
 
1097
1176
    @needs_write_lock
1098
1177
    def update(self):
1147
1226
        revision_id: if not None, the revision history in the new branch will
1148
1227
                     be truncated to end with revision_id.
1149
1228
        """
 
1229
        if (repository_policy is not None and
 
1230
            repository_policy.requires_stacking()):
 
1231
            to_bzrdir._format.require_stacking(_skip_repo=True)
1150
1232
        result = to_bzrdir.create_branch()
1151
1233
        result.lock_write()
1152
1234
        try:
1274
1356
        """
1275
1357
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1276
1358
        # 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
1277
1361
        if revision_id is None:
1278
1362
            revision_id = self.last_revision()
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
 
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)
1289
1366
        return dir_to.open_branch()
1290
1367
 
1291
1368
    def create_checkout(self, to_location, revision_id=None,
1310
1387
        if lightweight:
1311
1388
            format = self._get_checkout_format()
1312
1389
            checkout = format.initialize_on_transport(t)
1313
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1390
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1391
                target_branch=self)
1314
1392
        else:
1315
1393
            format = self._get_checkout_format()
1316
1394
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1358
1436
    def supports_tags(self):
1359
1437
        return self._format.supports_tags()
1360
1438
 
 
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
 
1361
1451
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1362
1452
                                         other_branch):
1363
1453
        """Ensure that revision_b is a descendant of revision_a.
1427
1517
        return not (self == other)
1428
1518
 
1429
1519
    @classmethod
1430
 
    def find_format(klass, a_bzrdir):
 
1520
    def find_format(klass, a_bzrdir, name=None):
1431
1521
        """Return the format for the branch object in a_bzrdir."""
1432
1522
        try:
1433
 
            transport = a_bzrdir.get_branch_transport(None)
1434
 
            format_string = transport.get("format").read()
 
1523
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1524
            format_string = transport.get_bytes("format")
1435
1525
            return klass._formats[format_string]
1436
1526
        except errors.NoSuchFile:
1437
 
            raise errors.NotBranchError(path=transport.base)
 
1527
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1438
1528
        except KeyError:
1439
1529
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1440
1530
 
1443
1533
        """Return the current default format."""
1444
1534
        return klass._default_format
1445
1535
 
1446
 
    def get_reference(self, a_bzrdir):
 
1536
    def get_reference(self, a_bzrdir, name=None):
1447
1537
        """Get the target reference of the branch in a_bzrdir.
1448
1538
 
1449
1539
        format probing must have been completed before calling
1451
1541
        in a_bzrdir is correct.
1452
1542
 
1453
1543
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1544
        :param name: Name of the colocated branch to fetch
1454
1545
        :return: None if the branch is not a reference branch.
1455
1546
        """
1456
1547
        return None
1457
1548
 
1458
1549
    @classmethod
1459
 
    def set_reference(self, a_bzrdir, to_branch):
 
1550
    def set_reference(self, a_bzrdir, name, to_branch):
1460
1551
        """Set the target reference of the branch in a_bzrdir.
1461
1552
 
1462
1553
        format probing must have been completed before calling
1464
1555
        in a_bzrdir is correct.
1465
1556
 
1466
1557
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1558
        :param name: Name of colocated branch to set, None for default
1467
1559
        :param to_branch: branch that the checkout is to reference
1468
1560
        """
1469
1561
        raise NotImplementedError(self.set_reference)
1476
1568
        """Return the short format description for this format."""
1477
1569
        raise NotImplementedError(self.get_format_description)
1478
1570
 
1479
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1480
 
                           set_format=True):
 
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):
1481
1581
        """Initialize a branch in a bzrdir, with specified files
1482
1582
 
1483
1583
        :param a_bzrdir: The bzrdir to initialize the branch in
1484
1584
        :param utf8_files: The files to create as a list of
1485
1585
            (filename, content) tuples
 
1586
        :param name: Name of colocated branch to create, if any
1486
1587
        :param set_format: If True, set the format with
1487
1588
            self.get_format_string.  (BzrBranch4 has its format set
1488
1589
            elsewhere)
1489
1590
        :return: a branch in this format
1490
1591
        """
1491
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1492
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1592
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1593
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1493
1594
        lock_map = {
1494
1595
            'metadir': ('lock', lockdir.LockDir),
1495
1596
            'branch4': ('branch-lock', lockable_files.TransportLock),
1516
1617
        finally:
1517
1618
            if lock_taken:
1518
1619
                control_files.unlock()
1519
 
        return self.open(a_bzrdir, _found=True)
 
1620
        branch = self.open(a_bzrdir, name, _found=True)
 
1621
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1622
        return branch
1520
1623
 
1521
 
    def initialize(self, a_bzrdir):
1522
 
        """Create a branch of this format in a_bzrdir."""
 
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
        """
1523
1629
        raise NotImplementedError(self.initialize)
1524
1630
 
1525
1631
    def is_supported(self):
1555
1661
        """
1556
1662
        raise NotImplementedError(self.network_name)
1557
1663
 
1558
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1664
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1559
1665
        """Return the branch object for a_bzrdir
1560
1666
 
1561
1667
        :param a_bzrdir: A BzrDir that contains a branch.
 
1668
        :param name: Name of colocated branch to open
1562
1669
        :param _found: a private parameter, do not use it. It is used to
1563
1670
            indicate if format probing has already be done.
1564
1671
        :param ignore_fallbacks: when set, no fallback branches will be opened
1672
1779
            "multiple hooks installed for transform_fallback_location, "
1673
1780
            "all are called with the url returned from the previous hook."
1674
1781
            "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
 
1675
1799
 
1676
1800
 
1677
1801
# install the default hooks into the Branch class.
1716
1840
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1717
1841
 
1718
1842
 
 
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
 
1719
1921
class BzrBranchFormat4(BranchFormat):
1720
1922
    """Bzr branch format 4.
1721
1923
 
1728
1930
        """See BranchFormat.get_format_description()."""
1729
1931
        return "Branch format 4"
1730
1932
 
1731
 
    def initialize(self, a_bzrdir):
 
1933
    def initialize(self, a_bzrdir, name=None):
1732
1934
        """Create a branch of this format in a_bzrdir."""
1733
1935
        utf8_files = [('revision-history', ''),
1734
1936
                      ('branch-name', ''),
1735
1937
                      ]
1736
 
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1938
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1737
1939
                                       lock_type='branch4', set_format=False)
1738
1940
 
1739
1941
    def __init__(self):
1744
1946
        """The network name for this format is the control dirs disk label."""
1745
1947
        return self._matchingbzrdir.get_format_string()
1746
1948
 
1747
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1949
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1748
1950
        """See BranchFormat.open()."""
1749
1951
        if not _found:
1750
1952
            # we are being called directly and must probe.
1752
1954
        return BzrBranch(_format=self,
1753
1955
                         _control_files=a_bzrdir._control_files,
1754
1956
                         a_bzrdir=a_bzrdir,
 
1957
                         name=name,
1755
1958
                         _repository=a_bzrdir.open_repository())
1756
1959
 
1757
1960
    def __str__(self):
1772
1975
        """
1773
1976
        return self.get_format_string()
1774
1977
 
1775
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1978
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1776
1979
        """See BranchFormat.open()."""
1777
1980
        if not _found:
1778
 
            format = BranchFormat.find_format(a_bzrdir)
 
1981
            format = BranchFormat.find_format(a_bzrdir, name=name)
1779
1982
            if format.__class__ != self.__class__:
1780
1983
                raise AssertionError("wrong format %r found for %r" %
1781
1984
                    (format, self))
 
1985
        transport = a_bzrdir.get_branch_transport(None, name=name)
1782
1986
        try:
1783
 
            transport = a_bzrdir.get_branch_transport(None)
1784
1987
            control_files = lockable_files.LockableFiles(transport, 'lock',
1785
1988
                                                         lockdir.LockDir)
1786
1989
            return self._branch_class()(_format=self,
1787
1990
                              _control_files=control_files,
 
1991
                              name=name,
1788
1992
                              a_bzrdir=a_bzrdir,
1789
1993
                              _repository=a_bzrdir.find_repository(),
1790
1994
                              ignore_fallbacks=ignore_fallbacks)
1791
1995
        except errors.NoSuchFile:
1792
 
            raise errors.NotBranchError(path=transport.base)
 
1996
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1793
1997
 
1794
1998
    def __init__(self):
1795
1999
        super(BranchFormatMetadir, self).__init__()
1824
2028
        """See BranchFormat.get_format_description()."""
1825
2029
        return "Branch format 5"
1826
2030
 
1827
 
    def initialize(self, a_bzrdir):
 
2031
    def initialize(self, a_bzrdir, name=None):
1828
2032
        """Create a branch of this format in a_bzrdir."""
1829
2033
        utf8_files = [('revision-history', ''),
1830
2034
                      ('branch-name', ''),
1831
2035
                      ]
1832
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2036
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1833
2037
 
1834
2038
    def supports_tags(self):
1835
2039
        return False
1857
2061
        """See BranchFormat.get_format_description()."""
1858
2062
        return "Branch format 6"
1859
2063
 
1860
 
    def initialize(self, a_bzrdir):
 
2064
    def initialize(self, a_bzrdir, name=None):
1861
2065
        """Create a branch of this format in a_bzrdir."""
1862
2066
        utf8_files = [('last-revision', '0 null:\n'),
1863
2067
                      ('branch.conf', ''),
1864
2068
                      ('tags', ''),
1865
2069
                      ]
1866
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2070
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1867
2071
 
1868
2072
    def make_tags(self, branch):
1869
2073
        """See bzrlib.branch.BranchFormat.make_tags()."""
1887
2091
        """See BranchFormat.get_format_description()."""
1888
2092
        return "Branch format 8"
1889
2093
 
1890
 
    def initialize(self, a_bzrdir):
 
2094
    def initialize(self, a_bzrdir, name=None):
1891
2095
        """Create a branch of this format in a_bzrdir."""
1892
2096
        utf8_files = [('last-revision', '0 null:\n'),
1893
2097
                      ('branch.conf', ''),
1894
2098
                      ('tags', ''),
1895
2099
                      ('references', '')
1896
2100
                      ]
1897
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2101
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1898
2102
 
1899
2103
    def __init__(self):
1900
2104
        super(BzrBranchFormat8, self).__init__()
1923
2127
    This format was introduced in bzr 1.6.
1924
2128
    """
1925
2129
 
1926
 
    def initialize(self, a_bzrdir):
 
2130
    def initialize(self, a_bzrdir, name=None):
1927
2131
        """Create a branch of this format in a_bzrdir."""
1928
2132
        utf8_files = [('last-revision', '0 null:\n'),
1929
2133
                      ('branch.conf', ''),
1930
2134
                      ('tags', ''),
1931
2135
                      ]
1932
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2136
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1933
2137
 
1934
2138
    def _branch_class(self):
1935
2139
        return BzrBranch7
1967
2171
        """See BranchFormat.get_format_description()."""
1968
2172
        return "Checkout reference format 1"
1969
2173
 
1970
 
    def get_reference(self, a_bzrdir):
 
2174
    def get_reference(self, a_bzrdir, name=None):
1971
2175
        """See BranchFormat.get_reference()."""
1972
 
        transport = a_bzrdir.get_branch_transport(None)
1973
 
        return transport.get('location').read()
 
2176
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2177
        return transport.get_bytes('location')
1974
2178
 
1975
 
    def set_reference(self, a_bzrdir, to_branch):
 
2179
    def set_reference(self, a_bzrdir, name, to_branch):
1976
2180
        """See BranchFormat.set_reference()."""
1977
 
        transport = a_bzrdir.get_branch_transport(None)
 
2181
        transport = a_bzrdir.get_branch_transport(None, name=name)
1978
2182
        location = transport.put_bytes('location', to_branch.base)
1979
2183
 
1980
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2184
    def initialize(self, a_bzrdir, name=None, target_branch=None):
1981
2185
        """Create a branch of this format in a_bzrdir."""
1982
2186
        if target_branch is None:
1983
2187
            # this format does not implement branch itself, thus the implicit
1984
2188
            # creation contract must see it as uninitializable
1985
2189
            raise errors.UninitializableFormat(self)
1986
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1987
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2190
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2191
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1988
2192
        branch_transport.put_bytes('location',
1989
 
            target_branch.bzrdir.root_transport.base)
 
2193
            target_branch.bzrdir.user_url)
1990
2194
        branch_transport.put_bytes('format', self.get_format_string())
1991
 
        return self.open(
1992
 
            a_bzrdir, _found=True,
 
2195
        branch = self.open(
 
2196
            a_bzrdir, name, _found=True,
1993
2197
            possible_transports=[target_branch.bzrdir.root_transport])
 
2198
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2199
        return branch
1994
2200
 
1995
2201
    def __init__(self):
1996
2202
        super(BranchReferenceFormat, self).__init__()
2002
2208
        def clone(to_bzrdir, revision_id=None,
2003
2209
            repository_policy=None):
2004
2210
            """See Branch.clone()."""
2005
 
            return format.initialize(to_bzrdir, a_branch)
 
2211
            return format.initialize(to_bzrdir, target_branch=a_branch)
2006
2212
            # cannot obey revision_id limits when cloning a reference ...
2007
2213
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2008
2214
            # emit some sort of warning/error to the caller ?!
2009
2215
        return clone
2010
2216
 
2011
 
    def open(self, a_bzrdir, _found=False, location=None,
 
2217
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2012
2218
             possible_transports=None, ignore_fallbacks=False):
2013
2219
        """Return the branch that the branch reference in a_bzrdir points at.
2014
2220
 
2015
2221
        :param a_bzrdir: A BzrDir that contains a branch.
 
2222
        :param name: Name of colocated branch to open, if any
2016
2223
        :param _found: a private parameter, do not use it. It is used to
2017
2224
            indicate if format probing has already be done.
2018
2225
        :param ignore_fallbacks: when set, no fallback branches will be opened
2023
2230
        :param possible_transports: An optional reusable transports list.
2024
2231
        """
2025
2232
        if not _found:
2026
 
            format = BranchFormat.find_format(a_bzrdir)
 
2233
            format = BranchFormat.find_format(a_bzrdir, name=name)
2027
2234
            if format.__class__ != self.__class__:
2028
2235
                raise AssertionError("wrong format %r found for %r" %
2029
2236
                    (format, self))
2030
2237
        if location is None:
2031
 
            location = self.get_reference(a_bzrdir)
 
2238
            location = self.get_reference(a_bzrdir, name)
2032
2239
        real_bzrdir = bzrdir.BzrDir.open(
2033
2240
            location, possible_transports=possible_transports)
2034
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2241
        result = real_bzrdir.open_branch(name=name, 
 
2242
            ignore_fallbacks=ignore_fallbacks)
2035
2243
        # this changes the behaviour of result.clone to create a new reference
2036
2244
        # rather than a copy of the content of the branch.
2037
2245
        # I did not use a proxy object because that needs much more extensive
2064
2272
BranchFormat.register_format(__format6)
2065
2273
BranchFormat.register_format(__format7)
2066
2274
BranchFormat.register_format(__format8)
2067
 
BranchFormat.set_default_format(__format6)
 
2275
BranchFormat.set_default_format(__format7)
2068
2276
_legacy_formats = [BzrBranchFormat4(),
2069
2277
    ]
2070
2278
network_format_registry.register(
2071
2279
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2072
2280
 
2073
2281
 
2074
 
class BzrBranch(Branch):
 
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
class BzrBranch(Branch, _RelockDebugMixin):
2075
2300
    """A branch stored in the actual filesystem.
2076
2301
 
2077
2302
    Note that it's "local" in the context of the filesystem; it doesn't
2083
2308
    :ivar repository: Repository for this branch.
2084
2309
    :ivar base: The url of the base directory for this branch; the one
2085
2310
        containing the .bzr directory.
 
2311
    :ivar name: Optional colocated branch name as it exists in the control
 
2312
        directory.
2086
2313
    """
2087
2314
 
2088
2315
    def __init__(self, _format=None,
2089
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2090
 
                 ignore_fallbacks=False):
 
2316
                 _control_files=None, a_bzrdir=None, name=None,
 
2317
                 _repository=None, ignore_fallbacks=False):
2091
2318
        """Create new branch object at a particular location."""
2092
2319
        if a_bzrdir is None:
2093
2320
            raise ValueError('a_bzrdir must be supplied')
2094
2321
        else:
2095
2322
            self.bzrdir = a_bzrdir
2096
2323
        self._base = self.bzrdir.transport.clone('..').base
 
2324
        self.name = name
2097
2325
        # XXX: We should be able to just do
2098
2326
        #   self.base = self.bzrdir.root_transport.base
2099
2327
        # but this does not quite work yet -- mbp 20080522
2106
2334
        Branch.__init__(self)
2107
2335
 
2108
2336
    def __str__(self):
2109
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
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)
2110
2342
 
2111
2343
    __repr__ = __str__
2112
2344
 
2123
2355
        return self.control_files.is_locked()
2124
2356
 
2125
2357
    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
        if not self.is_locked():
 
2365
            self._note_lock('w')
2126
2366
        # All-in-one needs to always unlock/lock.
2127
2367
        repo_control = getattr(self.repository, 'control_files', None)
2128
2368
        if self.control_files == repo_control or not self.is_locked():
 
2369
            self.repository._warn_if_deprecated(self)
2129
2370
            self.repository.lock_write()
2130
2371
            took_lock = True
2131
2372
        else:
2132
2373
            took_lock = False
2133
2374
        try:
2134
 
            return self.control_files.lock_write(token=token)
 
2375
            return BranchWriteLockResult(self.unlock,
 
2376
                self.control_files.lock_write(token=token))
2135
2377
        except:
2136
2378
            if took_lock:
2137
2379
                self.repository.unlock()
2138
2380
            raise
2139
2381
 
2140
2382
    def lock_read(self):
 
2383
        """Lock the branch for read operations.
 
2384
 
 
2385
        :return: A bzrlib.lock.LogicalLockResult.
 
2386
        """
 
2387
        if not self.is_locked():
 
2388
            self._note_lock('r')
2141
2389
        # All-in-one needs to always unlock/lock.
2142
2390
        repo_control = getattr(self.repository, 'control_files', None)
2143
2391
        if self.control_files == repo_control or not self.is_locked():
 
2392
            self.repository._warn_if_deprecated(self)
2144
2393
            self.repository.lock_read()
2145
2394
            took_lock = True
2146
2395
        else:
2147
2396
            took_lock = False
2148
2397
        try:
2149
2398
            self.control_files.lock_read()
 
2399
            return LogicalLockResult(self.unlock)
2150
2400
        except:
2151
2401
            if took_lock:
2152
2402
                self.repository.unlock()
2153
2403
            raise
2154
2404
 
 
2405
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2155
2406
    def unlock(self):
2156
2407
        try:
2157
2408
            self.control_files.unlock()
2320
2571
        return result
2321
2572
 
2322
2573
    def get_stacked_on_url(self):
2323
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2574
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2324
2575
 
2325
2576
    def set_push_location(self, location):
2326
2577
        """See Branch.set_push_location."""
2516
2767
        if _mod_revision.is_null(last_revision):
2517
2768
            return
2518
2769
        if last_revision not in self._lefthand_history(revision_id):
2519
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2770
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2520
2771
 
2521
2772
    def _gen_revision_history(self):
2522
2773
        """Generate the revision history from last revision
2622
2873
        if branch_location is None:
2623
2874
            return Branch.reference_parent(self, file_id, path,
2624
2875
                                           possible_transports)
2625
 
        branch_location = urlutils.join(self.base, branch_location)
 
2876
        branch_location = urlutils.join(self.user_url, branch_location)
2626
2877
        return Branch.open(branch_location,
2627
2878
                           possible_transports=possible_transports)
2628
2879
 
2674
2925
        return stacked_url
2675
2926
 
2676
2927
    def _get_append_revisions_only(self):
2677
 
        value = self.get_config().get_user_option('append_revisions_only')
2678
 
        return value == 'True'
 
2928
        return self.get_config(
 
2929
            ).get_user_option_as_bool('append_revisions_only')
2679
2930
 
2680
2931
    @needs_write_lock
2681
2932
    def generate_revision_history(self, revision_id, last_rev=None,
2743
2994
    """
2744
2995
 
2745
2996
    def get_stacked_on_url(self):
2746
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2997
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2747
2998
 
2748
2999
 
2749
3000
######################################################################
2836
3087
        :param verbose: Requests more detailed display of what was checked,
2837
3088
            if any.
2838
3089
        """
2839
 
        note('checked branch %s format %s', self.branch.base,
 
3090
        note('checked branch %s format %s', self.branch.user_url,
2840
3091
            self.branch._format)
2841
3092
        for error in self.errors:
2842
3093
            note('found error:%s', error)
3171
3422
        if local and not bound_location:
3172
3423
            raise errors.LocalRequiresBoundBranch()
3173
3424
        master_branch = None
3174
 
        if not local and bound_location and self.source.base != bound_location:
 
3425
        if not local and bound_location and self.source.user_url != bound_location:
3175
3426
            # not pulling from master, so we need to update master.
3176
3427
            master_branch = self.target.get_master_branch(possible_transports)
3177
3428
            master_branch.lock_write()