/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from cStringIO import StringIO
18
19
import sys
19
20
 
20
21
from bzrlib.lazy_import import lazy_import
30
31
        lockable_files,
31
32
        repository,
32
33
        revision as _mod_revision,
 
34
        rio,
33
35
        symbol_versioning,
34
36
        transport,
35
37
        tsort,
36
38
        ui,
37
39
        urlutils,
38
40
        )
39
 
from bzrlib.config import BranchConfig
 
41
from bzrlib.config import BranchConfig, TransportConfig
40
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
41
43
from bzrlib.tag import (
42
44
    BasicTags,
44
46
    )
45
47
""")
46
48
 
47
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
48
50
from bzrlib.hooks import HookPoint, Hooks
49
51
from bzrlib.inter import InterObject
 
52
from bzrlib.lock import _RelockDebugMixin
50
53
from bzrlib import registry
51
54
from bzrlib.symbol_versioning import (
52
55
    deprecated_in,
60
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
61
64
 
62
65
 
63
 
# TODO: Maybe include checks for common corruption of newlines, etc?
64
 
 
65
 
# TODO: Some operations like log might retrieve the same revisions
66
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
67
 
# cache in memory to make this faster.  In general anything can be
68
 
# cached in memory between lock and unlock operations. .. nb thats
69
 
# what the transaction identity map provides
70
 
 
71
 
 
72
 
######################################################################
73
 
# branch objects
74
 
 
75
 
class Branch(object):
 
66
class Branch(bzrdir.ControlComponent):
76
67
    """Branch holding a history of revisions.
77
68
 
78
 
    base
79
 
        Base directory/url of the branch.
 
69
    :ivar base:
 
70
        Base directory/url of the branch; using control_url and
 
71
        control_transport is more standardized.
80
72
 
81
73
    hooks: An instance of BranchHooks.
82
74
    """
84
76
    # - RBC 20060112
85
77
    base = None
86
78
 
 
79
    @property
 
80
    def control_transport(self):
 
81
        return self._transport
 
82
 
 
83
    @property
 
84
    def user_transport(self):
 
85
        return self.bzrdir.user_transport
 
86
 
87
87
    def __init__(self, *ignored, **ignored_too):
88
88
        self.tags = self._format.make_tags(self)
89
89
        self._revision_history_cache = None
90
90
        self._revision_id_to_revno_cache = None
91
91
        self._partial_revision_id_to_revno_cache = {}
 
92
        self._partial_revision_history_cache = []
92
93
        self._last_revision_info_cache = None
93
94
        self._merge_sorted_revisions_cache = None
94
95
        self._open_hook()
99
100
    def _open_hook(self):
100
101
        """Called by init to allow simpler extension of the base class."""
101
102
 
 
103
    def _activate_fallback_location(self, url):
 
104
        """Activate the branch/repository from url as a fallback repository."""
 
105
        repo = self._get_fallback_repository(url)
 
106
        if repo.has_same_location(self.repository):
 
107
            raise errors.UnstackableLocationError(self.user_url, url)
 
108
        self.repository.add_fallback_repository(repo)
 
109
 
102
110
    def break_lock(self):
103
111
        """Break a lock if one is present from another instance.
104
112
 
113
121
        if master is not None:
114
122
            master.break_lock()
115
123
 
 
124
    def _check_stackable_repo(self):
 
125
        if not self.repository._format.supports_external_lookups:
 
126
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
127
                self.repository.base)
 
128
 
 
129
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
130
        """Extend the partial history to include a given index
 
131
 
 
132
        If a stop_index is supplied, stop when that index has been reached.
 
133
        If a stop_revision is supplied, stop when that revision is
 
134
        encountered.  Otherwise, stop when the beginning of history is
 
135
        reached.
 
136
 
 
137
        :param stop_index: The index which should be present.  When it is
 
138
            present, history extension will stop.
 
139
        :param stop_revision: The revision id which should be present.  When
 
140
            it is encountered, history extension will stop.
 
141
        """
 
142
        if len(self._partial_revision_history_cache) == 0:
 
143
            self._partial_revision_history_cache = [self.last_revision()]
 
144
        repository._iter_for_revno(
 
145
            self.repository, self._partial_revision_history_cache,
 
146
            stop_index=stop_index, stop_revision=stop_revision)
 
147
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
148
            self._partial_revision_history_cache.pop()
 
149
 
 
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
 
116
158
    @staticmethod
117
159
    def open(base, _unsupported=False, possible_transports=None):
118
160
        """Open the branch rooted at base.
122
164
        """
123
165
        control = bzrdir.BzrDir.open(base, _unsupported,
124
166
                                     possible_transports=possible_transports)
125
 
        return control.open_branch(_unsupported)
 
167
        return control.open_branch(unsupported=_unsupported)
126
168
 
127
169
    @staticmethod
128
 
    def open_from_transport(transport, _unsupported=False):
 
170
    def open_from_transport(transport, name=None, _unsupported=False):
129
171
        """Open the branch rooted at transport"""
130
172
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
131
 
        return control.open_branch(_unsupported)
 
173
        return control.open_branch(name=name, unsupported=_unsupported)
132
174
 
133
175
    @staticmethod
134
176
    def open_containing(url, possible_transports=None):
157
199
    def get_config(self):
158
200
        return BranchConfig(self)
159
201
 
 
202
    def _get_config(self):
 
203
        """Get the concrete config for just the config in this branch.
 
204
 
 
205
        This is not intended for client use; see Branch.get_config for the
 
206
        public API.
 
207
 
 
208
        Added in 1.14.
 
209
 
 
210
        :return: An object supporting get_option and set_option.
 
211
        """
 
212
        raise NotImplementedError(self._get_config)
 
213
 
 
214
    def _get_fallback_repository(self, url):
 
215
        """Get the repository we fallback to at url."""
 
216
        url = urlutils.join(self.base, url)
 
217
        a_branch = Branch.open(url,
 
218
            possible_transports=[self.bzrdir.root_transport])
 
219
        return a_branch.repository
 
220
 
160
221
    def _get_tags_bytes(self):
161
222
        """Get the bytes of a serialised tags dict.
162
223
 
356
417
            * 'include' - the stop revision is the last item in the result
357
418
            * 'with-merges' - include the stop revision and all of its
358
419
              merged revisions in the result
 
420
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
421
              that are in both ancestries
359
422
        :param direction: either 'reverse' or 'forward':
360
423
            * reverse means return the start_revision_id first, i.e.
361
424
              start at the most recent revision and go backwards in history
383
446
        # start_revision_id.
384
447
        if self._merge_sorted_revisions_cache is None:
385
448
            last_revision = self.last_revision()
386
 
            graph = self.repository.get_graph()
387
 
            parent_map = dict(((key, value) for key, value in
388
 
                     graph.iter_ancestry([last_revision]) if value is not None))
389
 
            revision_graph = repository._strip_NULL_ghosts(parent_map)
390
 
            revs = tsort.merge_sort(revision_graph, last_revision, None,
391
 
                generate_revno=True)
392
 
            # Drop the sequence # before caching
393
 
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
394
 
 
 
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)
395
453
        filtered = self._filter_merge_sorted_revisions(
396
454
            self._merge_sorted_revisions_cache, start_revision_id,
397
455
            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)
398
459
        if direction == 'reverse':
399
460
            return filtered
400
461
        if direction == 'forward':
407
468
        """Iterate over an inclusive range of sorted revisions."""
408
469
        rev_iter = iter(merge_sorted_revisions)
409
470
        if start_revision_id is not None:
410
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
471
            for node in rev_iter:
 
472
                rev_id = node.key[-1]
411
473
                if rev_id != start_revision_id:
412
474
                    continue
413
475
                else:
414
476
                    # The decision to include the start or not
415
477
                    # depends on the stop_rule if a stop is provided
416
 
                    rev_iter = chain(
417
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
418
 
                        rev_iter)
 
478
                    # so pop this node back into the iterator
 
479
                    rev_iter = chain(iter([node]), rev_iter)
419
480
                    break
420
481
        if stop_revision_id is None:
421
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
422
 
                yield rev_id, depth, revno, end_of_merge
 
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)
423
487
        elif stop_rule == 'exclude':
424
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
488
            for node in rev_iter:
 
489
                rev_id = node.key[-1]
425
490
                if rev_id == stop_revision_id:
426
491
                    return
427
 
                yield rev_id, depth, revno, end_of_merge
 
492
                yield (rev_id, node.merge_depth, node.revno,
 
493
                       node.end_of_merge)
428
494
        elif stop_rule == 'include':
429
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
430
 
                yield rev_id, depth, revno, end_of_merge
 
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)
431
499
                if rev_id == stop_revision_id:
432
500
                    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)
433
513
        elif stop_rule == 'with-merges':
434
514
            stop_rev = self.repository.get_revision(stop_revision_id)
435
515
            if stop_rev.parent_ids:
436
516
                left_parent = stop_rev.parent_ids[0]
437
517
            else:
438
518
                left_parent = _mod_revision.NULL_REVISION
439
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
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]
440
525
                if rev_id == left_parent:
 
526
                    # reached the left parent after the stop_revision
441
527
                    return
442
 
                yield rev_id, depth, revno, end_of_merge
 
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)
443
538
        else:
444
539
            raise ValueError('invalid stop_rule %r' % stop_rule)
445
540
 
 
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
 
446
586
    def leave_lock_in_place(self):
447
587
        """Tell this branch object not to release the physical lock when this
448
588
        object is unlocked.
465
605
        :param other: The branch to bind to
466
606
        :type other: Branch
467
607
        """
468
 
        raise errors.UpgradeRequired(self.base)
 
608
        raise errors.UpgradeRequired(self.user_url)
 
609
 
 
610
    def set_append_revisions_only(self, enabled):
 
611
        if not self._format.supports_set_append_revisions_only():
 
612
            raise errors.UpgradeRequired(self.user_url)
 
613
        if enabled:
 
614
            value = 'True'
 
615
        else:
 
616
            value = 'False'
 
617
        self.get_config().set_user_option('append_revisions_only', value,
 
618
            warn_masked=True)
 
619
 
 
620
    def set_reference_info(self, file_id, tree_path, branch_location):
 
621
        """Set the branch location to use for a tree reference."""
 
622
        raise errors.UnsupportedOperation(self.set_reference_info, self)
 
623
 
 
624
    def get_reference_info(self, file_id):
 
625
        """Get the tree_path and branch_location for a tree reference."""
 
626
        raise errors.UnsupportedOperation(self.get_reference_info, self)
469
627
 
470
628
    @needs_write_lock
471
629
    def fetch(self, from_branch, last_revision=None, pb=None):
505
663
    def get_old_bound_location(self):
506
664
        """Return the URL of the branch we used to be bound to
507
665
        """
508
 
        raise errors.UpgradeRequired(self.base)
 
666
        raise errors.UpgradeRequired(self.user_url)
509
667
 
510
668
    def get_commit_builder(self, parents, config=None, timestamp=None,
511
669
                           timezone=None, committer=None, revprops=None,
561
719
    def set_revision_history(self, rev_history):
562
720
        raise NotImplementedError(self.set_revision_history)
563
721
 
 
722
    @needs_write_lock
 
723
    def set_parent(self, url):
 
724
        """See Branch.set_parent."""
 
725
        # TODO: Maybe delete old location files?
 
726
        # URLs should never be unicode, even on the local fs,
 
727
        # FIXUP this and get_parent in a future branch format bump:
 
728
        # read and rewrite the file. RBC 20060125
 
729
        if url is not None:
 
730
            if isinstance(url, unicode):
 
731
                try:
 
732
                    url = url.encode('ascii')
 
733
                except UnicodeEncodeError:
 
734
                    raise errors.InvalidURL(url,
 
735
                        "Urls must be 7-bit ascii, "
 
736
                        "use bzrlib.urlutils.escape")
 
737
            url = urlutils.relative_url(self.base, url)
 
738
        self._set_parent_location(url)
 
739
 
 
740
    @needs_write_lock
564
741
    def set_stacked_on_url(self, url):
565
742
        """Set the URL this branch is stacked against.
566
743
 
569
746
        :raises UnstackableRepositoryFormat: If the repository does not support
570
747
            stacking.
571
748
        """
572
 
        raise NotImplementedError(self.set_stacked_on_url)
 
749
        if not self._format.supports_stacking():
 
750
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
751
        # XXX: Changing from one fallback repository to another does not check
 
752
        # that all the data you need is present in the new fallback.
 
753
        # Possibly it should.
 
754
        self._check_stackable_repo()
 
755
        if not url:
 
756
            try:
 
757
                old_url = self.get_stacked_on_url()
 
758
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
759
                errors.UnstackableRepositoryFormat):
 
760
                return
 
761
            self._unstack()
 
762
        else:
 
763
            self._activate_fallback_location(url)
 
764
        # write this out after the repository is stacked to avoid setting a
 
765
        # stacked config that doesn't work.
 
766
        self._set_config_location('stacked_on_location', url)
 
767
 
 
768
    def _unstack(self):
 
769
        """Change a branch to be unstacked, copying data as needed.
 
770
        
 
771
        Don't call this directly, use set_stacked_on_url(None).
 
772
        """
 
773
        pb = ui.ui_factory.nested_progress_bar()
 
774
        try:
 
775
            pb.update("Unstacking")
 
776
            # The basic approach here is to fetch the tip of the branch,
 
777
            # including all available ghosts, from the existing stacked
 
778
            # repository into a new repository object without the fallbacks. 
 
779
            #
 
780
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
781
            # correct for CHKMap repostiories
 
782
            old_repository = self.repository
 
783
            if len(old_repository._fallback_repositories) != 1:
 
784
                raise AssertionError("can't cope with fallback repositories "
 
785
                    "of %r" % (self.repository,))
 
786
            # unlock it, including unlocking the fallback
 
787
            old_repository.unlock()
 
788
            old_repository.lock_read()
 
789
            try:
 
790
                # Repositories don't offer an interface to remove fallback
 
791
                # repositories today; take the conceptually simpler option and just
 
792
                # reopen it.  We reopen it starting from the URL so that we
 
793
                # get a separate connection for RemoteRepositories and can
 
794
                # stream from one of them to the other.  This does mean doing
 
795
                # separate SSH connection setup, but unstacking is not a
 
796
                # common operation so it's tolerable.
 
797
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
798
                new_repository = new_bzrdir.find_repository()
 
799
                self.repository = new_repository
 
800
                if self.repository._fallback_repositories:
 
801
                    raise AssertionError("didn't expect %r to have "
 
802
                        "fallback_repositories"
 
803
                        % (self.repository,))
 
804
                # this is not paired with an unlock because it's just restoring
 
805
                # the previous state; the lock's released when set_stacked_on_url
 
806
                # returns
 
807
                self.repository.lock_write()
 
808
                # XXX: If you unstack a branch while it has a working tree
 
809
                # with a pending merge, the pending-merged revisions will no
 
810
                # longer be present.  You can (probably) revert and remerge.
 
811
                #
 
812
                # XXX: This only fetches up to the tip of the repository; it
 
813
                # doesn't bring across any tags.  That's fairly consistent
 
814
                # with how branch works, but perhaps not ideal.
 
815
                self.repository.fetch(old_repository,
 
816
                    revision_id=self.last_revision(),
 
817
                    find_ghosts=True)
 
818
            finally:
 
819
                old_repository.unlock()
 
820
        finally:
 
821
            pb.finished()
573
822
 
574
823
    def _set_tags_bytes(self, bytes):
575
824
        """Mirror method for _get_tags_bytes.
611
860
        self._revision_id_to_revno_cache = None
612
861
        self._last_revision_info_cache = None
613
862
        self._merge_sorted_revisions_cache = None
 
863
        self._partial_revision_history_cache = []
 
864
        self._partial_revision_id_to_revno_cache = {}
614
865
 
615
866
    def _gen_revision_history(self):
616
867
        """Return sequence of revision hashes on to this branch.
653
904
 
654
905
    def unbind(self):
655
906
        """Older format branches cannot bind or unbind."""
656
 
        raise errors.UpgradeRequired(self.base)
657
 
 
658
 
    def set_append_revisions_only(self, enabled):
659
 
        """Older format branches are never restricted to append-only"""
660
 
        raise errors.UpgradeRequired(self.base)
 
907
        raise errors.UpgradeRequired(self.user_url)
661
908
 
662
909
    def last_revision(self):
663
910
        """Return last revision id, or NULL_REVISION."""
744
991
        except ValueError:
745
992
            raise errors.NoSuchRevision(self, revision_id)
746
993
 
 
994
    @needs_read_lock
747
995
    def get_rev_id(self, revno, history=None):
748
996
        """Find the revision id of the specified revno."""
749
997
        if revno == 0:
750
998
            return _mod_revision.NULL_REVISION
751
 
        if history is None:
752
 
            history = self.revision_history()
753
 
        if revno <= 0 or revno > len(history):
 
999
        last_revno, last_revid = self.last_revision_info()
 
1000
        if revno == last_revno:
 
1001
            return last_revid
 
1002
        if revno <= 0 or revno > last_revno:
754
1003
            raise errors.NoSuchRevision(self, revno)
755
 
        return history[revno - 1]
 
1004
        distance_from_last = last_revno - revno
 
1005
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
1006
            self._extend_partial_history(distance_from_last)
 
1007
        return self._partial_revision_history_cache[distance_from_last]
756
1008
 
 
1009
    @needs_write_lock
757
1010
    def pull(self, source, overwrite=False, stop_revision=None,
758
 
             possible_transports=None, _override_hook_target=None):
 
1011
             possible_transports=None, *args, **kwargs):
759
1012
        """Mirror source into this branch.
760
1013
 
761
1014
        This branch is considered to be 'local', having low latency.
762
1015
 
763
1016
        :returns: PullResult instance
764
1017
        """
765
 
        raise NotImplementedError(self.pull)
 
1018
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
1019
            stop_revision=stop_revision,
 
1020
            possible_transports=possible_transports, *args, **kwargs)
766
1021
 
767
 
    def push(self, target, overwrite=False, stop_revision=None):
 
1022
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
1023
        **kwargs):
768
1024
        """Mirror this branch into target.
769
1025
 
770
1026
        This branch is considered to be 'local', having low latency.
771
1027
        """
772
 
        raise NotImplementedError(self.push)
 
1028
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
1029
            *args, **kwargs)
 
1030
 
 
1031
    def lossy_push(self, target, stop_revision=None):
 
1032
        """Push deltas into another branch.
 
1033
 
 
1034
        :note: This does not, like push, retain the revision ids from 
 
1035
            the source branch and will, rather than adding bzr-specific 
 
1036
            metadata, push only those semantics of the revision that can be 
 
1037
            natively represented by this branch' VCS.
 
1038
 
 
1039
        :param target: Target branch
 
1040
        :param stop_revision: Revision to push, defaults to last revision.
 
1041
        :return: BranchPushResult with an extra member revidmap: 
 
1042
            A dictionary mapping revision ids from the target branch 
 
1043
            to new revision ids in the target branch, for each 
 
1044
            revision that was pushed.
 
1045
        """
 
1046
        inter = InterBranch.get(self, target)
 
1047
        lossy_push = getattr(inter, "lossy_push", None)
 
1048
        if lossy_push is None:
 
1049
            raise errors.LossyPushToSameVCS(self, target)
 
1050
        return lossy_push(stop_revision)
773
1051
 
774
1052
    def basis_tree(self):
775
1053
        """Return `Tree` object for last revision."""
792
1070
        try:
793
1071
            return urlutils.join(self.base[:-1], parent)
794
1072
        except errors.InvalidURLJoin, e:
795
 
            raise errors.InaccessibleParent(parent, self.base)
 
1073
            raise errors.InaccessibleParent(parent, self.user_url)
796
1074
 
797
1075
    def _get_parent_location(self):
798
1076
        raise NotImplementedError(self._get_parent_location)
815
1093
            location = None
816
1094
        return location
817
1095
 
 
1096
    def get_child_submit_format(self):
 
1097
        """Return the preferred format of submissions to this branch."""
 
1098
        return self.get_config().get_user_option("child_submit_format")
 
1099
 
818
1100
    def get_submit_branch(self):
819
1101
        """Return the submit location of the branch.
820
1102
 
837
1119
    def get_public_branch(self):
838
1120
        """Return the public location of the branch.
839
1121
 
840
 
        This is is used by merge directives.
 
1122
        This is used by merge directives.
841
1123
        """
842
1124
        return self._get_config_location('public_branch')
843
1125
 
879
1161
        params = ChangeBranchTipParams(
880
1162
            self, old_revno, new_revno, old_revid, new_revid)
881
1163
        for hook in hooks:
882
 
            try:
883
 
                hook(params)
884
 
            except errors.TipChangeRejected:
885
 
                raise
886
 
            except Exception:
887
 
                exc_info = sys.exc_info()
888
 
                hook_name = Branch.hooks.get_hook_name(hook)
889
 
                raise errors.HookFailed(
890
 
                    'pre_change_branch_tip', hook_name, exc_info)
891
 
 
892
 
    def set_parent(self, url):
893
 
        raise NotImplementedError(self.set_parent)
 
1164
            hook(params)
894
1165
 
895
1166
    @needs_write_lock
896
1167
    def update(self):
927
1198
                     be truncated to end with revision_id.
928
1199
        """
929
1200
        result = to_bzrdir.create_branch()
930
 
        if repository_policy is not None:
931
 
            repository_policy.configure_branch(result)
932
 
        self.copy_content_into(result, revision_id=revision_id)
933
 
        return  result
 
1201
        result.lock_write()
 
1202
        try:
 
1203
            if repository_policy is not None:
 
1204
                repository_policy.configure_branch(result)
 
1205
            self.copy_content_into(result, revision_id=revision_id)
 
1206
        finally:
 
1207
            result.unlock()
 
1208
        return result
934
1209
 
935
1210
    @needs_read_lock
936
1211
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
941
1216
        revision_id: if not None, the revision history in the new branch will
942
1217
                     be truncated to end with revision_id.
943
1218
        """
 
1219
        if (repository_policy is not None and
 
1220
            repository_policy.requires_stacking()):
 
1221
            to_bzrdir._format.require_stacking(_skip_repo=True)
944
1222
        result = to_bzrdir.create_branch()
945
 
        if repository_policy is not None:
946
 
            repository_policy.configure_branch(result)
947
 
        self.copy_content_into(result, revision_id=revision_id)
948
 
        result.set_parent(self.bzrdir.root_transport.base)
 
1223
        result.lock_write()
 
1224
        try:
 
1225
            if repository_policy is not None:
 
1226
                repository_policy.configure_branch(result)
 
1227
            self.copy_content_into(result, revision_id=revision_id)
 
1228
            result.set_parent(self.bzrdir.root_transport.base)
 
1229
        finally:
 
1230
            result.unlock()
949
1231
        return result
950
1232
 
951
1233
    def _synchronize_history(self, destination, revision_id):
963
1245
        source_revno, source_revision_id = self.last_revision_info()
964
1246
        if revision_id is None:
965
1247
            revno, revision_id = source_revno, source_revision_id
966
 
        elif source_revision_id == revision_id:
967
 
            # we know the revno without needing to walk all of history
968
 
            revno = source_revno
969
1248
        else:
970
 
            # To figure out the revno for a random revision, we need to build
971
 
            # the revision history, and count its length.
972
 
            # We don't care about the order, just how long it is.
973
 
            # Alternatively, we could start at the current location, and count
974
 
            # backwards. But there is no guarantee that we will find it since
975
 
            # it may be a merged revision.
976
 
            revno = len(list(self.repository.iter_reverse_revision_history(
977
 
                                                                revision_id)))
 
1249
            graph = self.repository.get_graph()
 
1250
            try:
 
1251
                revno = graph.find_distance_to_null(revision_id, 
 
1252
                    [(source_revision_id, source_revno)])
 
1253
            except errors.GhostRevisionsHaveNoRevno:
 
1254
                # Default to 1, if we can't find anything else
 
1255
                revno = 1
978
1256
        destination.set_last_revision_info(revno, revision_id)
979
1257
 
980
1258
    @needs_read_lock
984
1262
        revision_id: if not None, the revision history in the new branch will
985
1263
                     be truncated to end with revision_id.
986
1264
        """
 
1265
        self.update_references(destination)
987
1266
        self._synchronize_history(destination, revision_id)
988
1267
        try:
989
1268
            parent = self.get_parent()
995
1274
        if self._push_should_merge_tags():
996
1275
            self.tags.merge_to(destination.tags)
997
1276
 
 
1277
    def update_references(self, target):
 
1278
        if not getattr(self._format, 'supports_reference_locations', False):
 
1279
            return
 
1280
        reference_dict = self._get_all_reference_info()
 
1281
        if len(reference_dict) == 0:
 
1282
            return
 
1283
        old_base = self.base
 
1284
        new_base = target.base
 
1285
        target_reference_dict = target._get_all_reference_info()
 
1286
        for file_id, (tree_path, branch_location) in (
 
1287
            reference_dict.items()):
 
1288
            branch_location = urlutils.rebase_url(branch_location,
 
1289
                                                  old_base, new_base)
 
1290
            target_reference_dict.setdefault(
 
1291
                file_id, (tree_path, branch_location))
 
1292
        target._set_all_reference_info(target_reference_dict)
 
1293
 
998
1294
    @needs_read_lock
999
 
    def check(self):
 
1295
    def check(self, refs):
1000
1296
        """Check consistency of the branch.
1001
1297
 
1002
1298
        In particular this checks that revisions given in the revision-history
1005
1301
 
1006
1302
        Callers will typically also want to check the repository.
1007
1303
 
 
1304
        :param refs: Calculated refs for this branch as specified by
 
1305
            branch._get_check_refs()
1008
1306
        :return: A BranchCheckResult.
1009
1307
        """
1010
 
        mainline_parent_id = None
 
1308
        result = BranchCheckResult(self)
1011
1309
        last_revno, last_revision_id = self.last_revision_info()
1012
 
        real_rev_history = list(self.repository.iter_reverse_revision_history(
1013
 
                                last_revision_id))
1014
 
        real_rev_history.reverse()
1015
 
        if len(real_rev_history) != last_revno:
1016
 
            raise errors.BzrCheckError('revno does not match len(mainline)'
1017
 
                ' %s != %s' % (last_revno, len(real_rev_history)))
1018
 
        # TODO: We should probably also check that real_rev_history actually
1019
 
        #       matches self.revision_history()
1020
 
        for revision_id in real_rev_history:
1021
 
            try:
1022
 
                revision = self.repository.get_revision(revision_id)
1023
 
            except errors.NoSuchRevision, e:
1024
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
1025
 
                            % revision_id)
1026
 
            # In general the first entry on the revision history has no parents.
1027
 
            # But it's not illegal for it to have parents listed; this can happen
1028
 
            # in imports from Arch when the parents weren't reachable.
1029
 
            if mainline_parent_id is not None:
1030
 
                if mainline_parent_id not in revision.parent_ids:
1031
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
1032
 
                                        "parents of {%s}"
1033
 
                                        % (mainline_parent_id, revision_id))
1034
 
            mainline_parent_id = revision_id
1035
 
        return BranchCheckResult(self)
 
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
1036
1321
 
1037
1322
    def _get_checkout_format(self):
1038
1323
        """Return the most suitable metadir for a checkout of this branch.
1048
1333
        return format
1049
1334
 
1050
1335
    def create_clone_on_transport(self, to_transport, revision_id=None,
1051
 
        stacked_on=None):
 
1336
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1052
1337
        """Create a clone of this branch and its bzrdir.
1053
1338
 
1054
1339
        :param to_transport: The transport to clone onto.
1055
1340
        :param revision_id: The revision id to use as tip in the new branch.
1056
1341
            If None the tip is obtained from this branch.
1057
1342
        :param stacked_on: An optional URL to stack the clone on.
 
1343
        :param create_prefix: Create any missing directories leading up to
 
1344
            to_transport.
 
1345
        :param use_existing_dir: Use an existing directory if one exists.
1058
1346
        """
1059
1347
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1060
1348
        # clone call. Or something. 20090224 RBC/spiv.
 
1349
        if revision_id is None:
 
1350
            revision_id = self.last_revision()
1061
1351
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1062
 
            revision_id=revision_id, stacked_on=stacked_on)
 
1352
            revision_id=revision_id, stacked_on=stacked_on,
 
1353
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1063
1354
        return dir_to.open_branch()
1064
1355
 
1065
1356
    def create_checkout(self, to_location, revision_id=None,
1084
1375
        if lightweight:
1085
1376
            format = self._get_checkout_format()
1086
1377
            checkout = format.initialize_on_transport(t)
1087
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1378
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1379
                target_branch=self)
1088
1380
        else:
1089
1381
            format = self._get_checkout_format()
1090
1382
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1119
1411
        reconciler.reconcile()
1120
1412
        return reconciler
1121
1413
 
1122
 
    def reference_parent(self, file_id, path):
 
1414
    def reference_parent(self, file_id, path, possible_transports=None):
1123
1415
        """Return the parent branch for a tree-reference file_id
1124
1416
        :param file_id: The file_id of the tree reference
1125
1417
        :param path: The path of the file_id in the tree
1126
1418
        :return: A branch associated with the file_id
1127
1419
        """
1128
1420
        # FIXME should provide multiple branches, based on config
1129
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
1421
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1422
                           possible_transports=possible_transports)
1130
1423
 
1131
1424
    def supports_tags(self):
1132
1425
        return self._format.supports_tags()
1133
1426
 
 
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
 
1134
1439
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1135
1440
                                         other_branch):
1136
1441
        """Ensure that revision_b is a descendant of revision_a.
1191
1496
    _formats = {}
1192
1497
    """The known formats."""
1193
1498
 
 
1499
    can_set_append_revisions_only = True
 
1500
 
1194
1501
    def __eq__(self, other):
1195
1502
        return self.__class__ is other.__class__
1196
1503
 
1198
1505
        return not (self == other)
1199
1506
 
1200
1507
    @classmethod
1201
 
    def find_format(klass, a_bzrdir):
 
1508
    def find_format(klass, a_bzrdir, name=None):
1202
1509
        """Return the format for the branch object in a_bzrdir."""
1203
1510
        try:
1204
 
            transport = a_bzrdir.get_branch_transport(None)
1205
 
            format_string = transport.get("format").read()
 
1511
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1512
            format_string = transport.get_bytes("format")
1206
1513
            return klass._formats[format_string]
1207
1514
        except errors.NoSuchFile:
1208
 
            raise errors.NotBranchError(path=transport.base)
 
1515
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1209
1516
        except KeyError:
1210
1517
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1211
1518
 
1247
1554
        """Return the short format description for this format."""
1248
1555
        raise NotImplementedError(self.get_format_description)
1249
1556
 
1250
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1251
 
                           set_format=True):
 
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):
1252
1567
        """Initialize a branch in a bzrdir, with specified files
1253
1568
 
1254
1569
        :param a_bzrdir: The bzrdir to initialize the branch in
1255
1570
        :param utf8_files: The files to create as a list of
1256
1571
            (filename, content) tuples
 
1572
        :param name: Name of colocated branch to create, if any
1257
1573
        :param set_format: If True, set the format with
1258
1574
            self.get_format_string.  (BzrBranch4 has its format set
1259
1575
            elsewhere)
1260
1576
        :return: a branch in this format
1261
1577
        """
1262
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1263
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1578
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1579
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1264
1580
        lock_map = {
1265
1581
            'metadir': ('lock', lockdir.LockDir),
1266
1582
            'branch4': ('branch-lock', lockable_files.TransportLock),
1269
1585
        control_files = lockable_files.LockableFiles(branch_transport,
1270
1586
            lock_name, lock_class)
1271
1587
        control_files.create_lock()
1272
 
        control_files.lock_write()
 
1588
        try:
 
1589
            control_files.lock_write()
 
1590
        except errors.LockContention:
 
1591
            if lock_type != 'branch4':
 
1592
                raise
 
1593
            lock_taken = False
 
1594
        else:
 
1595
            lock_taken = True
1273
1596
        if set_format:
1274
1597
            utf8_files += [('format', self.get_format_string())]
1275
1598
        try:
1278
1601
                    filename, content,
1279
1602
                    mode=a_bzrdir._get_file_mode())
1280
1603
        finally:
1281
 
            control_files.unlock()
1282
 
        return self.open(a_bzrdir, _found=True)
 
1604
            if lock_taken:
 
1605
                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
1283
1609
 
1284
 
    def initialize(self, a_bzrdir):
1285
 
        """Create a branch of this format in a_bzrdir."""
 
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
        """
1286
1615
        raise NotImplementedError(self.initialize)
1287
1616
 
1288
1617
    def is_supported(self):
1318
1647
        """
1319
1648
        raise NotImplementedError(self.network_name)
1320
1649
 
1321
 
    def open(self, a_bzrdir, _found=False):
 
1650
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1322
1651
        """Return the branch object for a_bzrdir
1323
1652
 
1324
 
        _found is a private parameter, do not use it. It is used to indicate
1325
 
               if format probing has already be done.
 
1653
        :param a_bzrdir: A BzrDir that contains a branch.
 
1654
        :param name: Name of colocated branch to open
 
1655
        :param _found: a private parameter, do not use it. It is used to
 
1656
            indicate if format probing has already be done.
 
1657
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
1658
            (if there are any).  Default is to open fallbacks.
1326
1659
        """
1327
1660
        raise NotImplementedError(self.open)
1328
1661
 
1338
1671
    def set_default_format(klass, format):
1339
1672
        klass._default_format = format
1340
1673
 
 
1674
    def supports_set_append_revisions_only(self):
 
1675
        """True if this format supports set_append_revisions_only."""
 
1676
        return False
 
1677
 
1341
1678
    def supports_stacking(self):
1342
1679
        """True if this format records a stacked-on branch."""
1343
1680
        return False
1405
1742
            "post_uncommit is called with (local, master, old_revno, "
1406
1743
            "old_revid, new_revno, new_revid) where local is the local branch "
1407
1744
            "or None, master is the target branch, and an empty branch "
1408
 
            "recieves new_revno of 0, new_revid of None.", (0, 15), None))
 
1745
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1409
1746
        self.create_hook(HookPoint('pre_change_branch_tip',
1410
1747
            "Called in bzr client and server before a change to the tip of a "
1411
1748
            "branch is made. pre_change_branch_tip is called with a "
1428
1765
            "multiple hooks installed for transform_fallback_location, "
1429
1766
            "all are called with the url returned from the previous hook."
1430
1767
            "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
 
1431
1785
 
1432
1786
 
1433
1787
# install the default hooks into the Branch class.
1472
1826
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1473
1827
 
1474
1828
 
 
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
 
1475
1907
class BzrBranchFormat4(BranchFormat):
1476
1908
    """Bzr branch format 4.
1477
1909
 
1484
1916
        """See BranchFormat.get_format_description()."""
1485
1917
        return "Branch format 4"
1486
1918
 
1487
 
    def initialize(self, a_bzrdir):
 
1919
    def initialize(self, a_bzrdir, name=None):
1488
1920
        """Create a branch of this format in a_bzrdir."""
1489
1921
        utf8_files = [('revision-history', ''),
1490
1922
                      ('branch-name', ''),
1491
1923
                      ]
1492
 
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1924
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1493
1925
                                       lock_type='branch4', set_format=False)
1494
1926
 
1495
1927
    def __init__(self):
1500
1932
        """The network name for this format is the control dirs disk label."""
1501
1933
        return self._matchingbzrdir.get_format_string()
1502
1934
 
1503
 
    def open(self, a_bzrdir, _found=False):
1504
 
        """Return the branch object for a_bzrdir
1505
 
 
1506
 
        _found is a private parameter, do not use it. It is used to indicate
1507
 
               if format probing has already be done.
1508
 
        """
 
1935
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1936
        """See BranchFormat.open()."""
1509
1937
        if not _found:
1510
1938
            # we are being called directly and must probe.
1511
1939
            raise NotImplementedError
1512
1940
        return BzrBranch(_format=self,
1513
1941
                         _control_files=a_bzrdir._control_files,
1514
1942
                         a_bzrdir=a_bzrdir,
 
1943
                         name=name,
1515
1944
                         _repository=a_bzrdir.open_repository())
1516
1945
 
1517
1946
    def __str__(self):
1532
1961
        """
1533
1962
        return self.get_format_string()
1534
1963
 
1535
 
    def open(self, a_bzrdir, _found=False):
1536
 
        """Return the branch object for a_bzrdir.
1537
 
 
1538
 
        _found is a private parameter, do not use it. It is used to indicate
1539
 
               if format probing has already be done.
1540
 
        """
 
1964
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1965
        """See BranchFormat.open()."""
1541
1966
        if not _found:
1542
 
            format = BranchFormat.find_format(a_bzrdir)
 
1967
            format = BranchFormat.find_format(a_bzrdir, name=name)
1543
1968
            if format.__class__ != self.__class__:
1544
1969
                raise AssertionError("wrong format %r found for %r" %
1545
1970
                    (format, self))
 
1971
        transport = a_bzrdir.get_branch_transport(None, name=name)
1546
1972
        try:
1547
 
            transport = a_bzrdir.get_branch_transport(None)
1548
1973
            control_files = lockable_files.LockableFiles(transport, 'lock',
1549
1974
                                                         lockdir.LockDir)
1550
1975
            return self._branch_class()(_format=self,
1551
1976
                              _control_files=control_files,
 
1977
                              name=name,
1552
1978
                              a_bzrdir=a_bzrdir,
1553
 
                              _repository=a_bzrdir.find_repository())
 
1979
                              _repository=a_bzrdir.find_repository(),
 
1980
                              ignore_fallbacks=ignore_fallbacks)
1554
1981
        except errors.NoSuchFile:
1555
 
            raise errors.NotBranchError(path=transport.base)
 
1982
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1556
1983
 
1557
1984
    def __init__(self):
1558
1985
        super(BranchFormatMetadir, self).__init__()
1587
2014
        """See BranchFormat.get_format_description()."""
1588
2015
        return "Branch format 5"
1589
2016
 
1590
 
    def initialize(self, a_bzrdir):
 
2017
    def initialize(self, a_bzrdir, name=None):
1591
2018
        """Create a branch of this format in a_bzrdir."""
1592
2019
        utf8_files = [('revision-history', ''),
1593
2020
                      ('branch-name', ''),
1594
2021
                      ]
1595
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2022
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1596
2023
 
1597
2024
    def supports_tags(self):
1598
2025
        return False
1620
2047
        """See BranchFormat.get_format_description()."""
1621
2048
        return "Branch format 6"
1622
2049
 
1623
 
    def initialize(self, a_bzrdir):
1624
 
        """Create a branch of this format in a_bzrdir."""
1625
 
        utf8_files = [('last-revision', '0 null:\n'),
1626
 
                      ('branch.conf', ''),
1627
 
                      ('tags', ''),
1628
 
                      ]
1629
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1630
 
 
1631
 
    def make_tags(self, branch):
1632
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1633
 
        return BasicTags(branch)
1634
 
 
1635
 
 
1636
 
 
1637
 
class BzrBranchFormat7(BranchFormatMetadir):
 
2050
    def initialize(self, a_bzrdir, name=None):
 
2051
        """Create a branch of this format in a_bzrdir."""
 
2052
        utf8_files = [('last-revision', '0 null:\n'),
 
2053
                      ('branch.conf', ''),
 
2054
                      ('tags', ''),
 
2055
                      ]
 
2056
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2057
 
 
2058
    def make_tags(self, branch):
 
2059
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2060
        return BasicTags(branch)
 
2061
 
 
2062
    def supports_set_append_revisions_only(self):
 
2063
        return True
 
2064
 
 
2065
 
 
2066
class BzrBranchFormat8(BranchFormatMetadir):
 
2067
    """Metadir format supporting storing locations of subtree branches."""
 
2068
 
 
2069
    def _branch_class(self):
 
2070
        return BzrBranch8
 
2071
 
 
2072
    def get_format_string(self):
 
2073
        """See BranchFormat.get_format_string()."""
 
2074
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
 
2075
 
 
2076
    def get_format_description(self):
 
2077
        """See BranchFormat.get_format_description()."""
 
2078
        return "Branch format 8"
 
2079
 
 
2080
    def initialize(self, a_bzrdir, name=None):
 
2081
        """Create a branch of this format in a_bzrdir."""
 
2082
        utf8_files = [('last-revision', '0 null:\n'),
 
2083
                      ('branch.conf', ''),
 
2084
                      ('tags', ''),
 
2085
                      ('references', '')
 
2086
                      ]
 
2087
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2088
 
 
2089
    def __init__(self):
 
2090
        super(BzrBranchFormat8, self).__init__()
 
2091
        self._matchingbzrdir.repository_format = \
 
2092
            RepositoryFormatKnitPack5RichRoot()
 
2093
 
 
2094
    def make_tags(self, branch):
 
2095
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2096
        return BasicTags(branch)
 
2097
 
 
2098
    def supports_set_append_revisions_only(self):
 
2099
        return True
 
2100
 
 
2101
    def supports_stacking(self):
 
2102
        return True
 
2103
 
 
2104
    supports_reference_locations = True
 
2105
 
 
2106
 
 
2107
class BzrBranchFormat7(BzrBranchFormat8):
1638
2108
    """Branch format with last-revision, tags, and a stacked location pointer.
1639
2109
 
1640
2110
    The stacked location pointer is passed down to the repository and requires
1643
2113
    This format was introduced in bzr 1.6.
1644
2114
    """
1645
2115
 
 
2116
    def initialize(self, a_bzrdir, name=None):
 
2117
        """Create a branch of this format in a_bzrdir."""
 
2118
        utf8_files = [('last-revision', '0 null:\n'),
 
2119
                      ('branch.conf', ''),
 
2120
                      ('tags', ''),
 
2121
                      ]
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2123
 
1646
2124
    def _branch_class(self):
1647
2125
        return BzrBranch7
1648
2126
 
1654
2132
        """See BranchFormat.get_format_description()."""
1655
2133
        return "Branch format 7"
1656
2134
 
1657
 
    def initialize(self, a_bzrdir):
1658
 
        """Create a branch of this format in a_bzrdir."""
1659
 
        utf8_files = [('last-revision', '0 null:\n'),
1660
 
                      ('branch.conf', ''),
1661
 
                      ('tags', ''),
1662
 
                      ]
1663
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1664
 
 
1665
 
    def __init__(self):
1666
 
        super(BzrBranchFormat7, self).__init__()
1667
 
        self._matchingbzrdir.repository_format = \
1668
 
            RepositoryFormatKnitPack5RichRoot()
1669
 
 
1670
 
    def make_tags(self, branch):
1671
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1672
 
        return BasicTags(branch)
1673
 
 
1674
 
    def supports_stacking(self):
 
2135
    def supports_set_append_revisions_only(self):
1675
2136
        return True
1676
2137
 
 
2138
    supports_reference_locations = False
 
2139
 
1677
2140
 
1678
2141
class BranchReferenceFormat(BranchFormat):
1679
2142
    """Bzr branch reference format.
1697
2160
    def get_reference(self, a_bzrdir):
1698
2161
        """See BranchFormat.get_reference()."""
1699
2162
        transport = a_bzrdir.get_branch_transport(None)
1700
 
        return transport.get('location').read()
 
2163
        return transport.get_bytes('location')
1701
2164
 
1702
2165
    def set_reference(self, a_bzrdir, to_branch):
1703
2166
        """See BranchFormat.set_reference()."""
1704
2167
        transport = a_bzrdir.get_branch_transport(None)
1705
2168
        location = transport.put_bytes('location', to_branch.base)
1706
2169
 
1707
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2170
    def initialize(self, a_bzrdir, name=None, target_branch=None):
1708
2171
        """Create a branch of this format in a_bzrdir."""
1709
2172
        if target_branch is None:
1710
2173
            # this format does not implement branch itself, thus the implicit
1711
2174
            # creation contract must see it as uninitializable
1712
2175
            raise errors.UninitializableFormat(self)
1713
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1714
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2176
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2177
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1715
2178
        branch_transport.put_bytes('location',
1716
 
            target_branch.bzrdir.root_transport.base)
 
2179
            target_branch.bzrdir.user_url)
1717
2180
        branch_transport.put_bytes('format', self.get_format_string())
1718
 
        return self.open(
1719
 
            a_bzrdir, _found=True,
 
2181
        branch = self.open(
 
2182
            a_bzrdir, name, _found=True,
1720
2183
            possible_transports=[target_branch.bzrdir.root_transport])
 
2184
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2185
        return branch
1721
2186
 
1722
2187
    def __init__(self):
1723
2188
        super(BranchReferenceFormat, self).__init__()
1729
2194
        def clone(to_bzrdir, revision_id=None,
1730
2195
            repository_policy=None):
1731
2196
            """See Branch.clone()."""
1732
 
            return format.initialize(to_bzrdir, a_branch)
 
2197
            return format.initialize(to_bzrdir, target_branch=a_branch)
1733
2198
            # cannot obey revision_id limits when cloning a reference ...
1734
2199
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1735
2200
            # emit some sort of warning/error to the caller ?!
1736
2201
        return clone
1737
2202
 
1738
 
    def open(self, a_bzrdir, _found=False, location=None,
1739
 
             possible_transports=None):
 
2203
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2204
             possible_transports=None, ignore_fallbacks=False):
1740
2205
        """Return the branch that the branch reference in a_bzrdir points at.
1741
2206
 
1742
 
        _found is a private parameter, do not use it. It is used to indicate
1743
 
               if format probing has already be done.
 
2207
        :param a_bzrdir: A BzrDir that contains a branch.
 
2208
        :param name: Name of colocated branch to open, if any
 
2209
        :param _found: a private parameter, do not use it. It is used to
 
2210
            indicate if format probing has already be done.
 
2211
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
2212
            (if there are any).  Default is to open fallbacks.
 
2213
        :param location: The location of the referenced branch.  If
 
2214
            unspecified, this will be determined from the branch reference in
 
2215
            a_bzrdir.
 
2216
        :param possible_transports: An optional reusable transports list.
1744
2217
        """
1745
2218
        if not _found:
1746
 
            format = BranchFormat.find_format(a_bzrdir)
 
2219
            format = BranchFormat.find_format(a_bzrdir, name=name)
1747
2220
            if format.__class__ != self.__class__:
1748
2221
                raise AssertionError("wrong format %r found for %r" %
1749
2222
                    (format, self))
1751
2224
            location = self.get_reference(a_bzrdir)
1752
2225
        real_bzrdir = bzrdir.BzrDir.open(
1753
2226
            location, possible_transports=possible_transports)
1754
 
        result = real_bzrdir.open_branch()
 
2227
        result = real_bzrdir.open_branch(name=name, 
 
2228
            ignore_fallbacks=ignore_fallbacks)
1755
2229
        # this changes the behaviour of result.clone to create a new reference
1756
2230
        # rather than a copy of the content of the branch.
1757
2231
        # I did not use a proxy object because that needs much more extensive
1778
2252
__format5 = BzrBranchFormat5()
1779
2253
__format6 = BzrBranchFormat6()
1780
2254
__format7 = BzrBranchFormat7()
 
2255
__format8 = BzrBranchFormat8()
1781
2256
BranchFormat.register_format(__format5)
1782
2257
BranchFormat.register_format(BranchReferenceFormat())
1783
2258
BranchFormat.register_format(__format6)
1784
2259
BranchFormat.register_format(__format7)
1785
 
BranchFormat.set_default_format(__format6)
 
2260
BranchFormat.register_format(__format8)
 
2261
BranchFormat.set_default_format(__format7)
1786
2262
_legacy_formats = [BzrBranchFormat4(),
1787
2263
    ]
1788
2264
network_format_registry.register(
1789
2265
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1790
2266
 
1791
2267
 
1792
 
class BzrBranch(Branch):
 
2268
class BzrBranch(Branch, _RelockDebugMixin):
1793
2269
    """A branch stored in the actual filesystem.
1794
2270
 
1795
2271
    Note that it's "local" in the context of the filesystem; it doesn't
1801
2277
    :ivar repository: Repository for this branch.
1802
2278
    :ivar base: The url of the base directory for this branch; the one
1803
2279
        containing the .bzr directory.
 
2280
    :ivar name: Optional colocated branch name as it exists in the control
 
2281
        directory.
1804
2282
    """
1805
2283
 
1806
2284
    def __init__(self, _format=None,
1807
 
                 _control_files=None, a_bzrdir=None, _repository=None):
 
2285
                 _control_files=None, a_bzrdir=None, name=None,
 
2286
                 _repository=None, ignore_fallbacks=False):
1808
2287
        """Create new branch object at a particular location."""
1809
2288
        if a_bzrdir is None:
1810
2289
            raise ValueError('a_bzrdir must be supplied')
1811
2290
        else:
1812
2291
            self.bzrdir = a_bzrdir
1813
2292
        self._base = self.bzrdir.transport.clone('..').base
 
2293
        self.name = name
1814
2294
        # XXX: We should be able to just do
1815
2295
        #   self.base = self.bzrdir.root_transport.base
1816
2296
        # but this does not quite work yet -- mbp 20080522
1823
2303
        Branch.__init__(self)
1824
2304
 
1825
2305
    def __str__(self):
1826
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
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)
1827
2311
 
1828
2312
    __repr__ = __str__
1829
2313
 
1833
2317
 
1834
2318
    base = property(_get_base, doc="The URL for the root of this branch.")
1835
2319
 
 
2320
    def _get_config(self):
 
2321
        return TransportConfig(self._transport, 'branch.conf')
 
2322
 
1836
2323
    def is_locked(self):
1837
2324
        return self.control_files.is_locked()
1838
2325
 
1839
2326
    def lock_write(self, token=None):
1840
 
        repo_token = self.repository.lock_write()
 
2327
        if not self.is_locked():
 
2328
            self._note_lock('w')
 
2329
        # All-in-one needs to always unlock/lock.
 
2330
        repo_control = getattr(self.repository, 'control_files', None)
 
2331
        if self.control_files == repo_control or not self.is_locked():
 
2332
            self.repository._warn_if_deprecated(self)
 
2333
            self.repository.lock_write()
 
2334
            took_lock = True
 
2335
        else:
 
2336
            took_lock = False
1841
2337
        try:
1842
 
            token = self.control_files.lock_write(token=token)
 
2338
            return self.control_files.lock_write(token=token)
1843
2339
        except:
1844
 
            self.repository.unlock()
 
2340
            if took_lock:
 
2341
                self.repository.unlock()
1845
2342
            raise
1846
 
        return token
1847
2343
 
1848
2344
    def lock_read(self):
1849
 
        self.repository.lock_read()
 
2345
        if not self.is_locked():
 
2346
            self._note_lock('r')
 
2347
        # All-in-one needs to always unlock/lock.
 
2348
        repo_control = getattr(self.repository, 'control_files', None)
 
2349
        if self.control_files == repo_control or not self.is_locked():
 
2350
            self.repository._warn_if_deprecated(self)
 
2351
            self.repository.lock_read()
 
2352
            took_lock = True
 
2353
        else:
 
2354
            took_lock = False
1850
2355
        try:
1851
2356
            self.control_files.lock_read()
1852
2357
        except:
1853
 
            self.repository.unlock()
 
2358
            if took_lock:
 
2359
                self.repository.unlock()
1854
2360
            raise
1855
2361
 
 
2362
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1856
2363
    def unlock(self):
1857
 
        # TODO: test for failed two phase locks. This is known broken.
1858
2364
        try:
1859
2365
            self.control_files.unlock()
1860
2366
        finally:
1861
 
            self.repository.unlock()
1862
 
        if not self.control_files.is_locked():
1863
 
            # we just released the lock
1864
 
            self._clear_cached_state()
 
2367
            # All-in-one needs to always unlock/lock.
 
2368
            repo_control = getattr(self.repository, 'control_files', None)
 
2369
            if (self.control_files == repo_control or
 
2370
                not self.control_files.is_locked()):
 
2371
                self.repository.unlock()
 
2372
            if not self.control_files.is_locked():
 
2373
                # we just released the lock
 
2374
                self._clear_cached_state()
1865
2375
 
1866
2376
    def peek_lock_mode(self):
1867
2377
        if self.control_files._lock_count == 0:
1986
2496
        """See Branch.basis_tree."""
1987
2497
        return self.repository.revision_tree(self.last_revision())
1988
2498
 
1989
 
    @needs_write_lock
1990
 
    def pull(self, source, overwrite=False, stop_revision=None,
1991
 
             _hook_master=None, run_hooks=True, possible_transports=None,
1992
 
             _override_hook_target=None):
1993
 
        """See Branch.pull.
1994
 
 
1995
 
        :param _hook_master: Private parameter - set the branch to
1996
 
            be supplied as the master to pull hooks.
1997
 
        :param run_hooks: Private parameter - if false, this branch
1998
 
            is being called because it's the master of the primary branch,
1999
 
            so it should not run its hooks.
2000
 
        :param _override_hook_target: Private parameter - set the branch to be
2001
 
            supplied as the target_branch to pull hooks.
2002
 
        """
2003
 
        result = PullResult()
2004
 
        result.source_branch = source
2005
 
        if _override_hook_target is None:
2006
 
            result.target_branch = self
2007
 
        else:
2008
 
            result.target_branch = _override_hook_target
2009
 
        source.lock_read()
2010
 
        try:
2011
 
            # We assume that during 'pull' the local repository is closer than
2012
 
            # the remote one.
2013
 
            graph = self.repository.get_graph(source.repository)
2014
 
            result.old_revno, result.old_revid = self.last_revision_info()
2015
 
            self.update_revisions(source, stop_revision, overwrite=overwrite,
2016
 
                                  graph=graph)
2017
 
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2018
 
            result.new_revno, result.new_revid = self.last_revision_info()
2019
 
            if _hook_master:
2020
 
                result.master_branch = _hook_master
2021
 
                result.local_branch = result.target_branch
2022
 
            else:
2023
 
                result.master_branch = result.target_branch
2024
 
                result.local_branch = None
2025
 
            if run_hooks:
2026
 
                for hook in Branch.hooks['post_pull']:
2027
 
                    hook(result)
2028
 
        finally:
2029
 
            source.unlock()
2030
 
        return result
2031
 
 
2032
2499
    def _get_parent_location(self):
2033
2500
        _locs = ['parent', 'pull', 'x-pull']
2034
2501
        for l in _locs:
2038
2505
                pass
2039
2506
        return None
2040
2507
 
2041
 
    @needs_read_lock
2042
 
    def push(self, target, overwrite=False, stop_revision=None,
2043
 
             _override_hook_source_branch=None):
2044
 
        """See Branch.push.
2045
 
 
2046
 
        This is the basic concrete implementation of push()
2047
 
 
2048
 
        :param _override_hook_source_branch: If specified, run
2049
 
        the hooks passing this Branch as the source, rather than self.
2050
 
        This is for use of RemoteBranch, where push is delegated to the
2051
 
        underlying vfs-based Branch.
2052
 
        """
2053
 
        # TODO: Public option to disable running hooks - should be trivial but
2054
 
        # needs tests.
2055
 
        return _run_with_write_locked_target(
2056
 
            target, self._push_with_bound_branches, target, overwrite,
2057
 
            stop_revision,
2058
 
            _override_hook_source_branch=_override_hook_source_branch)
2059
 
 
2060
 
    def _push_with_bound_branches(self, target, overwrite,
2061
 
            stop_revision,
2062
 
            _override_hook_source_branch=None):
2063
 
        """Push from self into target, and into target's master if any.
2064
 
 
2065
 
        This is on the base BzrBranch class even though it doesn't support
2066
 
        bound branches because the *target* might be bound.
2067
 
        """
2068
 
        def _run_hooks():
2069
 
            if _override_hook_source_branch:
2070
 
                result.source_branch = _override_hook_source_branch
2071
 
            for hook in Branch.hooks['post_push']:
2072
 
                hook(result)
2073
 
 
2074
 
        bound_location = target.get_bound_location()
2075
 
        if bound_location and target.base != bound_location:
2076
 
            # there is a master branch.
2077
 
            #
2078
 
            # XXX: Why the second check?  Is it even supported for a branch to
2079
 
            # be bound to itself? -- mbp 20070507
2080
 
            master_branch = target.get_master_branch()
2081
 
            master_branch.lock_write()
2082
 
            try:
2083
 
                # push into the master from this branch.
2084
 
                self._basic_push(master_branch, overwrite, stop_revision)
2085
 
                # and push into the target branch from this. Note that we push from
2086
 
                # this branch again, because its considered the highest bandwidth
2087
 
                # repository.
2088
 
                result = self._basic_push(target, overwrite, stop_revision)
2089
 
                result.master_branch = master_branch
2090
 
                result.local_branch = target
2091
 
                _run_hooks()
2092
 
                return result
2093
 
            finally:
2094
 
                master_branch.unlock()
2095
 
        else:
2096
 
            # no master branch
2097
 
            result = self._basic_push(target, overwrite, stop_revision)
2098
 
            # TODO: Why set master_branch and local_branch if there's no
2099
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
2100
 
            # 20070504
2101
 
            result.master_branch = target
2102
 
            result.local_branch = None
2103
 
            _run_hooks()
2104
 
            return result
2105
 
 
2106
2508
    def _basic_push(self, target, overwrite, stop_revision):
2107
2509
        """Basic implementation of push without bound branches or hooks.
2108
2510
 
2109
 
        Must be called with self read locked and target write locked.
 
2511
        Must be called with source read locked and target write locked.
2110
2512
        """
2111
2513
        result = BranchPushResult()
2112
2514
        result.source_branch = self
2113
2515
        result.target_branch = target
2114
2516
        result.old_revno, result.old_revid = target.last_revision_info()
 
2517
        self.update_references(target)
2115
2518
        if result.old_revid != self.last_revision():
2116
2519
            # We assume that during 'push' this repository is closer than
2117
2520
            # the target.
2118
2521
            graph = self.repository.get_graph(target.repository)
2119
 
            target.update_revisions(self, stop_revision, overwrite=overwrite,
2120
 
                                    graph=graph)
 
2522
            target.update_revisions(self, stop_revision,
 
2523
                overwrite=overwrite, graph=graph)
2121
2524
        if self._push_should_merge_tags():
2122
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2525
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2526
                overwrite)
2123
2527
        result.new_revno, result.new_revid = target.last_revision_info()
2124
2528
        return result
2125
2529
 
2126
2530
    def get_stacked_on_url(self):
2127
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2531
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2128
2532
 
2129
2533
    def set_push_location(self, location):
2130
2534
        """See Branch.set_push_location."""
2132
2536
            'push_location', location,
2133
2537
            store=_mod_config.STORE_LOCATION_NORECURSE)
2134
2538
 
2135
 
    @needs_write_lock
2136
 
    def set_parent(self, url):
2137
 
        """See Branch.set_parent."""
2138
 
        # TODO: Maybe delete old location files?
2139
 
        # URLs should never be unicode, even on the local fs,
2140
 
        # FIXUP this and get_parent in a future branch format bump:
2141
 
        # read and rewrite the file. RBC 20060125
2142
 
        if url is not None:
2143
 
            if isinstance(url, unicode):
2144
 
                try:
2145
 
                    url = url.encode('ascii')
2146
 
                except UnicodeEncodeError:
2147
 
                    raise errors.InvalidURL(url,
2148
 
                        "Urls must be 7-bit ascii, "
2149
 
                        "use bzrlib.urlutils.escape")
2150
 
            url = urlutils.relative_url(self.base, url)
2151
 
        self._set_parent_location(url)
2152
 
 
2153
2539
    def _set_parent_location(self, url):
2154
2540
        if url is None:
2155
2541
            self._transport.delete('parent')
2157
2543
            self._transport.put_bytes('parent', url + '\n',
2158
2544
                mode=self.bzrdir._get_file_mode())
2159
2545
 
2160
 
    def set_stacked_on_url(self, url):
2161
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2162
 
 
2163
2546
 
2164
2547
class BzrBranch5(BzrBranch):
2165
2548
    """A format 5 branch. This supports new features over plain branches.
2167
2550
    It has support for a master_branch which is the data for bound branches.
2168
2551
    """
2169
2552
 
2170
 
    @needs_write_lock
2171
 
    def pull(self, source, overwrite=False, stop_revision=None,
2172
 
             run_hooks=True, possible_transports=None,
2173
 
             _override_hook_target=None):
2174
 
        """Pull from source into self, updating my master if any.
2175
 
 
2176
 
        :param run_hooks: Private parameter - if false, this branch
2177
 
            is being called because it's the master of the primary branch,
2178
 
            so it should not run its hooks.
2179
 
        """
2180
 
        bound_location = self.get_bound_location()
2181
 
        master_branch = None
2182
 
        if bound_location and source.base != bound_location:
2183
 
            # not pulling from master, so we need to update master.
2184
 
            master_branch = self.get_master_branch(possible_transports)
2185
 
            master_branch.lock_write()
2186
 
        try:
2187
 
            if master_branch:
2188
 
                # pull from source into master.
2189
 
                master_branch.pull(source, overwrite, stop_revision,
2190
 
                    run_hooks=False)
2191
 
            return super(BzrBranch5, self).pull(source, overwrite,
2192
 
                stop_revision, _hook_master=master_branch,
2193
 
                run_hooks=run_hooks,
2194
 
                _override_hook_target=_override_hook_target)
2195
 
        finally:
2196
 
            if master_branch:
2197
 
                master_branch.unlock()
2198
 
 
2199
2553
    def get_bound_location(self):
2200
2554
        try:
2201
2555
            return self._transport.get_bytes('bound')[:-1]
2288
2642
        return None
2289
2643
 
2290
2644
 
2291
 
class BzrBranch7(BzrBranch5):
2292
 
    """A branch with support for a fallback repository."""
2293
 
 
2294
 
    def _get_fallback_repository(self, url):
2295
 
        """Get the repository we fallback to at url."""
2296
 
        url = urlutils.join(self.base, url)
2297
 
        a_bzrdir = bzrdir.BzrDir.open(url,
2298
 
                                      possible_transports=[self._transport])
2299
 
        return a_bzrdir.open_branch().repository
2300
 
 
2301
 
    def _activate_fallback_location(self, url):
2302
 
        """Activate the branch/repository from url as a fallback repository."""
2303
 
        self.repository.add_fallback_repository(
2304
 
            self._get_fallback_repository(url))
 
2645
class BzrBranch8(BzrBranch5):
 
2646
    """A branch that stores tree-reference locations."""
2305
2647
 
2306
2648
    def _open_hook(self):
 
2649
        if self._ignore_fallbacks:
 
2650
            return
2307
2651
        try:
2308
2652
            url = self.get_stacked_on_url()
2309
2653
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2319
2663
                        "None, not a URL." % hook_name)
2320
2664
            self._activate_fallback_location(url)
2321
2665
 
2322
 
    def _check_stackable_repo(self):
2323
 
        if not self.repository._format.supports_external_lookups:
2324
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
2325
 
                self.repository.base)
2326
 
 
2327
2666
    def __init__(self, *args, **kwargs):
2328
 
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
2667
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
 
2668
        super(BzrBranch8, self).__init__(*args, **kwargs)
2329
2669
        self._last_revision_info_cache = None
2330
 
        self._partial_revision_history_cache = []
 
2670
        self._reference_info = None
2331
2671
 
2332
2672
    def _clear_cached_state(self):
2333
 
        super(BzrBranch7, self)._clear_cached_state()
 
2673
        super(BzrBranch8, self)._clear_cached_state()
2334
2674
        self._last_revision_info_cache = None
2335
 
        self._partial_revision_history_cache = []
 
2675
        self._reference_info = None
2336
2676
 
2337
2677
    def _last_revision_info(self):
2338
2678
        revision_string = self._transport.get_bytes('last-revision')
2384
2724
        if _mod_revision.is_null(last_revision):
2385
2725
            return
2386
2726
        if last_revision not in self._lefthand_history(revision_id):
2387
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2727
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2388
2728
 
2389
2729
    def _gen_revision_history(self):
2390
2730
        """Generate the revision history from last revision
2393
2733
        self._extend_partial_history(stop_index=last_revno-1)
2394
2734
        return list(reversed(self._partial_revision_history_cache))
2395
2735
 
2396
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
2397
 
        """Extend the partial history to include a given index
2398
 
 
2399
 
        If a stop_index is supplied, stop when that index has been reached.
2400
 
        If a stop_revision is supplied, stop when that revision is
2401
 
        encountered.  Otherwise, stop when the beginning of history is
2402
 
        reached.
2403
 
 
2404
 
        :param stop_index: The index which should be present.  When it is
2405
 
            present, history extension will stop.
2406
 
        :param revision_id: The revision id which should be present.  When
2407
 
            it is encountered, history extension will stop.
2408
 
        """
2409
 
        repo = self.repository
2410
 
        if len(self._partial_revision_history_cache) == 0:
2411
 
            iterator = repo.iter_reverse_revision_history(self.last_revision())
2412
 
        else:
2413
 
            start_revision = self._partial_revision_history_cache[-1]
2414
 
            iterator = repo.iter_reverse_revision_history(start_revision)
2415
 
            #skip the last revision in the list
2416
 
            next_revision = iterator.next()
2417
 
        for revision_id in iterator:
2418
 
            self._partial_revision_history_cache.append(revision_id)
2419
 
            if (stop_index is not None and
2420
 
                len(self._partial_revision_history_cache) > stop_index):
2421
 
                break
2422
 
            if revision_id == stop_revision:
2423
 
                break
2424
 
 
2425
2736
    def _write_revision_history(self, history):
2426
2737
        """Factored out of set_revision_history.
2427
2738
 
2448
2759
        """Set the parent branch"""
2449
2760
        return self._get_config_location('parent_location')
2450
2761
 
 
2762
    @needs_write_lock
 
2763
    def _set_all_reference_info(self, info_dict):
 
2764
        """Replace all reference info stored in a branch.
 
2765
 
 
2766
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
 
2767
        """
 
2768
        s = StringIO()
 
2769
        writer = rio.RioWriter(s)
 
2770
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2771
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2772
                                branch_location=branch_location)
 
2773
            writer.write_stanza(stanza)
 
2774
        self._transport.put_bytes('references', s.getvalue())
 
2775
        self._reference_info = info_dict
 
2776
 
 
2777
    @needs_read_lock
 
2778
    def _get_all_reference_info(self):
 
2779
        """Return all the reference info stored in a branch.
 
2780
 
 
2781
        :return: A dict of {file_id: (tree_path, branch_location)}
 
2782
        """
 
2783
        if self._reference_info is not None:
 
2784
            return self._reference_info
 
2785
        rio_file = self._transport.get('references')
 
2786
        try:
 
2787
            stanzas = rio.read_stanzas(rio_file)
 
2788
            info_dict = dict((s['file_id'], (s['tree_path'],
 
2789
                             s['branch_location'])) for s in stanzas)
 
2790
        finally:
 
2791
            rio_file.close()
 
2792
        self._reference_info = info_dict
 
2793
        return info_dict
 
2794
 
 
2795
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2796
        """Set the branch location to use for a tree reference.
 
2797
 
 
2798
        :param file_id: The file-id of the tree reference.
 
2799
        :param tree_path: The path of the tree reference in the tree.
 
2800
        :param branch_location: The location of the branch to retrieve tree
 
2801
            references from.
 
2802
        """
 
2803
        info_dict = self._get_all_reference_info()
 
2804
        info_dict[file_id] = (tree_path, branch_location)
 
2805
        if None in (tree_path, branch_location):
 
2806
            if tree_path is not None:
 
2807
                raise ValueError('tree_path must be None when branch_location'
 
2808
                                 ' is None.')
 
2809
            if branch_location is not None:
 
2810
                raise ValueError('branch_location must be None when tree_path'
 
2811
                                 ' is None.')
 
2812
            del info_dict[file_id]
 
2813
        self._set_all_reference_info(info_dict)
 
2814
 
 
2815
    def get_reference_info(self, file_id):
 
2816
        """Get the tree_path and branch_location for a tree reference.
 
2817
 
 
2818
        :return: a tuple of (tree_path, branch_location)
 
2819
        """
 
2820
        return self._get_all_reference_info().get(file_id, (None, None))
 
2821
 
 
2822
    def reference_parent(self, file_id, path, possible_transports=None):
 
2823
        """Return the parent branch for a tree-reference file_id.
 
2824
 
 
2825
        :param file_id: The file_id of the tree reference
 
2826
        :param path: The path of the file_id in the tree
 
2827
        :return: A branch associated with the file_id
 
2828
        """
 
2829
        branch_location = self.get_reference_info(file_id)[1]
 
2830
        if branch_location is None:
 
2831
            return Branch.reference_parent(self, file_id, path,
 
2832
                                           possible_transports)
 
2833
        branch_location = urlutils.join(self.user_url, branch_location)
 
2834
        return Branch.open(branch_location,
 
2835
                           possible_transports=possible_transports)
 
2836
 
2451
2837
    def set_push_location(self, location):
2452
2838
        """See Branch.set_push_location."""
2453
2839
        self._set_config_location('push_location', location)
2495
2881
            raise errors.NotStacked(self)
2496
2882
        return stacked_url
2497
2883
 
2498
 
    def set_append_revisions_only(self, enabled):
2499
 
        if enabled:
2500
 
            value = 'True'
2501
 
        else:
2502
 
            value = 'False'
2503
 
        self.get_config().set_user_option('append_revisions_only', value,
2504
 
            warn_masked=True)
2505
 
 
2506
 
    def set_stacked_on_url(self, url):
2507
 
        self._check_stackable_repo()
2508
 
        if not url:
2509
 
            try:
2510
 
                old_url = self.get_stacked_on_url()
2511
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
2512
 
                errors.UnstackableRepositoryFormat):
2513
 
                return
2514
 
            url = ''
2515
 
            # repositories don't offer an interface to remove fallback
2516
 
            # repositories today; take the conceptually simpler option and just
2517
 
            # reopen it.
2518
 
            self.repository = self.bzrdir.find_repository()
2519
 
            # for every revision reference the branch has, ensure it is pulled
2520
 
            # in.
2521
 
            source_repository = self._get_fallback_repository(old_url)
2522
 
            for revision_id in chain([self.last_revision()],
2523
 
                self.tags.get_reverse_tag_dict()):
2524
 
                self.repository.fetch(source_repository, revision_id,
2525
 
                    find_ghosts=True)
2526
 
        else:
2527
 
            self._activate_fallback_location(url)
2528
 
        # write this out after the repository is stacked to avoid setting a
2529
 
        # stacked config that doesn't work.
2530
 
        self._set_config_location('stacked_on_location', url)
2531
 
 
2532
2884
    def _get_append_revisions_only(self):
2533
 
        value = self.get_config().get_user_option('append_revisions_only')
2534
 
        return value == 'True'
 
2885
        return self.get_config(
 
2886
            ).get_user_option_as_bool('append_revisions_only')
2535
2887
 
2536
2888
    @needs_write_lock
2537
2889
    def generate_revision_history(self, revision_id, last_rev=None,
2577
2929
        return self.revno() - index
2578
2930
 
2579
2931
 
 
2932
class BzrBranch7(BzrBranch8):
 
2933
    """A branch with support for a fallback repository."""
 
2934
 
 
2935
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2936
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
 
2937
 
 
2938
    def get_reference_info(self, file_id):
 
2939
        Branch.get_reference_info(self, file_id)
 
2940
 
 
2941
    def reference_parent(self, file_id, path, possible_transports=None):
 
2942
        return Branch.reference_parent(self, file_id, path,
 
2943
                                       possible_transports)
 
2944
 
 
2945
 
2580
2946
class BzrBranch6(BzrBranch7):
2581
2947
    """See BzrBranchFormat6 for the capabilities of this branch.
2582
2948
 
2585
2951
    """
2586
2952
 
2587
2953
    def get_stacked_on_url(self):
2588
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2589
 
 
2590
 
    def set_stacked_on_url(self, url):
2591
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2954
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2592
2955
 
2593
2956
 
2594
2957
######################################################################
2673
3036
 
2674
3037
    def __init__(self, branch):
2675
3038
        self.branch = branch
 
3039
        self.errors = []
2676
3040
 
2677
3041
    def report_results(self, verbose):
2678
3042
        """Report the check results via trace.note.
2680
3044
        :param verbose: Requests more detailed display of what was checked,
2681
3045
            if any.
2682
3046
        """
2683
 
        note('checked branch %s format %s',
2684
 
             self.branch.base,
2685
 
             self.branch._format)
 
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)
2686
3051
 
2687
3052
 
2688
3053
class Converter5to6(object):
2726
3091
        branch._transport.put_bytes('format', format.get_format_string())
2727
3092
 
2728
3093
 
 
3094
class Converter7to8(object):
 
3095
    """Perform an in-place upgrade of format 6 to format 7"""
 
3096
 
 
3097
    def convert(self, branch):
 
3098
        format = BzrBranchFormat8()
 
3099
        branch._transport.put_bytes('references', '')
 
3100
        # update target format
 
3101
        branch._transport.put_bytes('format', format.get_format_string())
 
3102
 
2729
3103
 
2730
3104
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2731
3105
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2774
3148
    @staticmethod
2775
3149
    def _get_branch_formats_to_test():
2776
3150
        """Return a tuple with the Branch formats to use when testing."""
2777
 
        raise NotImplementedError(self._get_branch_formats_to_test)
 
3151
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3152
 
 
3153
    def pull(self, overwrite=False, stop_revision=None,
 
3154
             possible_transports=None, local=False):
 
3155
        """Mirror source into target branch.
 
3156
 
 
3157
        The target branch is considered to be 'local', having low latency.
 
3158
 
 
3159
        :returns: PullResult instance
 
3160
        """
 
3161
        raise NotImplementedError(self.pull)
2778
3162
 
2779
3163
    def update_revisions(self, stop_revision=None, overwrite=False,
2780
3164
                         graph=None):
2789
3173
        """
2790
3174
        raise NotImplementedError(self.update_revisions)
2791
3175
 
 
3176
    def push(self, overwrite=False, stop_revision=None,
 
3177
             _override_hook_source_branch=None):
 
3178
        """Mirror the source branch into the target branch.
 
3179
 
 
3180
        The source branch is considered to be 'local', having low latency.
 
3181
        """
 
3182
        raise NotImplementedError(self.push)
 
3183
 
2792
3184
 
2793
3185
class GenericInterBranch(InterBranch):
2794
3186
    """InterBranch implementation that uses public Branch functions.
2841
3233
        finally:
2842
3234
            self.source.unlock()
2843
3235
 
 
3236
    def pull(self, overwrite=False, stop_revision=None,
 
3237
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3238
             _override_hook_target=None, local=False):
 
3239
        """See Branch.pull.
 
3240
 
 
3241
        :param _hook_master: Private parameter - set the branch to
 
3242
            be supplied as the master to pull hooks.
 
3243
        :param run_hooks: Private parameter - if false, this branch
 
3244
            is being called because it's the master of the primary branch,
 
3245
            so it should not run its hooks.
 
3246
        :param _override_hook_target: Private parameter - set the branch to be
 
3247
            supplied as the target_branch to pull hooks.
 
3248
        :param local: Only update the local branch, and not the bound branch.
 
3249
        """
 
3250
        # This type of branch can't be bound.
 
3251
        if local:
 
3252
            raise errors.LocalRequiresBoundBranch()
 
3253
        result = PullResult()
 
3254
        result.source_branch = self.source
 
3255
        if _override_hook_target is None:
 
3256
            result.target_branch = self.target
 
3257
        else:
 
3258
            result.target_branch = _override_hook_target
 
3259
        self.source.lock_read()
 
3260
        try:
 
3261
            # We assume that during 'pull' the target repository is closer than
 
3262
            # the source one.
 
3263
            self.source.update_references(self.target)
 
3264
            graph = self.target.repository.get_graph(self.source.repository)
 
3265
            # TODO: Branch formats should have a flag that indicates 
 
3266
            # that revno's are expensive, and pull() should honor that flag.
 
3267
            # -- JRV20090506
 
3268
            result.old_revno, result.old_revid = \
 
3269
                self.target.last_revision_info()
 
3270
            self.target.update_revisions(self.source, stop_revision,
 
3271
                overwrite=overwrite, graph=graph)
 
3272
            # TODO: The old revid should be specified when merging tags, 
 
3273
            # so a tags implementation that versions tags can only 
 
3274
            # pull in the most recent changes. -- JRV20090506
 
3275
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3276
                overwrite)
 
3277
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3278
            if _hook_master:
 
3279
                result.master_branch = _hook_master
 
3280
                result.local_branch = result.target_branch
 
3281
            else:
 
3282
                result.master_branch = result.target_branch
 
3283
                result.local_branch = None
 
3284
            if run_hooks:
 
3285
                for hook in Branch.hooks['post_pull']:
 
3286
                    hook(result)
 
3287
        finally:
 
3288
            self.source.unlock()
 
3289
        return result
 
3290
 
 
3291
    def push(self, overwrite=False, stop_revision=None,
 
3292
             _override_hook_source_branch=None):
 
3293
        """See InterBranch.push.
 
3294
 
 
3295
        This is the basic concrete implementation of push()
 
3296
 
 
3297
        :param _override_hook_source_branch: If specified, run
 
3298
        the hooks passing this Branch as the source, rather than self.
 
3299
        This is for use of RemoteBranch, where push is delegated to the
 
3300
        underlying vfs-based Branch.
 
3301
        """
 
3302
        # TODO: Public option to disable running hooks - should be trivial but
 
3303
        # needs tests.
 
3304
        self.source.lock_read()
 
3305
        try:
 
3306
            return _run_with_write_locked_target(
 
3307
                self.target, self._push_with_bound_branches, overwrite,
 
3308
                stop_revision,
 
3309
                _override_hook_source_branch=_override_hook_source_branch)
 
3310
        finally:
 
3311
            self.source.unlock()
 
3312
 
 
3313
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3314
            _override_hook_source_branch=None):
 
3315
        """Push from source into target, and into target's master if any.
 
3316
        """
 
3317
        def _run_hooks():
 
3318
            if _override_hook_source_branch:
 
3319
                result.source_branch = _override_hook_source_branch
 
3320
            for hook in Branch.hooks['post_push']:
 
3321
                hook(result)
 
3322
 
 
3323
        bound_location = self.target.get_bound_location()
 
3324
        if bound_location and self.target.base != bound_location:
 
3325
            # there is a master branch.
 
3326
            #
 
3327
            # XXX: Why the second check?  Is it even supported for a branch to
 
3328
            # be bound to itself? -- mbp 20070507
 
3329
            master_branch = self.target.get_master_branch()
 
3330
            master_branch.lock_write()
 
3331
            try:
 
3332
                # push into the master from the source branch.
 
3333
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3334
                # and push into the target branch from the source. Note that we
 
3335
                # push from the source branch again, because its considered the
 
3336
                # highest bandwidth repository.
 
3337
                result = self.source._basic_push(self.target, overwrite,
 
3338
                    stop_revision)
 
3339
                result.master_branch = master_branch
 
3340
                result.local_branch = self.target
 
3341
                _run_hooks()
 
3342
                return result
 
3343
            finally:
 
3344
                master_branch.unlock()
 
3345
        else:
 
3346
            # no master branch
 
3347
            result = self.source._basic_push(self.target, overwrite,
 
3348
                stop_revision)
 
3349
            # TODO: Why set master_branch and local_branch if there's no
 
3350
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3351
            # 20070504
 
3352
            result.master_branch = self.target
 
3353
            result.local_branch = None
 
3354
            _run_hooks()
 
3355
            return result
 
3356
 
2844
3357
    @classmethod
2845
3358
    def is_compatible(self, source, target):
2846
3359
        # GenericBranch uses the public API, so always compatible
2847
3360
        return True
2848
3361
 
2849
3362
 
 
3363
class InterToBranch5(GenericInterBranch):
 
3364
 
 
3365
    @staticmethod
 
3366
    def _get_branch_formats_to_test():
 
3367
        return BranchFormat._default_format, BzrBranchFormat5()
 
3368
 
 
3369
    def pull(self, overwrite=False, stop_revision=None,
 
3370
             possible_transports=None, run_hooks=True,
 
3371
             _override_hook_target=None, local=False):
 
3372
        """Pull from source into self, updating my master if any.
 
3373
 
 
3374
        :param run_hooks: Private parameter - if false, this branch
 
3375
            is being called because it's the master of the primary branch,
 
3376
            so it should not run its hooks.
 
3377
        """
 
3378
        bound_location = self.target.get_bound_location()
 
3379
        if local and not bound_location:
 
3380
            raise errors.LocalRequiresBoundBranch()
 
3381
        master_branch = None
 
3382
        if not local and bound_location and self.source.user_url != bound_location:
 
3383
            # not pulling from master, so we need to update master.
 
3384
            master_branch = self.target.get_master_branch(possible_transports)
 
3385
            master_branch.lock_write()
 
3386
        try:
 
3387
            if master_branch:
 
3388
                # pull from source into master.
 
3389
                master_branch.pull(self.source, overwrite, stop_revision,
 
3390
                    run_hooks=False)
 
3391
            return super(InterToBranch5, self).pull(overwrite,
 
3392
                stop_revision, _hook_master=master_branch,
 
3393
                run_hooks=run_hooks,
 
3394
                _override_hook_target=_override_hook_target)
 
3395
        finally:
 
3396
            if master_branch:
 
3397
                master_branch.unlock()
 
3398
 
 
3399
 
2850
3400
InterBranch.register_optimiser(GenericInterBranch)
 
3401
InterBranch.register_optimiser(InterToBranch5)