/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: Vincent Ladeuil
  • Date: 2009-09-02 08:26:27 UTC
  • mto: (4669.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4670.
  • Revision ID: v.ladeuil+lp@free.fr-20090902082627-cit8vm6tefu9hwk2
Cleanup emacs-bzr-send-XXXXXX.el leaks in /tmp during selftest.

* tests/test_mail_client.py:
(TestEmacsMail.test_commandline,
TestEmacsMail.test_commandline_is_8bit): Cleanup the generated tmp
file.

* mail_client.py:
(EmacsMail.__init__, EmacsMail._get_compose_commandline): Keep
track of the tmp file to ease cleanup during testing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
32
 
        remote,
33
32
        repository,
34
33
        revision as _mod_revision,
35
34
        rio,
47
46
    )
48
47
""")
49
48
 
50
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
50
from bzrlib.hooks import HookPoint, Hooks
52
51
from bzrlib.inter import InterObject
53
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
52
from bzrlib import registry
55
53
from bzrlib.symbol_versioning import (
56
54
    deprecated_in,
64
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
63
 
66
64
 
67
 
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):
68
78
    """Branch holding a history of revisions.
69
79
 
70
 
    :ivar base:
71
 
        Base directory/url of the branch; using control_url and
72
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
73
82
 
74
83
    hooks: An instance of BranchHooks.
75
84
    """
77
86
    # - RBC 20060112
78
87
    base = None
79
88
 
80
 
    @property
81
 
    def control_transport(self):
82
 
        return self._transport
83
 
 
84
 
    @property
85
 
    def user_transport(self):
86
 
        return self.bzrdir.user_transport
87
 
 
88
89
    def __init__(self, *ignored, **ignored_too):
89
90
        self.tags = self._format.make_tags(self)
90
91
        self._revision_history_cache = None
105
106
        """Activate the branch/repository from url as a fallback repository."""
106
107
        repo = self._get_fallback_repository(url)
107
108
        if repo.has_same_location(self.repository):
108
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
109
110
        self.repository.add_fallback_repository(repo)
110
111
 
111
112
    def break_lock(self):
165
166
        """
166
167
        control = bzrdir.BzrDir.open(base, _unsupported,
167
168
                                     possible_transports=possible_transports)
168
 
        return control.open_branch(unsupported=_unsupported)
 
169
        return control.open_branch(_unsupported)
169
170
 
170
171
    @staticmethod
171
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
172
    def open_from_transport(transport, _unsupported=False):
172
173
        """Open the branch rooted at transport"""
173
174
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
175
        return control.open_branch(_unsupported)
175
176
 
176
177
    @staticmethod
177
178
    def open_containing(url, possible_transports=None):
198
199
        return self.supports_tags() and self.tags.get_tag_dict()
199
200
 
200
201
    def get_config(self):
201
 
        """Get a bzrlib.config.BranchConfig for this Branch.
202
 
 
203
 
        This can then be used to get and set configuration options for the
204
 
        branch.
205
 
 
206
 
        :return: A bzrlib.config.BranchConfig.
207
 
        """
208
202
        return BranchConfig(self)
209
203
 
210
204
    def _get_config(self):
222
216
    def _get_fallback_repository(self, url):
223
217
        """Get the repository we fallback to at url."""
224
218
        url = urlutils.join(self.base, url)
225
 
        a_branch = Branch.open(url,
 
219
        a_bzrdir = bzrdir.BzrDir.open(url,
226
220
            possible_transports=[self.bzrdir.root_transport])
227
 
        return a_branch.repository
 
221
        return a_bzrdir.open_branch().repository
228
222
 
229
223
    def _get_tags_bytes(self):
230
224
        """Get the bytes of a serialised tags dict.
246
240
        if not local and not config.has_explicit_nickname():
247
241
            try:
248
242
                master = self.get_master_branch(possible_transports)
249
 
                if master and self.user_url == master.user_url:
250
 
                    raise errors.RecursiveBind(self.user_url)
251
243
                if master is not None:
252
244
                    # return the master branch value
253
245
                    return master.nick
254
 
            except errors.RecursiveBind, e:
255
 
                raise e
256
246
            except errors.BzrError, e:
257
247
                # Silently fall back to local implicit nick if the master is
258
248
                # unavailable
295
285
        new_history.reverse()
296
286
        return new_history
297
287
 
298
 
    def lock_write(self, token=None):
299
 
        """Lock the branch for write operations.
300
 
 
301
 
        :param token: A token to permit reacquiring a previously held and
302
 
            preserved lock.
303
 
        :return: A BranchWriteLockResult.
304
 
        """
 
288
    def lock_write(self):
305
289
        raise NotImplementedError(self.lock_write)
306
290
 
307
291
    def lock_read(self):
308
 
        """Lock the branch for read operations.
309
 
 
310
 
        :return: A bzrlib.lock.LogicalLockResult.
311
 
        """
312
292
        raise NotImplementedError(self.lock_read)
313
293
 
314
294
    def unlock(self):
439
419
            * 'include' - the stop revision is the last item in the result
440
420
            * 'with-merges' - include the stop revision and all of its
441
421
              merged revisions in the result
442
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
443
 
              that are in both ancestries
444
422
        :param direction: either 'reverse' or 'forward':
445
423
            * reverse means return the start_revision_id first, i.e.
446
424
              start at the most recent revision and go backwards in history
468
446
        # start_revision_id.
469
447
        if self._merge_sorted_revisions_cache is None:
470
448
            last_revision = self.last_revision()
471
 
            known_graph = self.repository.get_known_graph_ancestry(
472
 
                [last_revision])
 
449
            last_key = (last_revision,)
 
450
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
451
                [last_key])
473
452
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
474
 
                last_revision)
 
453
                last_key)
475
454
        filtered = self._filter_merge_sorted_revisions(
476
455
            self._merge_sorted_revisions_cache, start_revision_id,
477
456
            stop_revision_id, stop_rule)
478
 
        # Make sure we don't return revisions that are not part of the
479
 
        # start_revision_id ancestry.
480
 
        filtered = self._filter_start_non_ancestors(filtered)
481
457
        if direction == 'reverse':
482
458
            return filtered
483
459
        if direction == 'forward':
520
496
                       node.end_of_merge)
521
497
                if rev_id == stop_revision_id:
522
498
                    return
523
 
        elif stop_rule == 'with-merges-without-common-ancestry':
524
 
            # We want to exclude all revisions that are already part of the
525
 
            # stop_revision_id ancestry.
526
 
            graph = self.repository.get_graph()
527
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
528
 
                                                    [stop_revision_id])
529
 
            for node in rev_iter:
530
 
                rev_id = node.key[-1]
531
 
                if rev_id not in ancestors:
532
 
                    continue
533
 
                yield (rev_id, node.merge_depth, node.revno,
534
 
                       node.end_of_merge)
535
499
        elif stop_rule == 'with-merges':
536
500
            stop_rev = self.repository.get_revision(stop_revision_id)
537
501
            if stop_rev.parent_ids:
538
502
                left_parent = stop_rev.parent_ids[0]
539
503
            else:
540
504
                left_parent = _mod_revision.NULL_REVISION
541
 
            # left_parent is the actual revision we want to stop logging at,
542
 
            # since we want to show the merged revisions after the stop_rev too
543
 
            reached_stop_revision_id = False
544
 
            revision_id_whitelist = []
545
505
            for node in rev_iter:
546
506
                rev_id = node.key[-1]
547
507
                if rev_id == left_parent:
548
 
                    # reached the left parent after the stop_revision
549
508
                    return
550
 
                if (not reached_stop_revision_id or
551
 
                        rev_id in revision_id_whitelist):
552
 
                    yield (rev_id, node.merge_depth, node.revno,
 
509
                yield (rev_id, node.merge_depth, node.revno,
553
510
                       node.end_of_merge)
554
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
555
 
                        # only do the merged revs of rev_id from now on
556
 
                        rev = self.repository.get_revision(rev_id)
557
 
                        if rev.parent_ids:
558
 
                            reached_stop_revision_id = True
559
 
                            revision_id_whitelist.extend(rev.parent_ids)
560
511
        else:
561
512
            raise ValueError('invalid stop_rule %r' % stop_rule)
562
513
 
563
 
    def _filter_start_non_ancestors(self, rev_iter):
564
 
        # If we started from a dotted revno, we want to consider it as a tip
565
 
        # and don't want to yield revisions that are not part of its
566
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
567
 
        # uninteresting descendants of the first parent of our tip before the
568
 
        # tip itself.
569
 
        first = rev_iter.next()
570
 
        (rev_id, merge_depth, revno, end_of_merge) = first
571
 
        yield first
572
 
        if not merge_depth:
573
 
            # We start at a mainline revision so by definition, all others
574
 
            # revisions in rev_iter are ancestors
575
 
            for node in rev_iter:
576
 
                yield node
577
 
 
578
 
        clean = False
579
 
        whitelist = set()
580
 
        pmap = self.repository.get_parent_map([rev_id])
581
 
        parents = pmap.get(rev_id, [])
582
 
        if parents:
583
 
            whitelist.update(parents)
584
 
        else:
585
 
            # If there is no parents, there is nothing of interest left
586
 
 
587
 
            # FIXME: It's hard to test this scenario here as this code is never
588
 
            # called in that case. -- vila 20100322
589
 
            return
590
 
 
591
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
592
 
            if not clean:
593
 
                if rev_id in whitelist:
594
 
                    pmap = self.repository.get_parent_map([rev_id])
595
 
                    parents = pmap.get(rev_id, [])
596
 
                    whitelist.remove(rev_id)
597
 
                    whitelist.update(parents)
598
 
                    if merge_depth == 0:
599
 
                        # We've reached the mainline, there is nothing left to
600
 
                        # filter
601
 
                        clean = True
602
 
                else:
603
 
                    # A revision that is not part of the ancestry of our
604
 
                    # starting revision.
605
 
                    continue
606
 
            yield (rev_id, merge_depth, revno, end_of_merge)
607
 
 
608
514
    def leave_lock_in_place(self):
609
515
        """Tell this branch object not to release the physical lock when this
610
516
        object is unlocked.
627
533
        :param other: The branch to bind to
628
534
        :type other: Branch
629
535
        """
630
 
        raise errors.UpgradeRequired(self.user_url)
 
536
        raise errors.UpgradeRequired(self.base)
631
537
 
632
538
    def set_append_revisions_only(self, enabled):
633
539
        if not self._format.supports_set_append_revisions_only():
634
 
            raise errors.UpgradeRequired(self.user_url)
 
540
            raise errors.UpgradeRequired(self.base)
635
541
        if enabled:
636
542
            value = 'True'
637
543
        else:
685
591
    def get_old_bound_location(self):
686
592
        """Return the URL of the branch we used to be bound to
687
593
        """
688
 
        raise errors.UpgradeRequired(self.user_url)
 
594
        raise errors.UpgradeRequired(self.base)
689
595
 
690
596
    def get_commit_builder(self, parents, config=None, timestamp=None,
691
597
                           timezone=None, committer=None, revprops=None,
769
675
            stacking.
770
676
        """
771
677
        if not self._format.supports_stacking():
772
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
678
            raise errors.UnstackableBranchFormat(self._format, self.base)
773
679
        # XXX: Changing from one fallback repository to another does not check
774
680
        # that all the data you need is present in the new fallback.
775
681
        # Possibly it should.
805
711
            if len(old_repository._fallback_repositories) != 1:
806
712
                raise AssertionError("can't cope with fallback repositories "
807
713
                    "of %r" % (self.repository,))
808
 
            # Open the new repository object.
809
 
            # Repositories don't offer an interface to remove fallback
810
 
            # repositories today; take the conceptually simpler option and just
811
 
            # reopen it.  We reopen it starting from the URL so that we
812
 
            # get a separate connection for RemoteRepositories and can
813
 
            # stream from one of them to the other.  This does mean doing
814
 
            # separate SSH connection setup, but unstacking is not a
815
 
            # common operation so it's tolerable.
816
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
817
 
            new_repository = new_bzrdir.find_repository()
818
 
            if new_repository._fallback_repositories:
819
 
                raise AssertionError("didn't expect %r to have "
820
 
                    "fallback_repositories"
821
 
                    % (self.repository,))
822
 
            # Replace self.repository with the new repository.
823
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
824
 
            # lock count) of self.repository to the new repository.
825
 
            lock_token = old_repository.lock_write().repository_token
826
 
            self.repository = new_repository
827
 
            if isinstance(self, remote.RemoteBranch):
828
 
                # Remote branches can have a second reference to the old
829
 
                # repository that need to be replaced.
830
 
                if self._real_branch is not None:
831
 
                    self._real_branch.repository = new_repository
832
 
            self.repository.lock_write(token=lock_token)
833
 
            if lock_token is not None:
834
 
                old_repository.leave_lock_in_place()
 
714
            # unlock it, including unlocking the fallback
835
715
            old_repository.unlock()
836
 
            if lock_token is not None:
837
 
                # XXX: self.repository.leave_lock_in_place() before this
838
 
                # function will not be preserved.  Fortunately that doesn't
839
 
                # affect the current default format (2a), and would be a
840
 
                # corner-case anyway.
841
 
                #  - Andrew Bennetts, 2010/06/30
842
 
                self.repository.dont_leave_lock_in_place()
843
 
            old_lock_count = 0
844
 
            while True:
845
 
                try:
846
 
                    old_repository.unlock()
847
 
                except errors.LockNotHeld:
848
 
                    break
849
 
                old_lock_count += 1
850
 
            if old_lock_count == 0:
851
 
                raise AssertionError(
852
 
                    'old_repository should have been locked at least once.')
853
 
            for i in range(old_lock_count-1):
 
716
            old_repository.lock_read()
 
717
            try:
 
718
                # Repositories don't offer an interface to remove fallback
 
719
                # repositories today; take the conceptually simpler option and just
 
720
                # reopen it.  We reopen it starting from the URL so that we
 
721
                # get a separate connection for RemoteRepositories and can
 
722
                # stream from one of them to the other.  This does mean doing
 
723
                # separate SSH connection setup, but unstacking is not a
 
724
                # common operation so it's tolerable.
 
725
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
726
                new_repository = new_bzrdir.find_repository()
 
727
                self.repository = new_repository
 
728
                if self.repository._fallback_repositories:
 
729
                    raise AssertionError("didn't expect %r to have "
 
730
                        "fallback_repositories"
 
731
                        % (self.repository,))
 
732
                # this is not paired with an unlock because it's just restoring
 
733
                # the previous state; the lock's released when set_stacked_on_url
 
734
                # returns
854
735
                self.repository.lock_write()
855
 
            # Fetch from the old repository into the new.
856
 
            old_repository.lock_read()
857
 
            try:
858
736
                # XXX: If you unstack a branch while it has a working tree
859
737
                # with a pending merge, the pending-merged revisions will no
860
738
                # longer be present.  You can (probably) revert and remerge.
954
832
 
955
833
    def unbind(self):
956
834
        """Older format branches cannot bind or unbind."""
957
 
        raise errors.UpgradeRequired(self.user_url)
 
835
        raise errors.UpgradeRequired(self.base)
958
836
 
959
837
    def last_revision(self):
960
838
        """Return last revision id, or NULL_REVISION."""
1001
879
                raise errors.NoSuchRevision(self, stop_revision)
1002
880
        return other_history[self_len:stop_revision]
1003
881
 
 
882
    @needs_write_lock
1004
883
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1005
884
                         graph=None):
1006
885
        """Pull in new perfect-fit revisions.
1055
934
            self._extend_partial_history(distance_from_last)
1056
935
        return self._partial_revision_history_cache[distance_from_last]
1057
936
 
 
937
    @needs_write_lock
1058
938
    def pull(self, source, overwrite=False, stop_revision=None,
1059
939
             possible_transports=None, *args, **kwargs):
1060
940
        """Mirror source into this branch.
1118
998
        try:
1119
999
            return urlutils.join(self.base[:-1], parent)
1120
1000
        except errors.InvalidURLJoin, e:
1121
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1001
            raise errors.InaccessibleParent(parent, self.base)
1122
1002
 
1123
1003
    def _get_parent_location(self):
1124
1004
        raise NotImplementedError(self._get_parent_location)
1209
1089
        params = ChangeBranchTipParams(
1210
1090
            self, old_revno, new_revno, old_revid, new_revid)
1211
1091
        for hook in hooks:
1212
 
            hook(params)
 
1092
            try:
 
1093
                hook(params)
 
1094
            except errors.TipChangeRejected:
 
1095
                raise
 
1096
            except Exception:
 
1097
                exc_info = sys.exc_info()
 
1098
                hook_name = Branch.hooks.get_hook_name(hook)
 
1099
                raise errors.HookFailed(
 
1100
                    'pre_change_branch_tip', hook_name, exc_info)
1213
1101
 
1214
1102
    @needs_write_lock
1215
1103
    def update(self):
1303
1191
                revno = 1
1304
1192
        destination.set_last_revision_info(revno, revision_id)
1305
1193
 
 
1194
    @needs_read_lock
1306
1195
    def copy_content_into(self, destination, revision_id=None):
1307
1196
        """Copy the content of self into destination.
1308
1197
 
1309
1198
        revision_id: if not None, the revision history in the new branch will
1310
1199
                     be truncated to end with revision_id.
1311
1200
        """
1312
 
        return InterBranch.get(self, destination).copy_content_into(
1313
 
            revision_id=revision_id)
 
1201
        self.update_references(destination)
 
1202
        self._synchronize_history(destination, revision_id)
 
1203
        try:
 
1204
            parent = self.get_parent()
 
1205
        except errors.InaccessibleParent, e:
 
1206
            mutter('parent was not accessible to copy: %s', e)
 
1207
        else:
 
1208
            if parent:
 
1209
                destination.set_parent(parent)
 
1210
        if self._push_should_merge_tags():
 
1211
            self.tags.merge_to(destination.tags)
1314
1212
 
1315
1213
    def update_references(self, target):
1316
1214
        if not getattr(self._format, 'supports_reference_locations', False):
1384
1282
        """
1385
1283
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1386
1284
        # clone call. Or something. 20090224 RBC/spiv.
1387
 
        # XXX: Should this perhaps clone colocated branches as well, 
1388
 
        # rather than just the default branch? 20100319 JRV
1389
1285
        if revision_id is None:
1390
1286
            revision_id = self.last_revision()
1391
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1392
 
            revision_id=revision_id, stacked_on=stacked_on,
1393
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1287
        try:
 
1288
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1289
                revision_id=revision_id, stacked_on=stacked_on,
 
1290
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1291
        except errors.FileExists:
 
1292
            if not use_existing_dir:
 
1293
                raise
 
1294
        except errors.NoSuchFile:
 
1295
            if not create_prefix:
 
1296
                raise
1394
1297
        return dir_to.open_branch()
1395
1298
 
1396
1299
    def create_checkout(self, to_location, revision_id=None,
1415
1318
        if lightweight:
1416
1319
            format = self._get_checkout_format()
1417
1320
            checkout = format.initialize_on_transport(t)
1418
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1419
 
                target_branch=self)
 
1321
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1420
1322
        else:
1421
1323
            format = self._get_checkout_format()
1422
1324
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1464
1366
    def supports_tags(self):
1465
1367
        return self._format.supports_tags()
1466
1368
 
1467
 
    def automatic_tag_name(self, revision_id):
1468
 
        """Try to automatically find the tag name for a revision.
1469
 
 
1470
 
        :param revision_id: Revision id of the revision.
1471
 
        :return: A tag name or None if no tag name could be determined.
1472
 
        """
1473
 
        for hook in Branch.hooks['automatic_tag_name']:
1474
 
            ret = hook(self, revision_id)
1475
 
            if ret is not None:
1476
 
                return ret
1477
 
        return None
1478
 
 
1479
1369
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1480
1370
                                         other_branch):
1481
1371
        """Ensure that revision_b is a descendant of revision_a.
1545
1435
        return not (self == other)
1546
1436
 
1547
1437
    @classmethod
1548
 
    def find_format(klass, a_bzrdir, name=None):
 
1438
    def find_format(klass, a_bzrdir):
1549
1439
        """Return the format for the branch object in a_bzrdir."""
1550
1440
        try:
1551
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1552
 
            format_string = transport.get_bytes("format")
1553
 
            format = klass._formats[format_string]
1554
 
            if isinstance(format, MetaDirBranchFormatFactory):
1555
 
                return format()
1556
 
            return format
 
1441
            transport = a_bzrdir.get_branch_transport(None)
 
1442
            format_string = transport.get("format").read()
 
1443
            return klass._formats[format_string]
1557
1444
        except errors.NoSuchFile:
1558
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1445
            raise errors.NotBranchError(path=transport.base)
1559
1446
        except KeyError:
1560
1447
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1561
1448
 
1564
1451
        """Return the current default format."""
1565
1452
        return klass._default_format
1566
1453
 
1567
 
    @classmethod
1568
 
    def get_formats(klass):
1569
 
        """Get all the known formats.
1570
 
 
1571
 
        Warning: This triggers a load of all lazy registered formats: do not
1572
 
        use except when that is desireed.
1573
 
        """
1574
 
        result = []
1575
 
        for fmt in klass._formats.values():
1576
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1577
 
                fmt = fmt()
1578
 
            result.append(fmt)
1579
 
        return result
1580
 
 
1581
 
    def get_reference(self, a_bzrdir, name=None):
 
1454
    def get_reference(self, a_bzrdir):
1582
1455
        """Get the target reference of the branch in a_bzrdir.
1583
1456
 
1584
1457
        format probing must have been completed before calling
1586
1459
        in a_bzrdir is correct.
1587
1460
 
1588
1461
        :param a_bzrdir: The bzrdir to get the branch data from.
1589
 
        :param name: Name of the colocated branch to fetch
1590
1462
        :return: None if the branch is not a reference branch.
1591
1463
        """
1592
1464
        return None
1593
1465
 
1594
1466
    @classmethod
1595
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1467
    def set_reference(self, a_bzrdir, to_branch):
1596
1468
        """Set the target reference of the branch in a_bzrdir.
1597
1469
 
1598
1470
        format probing must have been completed before calling
1600
1472
        in a_bzrdir is correct.
1601
1473
 
1602
1474
        :param a_bzrdir: The bzrdir to set the branch reference for.
1603
 
        :param name: Name of colocated branch to set, None for default
1604
1475
        :param to_branch: branch that the checkout is to reference
1605
1476
        """
1606
1477
        raise NotImplementedError(self.set_reference)
1613
1484
        """Return the short format description for this format."""
1614
1485
        raise NotImplementedError(self.get_format_description)
1615
1486
 
1616
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1617
 
        hooks = Branch.hooks['post_branch_init']
1618
 
        if not hooks:
1619
 
            return
1620
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1621
 
        for hook in hooks:
1622
 
            hook(params)
1623
 
 
1624
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1625
 
                           lock_type='metadir', set_format=True):
 
1487
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1488
                           set_format=True):
1626
1489
        """Initialize a branch in a bzrdir, with specified files
1627
1490
 
1628
1491
        :param a_bzrdir: The bzrdir to initialize the branch in
1629
1492
        :param utf8_files: The files to create as a list of
1630
1493
            (filename, content) tuples
1631
 
        :param name: Name of colocated branch to create, if any
1632
1494
        :param set_format: If True, set the format with
1633
1495
            self.get_format_string.  (BzrBranch4 has its format set
1634
1496
            elsewhere)
1635
1497
        :return: a branch in this format
1636
1498
        """
1637
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1638
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1499
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1500
        branch_transport = a_bzrdir.get_branch_transport(self)
1639
1501
        lock_map = {
1640
1502
            'metadir': ('lock', lockdir.LockDir),
1641
1503
            'branch4': ('branch-lock', lockable_files.TransportLock),
1662
1524
        finally:
1663
1525
            if lock_taken:
1664
1526
                control_files.unlock()
1665
 
        branch = self.open(a_bzrdir, name, _found=True)
1666
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1667
 
        return branch
 
1527
        return self.open(a_bzrdir, _found=True)
1668
1528
 
1669
 
    def initialize(self, a_bzrdir, name=None):
1670
 
        """Create a branch of this format in a_bzrdir.
1671
 
        
1672
 
        :param name: Name of the colocated branch to create.
1673
 
        """
 
1529
    def initialize(self, a_bzrdir):
 
1530
        """Create a branch of this format in a_bzrdir."""
1674
1531
        raise NotImplementedError(self.initialize)
1675
1532
 
1676
1533
    def is_supported(self):
1706
1563
        """
1707
1564
        raise NotImplementedError(self.network_name)
1708
1565
 
1709
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1566
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1710
1567
        """Return the branch object for a_bzrdir
1711
1568
 
1712
1569
        :param a_bzrdir: A BzrDir that contains a branch.
1713
 
        :param name: Name of colocated branch to open
1714
1570
        :param _found: a private parameter, do not use it. It is used to
1715
1571
            indicate if format probing has already be done.
1716
1572
        :param ignore_fallbacks: when set, no fallback branches will be opened
1720
1576
 
1721
1577
    @classmethod
1722
1578
    def register_format(klass, format):
1723
 
        """Register a metadir format.
1724
 
        
1725
 
        See MetaDirBranchFormatFactory for the ability to register a format
1726
 
        without loading the code the format needs until it is actually used.
1727
 
        """
 
1579
        """Register a metadir format."""
1728
1580
        klass._formats[format.get_format_string()] = format
1729
1581
        # Metadir formats have a network name of their format string, and get
1730
 
        # registered as factories.
1731
 
        if isinstance(format, MetaDirBranchFormatFactory):
1732
 
            network_format_registry.register(format.get_format_string(), format)
1733
 
        else:
1734
 
            network_format_registry.register(format.get_format_string(),
1735
 
                format.__class__)
 
1582
        # registered as class factories.
 
1583
        network_format_registry.register(format.get_format_string(), format.__class__)
1736
1584
 
1737
1585
    @classmethod
1738
1586
    def set_default_format(klass, format):
1758
1606
        return False  # by default
1759
1607
 
1760
1608
 
1761
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1762
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1763
 
    
1764
 
    While none of the built in BranchFormats are lazy registered yet,
1765
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1766
 
    use it, and the bzr-loom plugin uses it as well (see
1767
 
    bzrlib.plugins.loom.formats).
1768
 
    """
1769
 
 
1770
 
    def __init__(self, format_string, module_name, member_name):
1771
 
        """Create a MetaDirBranchFormatFactory.
1772
 
 
1773
 
        :param format_string: The format string the format has.
1774
 
        :param module_name: Module to load the format class from.
1775
 
        :param member_name: Attribute name within the module for the format class.
1776
 
        """
1777
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1778
 
        self._format_string = format_string
1779
 
        
1780
 
    def get_format_string(self):
1781
 
        """See BranchFormat.get_format_string."""
1782
 
        return self._format_string
1783
 
 
1784
 
    def __call__(self):
1785
 
        """Used for network_format_registry support."""
1786
 
        return self.get_obj()()
1787
 
 
1788
 
 
1789
1609
class BranchHooks(Hooks):
1790
1610
    """A dictionary mapping hook name to a list of callables for branch hooks.
1791
1611
 
1860
1680
            "multiple hooks installed for transform_fallback_location, "
1861
1681
            "all are called with the url returned from the previous hook."
1862
1682
            "The order is however undefined.", (1, 9), None))
1863
 
        self.create_hook(HookPoint('automatic_tag_name',
1864
 
            "Called to determine an automatic tag name for a revision. "
1865
 
            "automatic_tag_name is called with (branch, revision_id) and "
1866
 
            "should return a tag name or None if no tag name could be "
1867
 
            "determined. The first non-None tag name returned will be used.",
1868
 
            (2, 2), None))
1869
 
        self.create_hook(HookPoint('post_branch_init',
1870
 
            "Called after new branch initialization completes. "
1871
 
            "post_branch_init is called with a "
1872
 
            "bzrlib.branch.BranchInitHookParams. "
1873
 
            "Note that init, branch and checkout (both heavyweight and "
1874
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1875
 
        self.create_hook(HookPoint('post_switch',
1876
 
            "Called after a checkout switches branch. "
1877
 
            "post_switch is called with a "
1878
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1879
 
 
1880
1683
 
1881
1684
 
1882
1685
# install the default hooks into the Branch class.
1921
1724
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1922
1725
 
1923
1726
 
1924
 
class BranchInitHookParams(object):
1925
 
    """Object holding parameters passed to *_branch_init hooks.
1926
 
 
1927
 
    There are 4 fields that hooks may wish to access:
1928
 
 
1929
 
    :ivar format: the branch format
1930
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1931
 
    :ivar name: name of colocated branch, if any (or None)
1932
 
    :ivar branch: the branch created
1933
 
 
1934
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1935
 
    the checkout, hence they are different from the corresponding fields in
1936
 
    branch, which refer to the original branch.
1937
 
    """
1938
 
 
1939
 
    def __init__(self, format, a_bzrdir, name, branch):
1940
 
        """Create a group of BranchInitHook parameters.
1941
 
 
1942
 
        :param format: the branch format
1943
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1944
 
            initialized
1945
 
        :param name: name of colocated branch, if any (or None)
1946
 
        :param branch: the branch created
1947
 
 
1948
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1949
 
        to the checkout, hence they are different from the corresponding fields
1950
 
        in branch, which refer to the original branch.
1951
 
        """
1952
 
        self.format = format
1953
 
        self.bzrdir = a_bzrdir
1954
 
        self.name = name
1955
 
        self.branch = branch
1956
 
 
1957
 
    def __eq__(self, other):
1958
 
        return self.__dict__ == other.__dict__
1959
 
 
1960
 
    def __repr__(self):
1961
 
        if self.branch:
1962
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
        else:
1964
 
            return "<%s of format:%s bzrdir:%s>" % (
1965
 
                self.__class__.__name__, self.branch,
1966
 
                self.format, self.bzrdir)
1967
 
 
1968
 
 
1969
 
class SwitchHookParams(object):
1970
 
    """Object holding parameters passed to *_switch hooks.
1971
 
 
1972
 
    There are 4 fields that hooks may wish to access:
1973
 
 
1974
 
    :ivar control_dir: BzrDir of the checkout to change
1975
 
    :ivar to_branch: branch that the checkout is to reference
1976
 
    :ivar force: skip the check for local commits in a heavy checkout
1977
 
    :ivar revision_id: revision ID to switch to (or None)
1978
 
    """
1979
 
 
1980
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1981
 
        """Create a group of SwitchHook parameters.
1982
 
 
1983
 
        :param control_dir: BzrDir of the checkout to change
1984
 
        :param to_branch: branch that the checkout is to reference
1985
 
        :param force: skip the check for local commits in a heavy checkout
1986
 
        :param revision_id: revision ID to switch to (or None)
1987
 
        """
1988
 
        self.control_dir = control_dir
1989
 
        self.to_branch = to_branch
1990
 
        self.force = force
1991
 
        self.revision_id = revision_id
1992
 
 
1993
 
    def __eq__(self, other):
1994
 
        return self.__dict__ == other.__dict__
1995
 
 
1996
 
    def __repr__(self):
1997
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
 
            self.control_dir, self.to_branch,
1999
 
            self.revision_id)
2000
 
 
2001
 
 
2002
1727
class BzrBranchFormat4(BranchFormat):
2003
1728
    """Bzr branch format 4.
2004
1729
 
2011
1736
        """See BranchFormat.get_format_description()."""
2012
1737
        return "Branch format 4"
2013
1738
 
2014
 
    def initialize(self, a_bzrdir, name=None):
 
1739
    def initialize(self, a_bzrdir):
2015
1740
        """Create a branch of this format in a_bzrdir."""
2016
1741
        utf8_files = [('revision-history', ''),
2017
1742
                      ('branch-name', ''),
2018
1743
                      ]
2019
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1744
        return self._initialize_helper(a_bzrdir, utf8_files,
2020
1745
                                       lock_type='branch4', set_format=False)
2021
1746
 
2022
1747
    def __init__(self):
2027
1752
        """The network name for this format is the control dirs disk label."""
2028
1753
        return self._matchingbzrdir.get_format_string()
2029
1754
 
2030
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1755
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2031
1756
        """See BranchFormat.open()."""
2032
1757
        if not _found:
2033
1758
            # we are being called directly and must probe.
2035
1760
        return BzrBranch(_format=self,
2036
1761
                         _control_files=a_bzrdir._control_files,
2037
1762
                         a_bzrdir=a_bzrdir,
2038
 
                         name=name,
2039
1763
                         _repository=a_bzrdir.open_repository())
2040
1764
 
2041
1765
    def __str__(self):
2056
1780
        """
2057
1781
        return self.get_format_string()
2058
1782
 
2059
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1783
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2060
1784
        """See BranchFormat.open()."""
2061
1785
        if not _found:
2062
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1786
            format = BranchFormat.find_format(a_bzrdir)
2063
1787
            if format.__class__ != self.__class__:
2064
1788
                raise AssertionError("wrong format %r found for %r" %
2065
1789
                    (format, self))
2066
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2067
1790
        try:
 
1791
            transport = a_bzrdir.get_branch_transport(None)
2068
1792
            control_files = lockable_files.LockableFiles(transport, 'lock',
2069
1793
                                                         lockdir.LockDir)
2070
1794
            return self._branch_class()(_format=self,
2071
1795
                              _control_files=control_files,
2072
 
                              name=name,
2073
1796
                              a_bzrdir=a_bzrdir,
2074
1797
                              _repository=a_bzrdir.find_repository(),
2075
1798
                              ignore_fallbacks=ignore_fallbacks)
2076
1799
        except errors.NoSuchFile:
2077
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1800
            raise errors.NotBranchError(path=transport.base)
2078
1801
 
2079
1802
    def __init__(self):
2080
1803
        super(BranchFormatMetadir, self).__init__()
2109
1832
        """See BranchFormat.get_format_description()."""
2110
1833
        return "Branch format 5"
2111
1834
 
2112
 
    def initialize(self, a_bzrdir, name=None):
 
1835
    def initialize(self, a_bzrdir):
2113
1836
        """Create a branch of this format in a_bzrdir."""
2114
1837
        utf8_files = [('revision-history', ''),
2115
1838
                      ('branch-name', ''),
2116
1839
                      ]
2117
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1840
        return self._initialize_helper(a_bzrdir, utf8_files)
2118
1841
 
2119
1842
    def supports_tags(self):
2120
1843
        return False
2142
1865
        """See BranchFormat.get_format_description()."""
2143
1866
        return "Branch format 6"
2144
1867
 
2145
 
    def initialize(self, a_bzrdir, name=None):
 
1868
    def initialize(self, a_bzrdir):
2146
1869
        """Create a branch of this format in a_bzrdir."""
2147
1870
        utf8_files = [('last-revision', '0 null:\n'),
2148
1871
                      ('branch.conf', ''),
2149
1872
                      ('tags', ''),
2150
1873
                      ]
2151
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1874
        return self._initialize_helper(a_bzrdir, utf8_files)
2152
1875
 
2153
1876
    def make_tags(self, branch):
2154
1877
        """See bzrlib.branch.BranchFormat.make_tags()."""
2172
1895
        """See BranchFormat.get_format_description()."""
2173
1896
        return "Branch format 8"
2174
1897
 
2175
 
    def initialize(self, a_bzrdir, name=None):
 
1898
    def initialize(self, a_bzrdir):
2176
1899
        """Create a branch of this format in a_bzrdir."""
2177
1900
        utf8_files = [('last-revision', '0 null:\n'),
2178
1901
                      ('branch.conf', ''),
2179
1902
                      ('tags', ''),
2180
1903
                      ('references', '')
2181
1904
                      ]
2182
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1905
        return self._initialize_helper(a_bzrdir, utf8_files)
2183
1906
 
2184
1907
    def __init__(self):
2185
1908
        super(BzrBranchFormat8, self).__init__()
2208
1931
    This format was introduced in bzr 1.6.
2209
1932
    """
2210
1933
 
2211
 
    def initialize(self, a_bzrdir, name=None):
 
1934
    def initialize(self, a_bzrdir):
2212
1935
        """Create a branch of this format in a_bzrdir."""
2213
1936
        utf8_files = [('last-revision', '0 null:\n'),
2214
1937
                      ('branch.conf', ''),
2215
1938
                      ('tags', ''),
2216
1939
                      ]
2217
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1940
        return self._initialize_helper(a_bzrdir, utf8_files)
2218
1941
 
2219
1942
    def _branch_class(self):
2220
1943
        return BzrBranch7
2252
1975
        """See BranchFormat.get_format_description()."""
2253
1976
        return "Checkout reference format 1"
2254
1977
 
2255
 
    def get_reference(self, a_bzrdir, name=None):
 
1978
    def get_reference(self, a_bzrdir):
2256
1979
        """See BranchFormat.get_reference()."""
2257
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2258
 
        return transport.get_bytes('location')
 
1980
        transport = a_bzrdir.get_branch_transport(None)
 
1981
        return transport.get('location').read()
2259
1982
 
2260
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1983
    def set_reference(self, a_bzrdir, to_branch):
2261
1984
        """See BranchFormat.set_reference()."""
2262
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1985
        transport = a_bzrdir.get_branch_transport(None)
2263
1986
        location = transport.put_bytes('location', to_branch.base)
2264
1987
 
2265
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1988
    def initialize(self, a_bzrdir, target_branch=None):
2266
1989
        """Create a branch of this format in a_bzrdir."""
2267
1990
        if target_branch is None:
2268
1991
            # this format does not implement branch itself, thus the implicit
2269
1992
            # creation contract must see it as uninitializable
2270
1993
            raise errors.UninitializableFormat(self)
2271
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2272
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1994
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1995
        branch_transport = a_bzrdir.get_branch_transport(self)
2273
1996
        branch_transport.put_bytes('location',
2274
 
            target_branch.bzrdir.user_url)
 
1997
            target_branch.bzrdir.root_transport.base)
2275
1998
        branch_transport.put_bytes('format', self.get_format_string())
2276
 
        branch = self.open(
2277
 
            a_bzrdir, name, _found=True,
 
1999
        return self.open(
 
2000
            a_bzrdir, _found=True,
2278
2001
            possible_transports=[target_branch.bzrdir.root_transport])
2279
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2280
 
        return branch
2281
2002
 
2282
2003
    def __init__(self):
2283
2004
        super(BranchReferenceFormat, self).__init__()
2289
2010
        def clone(to_bzrdir, revision_id=None,
2290
2011
            repository_policy=None):
2291
2012
            """See Branch.clone()."""
2292
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2013
            return format.initialize(to_bzrdir, a_branch)
2293
2014
            # cannot obey revision_id limits when cloning a reference ...
2294
2015
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2295
2016
            # emit some sort of warning/error to the caller ?!
2296
2017
        return clone
2297
2018
 
2298
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2019
    def open(self, a_bzrdir, _found=False, location=None,
2299
2020
             possible_transports=None, ignore_fallbacks=False):
2300
2021
        """Return the branch that the branch reference in a_bzrdir points at.
2301
2022
 
2302
2023
        :param a_bzrdir: A BzrDir that contains a branch.
2303
 
        :param name: Name of colocated branch to open, if any
2304
2024
        :param _found: a private parameter, do not use it. It is used to
2305
2025
            indicate if format probing has already be done.
2306
2026
        :param ignore_fallbacks: when set, no fallback branches will be opened
2311
2031
        :param possible_transports: An optional reusable transports list.
2312
2032
        """
2313
2033
        if not _found:
2314
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2034
            format = BranchFormat.find_format(a_bzrdir)
2315
2035
            if format.__class__ != self.__class__:
2316
2036
                raise AssertionError("wrong format %r found for %r" %
2317
2037
                    (format, self))
2318
2038
        if location is None:
2319
 
            location = self.get_reference(a_bzrdir, name)
 
2039
            location = self.get_reference(a_bzrdir)
2320
2040
        real_bzrdir = bzrdir.BzrDir.open(
2321
2041
            location, possible_transports=possible_transports)
2322
 
        result = real_bzrdir.open_branch(name=name, 
2323
 
            ignore_fallbacks=ignore_fallbacks)
 
2042
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2324
2043
        # this changes the behaviour of result.clone to create a new reference
2325
2044
        # rather than a copy of the content of the branch.
2326
2045
        # I did not use a proxy object because that needs much more extensive
2360
2079
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2361
2080
 
2362
2081
 
2363
 
class BranchWriteLockResult(LogicalLockResult):
2364
 
    """The result of write locking a branch.
2365
 
 
2366
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2367
 
        None.
2368
 
    :ivar unlock: A callable which will unlock the lock.
2369
 
    """
2370
 
 
2371
 
    def __init__(self, unlock, branch_token):
2372
 
        LogicalLockResult.__init__(self, unlock)
2373
 
        self.branch_token = branch_token
2374
 
 
2375
 
    def __repr__(self):
2376
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2377
 
            self.unlock)
2378
 
 
2379
 
 
2380
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2082
class BzrBranch(Branch):
2381
2083
    """A branch stored in the actual filesystem.
2382
2084
 
2383
2085
    Note that it's "local" in the context of the filesystem; it doesn't
2389
2091
    :ivar repository: Repository for this branch.
2390
2092
    :ivar base: The url of the base directory for this branch; the one
2391
2093
        containing the .bzr directory.
2392
 
    :ivar name: Optional colocated branch name as it exists in the control
2393
 
        directory.
2394
2094
    """
2395
2095
 
2396
2096
    def __init__(self, _format=None,
2397
 
                 _control_files=None, a_bzrdir=None, name=None,
2398
 
                 _repository=None, ignore_fallbacks=False):
 
2097
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2098
                 ignore_fallbacks=False):
2399
2099
        """Create new branch object at a particular location."""
2400
2100
        if a_bzrdir is None:
2401
2101
            raise ValueError('a_bzrdir must be supplied')
2402
2102
        else:
2403
2103
            self.bzrdir = a_bzrdir
2404
2104
        self._base = self.bzrdir.transport.clone('..').base
2405
 
        self.name = name
2406
2105
        # XXX: We should be able to just do
2407
2106
        #   self.base = self.bzrdir.root_transport.base
2408
2107
        # but this does not quite work yet -- mbp 20080522
2415
2114
        Branch.__init__(self)
2416
2115
 
2417
2116
    def __str__(self):
2418
 
        if self.name is None:
2419
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2420
 
        else:
2421
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2422
 
                self.name)
 
2117
        return '%s(%r)' % (self.__class__.__name__, self.base)
2423
2118
 
2424
2119
    __repr__ = __str__
2425
2120
 
2436
2131
        return self.control_files.is_locked()
2437
2132
 
2438
2133
    def lock_write(self, token=None):
2439
 
        """Lock the branch for write operations.
2440
 
 
2441
 
        :param token: A token to permit reacquiring a previously held and
2442
 
            preserved lock.
2443
 
        :return: A BranchWriteLockResult.
2444
 
        """
2445
 
        if not self.is_locked():
2446
 
            self._note_lock('w')
2447
2134
        # All-in-one needs to always unlock/lock.
2448
2135
        repo_control = getattr(self.repository, 'control_files', None)
2449
2136
        if self.control_files == repo_control or not self.is_locked():
2450
 
            self.repository._warn_if_deprecated(self)
2451
2137
            self.repository.lock_write()
2452
2138
            took_lock = True
2453
2139
        else:
2454
2140
            took_lock = False
2455
2141
        try:
2456
 
            return BranchWriteLockResult(self.unlock,
2457
 
                self.control_files.lock_write(token=token))
 
2142
            return self.control_files.lock_write(token=token)
2458
2143
        except:
2459
2144
            if took_lock:
2460
2145
                self.repository.unlock()
2461
2146
            raise
2462
2147
 
2463
2148
    def lock_read(self):
2464
 
        """Lock the branch for read operations.
2465
 
 
2466
 
        :return: A bzrlib.lock.LogicalLockResult.
2467
 
        """
2468
 
        if not self.is_locked():
2469
 
            self._note_lock('r')
2470
2149
        # All-in-one needs to always unlock/lock.
2471
2150
        repo_control = getattr(self.repository, 'control_files', None)
2472
2151
        if self.control_files == repo_control or not self.is_locked():
2473
 
            self.repository._warn_if_deprecated(self)
2474
2152
            self.repository.lock_read()
2475
2153
            took_lock = True
2476
2154
        else:
2477
2155
            took_lock = False
2478
2156
        try:
2479
2157
            self.control_files.lock_read()
2480
 
            return LogicalLockResult(self.unlock)
2481
2158
        except:
2482
2159
            if took_lock:
2483
2160
                self.repository.unlock()
2484
2161
            raise
2485
2162
 
2486
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2487
2163
    def unlock(self):
2488
2164
        try:
2489
2165
            self.control_files.unlock()
2652
2328
        return result
2653
2329
 
2654
2330
    def get_stacked_on_url(self):
2655
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2331
        raise errors.UnstackableBranchFormat(self._format, self.base)
2656
2332
 
2657
2333
    def set_push_location(self, location):
2658
2334
        """See Branch.set_push_location."""
2848
2524
        if _mod_revision.is_null(last_revision):
2849
2525
            return
2850
2526
        if last_revision not in self._lefthand_history(revision_id):
2851
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2527
            raise errors.AppendRevisionsOnlyViolation(self.base)
2852
2528
 
2853
2529
    def _gen_revision_history(self):
2854
2530
        """Generate the revision history from last revision
2954
2630
        if branch_location is None:
2955
2631
            return Branch.reference_parent(self, file_id, path,
2956
2632
                                           possible_transports)
2957
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2633
        branch_location = urlutils.join(self.base, branch_location)
2958
2634
        return Branch.open(branch_location,
2959
2635
                           possible_transports=possible_transports)
2960
2636
 
3006
2682
        return stacked_url
3007
2683
 
3008
2684
    def _get_append_revisions_only(self):
3009
 
        return self.get_config(
3010
 
            ).get_user_option_as_bool('append_revisions_only')
 
2685
        value = self.get_config().get_user_option('append_revisions_only')
 
2686
        return value == 'True'
3011
2687
 
3012
2688
    @needs_write_lock
3013
2689
    def generate_revision_history(self, revision_id, last_rev=None,
3075
2751
    """
3076
2752
 
3077
2753
    def get_stacked_on_url(self):
3078
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2754
        raise errors.UnstackableBranchFormat(self._format, self.base)
3079
2755
 
3080
2756
 
3081
2757
######################################################################
3168
2844
        :param verbose: Requests more detailed display of what was checked,
3169
2845
            if any.
3170
2846
        """
3171
 
        note('checked branch %s format %s', self.branch.user_url,
 
2847
        note('checked branch %s format %s', self.branch.base,
3172
2848
            self.branch._format)
3173
2849
        for error in self.errors:
3174
2850
            note('found error:%s', error)
3269
2945
    _optimisers = []
3270
2946
    """The available optimised InterBranch types."""
3271
2947
 
3272
 
    @classmethod
3273
 
    def _get_branch_formats_to_test(klass):
3274
 
        """Return an iterable of format tuples for testing.
3275
 
        
3276
 
        :return: An iterable of (from_format, to_format) to use when testing
3277
 
            this InterBranch class. Each InterBranch class should define this
3278
 
            method itself.
3279
 
        """
3280
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2948
    @staticmethod
 
2949
    def _get_branch_formats_to_test():
 
2950
        """Return a tuple with the Branch formats to use when testing."""
 
2951
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3281
2952
 
3282
 
    @needs_write_lock
3283
2953
    def pull(self, overwrite=False, stop_revision=None,
3284
2954
             possible_transports=None, local=False):
3285
2955
        """Mirror source into target branch.
3290
2960
        """
3291
2961
        raise NotImplementedError(self.pull)
3292
2962
 
3293
 
    @needs_write_lock
3294
2963
    def update_revisions(self, stop_revision=None, overwrite=False,
3295
2964
                         graph=None):
3296
2965
        """Pull in new perfect-fit revisions.
3304
2973
        """
3305
2974
        raise NotImplementedError(self.update_revisions)
3306
2975
 
3307
 
    @needs_write_lock
3308
2976
    def push(self, overwrite=False, stop_revision=None,
3309
2977
             _override_hook_source_branch=None):
3310
2978
        """Mirror the source branch into the target branch.
3315
2983
 
3316
2984
 
3317
2985
class GenericInterBranch(InterBranch):
3318
 
    """InterBranch implementation that uses public Branch functions."""
3319
 
 
3320
 
    @classmethod
3321
 
    def is_compatible(klass, source, target):
3322
 
        # GenericBranch uses the public API, so always compatible
3323
 
        return True
3324
 
 
3325
 
    @classmethod
3326
 
    def _get_branch_formats_to_test(klass):
3327
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3328
 
 
3329
 
    @classmethod
3330
 
    def unwrap_format(klass, format):
3331
 
        if isinstance(format, remote.RemoteBranchFormat):
3332
 
            format._ensure_real()
3333
 
            return format._custom_format
3334
 
        return format                                                                                                  
3335
 
 
3336
 
    @needs_write_lock
3337
 
    def copy_content_into(self, revision_id=None):
3338
 
        """Copy the content of source into target
3339
 
 
3340
 
        revision_id: if not None, the revision history in the new branch will
3341
 
                     be truncated to end with revision_id.
3342
 
        """
3343
 
        self.source.update_references(self.target)
3344
 
        self.source._synchronize_history(self.target, revision_id)
3345
 
        try:
3346
 
            parent = self.source.get_parent()
3347
 
        except errors.InaccessibleParent, e:
3348
 
            mutter('parent was not accessible to copy: %s', e)
3349
 
        else:
3350
 
            if parent:
3351
 
                self.target.set_parent(parent)
3352
 
        if self.source._push_should_merge_tags():
3353
 
            self.source.tags.merge_to(self.target.tags)
3354
 
 
3355
 
    @needs_write_lock
 
2986
    """InterBranch implementation that uses public Branch functions.
 
2987
    """
 
2988
 
 
2989
    @staticmethod
 
2990
    def _get_branch_formats_to_test():
 
2991
        return BranchFormat._default_format, BranchFormat._default_format
 
2992
 
3356
2993
    def update_revisions(self, stop_revision=None, overwrite=False,
3357
2994
        graph=None):
3358
2995
        """See InterBranch.update_revisions()."""
3359
 
        other_revno, other_last_revision = self.source.last_revision_info()
3360
 
        stop_revno = None # unknown
3361
 
        if stop_revision is None:
3362
 
            stop_revision = other_last_revision
3363
 
            if _mod_revision.is_null(stop_revision):
3364
 
                # if there are no commits, we're done.
3365
 
                return
3366
 
            stop_revno = other_revno
3367
 
 
3368
 
        # what's the current last revision, before we fetch [and change it
3369
 
        # possibly]
3370
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3371
 
        # we fetch here so that we don't process data twice in the common
3372
 
        # case of having something to pull, and so that the check for
3373
 
        # already merged can operate on the just fetched graph, which will
3374
 
        # be cached in memory.
3375
 
        self.target.fetch(self.source, stop_revision)
3376
 
        # Check to see if one is an ancestor of the other
3377
 
        if not overwrite:
3378
 
            if graph is None:
3379
 
                graph = self.target.repository.get_graph()
3380
 
            if self.target._check_if_descendant_or_diverged(
3381
 
                    stop_revision, last_rev, graph, self.source):
3382
 
                # stop_revision is a descendant of last_rev, but we aren't
3383
 
                # overwriting, so we're done.
3384
 
                return
3385
 
        if stop_revno is None:
3386
 
            if graph is None:
3387
 
                graph = self.target.repository.get_graph()
3388
 
            this_revno, this_last_revision = \
3389
 
                    self.target.last_revision_info()
3390
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3391
 
                            [(other_last_revision, other_revno),
3392
 
                             (this_last_revision, this_revno)])
3393
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3394
 
 
3395
 
    @needs_write_lock
 
2996
        self.source.lock_read()
 
2997
        try:
 
2998
            other_revno, other_last_revision = self.source.last_revision_info()
 
2999
            stop_revno = None # unknown
 
3000
            if stop_revision is None:
 
3001
                stop_revision = other_last_revision
 
3002
                if _mod_revision.is_null(stop_revision):
 
3003
                    # if there are no commits, we're done.
 
3004
                    return
 
3005
                stop_revno = other_revno
 
3006
 
 
3007
            # what's the current last revision, before we fetch [and change it
 
3008
            # possibly]
 
3009
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3010
            # we fetch here so that we don't process data twice in the common
 
3011
            # case of having something to pull, and so that the check for
 
3012
            # already merged can operate on the just fetched graph, which will
 
3013
            # be cached in memory.
 
3014
            self.target.fetch(self.source, stop_revision)
 
3015
            # Check to see if one is an ancestor of the other
 
3016
            if not overwrite:
 
3017
                if graph is None:
 
3018
                    graph = self.target.repository.get_graph()
 
3019
                if self.target._check_if_descendant_or_diverged(
 
3020
                        stop_revision, last_rev, graph, self.source):
 
3021
                    # stop_revision is a descendant of last_rev, but we aren't
 
3022
                    # overwriting, so we're done.
 
3023
                    return
 
3024
            if stop_revno is None:
 
3025
                if graph is None:
 
3026
                    graph = self.target.repository.get_graph()
 
3027
                this_revno, this_last_revision = \
 
3028
                        self.target.last_revision_info()
 
3029
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3030
                                [(other_last_revision, other_revno),
 
3031
                                 (this_last_revision, this_revno)])
 
3032
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3033
        finally:
 
3034
            self.source.unlock()
 
3035
 
3396
3036
    def pull(self, overwrite=False, stop_revision=None,
3397
 
             possible_transports=None, run_hooks=True,
 
3037
             possible_transports=None, _hook_master=None, run_hooks=True,
3398
3038
             _override_hook_target=None, local=False):
3399
 
        """Pull from source into self, updating my master if any.
 
3039
        """See Branch.pull.
3400
3040
 
 
3041
        :param _hook_master: Private parameter - set the branch to
 
3042
            be supplied as the master to pull hooks.
3401
3043
        :param run_hooks: Private parameter - if false, this branch
3402
3044
            is being called because it's the master of the primary branch,
3403
3045
            so it should not run its hooks.
 
3046
        :param _override_hook_target: Private parameter - set the branch to be
 
3047
            supplied as the target_branch to pull hooks.
 
3048
        :param local: Only update the local branch, and not the bound branch.
3404
3049
        """
3405
 
        bound_location = self.target.get_bound_location()
3406
 
        if local and not bound_location:
 
3050
        # This type of branch can't be bound.
 
3051
        if local:
3407
3052
            raise errors.LocalRequiresBoundBranch()
3408
 
        master_branch = None
3409
 
        if not local and bound_location and self.source.user_url != bound_location:
3410
 
            # not pulling from master, so we need to update master.
3411
 
            master_branch = self.target.get_master_branch(possible_transports)
3412
 
            master_branch.lock_write()
 
3053
        result = PullResult()
 
3054
        result.source_branch = self.source
 
3055
        if _override_hook_target is None:
 
3056
            result.target_branch = self.target
 
3057
        else:
 
3058
            result.target_branch = _override_hook_target
 
3059
        self.source.lock_read()
3413
3060
        try:
3414
 
            if master_branch:
3415
 
                # pull from source into master.
3416
 
                master_branch.pull(self.source, overwrite, stop_revision,
3417
 
                    run_hooks=False)
3418
 
            return self._pull(overwrite,
3419
 
                stop_revision, _hook_master=master_branch,
3420
 
                run_hooks=run_hooks,
3421
 
                _override_hook_target=_override_hook_target)
 
3061
            # We assume that during 'pull' the target repository is closer than
 
3062
            # the source one.
 
3063
            self.source.update_references(self.target)
 
3064
            graph = self.target.repository.get_graph(self.source.repository)
 
3065
            # TODO: Branch formats should have a flag that indicates 
 
3066
            # that revno's are expensive, and pull() should honor that flag.
 
3067
            # -- JRV20090506
 
3068
            result.old_revno, result.old_revid = \
 
3069
                self.target.last_revision_info()
 
3070
            self.target.update_revisions(self.source, stop_revision,
 
3071
                overwrite=overwrite, graph=graph)
 
3072
            # TODO: The old revid should be specified when merging tags, 
 
3073
            # so a tags implementation that versions tags can only 
 
3074
            # pull in the most recent changes. -- JRV20090506
 
3075
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3076
                overwrite)
 
3077
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3078
            if _hook_master:
 
3079
                result.master_branch = _hook_master
 
3080
                result.local_branch = result.target_branch
 
3081
            else:
 
3082
                result.master_branch = result.target_branch
 
3083
                result.local_branch = None
 
3084
            if run_hooks:
 
3085
                for hook in Branch.hooks['post_pull']:
 
3086
                    hook(result)
3422
3087
        finally:
3423
 
            if master_branch:
3424
 
                master_branch.unlock()
 
3088
            self.source.unlock()
 
3089
        return result
3425
3090
 
3426
3091
    def push(self, overwrite=False, stop_revision=None,
3427
3092
             _override_hook_source_branch=None):
3489
3154
            _run_hooks()
3490
3155
            return result
3491
3156
 
3492
 
    def _pull(self, overwrite=False, stop_revision=None,
3493
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3157
    @classmethod
 
3158
    def is_compatible(self, source, target):
 
3159
        # GenericBranch uses the public API, so always compatible
 
3160
        return True
 
3161
 
 
3162
 
 
3163
class InterToBranch5(GenericInterBranch):
 
3164
 
 
3165
    @staticmethod
 
3166
    def _get_branch_formats_to_test():
 
3167
        return BranchFormat._default_format, BzrBranchFormat5()
 
3168
 
 
3169
    def pull(self, overwrite=False, stop_revision=None,
 
3170
             possible_transports=None, run_hooks=True,
3494
3171
             _override_hook_target=None, local=False):
3495
 
        """See Branch.pull.
3496
 
 
3497
 
        This function is the core worker, used by GenericInterBranch.pull to
3498
 
        avoid duplication when pulling source->master and source->local.
3499
 
 
3500
 
        :param _hook_master: Private parameter - set the branch to
3501
 
            be supplied as the master to pull hooks.
 
3172
        """Pull from source into self, updating my master if any.
 
3173
 
3502
3174
        :param run_hooks: Private parameter - if false, this branch
3503
3175
            is being called because it's the master of the primary branch,
3504
3176
            so it should not run its hooks.
3505
 
        :param _override_hook_target: Private parameter - set the branch to be
3506
 
            supplied as the target_branch to pull hooks.
3507
 
        :param local: Only update the local branch, and not the bound branch.
3508
3177
        """
3509
 
        # This type of branch can't be bound.
3510
 
        if local:
 
3178
        bound_location = self.target.get_bound_location()
 
3179
        if local and not bound_location:
3511
3180
            raise errors.LocalRequiresBoundBranch()
3512
 
        result = PullResult()
3513
 
        result.source_branch = self.source
3514
 
        if _override_hook_target is None:
3515
 
            result.target_branch = self.target
3516
 
        else:
3517
 
            result.target_branch = _override_hook_target
3518
 
        self.source.lock_read()
 
3181
        master_branch = None
 
3182
        if not local and bound_location and self.source.base != bound_location:
 
3183
            # not pulling from master, so we need to update master.
 
3184
            master_branch = self.target.get_master_branch(possible_transports)
 
3185
            master_branch.lock_write()
3519
3186
        try:
3520
 
            # We assume that during 'pull' the target repository is closer than
3521
 
            # the source one.
3522
 
            self.source.update_references(self.target)
3523
 
            graph = self.target.repository.get_graph(self.source.repository)
3524
 
            # TODO: Branch formats should have a flag that indicates 
3525
 
            # that revno's are expensive, and pull() should honor that flag.
3526
 
            # -- JRV20090506
3527
 
            result.old_revno, result.old_revid = \
3528
 
                self.target.last_revision_info()
3529
 
            self.target.update_revisions(self.source, stop_revision,
3530
 
                overwrite=overwrite, graph=graph)
3531
 
            # TODO: The old revid should be specified when merging tags, 
3532
 
            # so a tags implementation that versions tags can only 
3533
 
            # pull in the most recent changes. -- JRV20090506
3534
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3535
 
                overwrite)
3536
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3537
 
            if _hook_master:
3538
 
                result.master_branch = _hook_master
3539
 
                result.local_branch = result.target_branch
3540
 
            else:
3541
 
                result.master_branch = result.target_branch
3542
 
                result.local_branch = None
3543
 
            if run_hooks:
3544
 
                for hook in Branch.hooks['post_pull']:
3545
 
                    hook(result)
 
3187
            if master_branch:
 
3188
                # pull from source into master.
 
3189
                master_branch.pull(self.source, overwrite, stop_revision,
 
3190
                    run_hooks=False)
 
3191
            return super(InterToBranch5, self).pull(overwrite,
 
3192
                stop_revision, _hook_master=master_branch,
 
3193
                run_hooks=run_hooks,
 
3194
                _override_hook_target=_override_hook_target)
3546
3195
        finally:
3547
 
            self.source.unlock()
3548
 
        return result
 
3196
            if master_branch:
 
3197
                master_branch.unlock()
3549
3198
 
3550
3199
 
3551
3200
InterBranch.register_optimiser(GenericInterBranch)
 
3201
InterBranch.register_optimiser(InterToBranch5)