~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-16 08:26:29 UTC
  • mfrom: (4145.1.6 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090316082629-xuzqut3b3ur5bn3b
(robertc) Add a new repository method refresh_data to allow clean
        handling of _real_repositories after inserting a stream via the
        smart server. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
33
        symbol_versioning,
36
34
        transport,
37
35
        tsort,
38
36
        ui,
39
37
        urlutils,
40
38
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
39
from bzrlib.config import BranchConfig
42
40
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
41
from bzrlib.tag import (
44
42
    BasicTags,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
48
from bzrlib.hooks import HookPoint, Hooks
51
49
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
50
from bzrlib import registry
54
51
from bzrlib.symbol_versioning import (
55
52
    deprecated_in,
63
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
61
 
65
62
 
66
 
class Branch(bzrdir.ControlComponent):
 
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):
67
76
    """Branch holding a history of revisions.
68
77
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
78
    base
 
79
        Base directory/url of the branch.
72
80
 
73
81
    hooks: An instance of BranchHooks.
74
82
    """
76
84
    # - RBC 20060112
77
85
    base = None
78
86
 
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 = []
93
92
        self._last_revision_info_cache = None
94
93
        self._merge_sorted_revisions_cache = None
95
94
        self._open_hook()
100
99
    def _open_hook(self):
101
100
        """Called by init to allow simpler extension of the base class."""
102
101
 
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
 
 
110
102
    def break_lock(self):
111
103
        """Break a lock if one is present from another instance.
112
104
 
121
113
        if master is not None:
122
114
            master.break_lock()
123
115
 
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
 
 
158
116
    @staticmethod
159
117
    def open(base, _unsupported=False, possible_transports=None):
160
118
        """Open the branch rooted at base.
164
122
        """
165
123
        control = bzrdir.BzrDir.open(base, _unsupported,
166
124
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
125
        return control.open_branch(_unsupported)
168
126
 
169
127
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
128
    def open_from_transport(transport, _unsupported=False):
171
129
        """Open the branch rooted at transport"""
172
130
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
131
        return control.open_branch(_unsupported)
174
132
 
175
133
    @staticmethod
176
134
    def open_containing(url, possible_transports=None):
199
157
    def get_config(self):
200
158
        return BranchConfig(self)
201
159
 
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
 
 
221
160
    def _get_tags_bytes(self):
222
161
        """Get the bytes of a serialised tags dict.
223
162
 
417
356
            * 'include' - the stop revision is the last item in the result
418
357
            * 'with-merges' - include the stop revision and all of its
419
358
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
359
        :param direction: either 'reverse' or 'forward':
423
360
            * reverse means return the start_revision_id first, i.e.
424
361
              start at the most recent revision and go backwards in history
446
383
        # start_revision_id.
447
384
        if self._merge_sorted_revisions_cache is None:
448
385
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
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
 
453
395
        filtered = self._filter_merge_sorted_revisions(
454
396
            self._merge_sorted_revisions_cache, start_revision_id,
455
397
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
398
        if direction == 'reverse':
460
399
            return filtered
461
400
        if direction == 'forward':
468
407
        """Iterate over an inclusive range of sorted revisions."""
469
408
        rev_iter = iter(merge_sorted_revisions)
470
409
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
411
                if rev_id != start_revision_id:
474
412
                    continue
475
413
                else:
476
414
                    # The decision to include the start or not
477
415
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
416
                    rev_iter = chain(
 
417
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
418
                        rev_iter)
480
419
                    break
481
420
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
421
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
422
                yield rev_id, depth, revno, end_of_merge
487
423
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
424
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
425
                if rev_id == stop_revision_id:
491
426
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
427
                yield rev_id, depth, revno, end_of_merge
494
428
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
429
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
430
                yield rev_id, depth, revno, end_of_merge
499
431
                if rev_id == stop_revision_id:
500
432
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
433
        elif stop_rule == 'with-merges':
514
434
            stop_rev = self.repository.get_revision(stop_revision_id)
515
435
            if stop_rev.parent_ids:
516
436
                left_parent = stop_rev.parent_ids[0]
517
437
            else:
518
438
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
439
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
440
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
441
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
442
                yield rev_id, depth, revno, end_of_merge
538
443
        else:
539
444
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
445
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
446
    def leave_lock_in_place(self):
587
447
        """Tell this branch object not to release the physical lock when this
588
448
        object is unlocked.
605
465
        :param other: The branch to bind to
606
466
        :type other: Branch
607
467
        """
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)
 
468
        raise errors.UpgradeRequired(self.base)
627
469
 
628
470
    @needs_write_lock
629
471
    def fetch(self, from_branch, last_revision=None, pb=None):
663
505
    def get_old_bound_location(self):
664
506
        """Return the URL of the branch we used to be bound to
665
507
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
508
        raise errors.UpgradeRequired(self.base)
667
509
 
668
510
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
511
                           timezone=None, committer=None, revprops=None,
719
561
    def set_revision_history(self, rev_history):
720
562
        raise NotImplementedError(self.set_revision_history)
721
563
 
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
741
564
    def set_stacked_on_url(self, url):
742
565
        """Set the URL this branch is stacked against.
743
566
 
746
569
        :raises UnstackableRepositoryFormat: If the repository does not support
747
570
            stacking.
748
571
        """
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()
 
572
        raise NotImplementedError(self.set_stacked_on_url)
822
573
 
823
574
    def _set_tags_bytes(self, bytes):
824
575
        """Mirror method for _get_tags_bytes.
860
611
        self._revision_id_to_revno_cache = None
861
612
        self._last_revision_info_cache = None
862
613
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
614
 
866
615
    def _gen_revision_history(self):
867
616
        """Return sequence of revision hashes on to this branch.
904
653
 
905
654
    def unbind(self):
906
655
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
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)
908
661
 
909
662
    def last_revision(self):
910
663
        """Return last revision id, or NULL_REVISION."""
991
744
        except ValueError:
992
745
            raise errors.NoSuchRevision(self, revision_id)
993
746
 
994
 
    @needs_read_lock
995
747
    def get_rev_id(self, revno, history=None):
996
748
        """Find the revision id of the specified revno."""
997
749
        if revno == 0:
998
750
            return _mod_revision.NULL_REVISION
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:
 
751
        if history is None:
 
752
            history = self.revision_history()
 
753
        if revno <= 0 or revno > len(history):
1003
754
            raise errors.NoSuchRevision(self, revno)
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]
 
755
        return history[revno - 1]
1008
756
 
1009
 
    @needs_write_lock
1010
757
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
758
             possible_transports=None, _override_hook_target=None):
1012
759
        """Mirror source into this branch.
1013
760
 
1014
761
        This branch is considered to be 'local', having low latency.
1015
762
 
1016
763
        :returns: PullResult instance
1017
764
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
765
        raise NotImplementedError(self.pull)
1021
766
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
767
    def push(self, target, overwrite=False, stop_revision=None):
1024
768
        """Mirror this branch into target.
1025
769
 
1026
770
        This branch is considered to be 'local', having low latency.
1027
771
        """
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)
 
772
        raise NotImplementedError(self.push)
1051
773
 
1052
774
    def basis_tree(self):
1053
775
        """Return `Tree` object for last revision."""
1070
792
        try:
1071
793
            return urlutils.join(self.base[:-1], parent)
1072
794
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
795
            raise errors.InaccessibleParent(parent, self.base)
1074
796
 
1075
797
    def _get_parent_location(self):
1076
798
        raise NotImplementedError(self._get_parent_location)
1093
815
            location = None
1094
816
        return location
1095
817
 
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
 
 
1100
818
    def get_submit_branch(self):
1101
819
        """Return the submit location of the branch.
1102
820
 
1119
837
    def get_public_branch(self):
1120
838
        """Return the public location of the branch.
1121
839
 
1122
 
        This is used by merge directives.
 
840
        This is is used by merge directives.
1123
841
        """
1124
842
        return self._get_config_location('public_branch')
1125
843
 
1161
879
        params = ChangeBranchTipParams(
1162
880
            self, old_revno, new_revno, old_revid, new_revid)
1163
881
        for hook in hooks:
1164
 
            hook(params)
 
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)
1165
894
 
1166
895
    @needs_write_lock
1167
896
    def update(self):
1198
927
                     be truncated to end with revision_id.
1199
928
        """
1200
929
        result = to_bzrdir.create_branch()
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
 
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
1209
934
 
1210
935
    @needs_read_lock
1211
936
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1216
941
        revision_id: if not None, the revision history in the new branch will
1217
942
                     be truncated to end with revision_id.
1218
943
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
944
        result = to_bzrdir.create_branch()
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()
 
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)
1231
949
        return result
1232
950
 
1233
951
    def _synchronize_history(self, destination, revision_id):
1245
963
        source_revno, source_revision_id = self.last_revision_info()
1246
964
        if revision_id is None:
1247
965
            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
1248
969
        else:
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
 
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)))
1256
978
        destination.set_last_revision_info(revno, revision_id)
1257
979
 
1258
980
    @needs_read_lock
1262
984
        revision_id: if not None, the revision history in the new branch will
1263
985
                     be truncated to end with revision_id.
1264
986
        """
1265
 
        self.update_references(destination)
1266
987
        self._synchronize_history(destination, revision_id)
1267
988
        try:
1268
989
            parent = self.get_parent()
1274
995
        if self._push_should_merge_tags():
1275
996
            self.tags.merge_to(destination.tags)
1276
997
 
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
 
 
1294
998
    @needs_read_lock
1295
 
    def check(self, refs):
 
999
    def check(self):
1296
1000
        """Check consistency of the branch.
1297
1001
 
1298
1002
        In particular this checks that revisions given in the revision-history
1301
1005
 
1302
1006
        Callers will typically also want to check the repository.
1303
1007
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1008
        :return: A BranchCheckResult.
1307
1009
        """
1308
 
        result = BranchCheckResult(self)
 
1010
        mainline_parent_id = None
1309
1011
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
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)
1321
1036
 
1322
1037
    def _get_checkout_format(self):
1323
1038
        """Return the most suitable metadir for a checkout of this branch.
1333
1048
        return format
1334
1049
 
1335
1050
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1051
        stacked_on=None):
1337
1052
        """Create a clone of this branch and its bzrdir.
1338
1053
 
1339
1054
        :param to_transport: The transport to clone onto.
1340
1055
        :param revision_id: The revision id to use as tip in the new branch.
1341
1056
            If None the tip is obtained from this branch.
1342
1057
        :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.
1346
1058
        """
1347
1059
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1060
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1061
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1062
            revision_id=revision_id, stacked_on=stacked_on)
1354
1063
        return dir_to.open_branch()
1355
1064
 
1356
1065
    def create_checkout(self, to_location, revision_id=None,
1375
1084
        if lightweight:
1376
1085
            format = self._get_checkout_format()
1377
1086
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1087
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1088
        else:
1381
1089
            format = self._get_checkout_format()
1382
1090
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1119
        reconciler.reconcile()
1412
1120
        return reconciler
1413
1121
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1122
    def reference_parent(self, file_id, path):
1415
1123
        """Return the parent branch for a tree-reference file_id
1416
1124
        :param file_id: The file_id of the tree reference
1417
1125
        :param path: The path of the file_id in the tree
1418
1126
        :return: A branch associated with the file_id
1419
1127
        """
1420
1128
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1129
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1130
 
1424
1131
    def supports_tags(self):
1425
1132
        return self._format.supports_tags()
1426
1133
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1134
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1135
                                         other_branch):
1441
1136
        """Ensure that revision_b is a descendant of revision_a.
1496
1191
    _formats = {}
1497
1192
    """The known formats."""
1498
1193
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1194
    def __eq__(self, other):
1502
1195
        return self.__class__ is other.__class__
1503
1196
 
1505
1198
        return not (self == other)
1506
1199
 
1507
1200
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1201
    def find_format(klass, a_bzrdir):
1509
1202
        """Return the format for the branch object in a_bzrdir."""
1510
1203
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1204
            transport = a_bzrdir.get_branch_transport(None)
 
1205
            format_string = transport.get("format").read()
1513
1206
            return klass._formats[format_string]
1514
1207
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1208
            raise errors.NotBranchError(path=transport.base)
1516
1209
        except KeyError:
1517
1210
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1211
 
1554
1247
        """Return the short format description for this format."""
1555
1248
        raise NotImplementedError(self.get_format_description)
1556
1249
 
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):
 
1250
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1251
                           set_format=True):
1567
1252
        """Initialize a branch in a bzrdir, with specified files
1568
1253
 
1569
1254
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1255
        :param utf8_files: The files to create as a list of
1571
1256
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1257
        :param set_format: If True, set the format with
1574
1258
            self.get_format_string.  (BzrBranch4 has its format set
1575
1259
            elsewhere)
1576
1260
        :return: a branch in this format
1577
1261
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1262
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1263
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1264
        lock_map = {
1581
1265
            'metadir': ('lock', lockdir.LockDir),
1582
1266
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1269
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1270
            lock_name, lock_class)
1587
1271
        control_files.create_lock()
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
 
1272
        control_files.lock_write()
1596
1273
        if set_format:
1597
1274
            utf8_files += [('format', self.get_format_string())]
1598
1275
        try:
1601
1278
                    filename, content,
1602
1279
                    mode=a_bzrdir._get_file_mode())
1603
1280
        finally:
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
 
1281
            control_files.unlock()
 
1282
        return self.open(a_bzrdir, _found=True)
1609
1283
 
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
 
        """
 
1284
    def initialize(self, a_bzrdir):
 
1285
        """Create a branch of this format in a_bzrdir."""
1615
1286
        raise NotImplementedError(self.initialize)
1616
1287
 
1617
1288
    def is_supported(self):
1647
1318
        """
1648
1319
        raise NotImplementedError(self.network_name)
1649
1320
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1321
    def open(self, a_bzrdir, _found=False):
1651
1322
        """Return the branch object for a_bzrdir
1652
1323
 
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.
 
1324
        _found is a private parameter, do not use it. It is used to indicate
 
1325
               if format probing has already be done.
1659
1326
        """
1660
1327
        raise NotImplementedError(self.open)
1661
1328
 
1671
1338
    def set_default_format(klass, format):
1672
1339
        klass._default_format = format
1673
1340
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1341
    def supports_stacking(self):
1679
1342
        """True if this format records a stacked-on branch."""
1680
1343
        return False
1742
1405
            "post_uncommit is called with (local, master, old_revno, "
1743
1406
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1407
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1408
            "recieves new_revno of 0, new_revid of None.", (0, 15), None))
1746
1409
        self.create_hook(HookPoint('pre_change_branch_tip',
1747
1410
            "Called in bzr client and server before a change to the tip of a "
1748
1411
            "branch is made. pre_change_branch_tip is called with a "
1765
1428
            "multiple hooks installed for transform_fallback_location, "
1766
1429
            "all are called with the url returned from the previous hook."
1767
1430
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
1785
1431
 
1786
1432
 
1787
1433
# install the default hooks into the Branch class.
1826
1472
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1473
 
1828
1474
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1475
class BzrBranchFormat4(BranchFormat):
1908
1476
    """Bzr branch format 4.
1909
1477
 
1916
1484
        """See BranchFormat.get_format_description()."""
1917
1485
        return "Branch format 4"
1918
1486
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1487
    def initialize(self, a_bzrdir):
1920
1488
        """Create a branch of this format in a_bzrdir."""
1921
1489
        utf8_files = [('revision-history', ''),
1922
1490
                      ('branch-name', ''),
1923
1491
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1492
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1493
                                       lock_type='branch4', set_format=False)
1926
1494
 
1927
1495
    def __init__(self):
1932
1500
        """The network name for this format is the control dirs disk label."""
1933
1501
        return self._matchingbzrdir.get_format_string()
1934
1502
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
 
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
        """
1937
1509
        if not _found:
1938
1510
            # we are being called directly and must probe.
1939
1511
            raise NotImplementedError
1940
1512
        return BzrBranch(_format=self,
1941
1513
                         _control_files=a_bzrdir._control_files,
1942
1514
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1515
                         _repository=a_bzrdir.open_repository())
1945
1516
 
1946
1517
    def __str__(self):
1961
1532
        """
1962
1533
        return self.get_format_string()
1963
1534
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
 
        """See BranchFormat.open()."""
 
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
        """
1966
1541
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1542
            format = BranchFormat.find_format(a_bzrdir)
1968
1543
            if format.__class__ != self.__class__:
1969
1544
                raise AssertionError("wrong format %r found for %r" %
1970
1545
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1546
        try:
 
1547
            transport = a_bzrdir.get_branch_transport(None)
1973
1548
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1549
                                                         lockdir.LockDir)
1975
1550
            return self._branch_class()(_format=self,
1976
1551
                              _control_files=control_files,
1977
 
                              name=name,
1978
1552
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
1553
                              _repository=a_bzrdir.find_repository())
1981
1554
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1555
            raise errors.NotBranchError(path=transport.base)
1983
1556
 
1984
1557
    def __init__(self):
1985
1558
        super(BranchFormatMetadir, self).__init__()
2014
1587
        """See BranchFormat.get_format_description()."""
2015
1588
        return "Branch format 5"
2016
1589
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1590
    def initialize(self, a_bzrdir):
2018
1591
        """Create a branch of this format in a_bzrdir."""
2019
1592
        utf8_files = [('revision-history', ''),
2020
1593
                      ('branch-name', ''),
2021
1594
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1595
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1596
 
2024
1597
    def supports_tags(self):
2025
1598
        return False
2047
1620
        """See BranchFormat.get_format_description()."""
2048
1621
        return "Branch format 6"
2049
1622
 
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):
 
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):
2108
1638
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1639
 
2110
1640
    The stacked location pointer is passed down to the repository and requires
2113
1643
    This format was introduced in bzr 1.6.
2114
1644
    """
2115
1645
 
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
 
 
2124
1646
    def _branch_class(self):
2125
1647
        return BzrBranch7
2126
1648
 
2132
1654
        """See BranchFormat.get_format_description()."""
2133
1655
        return "Branch format 7"
2134
1656
 
2135
 
    def supports_set_append_revisions_only(self):
 
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):
2136
1675
        return True
2137
1676
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1677
 
2141
1678
class BranchReferenceFormat(BranchFormat):
2142
1679
    """Bzr branch reference format.
2160
1697
    def get_reference(self, a_bzrdir):
2161
1698
        """See BranchFormat.get_reference()."""
2162
1699
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1700
        return transport.get('location').read()
2164
1701
 
2165
1702
    def set_reference(self, a_bzrdir, to_branch):
2166
1703
        """See BranchFormat.set_reference()."""
2167
1704
        transport = a_bzrdir.get_branch_transport(None)
2168
1705
        location = transport.put_bytes('location', to_branch.base)
2169
1706
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1707
    def initialize(self, a_bzrdir, target_branch=None):
2171
1708
        """Create a branch of this format in a_bzrdir."""
2172
1709
        if target_branch is None:
2173
1710
            # this format does not implement branch itself, thus the implicit
2174
1711
            # creation contract must see it as uninitializable
2175
1712
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1713
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1714
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1715
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1716
            target_branch.bzrdir.root_transport.base)
2180
1717
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1718
        return self.open(
 
1719
            a_bzrdir, _found=True,
2183
1720
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1721
 
2187
1722
    def __init__(self):
2188
1723
        super(BranchReferenceFormat, self).__init__()
2194
1729
        def clone(to_bzrdir, revision_id=None,
2195
1730
            repository_policy=None):
2196
1731
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1732
            return format.initialize(to_bzrdir, a_branch)
2198
1733
            # cannot obey revision_id limits when cloning a reference ...
2199
1734
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1735
            # emit some sort of warning/error to the caller ?!
2201
1736
        return clone
2202
1737
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
1738
    def open(self, a_bzrdir, _found=False, location=None,
 
1739
             possible_transports=None):
2205
1740
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1741
 
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.
 
1742
        _found is a private parameter, do not use it. It is used to indicate
 
1743
               if format probing has already be done.
2217
1744
        """
2218
1745
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1746
            format = BranchFormat.find_format(a_bzrdir)
2220
1747
            if format.__class__ != self.__class__:
2221
1748
                raise AssertionError("wrong format %r found for %r" %
2222
1749
                    (format, self))
2224
1751
            location = self.get_reference(a_bzrdir)
2225
1752
        real_bzrdir = bzrdir.BzrDir.open(
2226
1753
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1754
        result = real_bzrdir.open_branch()
2229
1755
        # this changes the behaviour of result.clone to create a new reference
2230
1756
        # rather than a copy of the content of the branch.
2231
1757
        # I did not use a proxy object because that needs much more extensive
2252
1778
__format5 = BzrBranchFormat5()
2253
1779
__format6 = BzrBranchFormat6()
2254
1780
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1781
BranchFormat.register_format(__format5)
2257
1782
BranchFormat.register_format(BranchReferenceFormat())
2258
1783
BranchFormat.register_format(__format6)
2259
1784
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1785
BranchFormat.set_default_format(__format6)
2262
1786
_legacy_formats = [BzrBranchFormat4(),
2263
1787
    ]
2264
1788
network_format_registry.register(
2265
1789
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1790
 
2267
1791
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1792
class BzrBranch(Branch):
2269
1793
    """A branch stored in the actual filesystem.
2270
1794
 
2271
1795
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1801
    :ivar repository: Repository for this branch.
2278
1802
    :ivar base: The url of the base directory for this branch; the one
2279
1803
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1804
    """
2283
1805
 
2284
1806
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1807
                 _control_files=None, a_bzrdir=None, _repository=None):
2287
1808
        """Create new branch object at a particular location."""
2288
1809
        if a_bzrdir is None:
2289
1810
            raise ValueError('a_bzrdir must be supplied')
2290
1811
        else:
2291
1812
            self.bzrdir = a_bzrdir
2292
1813
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1814
        # XXX: We should be able to just do
2295
1815
        #   self.base = self.bzrdir.root_transport.base
2296
1816
        # but this does not quite work yet -- mbp 20080522
2303
1823
        Branch.__init__(self)
2304
1824
 
2305
1825
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
1826
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1827
 
2312
1828
    __repr__ = __str__
2313
1829
 
2317
1833
 
2318
1834
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
1835
 
2320
 
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
2322
 
 
2323
1836
    def is_locked(self):
2324
1837
        return self.control_files.is_locked()
2325
1838
 
2326
1839
    def lock_write(self, token=None):
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
 
1840
        repo_token = self.repository.lock_write()
2337
1841
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1842
            token = self.control_files.lock_write(token=token)
2339
1843
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1844
            self.repository.unlock()
2342
1845
            raise
 
1846
        return token
2343
1847
 
2344
1848
    def lock_read(self):
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
 
1849
        self.repository.lock_read()
2355
1850
        try:
2356
1851
            self.control_files.lock_read()
2357
1852
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1853
            self.repository.unlock()
2360
1854
            raise
2361
1855
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1856
    def unlock(self):
 
1857
        # TODO: test for failed two phase locks. This is known broken.
2364
1858
        try:
2365
1859
            self.control_files.unlock()
2366
1860
        finally:
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()
 
1861
            self.repository.unlock()
 
1862
        if not self.control_files.is_locked():
 
1863
            # we just released the lock
 
1864
            self._clear_cached_state()
2375
1865
 
2376
1866
    def peek_lock_mode(self):
2377
1867
        if self.control_files._lock_count == 0:
2496
1986
        """See Branch.basis_tree."""
2497
1987
        return self.repository.revision_tree(self.last_revision())
2498
1988
 
 
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
 
2499
2032
    def _get_parent_location(self):
2500
2033
        _locs = ['parent', 'pull', 'x-pull']
2501
2034
        for l in _locs:
2505
2038
                pass
2506
2039
        return None
2507
2040
 
 
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
 
2508
2106
    def _basic_push(self, target, overwrite, stop_revision):
2509
2107
        """Basic implementation of push without bound branches or hooks.
2510
2108
 
2511
 
        Must be called with source read locked and target write locked.
 
2109
        Must be called with self read locked and target write locked.
2512
2110
        """
2513
2111
        result = BranchPushResult()
2514
2112
        result.source_branch = self
2515
2113
        result.target_branch = target
2516
2114
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2115
        if result.old_revid != self.last_revision():
2519
2116
            # We assume that during 'push' this repository is closer than
2520
2117
            # the target.
2521
2118
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2119
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2120
                                    graph=graph)
2524
2121
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2122
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2123
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2124
        return result
2529
2125
 
2530
2126
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2127
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2128
 
2533
2129
    def set_push_location(self, location):
2534
2130
        """See Branch.set_push_location."""
2536
2132
            'push_location', location,
2537
2133
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2134
 
 
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
 
2539
2153
    def _set_parent_location(self, url):
2540
2154
        if url is None:
2541
2155
            self._transport.delete('parent')
2543
2157
            self._transport.put_bytes('parent', url + '\n',
2544
2158
                mode=self.bzrdir._get_file_mode())
2545
2159
 
 
2160
    def set_stacked_on_url(self, url):
 
2161
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2162
 
2546
2163
 
2547
2164
class BzrBranch5(BzrBranch):
2548
2165
    """A format 5 branch. This supports new features over plain branches.
2550
2167
    It has support for a master_branch which is the data for bound branches.
2551
2168
    """
2552
2169
 
 
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
 
2553
2199
    def get_bound_location(self):
2554
2200
        try:
2555
2201
            return self._transport.get_bytes('bound')[:-1]
2642
2288
        return None
2643
2289
 
2644
2290
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
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))
2647
2305
 
2648
2306
    def _open_hook(self):
2649
 
        if self._ignore_fallbacks:
2650
 
            return
2651
2307
        try:
2652
2308
            url = self.get_stacked_on_url()
2653
2309
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2663
2319
                        "None, not a URL." % hook_name)
2664
2320
            self._activate_fallback_location(url)
2665
2321
 
 
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
 
2666
2327
    def __init__(self, *args, **kwargs):
2667
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2328
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2329
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2330
        self._partial_revision_history_cache = []
2671
2331
 
2672
2332
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2333
        super(BzrBranch7, self)._clear_cached_state()
2674
2334
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2335
        self._partial_revision_history_cache = []
2676
2336
 
2677
2337
    def _last_revision_info(self):
2678
2338
        revision_string = self._transport.get_bytes('last-revision')
2724
2384
        if _mod_revision.is_null(last_revision):
2725
2385
            return
2726
2386
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2387
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2388
 
2729
2389
    def _gen_revision_history(self):
2730
2390
        """Generate the revision history from last revision
2733
2393
        self._extend_partial_history(stop_index=last_revno-1)
2734
2394
        return list(reversed(self._partial_revision_history_cache))
2735
2395
 
 
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
 
2736
2425
    def _write_revision_history(self, history):
2737
2426
        """Factored out of set_revision_history.
2738
2427
 
2759
2448
        """Set the parent branch"""
2760
2449
        return self._get_config_location('parent_location')
2761
2450
 
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
 
 
2837
2451
    def set_push_location(self, location):
2838
2452
        """See Branch.set_push_location."""
2839
2453
        self._set_config_location('push_location', location)
2881
2495
            raise errors.NotStacked(self)
2882
2496
        return stacked_url
2883
2497
 
 
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
 
2884
2532
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2533
        value = self.get_config().get_user_option('append_revisions_only')
 
2534
        return value == 'True'
2887
2535
 
2888
2536
    @needs_write_lock
2889
2537
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2577
        return self.revno() - index
2930
2578
 
2931
2579
 
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
 
 
2946
2580
class BzrBranch6(BzrBranch7):
2947
2581
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2582
 
2951
2585
    """
2952
2586
 
2953
2587
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
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)
2955
2592
 
2956
2593
 
2957
2594
######################################################################
3036
2673
 
3037
2674
    def __init__(self, branch):
3038
2675
        self.branch = branch
3039
 
        self.errors = []
3040
2676
 
3041
2677
    def report_results(self, verbose):
3042
2678
        """Report the check results via trace.note.
3044
2680
        :param verbose: Requests more detailed display of what was checked,
3045
2681
            if any.
3046
2682
        """
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)
 
2683
        note('checked branch %s format %s',
 
2684
             self.branch.base,
 
2685
             self.branch._format)
3051
2686
 
3052
2687
 
3053
2688
class Converter5to6(object):
3091
2726
        branch._transport.put_bytes('format', format.get_format_string())
3092
2727
 
3093
2728
 
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
 
 
3103
2729
 
3104
2730
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2731
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2774
    @staticmethod
3149
2775
    def _get_branch_formats_to_test():
3150
2776
        """Return a tuple with the Branch formats to use when testing."""
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)
 
2777
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2778
 
3163
2779
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2780
                         graph=None):
3173
2789
        """
3174
2790
        raise NotImplementedError(self.update_revisions)
3175
2791
 
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
 
 
3184
2792
 
3185
2793
class GenericInterBranch(InterBranch):
3186
2794
    """InterBranch implementation that uses public Branch functions.
3233
2841
        finally:
3234
2842
            self.source.unlock()
3235
2843
 
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
 
 
3357
2844
    @classmethod
3358
2845
    def is_compatible(self, source, target):
3359
2846
        # GenericBranch uses the public API, so always compatible
3360
2847
        return True
3361
2848
 
3362
2849
 
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
 
 
3400
2850
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)