/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: Martin Pool
  • Date: 2009-08-06 05:20:04 UTC
  • mto: This revision was merged to the branch mainline in revision 4595.
  • Revision ID: mbp@sourcefrog.net-20090806052004-22edm2oradkpm0xk
bundle_info blackbox test passes on rich-root formats

Show diffs side-by-side

added added

removed removed

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