/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-07-10 08:18:28 UTC
  • mto: This revision was merged to the branch mainline in revision 4566.
  • Revision ID: mbp@sourcefrog.net-20090710081828-3zqukazl1b62m05h
Additional test for stacking from absolute URL

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
104
106
        """Activate the branch/repository from url as a fallback repository."""
105
107
        repo = self._get_fallback_repository(url)
106
108
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
108
110
        self.repository.add_fallback_repository(repo)
109
111
 
110
112
    def break_lock(self):
147
149
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
150
            self._partial_revision_history_cache.pop()
149
151
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
152
    @staticmethod
159
153
    def open(base, _unsupported=False, possible_transports=None):
160
154
        """Open the branch rooted at base.
164
158
        """
165
159
        control = bzrdir.BzrDir.open(base, _unsupported,
166
160
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
161
        return control.open_branch(_unsupported)
168
162
 
169
163
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
164
    def open_from_transport(transport, _unsupported=False):
171
165
        """Open the branch rooted at transport"""
172
166
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
167
        return control.open_branch(_unsupported)
174
168
 
175
169
    @staticmethod
176
170
    def open_containing(url, possible_transports=None):
214
208
    def _get_fallback_repository(self, url):
215
209
        """Get the repository we fallback to at url."""
216
210
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
211
        a_bzrdir = bzrdir.BzrDir.open(url,
218
212
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
213
        return a_bzrdir.open_branch().repository
220
214
 
221
215
    def _get_tags_bytes(self):
222
216
        """Get the bytes of a serialised tags dict.
417
411
            * 'include' - the stop revision is the last item in the result
418
412
            * 'with-merges' - include the stop revision and all of its
419
413
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
414
        :param direction: either 'reverse' or 'forward':
423
415
            * reverse means return the start_revision_id first, i.e.
424
416
              start at the most recent revision and go backwards in history
446
438
        # start_revision_id.
447
439
        if self._merge_sorted_revisions_cache is None:
448
440
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
441
            graph = self.repository.get_graph()
 
442
            parent_map = dict(((key, value) for key, value in
 
443
                     graph.iter_ancestry([last_revision]) if value is not None))
 
444
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
445
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
446
                generate_revno=True)
 
447
            # Drop the sequence # before caching
 
448
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
449
 
453
450
        filtered = self._filter_merge_sorted_revisions(
454
451
            self._merge_sorted_revisions_cache, start_revision_id,
455
452
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
453
        if direction == 'reverse':
460
454
            return filtered
461
455
        if direction == 'forward':
468
462
        """Iterate over an inclusive range of sorted revisions."""
469
463
        rev_iter = iter(merge_sorted_revisions)
470
464
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
465
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
466
                if rev_id != start_revision_id:
474
467
                    continue
475
468
                else:
476
469
                    # The decision to include the start or not
477
470
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
471
                    rev_iter = chain(
 
472
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
473
                        rev_iter)
480
474
                    break
481
475
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
476
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
477
                yield rev_id, depth, revno, end_of_merge
487
478
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
479
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
480
                if rev_id == stop_revision_id:
491
481
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
482
                yield rev_id, depth, revno, end_of_merge
494
483
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
484
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
485
                yield rev_id, depth, revno, end_of_merge
499
486
                if rev_id == stop_revision_id:
500
487
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
488
        elif stop_rule == 'with-merges':
514
489
            stop_rev = self.repository.get_revision(stop_revision_id)
515
490
            if stop_rev.parent_ids:
516
491
                left_parent = stop_rev.parent_ids[0]
517
492
            else:
518
493
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
494
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
495
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
496
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
497
                yield rev_id, depth, revno, end_of_merge
538
498
        else:
539
499
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
500
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
501
    def leave_lock_in_place(self):
587
502
        """Tell this branch object not to release the physical lock when this
588
503
        object is unlocked.
605
520
        :param other: The branch to bind to
606
521
        :type other: Branch
607
522
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
 
523
        raise errors.UpgradeRequired(self.base)
609
524
 
610
525
    def set_append_revisions_only(self, enabled):
611
526
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
 
527
            raise errors.UpgradeRequired(self.base)
613
528
        if enabled:
614
529
            value = 'True'
615
530
        else:
663
578
    def get_old_bound_location(self):
664
579
        """Return the URL of the branch we used to be bound to
665
580
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
581
        raise errors.UpgradeRequired(self.base)
667
582
 
668
583
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
584
                           timezone=None, committer=None, revprops=None,
747
662
            stacking.
748
663
        """
749
664
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
665
            raise errors.UnstackableBranchFormat(self._format, self.base)
751
666
        # XXX: Changing from one fallback repository to another does not check
752
667
        # that all the data you need is present in the new fallback.
753
668
        # Possibly it should.
772
687
        """
773
688
        pb = ui.ui_factory.nested_progress_bar()
774
689
        try:
775
 
            pb.update("Unstacking")
776
690
            # The basic approach here is to fetch the tip of the branch,
777
691
            # including all available ghosts, from the existing stacked
778
692
            # repository into a new repository object without the fallbacks. 
904
818
 
905
819
    def unbind(self):
906
820
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
821
        raise errors.UpgradeRequired(self.base)
908
822
 
909
823
    def last_revision(self):
910
824
        """Return last revision id, or NULL_REVISION."""
1070
984
        try:
1071
985
            return urlutils.join(self.base[:-1], parent)
1072
986
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
987
            raise errors.InaccessibleParent(parent, self.base)
1074
988
 
1075
989
    def _get_parent_location(self):
1076
990
        raise NotImplementedError(self._get_parent_location)
1161
1075
        params = ChangeBranchTipParams(
1162
1076
            self, old_revno, new_revno, old_revid, new_revid)
1163
1077
        for hook in hooks:
1164
 
            hook(params)
 
1078
            try:
 
1079
                hook(params)
 
1080
            except errors.TipChangeRejected:
 
1081
                raise
 
1082
            except Exception:
 
1083
                exc_info = sys.exc_info()
 
1084
                hook_name = Branch.hooks.get_hook_name(hook)
 
1085
                raise errors.HookFailed(
 
1086
                    'pre_change_branch_tip', hook_name, exc_info)
1165
1087
 
1166
1088
    @needs_write_lock
1167
1089
    def update(self):
1216
1138
        revision_id: if not None, the revision history in the new branch will
1217
1139
                     be truncated to end with revision_id.
1218
1140
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1141
        result = to_bzrdir.create_branch()
1223
1142
        result.lock_write()
1224
1143
        try:
1292
1211
        target._set_all_reference_info(target_reference_dict)
1293
1212
 
1294
1213
    @needs_read_lock
1295
 
    def check(self, refs):
 
1214
    def check(self):
1296
1215
        """Check consistency of the branch.
1297
1216
 
1298
1217
        In particular this checks that revisions given in the revision-history
1301
1220
 
1302
1221
        Callers will typically also want to check the repository.
1303
1222
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1223
        :return: A BranchCheckResult.
1307
1224
        """
1308
 
        result = BranchCheckResult(self)
 
1225
        ret = BranchCheckResult(self)
 
1226
        mainline_parent_id = None
1309
1227
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
1228
        real_rev_history = []
 
1229
        try:
 
1230
            for revid in self.repository.iter_reverse_revision_history(
 
1231
                last_revision_id):
 
1232
                real_rev_history.append(revid)
 
1233
        except errors.RevisionNotPresent:
 
1234
            ret.ghosts_in_mainline = True
 
1235
        else:
 
1236
            ret.ghosts_in_mainline = False
 
1237
        real_rev_history.reverse()
 
1238
        if len(real_rev_history) != last_revno:
 
1239
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1240
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1241
        # TODO: We should probably also check that real_rev_history actually
 
1242
        #       matches self.revision_history()
 
1243
        for revision_id in real_rev_history:
 
1244
            try:
 
1245
                revision = self.repository.get_revision(revision_id)
 
1246
            except errors.NoSuchRevision, e:
 
1247
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1248
                            % revision_id)
 
1249
            # In general the first entry on the revision history has no parents.
 
1250
            # But it's not illegal for it to have parents listed; this can happen
 
1251
            # in imports from Arch when the parents weren't reachable.
 
1252
            if mainline_parent_id is not None:
 
1253
                if mainline_parent_id not in revision.parent_ids:
 
1254
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1255
                                        "parents of {%s}"
 
1256
                                        % (mainline_parent_id, revision_id))
 
1257
            mainline_parent_id = revision_id
 
1258
        return ret
1321
1259
 
1322
1260
    def _get_checkout_format(self):
1323
1261
        """Return the most suitable metadir for a checkout of this branch.
1348
1286
        # clone call. Or something. 20090224 RBC/spiv.
1349
1287
        if revision_id is None:
1350
1288
            revision_id = self.last_revision()
1351
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1289
        try:
 
1290
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1291
                revision_id=revision_id, stacked_on=stacked_on,
 
1292
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1293
        except errors.FileExists:
 
1294
            if not use_existing_dir:
 
1295
                raise
 
1296
        except errors.NoSuchFile:
 
1297
            if not create_prefix:
 
1298
                raise
1354
1299
        return dir_to.open_branch()
1355
1300
 
1356
1301
    def create_checkout(self, to_location, revision_id=None,
1375
1320
        if lightweight:
1376
1321
            format = self._get_checkout_format()
1377
1322
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1323
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1324
        else:
1381
1325
            format = self._get_checkout_format()
1382
1326
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1368
    def supports_tags(self):
1425
1369
        return self._format.supports_tags()
1426
1370
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1371
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1372
                                         other_branch):
1441
1373
        """Ensure that revision_b is a descendant of revision_a.
1505
1437
        return not (self == other)
1506
1438
 
1507
1439
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1440
    def find_format(klass, a_bzrdir):
1509
1441
        """Return the format for the branch object in a_bzrdir."""
1510
1442
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1443
            transport = a_bzrdir.get_branch_transport(None)
 
1444
            format_string = transport.get("format").read()
1513
1445
            return klass._formats[format_string]
1514
1446
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1447
            raise errors.NotBranchError(path=transport.base)
1516
1448
        except KeyError:
1517
1449
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1450
 
1554
1486
        """Return the short format description for this format."""
1555
1487
        raise NotImplementedError(self.get_format_description)
1556
1488
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1489
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1490
                           set_format=True):
1567
1491
        """Initialize a branch in a bzrdir, with specified files
1568
1492
 
1569
1493
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1494
        :param utf8_files: The files to create as a list of
1571
1495
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1496
        :param set_format: If True, set the format with
1574
1497
            self.get_format_string.  (BzrBranch4 has its format set
1575
1498
            elsewhere)
1576
1499
        :return: a branch in this format
1577
1500
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1501
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1502
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1503
        lock_map = {
1581
1504
            'metadir': ('lock', lockdir.LockDir),
1582
1505
            'branch4': ('branch-lock', lockable_files.TransportLock),
1603
1526
        finally:
1604
1527
            if lock_taken:
1605
1528
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1529
        return self.open(a_bzrdir, _found=True)
1609
1530
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1531
    def initialize(self, a_bzrdir):
 
1532
        """Create a branch of this format in a_bzrdir."""
1615
1533
        raise NotImplementedError(self.initialize)
1616
1534
 
1617
1535
    def is_supported(self):
1647
1565
        """
1648
1566
        raise NotImplementedError(self.network_name)
1649
1567
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1568
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1569
        """Return the branch object for a_bzrdir
1652
1570
 
1653
1571
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1572
        :param _found: a private parameter, do not use it. It is used to
1656
1573
            indicate if format probing has already be done.
1657
1574
        :param ignore_fallbacks: when set, no fallback branches will be opened
1765
1682
            "multiple hooks installed for transform_fallback_location, "
1766
1683
            "all are called with the url returned from the previous hook."
1767
1684
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
1785
1685
 
1786
1686
 
1787
1687
# install the default hooks into the Branch class.
1826
1726
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1727
 
1828
1728
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1729
class BzrBranchFormat4(BranchFormat):
1908
1730
    """Bzr branch format 4.
1909
1731
 
1916
1738
        """See BranchFormat.get_format_description()."""
1917
1739
        return "Branch format 4"
1918
1740
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1741
    def initialize(self, a_bzrdir):
1920
1742
        """Create a branch of this format in a_bzrdir."""
1921
1743
        utf8_files = [('revision-history', ''),
1922
1744
                      ('branch-name', ''),
1923
1745
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1746
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1747
                                       lock_type='branch4', set_format=False)
1926
1748
 
1927
1749
    def __init__(self):
1932
1754
        """The network name for this format is the control dirs disk label."""
1933
1755
        return self._matchingbzrdir.get_format_string()
1934
1756
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1757
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1758
        """See BranchFormat.open()."""
1937
1759
        if not _found:
1938
1760
            # we are being called directly and must probe.
1940
1762
        return BzrBranch(_format=self,
1941
1763
                         _control_files=a_bzrdir._control_files,
1942
1764
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1765
                         _repository=a_bzrdir.open_repository())
1945
1766
 
1946
1767
    def __str__(self):
1961
1782
        """
1962
1783
        return self.get_format_string()
1963
1784
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1785
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1786
        """See BranchFormat.open()."""
1966
1787
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1788
            format = BranchFormat.find_format(a_bzrdir)
1968
1789
            if format.__class__ != self.__class__:
1969
1790
                raise AssertionError("wrong format %r found for %r" %
1970
1791
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1792
        try:
 
1793
            transport = a_bzrdir.get_branch_transport(None)
1973
1794
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1795
                                                         lockdir.LockDir)
1975
1796
            return self._branch_class()(_format=self,
1976
1797
                              _control_files=control_files,
1977
 
                              name=name,
1978
1798
                              a_bzrdir=a_bzrdir,
1979
1799
                              _repository=a_bzrdir.find_repository(),
1980
1800
                              ignore_fallbacks=ignore_fallbacks)
1981
1801
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1802
            raise errors.NotBranchError(path=transport.base)
1983
1803
 
1984
1804
    def __init__(self):
1985
1805
        super(BranchFormatMetadir, self).__init__()
2014
1834
        """See BranchFormat.get_format_description()."""
2015
1835
        return "Branch format 5"
2016
1836
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1837
    def initialize(self, a_bzrdir):
2018
1838
        """Create a branch of this format in a_bzrdir."""
2019
1839
        utf8_files = [('revision-history', ''),
2020
1840
                      ('branch-name', ''),
2021
1841
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1842
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1843
 
2024
1844
    def supports_tags(self):
2025
1845
        return False
2047
1867
        """See BranchFormat.get_format_description()."""
2048
1868
        return "Branch format 6"
2049
1869
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1870
    def initialize(self, a_bzrdir):
2051
1871
        """Create a branch of this format in a_bzrdir."""
2052
1872
        utf8_files = [('last-revision', '0 null:\n'),
2053
1873
                      ('branch.conf', ''),
2054
1874
                      ('tags', ''),
2055
1875
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1876
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1877
 
2058
1878
    def make_tags(self, branch):
2059
1879
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
1897
        """See BranchFormat.get_format_description()."""
2078
1898
        return "Branch format 8"
2079
1899
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1900
    def initialize(self, a_bzrdir):
2081
1901
        """Create a branch of this format in a_bzrdir."""
2082
1902
        utf8_files = [('last-revision', '0 null:\n'),
2083
1903
                      ('branch.conf', ''),
2084
1904
                      ('tags', ''),
2085
1905
                      ('references', '')
2086
1906
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1907
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1908
 
2089
1909
    def __init__(self):
2090
1910
        super(BzrBranchFormat8, self).__init__()
2113
1933
    This format was introduced in bzr 1.6.
2114
1934
    """
2115
1935
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
1936
    def initialize(self, a_bzrdir):
2117
1937
        """Create a branch of this format in a_bzrdir."""
2118
1938
        utf8_files = [('last-revision', '0 null:\n'),
2119
1939
                      ('branch.conf', ''),
2120
1940
                      ('tags', ''),
2121
1941
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1942
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1943
 
2124
1944
    def _branch_class(self):
2125
1945
        return BzrBranch7
2160
1980
    def get_reference(self, a_bzrdir):
2161
1981
        """See BranchFormat.get_reference()."""
2162
1982
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1983
        return transport.get('location').read()
2164
1984
 
2165
1985
    def set_reference(self, a_bzrdir, to_branch):
2166
1986
        """See BranchFormat.set_reference()."""
2167
1987
        transport = a_bzrdir.get_branch_transport(None)
2168
1988
        location = transport.put_bytes('location', to_branch.base)
2169
1989
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1990
    def initialize(self, a_bzrdir, target_branch=None):
2171
1991
        """Create a branch of this format in a_bzrdir."""
2172
1992
        if target_branch is None:
2173
1993
            # this format does not implement branch itself, thus the implicit
2174
1994
            # creation contract must see it as uninitializable
2175
1995
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1996
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1997
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1998
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1999
            target_branch.bzrdir.root_transport.base)
2180
2000
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
2001
        return self.open(
 
2002
            a_bzrdir, _found=True,
2183
2003
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
2004
 
2187
2005
    def __init__(self):
2188
2006
        super(BranchReferenceFormat, self).__init__()
2194
2012
        def clone(to_bzrdir, revision_id=None,
2195
2013
            repository_policy=None):
2196
2014
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2015
            return format.initialize(to_bzrdir, a_branch)
2198
2016
            # cannot obey revision_id limits when cloning a reference ...
2199
2017
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
2018
            # emit some sort of warning/error to the caller ?!
2201
2019
        return clone
2202
2020
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2021
    def open(self, a_bzrdir, _found=False, location=None,
2204
2022
             possible_transports=None, ignore_fallbacks=False):
2205
2023
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2024
 
2207
2025
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
2026
        :param _found: a private parameter, do not use it. It is used to
2210
2027
            indicate if format probing has already be done.
2211
2028
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
2033
        :param possible_transports: An optional reusable transports list.
2217
2034
        """
2218
2035
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2036
            format = BranchFormat.find_format(a_bzrdir)
2220
2037
            if format.__class__ != self.__class__:
2221
2038
                raise AssertionError("wrong format %r found for %r" %
2222
2039
                    (format, self))
2224
2041
            location = self.get_reference(a_bzrdir)
2225
2042
        real_bzrdir = bzrdir.BzrDir.open(
2226
2043
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2044
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
2045
        # this changes the behaviour of result.clone to create a new reference
2230
2046
        # rather than a copy of the content of the branch.
2231
2047
        # I did not use a proxy object because that needs much more extensive
2258
2074
BranchFormat.register_format(__format6)
2259
2075
BranchFormat.register_format(__format7)
2260
2076
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
2077
BranchFormat.set_default_format(__format6)
2262
2078
_legacy_formats = [BzrBranchFormat4(),
2263
2079
    ]
2264
2080
network_format_registry.register(
2265
2081
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2082
 
2267
2083
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2084
class BzrBranch(Branch):
2269
2085
    """A branch stored in the actual filesystem.
2270
2086
 
2271
2087
    Note that it's "local" in the context of the filesystem; it doesn't
2277
2093
    :ivar repository: Repository for this branch.
2278
2094
    :ivar base: The url of the base directory for this branch; the one
2279
2095
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
2096
    """
2283
2097
 
2284
2098
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2099
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2100
                 ignore_fallbacks=False):
2287
2101
        """Create new branch object at a particular location."""
2288
2102
        if a_bzrdir is None:
2289
2103
            raise ValueError('a_bzrdir must be supplied')
2290
2104
        else:
2291
2105
            self.bzrdir = a_bzrdir
2292
2106
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
2107
        # XXX: We should be able to just do
2295
2108
        #   self.base = self.bzrdir.root_transport.base
2296
2109
        # but this does not quite work yet -- mbp 20080522
2303
2116
        Branch.__init__(self)
2304
2117
 
2305
2118
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
2119
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
2120
 
2312
2121
    __repr__ = __str__
2313
2122
 
2324
2133
        return self.control_files.is_locked()
2325
2134
 
2326
2135
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
2136
        # All-in-one needs to always unlock/lock.
2330
2137
        repo_control = getattr(self.repository, 'control_files', None)
2331
2138
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
2139
            self.repository.lock_write()
2334
2140
            took_lock = True
2335
2141
        else:
2342
2148
            raise
2343
2149
 
2344
2150
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
2151
        # All-in-one needs to always unlock/lock.
2348
2152
        repo_control = getattr(self.repository, 'control_files', None)
2349
2153
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
2154
            self.repository.lock_read()
2352
2155
            took_lock = True
2353
2156
        else:
2359
2162
                self.repository.unlock()
2360
2163
            raise
2361
2164
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
2165
    def unlock(self):
2364
2166
        try:
2365
2167
            self.control_files.unlock()
2528
2330
        return result
2529
2331
 
2530
2332
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2333
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2334
 
2533
2335
    def set_push_location(self, location):
2534
2336
        """See Branch.set_push_location."""
2724
2526
        if _mod_revision.is_null(last_revision):
2725
2527
            return
2726
2528
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2529
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2530
 
2729
2531
    def _gen_revision_history(self):
2730
2532
        """Generate the revision history from last revision
2830
2632
        if branch_location is None:
2831
2633
            return Branch.reference_parent(self, file_id, path,
2832
2634
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2635
        branch_location = urlutils.join(self.base, branch_location)
2834
2636
        return Branch.open(branch_location,
2835
2637
                           possible_transports=possible_transports)
2836
2638
 
2882
2684
        return stacked_url
2883
2685
 
2884
2686
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2687
        value = self.get_config().get_user_option('append_revisions_only')
 
2688
        return value == 'True'
2887
2689
 
2888
2690
    @needs_write_lock
2889
2691
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2753
    """
2952
2754
 
2953
2755
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2756
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2757
 
2956
2758
 
2957
2759
######################################################################
3036
2838
 
3037
2839
    def __init__(self, branch):
3038
2840
        self.branch = branch
3039
 
        self.errors = []
 
2841
        self.ghosts_in_mainline = False
3040
2842
 
3041
2843
    def report_results(self, verbose):
3042
2844
        """Report the check results via trace.note.
3044
2846
        :param verbose: Requests more detailed display of what was checked,
3045
2847
            if any.
3046
2848
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
3049
 
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
2849
        note('checked branch %s format %s',
 
2850
             self.branch.base,
 
2851
             self.branch._format)
 
2852
        if self.ghosts_in_mainline:
 
2853
            note('branch contains ghosts in mainline')
3051
2854
 
3052
2855
 
3053
2856
class Converter5to6(object):
3379
3182
        if local and not bound_location:
3380
3183
            raise errors.LocalRequiresBoundBranch()
3381
3184
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3185
        if not local and bound_location and self.source.base != bound_location:
3383
3186
            # not pulling from master, so we need to update master.
3384
3187
            master_branch = self.target.get_master_branch(possible_transports)
3385
3188
            master_branch.lock_write()