/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-25 04:20:12 UTC
  • mfrom: (3468.3.4 controlfiles)
  • Revision ID: pqm@pqm.ubuntu.com-20090325042012-23a6pm0mraw7g2kg
(mbp) better CountedLock handling of tokens,
        and bzrdir takes more responsibility for default file modes

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
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
 
from cStringIO import StringIO
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, LogicalLockResult
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
 
283
222
        new_history.reverse()
284
223
        return new_history
285
224
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
225
    def lock_write(self):
293
226
        raise NotImplementedError(self.lock_write)
294
227
 
295
228
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
229
        raise NotImplementedError(self.lock_read)
301
230
 
302
231
    def unlock(self):
427
356
            * 'include' - the stop revision is the last item in the result
428
357
            * 'with-merges' - include the stop revision and all of its
429
358
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
359
        :param direction: either 'reverse' or 'forward':
433
360
            * reverse means return the start_revision_id first, i.e.
434
361
              start at the most recent revision and go backwards in history
456
383
        # start_revision_id.
457
384
        if self._merge_sorted_revisions_cache is None:
458
385
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
461
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                last_revision)
 
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
 
463
395
        filtered = self._filter_merge_sorted_revisions(
464
396
            self._merge_sorted_revisions_cache, start_revision_id,
465
397
            stop_revision_id, stop_rule)
466
 
        # Make sure we don't return revisions that are not part of the
467
 
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
469
398
        if direction == 'reverse':
470
399
            return filtered
471
400
        if direction == 'forward':
478
407
        """Iterate over an inclusive range of sorted revisions."""
479
408
        rev_iter = iter(merge_sorted_revisions)
480
409
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
411
                if rev_id != start_revision_id:
484
412
                    continue
485
413
                else:
486
414
                    # The decision to include the start or not
487
415
                    # depends on the stop_rule if a stop is provided
488
 
                    # so pop this node back into the iterator
489
 
                    rev_iter = chain(iter([node]), rev_iter)
 
416
                    rev_iter = chain(
 
417
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
418
                        rev_iter)
490
419
                    break
491
420
        if stop_revision_id is None:
492
 
            # Yield everything
493
 
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
495
 
                yield (rev_id, node.merge_depth, node.revno,
496
 
                       node.end_of_merge)
 
421
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
422
                yield rev_id, depth, revno, end_of_merge
497
423
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
424
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
425
                if rev_id == stop_revision_id:
501
426
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
427
                yield rev_id, depth, revno, end_of_merge
504
428
        elif stop_rule == 'include':
505
 
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
507
 
                yield (rev_id, node.merge_depth, node.revno,
508
 
                       node.end_of_merge)
 
429
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
430
                yield rev_id, depth, revno, end_of_merge
509
431
                if rev_id == stop_revision_id:
510
432
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
433
        elif stop_rule == 'with-merges':
524
434
            stop_rev = self.repository.get_revision(stop_revision_id)
525
435
            if stop_rev.parent_ids:
526
436
                left_parent = stop_rev.parent_ids[0]
527
437
            else:
528
438
                left_parent = _mod_revision.NULL_REVISION
529
 
            # left_parent is the actual revision we want to stop logging at,
530
 
            # since we want to show the merged revisions after the stop_rev too
531
 
            reached_stop_revision_id = False
532
 
            revision_id_whitelist = []
533
 
            for node in rev_iter:
534
 
                rev_id = node.key[-1]
 
439
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
440
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
441
                    return
538
 
                if (not reached_stop_revision_id or
539
 
                        rev_id in revision_id_whitelist):
540
 
                    yield (rev_id, node.merge_depth, node.revno,
541
 
                       node.end_of_merge)
542
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
543
 
                        # only do the merged revs of rev_id from now on
544
 
                        rev = self.repository.get_revision(rev_id)
545
 
                        if rev.parent_ids:
546
 
                            reached_stop_revision_id = True
547
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
442
                yield rev_id, depth, revno, end_of_merge
548
443
        else:
549
444
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
445
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
552
 
        # If we started from a dotted revno, we want to consider it as a tip
553
 
        # and don't want to yield revisions that are not part of its
554
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
 
        # uninteresting descendants of the first parent of our tip before the
556
 
        # tip itself.
557
 
        first = rev_iter.next()
558
 
        (rev_id, merge_depth, revno, end_of_merge) = first
559
 
        yield first
560
 
        if not merge_depth:
561
 
            # We start at a mainline revision so by definition, all others
562
 
            # revisions in rev_iter are ancestors
563
 
            for node in rev_iter:
564
 
                yield node
565
 
 
566
 
        clean = False
567
 
        whitelist = set()
568
 
        pmap = self.repository.get_parent_map([rev_id])
569
 
        parents = pmap.get(rev_id, [])
570
 
        if parents:
571
 
            whitelist.update(parents)
572
 
        else:
573
 
            # If there is no parents, there is nothing of interest left
574
 
 
575
 
            # FIXME: It's hard to test this scenario here as this code is never
576
 
            # called in that case. -- vila 20100322
577
 
            return
578
 
 
579
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
580
 
            if not clean:
581
 
                if rev_id in whitelist:
582
 
                    pmap = self.repository.get_parent_map([rev_id])
583
 
                    parents = pmap.get(rev_id, [])
584
 
                    whitelist.remove(rev_id)
585
 
                    whitelist.update(parents)
586
 
                    if merge_depth == 0:
587
 
                        # We've reached the mainline, there is nothing left to
588
 
                        # filter
589
 
                        clean = True
590
 
                else:
591
 
                    # A revision that is not part of the ancestry of our
592
 
                    # starting revision.
593
 
                    continue
594
 
            yield (rev_id, merge_depth, revno, end_of_merge)
595
 
 
596
446
    def leave_lock_in_place(self):
597
447
        """Tell this branch object not to release the physical lock when this
598
448
        object is unlocked.
615
465
        :param other: The branch to bind to
616
466
        :type other: Branch
617
467
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
619
 
 
620
 
    def set_append_revisions_only(self, enabled):
621
 
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
623
 
        if enabled:
624
 
            value = 'True'
625
 
        else:
626
 
            value = 'False'
627
 
        self.get_config().set_user_option('append_revisions_only', value,
628
 
            warn_masked=True)
629
 
 
630
 
    def set_reference_info(self, file_id, tree_path, branch_location):
631
 
        """Set the branch location to use for a tree reference."""
632
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
633
 
 
634
 
    def get_reference_info(self, file_id):
635
 
        """Get the tree_path and branch_location for a tree reference."""
636
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
468
        raise errors.UpgradeRequired(self.base)
637
469
 
638
470
    @needs_write_lock
639
471
    def fetch(self, from_branch, last_revision=None, pb=None):
673
505
    def get_old_bound_location(self):
674
506
        """Return the URL of the branch we used to be bound to
675
507
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
508
        raise errors.UpgradeRequired(self.base)
677
509
 
678
510
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
511
                           timezone=None, committer=None, revprops=None,
729
561
    def set_revision_history(self, rev_history):
730
562
        raise NotImplementedError(self.set_revision_history)
731
563
 
732
 
    @needs_write_lock
733
 
    def set_parent(self, url):
734
 
        """See Branch.set_parent."""
735
 
        # TODO: Maybe delete old location files?
736
 
        # URLs should never be unicode, even on the local fs,
737
 
        # FIXUP this and get_parent in a future branch format bump:
738
 
        # read and rewrite the file. RBC 20060125
739
 
        if url is not None:
740
 
            if isinstance(url, unicode):
741
 
                try:
742
 
                    url = url.encode('ascii')
743
 
                except UnicodeEncodeError:
744
 
                    raise errors.InvalidURL(url,
745
 
                        "Urls must be 7-bit ascii, "
746
 
                        "use bzrlib.urlutils.escape")
747
 
            url = urlutils.relative_url(self.base, url)
748
 
        self._set_parent_location(url)
749
 
 
750
 
    @needs_write_lock
751
564
    def set_stacked_on_url(self, url):
752
565
        """Set the URL this branch is stacked against.
753
566
 
756
569
        :raises UnstackableRepositoryFormat: If the repository does not support
757
570
            stacking.
758
571
        """
759
 
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
 
        # XXX: Changing from one fallback repository to another does not check
762
 
        # that all the data you need is present in the new fallback.
763
 
        # Possibly it should.
764
 
        self._check_stackable_repo()
765
 
        if not url:
766
 
            try:
767
 
                old_url = self.get_stacked_on_url()
768
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
769
 
                errors.UnstackableRepositoryFormat):
770
 
                return
771
 
            self._unstack()
772
 
        else:
773
 
            self._activate_fallback_location(url)
774
 
        # write this out after the repository is stacked to avoid setting a
775
 
        # stacked config that doesn't work.
776
 
        self._set_config_location('stacked_on_location', url)
777
 
 
778
 
    def _unstack(self):
779
 
        """Change a branch to be unstacked, copying data as needed.
780
 
        
781
 
        Don't call this directly, use set_stacked_on_url(None).
782
 
        """
783
 
        pb = ui.ui_factory.nested_progress_bar()
784
 
        try:
785
 
            pb.update("Unstacking")
786
 
            # The basic approach here is to fetch the tip of the branch,
787
 
            # including all available ghosts, from the existing stacked
788
 
            # repository into a new repository object without the fallbacks. 
789
 
            #
790
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
 
            # correct for CHKMap repostiories
792
 
            old_repository = self.repository
793
 
            if len(old_repository._fallback_repositories) != 1:
794
 
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
797
 
            old_repository.unlock()
798
 
            old_repository.lock_read()
799
 
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
 
                # XXX: If you unstack a branch while it has a working tree
819
 
                # with a pending merge, the pending-merged revisions will no
820
 
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
828
 
            finally:
829
 
                old_repository.unlock()
830
 
        finally:
831
 
            pb.finished()
 
572
        raise NotImplementedError(self.set_stacked_on_url)
832
573
 
833
574
    def _set_tags_bytes(self, bytes):
834
575
        """Mirror method for _get_tags_bytes.
870
611
        self._revision_id_to_revno_cache = None
871
612
        self._last_revision_info_cache = None
872
613
        self._merge_sorted_revisions_cache = None
873
 
        self._partial_revision_history_cache = []
874
 
        self._partial_revision_id_to_revno_cache = {}
875
614
 
876
615
    def _gen_revision_history(self):
877
616
        """Return sequence of revision hashes on to this branch.
914
653
 
915
654
    def unbind(self):
916
655
        """Older format branches cannot bind or unbind."""
917
 
        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)
918
661
 
919
662
    def last_revision(self):
920
663
        """Return last revision id, or NULL_REVISION."""
1001
744
        except ValueError:
1002
745
            raise errors.NoSuchRevision(self, revision_id)
1003
746
 
1004
 
    @needs_read_lock
1005
747
    def get_rev_id(self, revno, history=None):
1006
748
        """Find the revision id of the specified revno."""
1007
749
        if revno == 0:
1008
750
            return _mod_revision.NULL_REVISION
1009
 
        last_revno, last_revid = self.last_revision_info()
1010
 
        if revno == last_revno:
1011
 
            return last_revid
1012
 
        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):
1013
754
            raise errors.NoSuchRevision(self, revno)
1014
 
        distance_from_last = last_revno - revno
1015
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1016
 
            self._extend_partial_history(distance_from_last)
1017
 
        return self._partial_revision_history_cache[distance_from_last]
 
755
        return history[revno - 1]
1018
756
 
1019
 
    @needs_write_lock
1020
757
    def pull(self, source, overwrite=False, stop_revision=None,
1021
 
             possible_transports=None, *args, **kwargs):
 
758
             possible_transports=None, _override_hook_target=None):
1022
759
        """Mirror source into this branch.
1023
760
 
1024
761
        This branch is considered to be 'local', having low latency.
1025
762
 
1026
763
        :returns: PullResult instance
1027
764
        """
1028
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
 
            stop_revision=stop_revision,
1030
 
            possible_transports=possible_transports, *args, **kwargs)
 
765
        raise NotImplementedError(self.pull)
1031
766
 
1032
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1033
 
        **kwargs):
 
767
    def push(self, target, overwrite=False, stop_revision=None):
1034
768
        """Mirror this branch into target.
1035
769
 
1036
770
        This branch is considered to be 'local', having low latency.
1037
771
        """
1038
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1039
 
            *args, **kwargs)
1040
 
 
1041
 
    def lossy_push(self, target, stop_revision=None):
1042
 
        """Push deltas into another branch.
1043
 
 
1044
 
        :note: This does not, like push, retain the revision ids from 
1045
 
            the source branch and will, rather than adding bzr-specific 
1046
 
            metadata, push only those semantics of the revision that can be 
1047
 
            natively represented by this branch' VCS.
1048
 
 
1049
 
        :param target: Target branch
1050
 
        :param stop_revision: Revision to push, defaults to last revision.
1051
 
        :return: BranchPushResult with an extra member revidmap: 
1052
 
            A dictionary mapping revision ids from the target branch 
1053
 
            to new revision ids in the target branch, for each 
1054
 
            revision that was pushed.
1055
 
        """
1056
 
        inter = InterBranch.get(self, target)
1057
 
        lossy_push = getattr(inter, "lossy_push", None)
1058
 
        if lossy_push is None:
1059
 
            raise errors.LossyPushToSameVCS(self, target)
1060
 
        return lossy_push(stop_revision)
 
772
        raise NotImplementedError(self.push)
1061
773
 
1062
774
    def basis_tree(self):
1063
775
        """Return `Tree` object for last revision."""
1080
792
        try:
1081
793
            return urlutils.join(self.base[:-1], parent)
1082
794
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
795
            raise errors.InaccessibleParent(parent, self.base)
1084
796
 
1085
797
    def _get_parent_location(self):
1086
798
        raise NotImplementedError(self._get_parent_location)
1103
815
            location = None
1104
816
        return location
1105
817
 
1106
 
    def get_child_submit_format(self):
1107
 
        """Return the preferred format of submissions to this branch."""
1108
 
        return self.get_config().get_user_option("child_submit_format")
1109
 
 
1110
818
    def get_submit_branch(self):
1111
819
        """Return the submit location of the branch.
1112
820
 
1129
837
    def get_public_branch(self):
1130
838
        """Return the public location of the branch.
1131
839
 
1132
 
        This is used by merge directives.
 
840
        This is is used by merge directives.
1133
841
        """
1134
842
        return self._get_config_location('public_branch')
1135
843
 
1171
879
        params = ChangeBranchTipParams(
1172
880
            self, old_revno, new_revno, old_revid, new_revid)
1173
881
        for hook in hooks:
1174
 
            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)
1175
894
 
1176
895
    @needs_write_lock
1177
896
    def update(self):
1208
927
                     be truncated to end with revision_id.
1209
928
        """
1210
929
        result = to_bzrdir.create_branch()
1211
 
        result.lock_write()
1212
 
        try:
1213
 
            if repository_policy is not None:
1214
 
                repository_policy.configure_branch(result)
1215
 
            self.copy_content_into(result, revision_id=revision_id)
1216
 
        finally:
1217
 
            result.unlock()
1218
 
        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
1219
934
 
1220
935
    @needs_read_lock
1221
936
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1226
941
        revision_id: if not None, the revision history in the new branch will
1227
942
                     be truncated to end with revision_id.
1228
943
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
944
        result = to_bzrdir.create_branch()
1233
 
        result.lock_write()
1234
 
        try:
1235
 
            if repository_policy is not None:
1236
 
                repository_policy.configure_branch(result)
1237
 
            self.copy_content_into(result, revision_id=revision_id)
1238
 
            result.set_parent(self.bzrdir.root_transport.base)
1239
 
        finally:
1240
 
            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)
1241
949
        return result
1242
950
 
1243
951
    def _synchronize_history(self, destination, revision_id):
1255
963
        source_revno, source_revision_id = self.last_revision_info()
1256
964
        if revision_id is None:
1257
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
1258
969
        else:
1259
 
            graph = self.repository.get_graph()
1260
 
            try:
1261
 
                revno = graph.find_distance_to_null(revision_id, 
1262
 
                    [(source_revision_id, source_revno)])
1263
 
            except errors.GhostRevisionsHaveNoRevno:
1264
 
                # Default to 1, if we can't find anything else
1265
 
                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)))
1266
978
        destination.set_last_revision_info(revno, revision_id)
1267
979
 
1268
980
    @needs_read_lock
1272
984
        revision_id: if not None, the revision history in the new branch will
1273
985
                     be truncated to end with revision_id.
1274
986
        """
1275
 
        self.update_references(destination)
1276
987
        self._synchronize_history(destination, revision_id)
1277
988
        try:
1278
989
            parent = self.get_parent()
1284
995
        if self._push_should_merge_tags():
1285
996
            self.tags.merge_to(destination.tags)
1286
997
 
1287
 
    def update_references(self, target):
1288
 
        if not getattr(self._format, 'supports_reference_locations', False):
1289
 
            return
1290
 
        reference_dict = self._get_all_reference_info()
1291
 
        if len(reference_dict) == 0:
1292
 
            return
1293
 
        old_base = self.base
1294
 
        new_base = target.base
1295
 
        target_reference_dict = target._get_all_reference_info()
1296
 
        for file_id, (tree_path, branch_location) in (
1297
 
            reference_dict.items()):
1298
 
            branch_location = urlutils.rebase_url(branch_location,
1299
 
                                                  old_base, new_base)
1300
 
            target_reference_dict.setdefault(
1301
 
                file_id, (tree_path, branch_location))
1302
 
        target._set_all_reference_info(target_reference_dict)
1303
 
 
1304
998
    @needs_read_lock
1305
 
    def check(self, refs):
 
999
    def check(self):
1306
1000
        """Check consistency of the branch.
1307
1001
 
1308
1002
        In particular this checks that revisions given in the revision-history
1311
1005
 
1312
1006
        Callers will typically also want to check the repository.
1313
1007
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
1008
        :return: A BranchCheckResult.
1317
1009
        """
1318
 
        result = BranchCheckResult(self)
 
1010
        mainline_parent_id = None
1319
1011
        last_revno, last_revision_id = self.last_revision_info()
1320
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
 
        if actual_revno != last_revno:
1322
 
            result.errors.append(errors.BzrCheckError(
1323
 
                'revno does not match len(mainline) %s != %s' % (
1324
 
                last_revno, actual_revno)))
1325
 
        # TODO: We should probably also check that self.revision_history
1326
 
        # matches the repository for older branch formats.
1327
 
        # If looking for the code that cross-checks repository parents against
1328
 
        # the iter_reverse_revision_history output, that is now a repository
1329
 
        # specific check.
1330
 
        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)
1331
1036
 
1332
1037
    def _get_checkout_format(self):
1333
1038
        """Return the most suitable metadir for a checkout of this branch.
1343
1048
        return format
1344
1049
 
1345
1050
    def create_clone_on_transport(self, to_transport, revision_id=None,
1346
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1051
        stacked_on=None):
1347
1052
        """Create a clone of this branch and its bzrdir.
1348
1053
 
1349
1054
        :param to_transport: The transport to clone onto.
1350
1055
        :param revision_id: The revision id to use as tip in the new branch.
1351
1056
            If None the tip is obtained from this branch.
1352
1057
        :param stacked_on: An optional URL to stack the clone on.
1353
 
        :param create_prefix: Create any missing directories leading up to
1354
 
            to_transport.
1355
 
        :param use_existing_dir: Use an existing directory if one exists.
1356
1058
        """
1357
1059
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1060
        # clone call. Or something. 20090224 RBC/spiv.
1359
 
        # XXX: Should this perhaps clone colocated branches as well, 
1360
 
        # rather than just the default branch? 20100319 JRV
1361
 
        if revision_id is None:
1362
 
            revision_id = self.last_revision()
1363
1061
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
 
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1062
            revision_id=revision_id, stacked_on=stacked_on)
1366
1063
        return dir_to.open_branch()
1367
1064
 
1368
1065
    def create_checkout(self, to_location, revision_id=None,
1387
1084
        if lightweight:
1388
1085
            format = self._get_checkout_format()
1389
1086
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1087
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1392
1088
        else:
1393
1089
            format = self._get_checkout_format()
1394
1090
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1423
1119
        reconciler.reconcile()
1424
1120
        return reconciler
1425
1121
 
1426
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1122
    def reference_parent(self, file_id, path):
1427
1123
        """Return the parent branch for a tree-reference file_id
1428
1124
        :param file_id: The file_id of the tree reference
1429
1125
        :param path: The path of the file_id in the tree
1430
1126
        :return: A branch associated with the file_id
1431
1127
        """
1432
1128
        # FIXME should provide multiple branches, based on config
1433
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1434
 
                           possible_transports=possible_transports)
 
1129
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1435
1130
 
1436
1131
    def supports_tags(self):
1437
1132
        return self._format.supports_tags()
1438
1133
 
1439
 
    def automatic_tag_name(self, revision_id):
1440
 
        """Try to automatically find the tag name for a revision.
1441
 
 
1442
 
        :param revision_id: Revision id of the revision.
1443
 
        :return: A tag name or None if no tag name could be determined.
1444
 
        """
1445
 
        for hook in Branch.hooks['automatic_tag_name']:
1446
 
            ret = hook(self, revision_id)
1447
 
            if ret is not None:
1448
 
                return ret
1449
 
        return None
1450
 
 
1451
1134
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1135
                                         other_branch):
1453
1136
        """Ensure that revision_b is a descendant of revision_a.
1508
1191
    _formats = {}
1509
1192
    """The known formats."""
1510
1193
 
1511
 
    can_set_append_revisions_only = True
1512
 
 
1513
1194
    def __eq__(self, other):
1514
1195
        return self.__class__ is other.__class__
1515
1196
 
1517
1198
        return not (self == other)
1518
1199
 
1519
1200
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
 
1201
    def find_format(klass, a_bzrdir):
1521
1202
        """Return the format for the branch object in a_bzrdir."""
1522
1203
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
 
1204
            transport = a_bzrdir.get_branch_transport(None)
 
1205
            format_string = transport.get("format").read()
1525
1206
            return klass._formats[format_string]
1526
1207
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1208
            raise errors.NotBranchError(path=transport.base)
1528
1209
        except KeyError:
1529
1210
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1211
 
1533
1214
        """Return the current default format."""
1534
1215
        return klass._default_format
1535
1216
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1217
    def get_reference(self, a_bzrdir):
1537
1218
        """Get the target reference of the branch in a_bzrdir.
1538
1219
 
1539
1220
        format probing must have been completed before calling
1541
1222
        in a_bzrdir is correct.
1542
1223
 
1543
1224
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1225
        :return: None if the branch is not a reference branch.
1546
1226
        """
1547
1227
        return None
1548
1228
 
1549
1229
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1230
    def set_reference(self, a_bzrdir, to_branch):
1551
1231
        """Set the target reference of the branch in a_bzrdir.
1552
1232
 
1553
1233
        format probing must have been completed before calling
1555
1235
        in a_bzrdir is correct.
1556
1236
 
1557
1237
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1238
        :param to_branch: branch that the checkout is to reference
1560
1239
        """
1561
1240
        raise NotImplementedError(self.set_reference)
1568
1247
        """Return the short format description for this format."""
1569
1248
        raise NotImplementedError(self.get_format_description)
1570
1249
 
1571
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
 
        hooks = Branch.hooks['post_branch_init']
1573
 
        if not hooks:
1574
 
            return
1575
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
 
        for hook in hooks:
1577
 
            hook(params)
1578
 
 
1579
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
 
1250
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1251
                           set_format=True):
1581
1252
        """Initialize a branch in a bzrdir, with specified files
1582
1253
 
1583
1254
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1255
        :param utf8_files: The files to create as a list of
1585
1256
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
1257
        :param set_format: If True, set the format with
1588
1258
            self.get_format_string.  (BzrBranch4 has its format set
1589
1259
            elsewhere)
1590
1260
        :return: a branch in this format
1591
1261
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        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)
1594
1264
        lock_map = {
1595
1265
            'metadir': ('lock', lockdir.LockDir),
1596
1266
            'branch4': ('branch-lock', lockable_files.TransportLock),
1599
1269
        control_files = lockable_files.LockableFiles(branch_transport,
1600
1270
            lock_name, lock_class)
1601
1271
        control_files.create_lock()
1602
 
        try:
1603
 
            control_files.lock_write()
1604
 
        except errors.LockContention:
1605
 
            if lock_type != 'branch4':
1606
 
                raise
1607
 
            lock_taken = False
1608
 
        else:
1609
 
            lock_taken = True
 
1272
        control_files.lock_write()
1610
1273
        if set_format:
1611
1274
            utf8_files += [('format', self.get_format_string())]
1612
1275
        try:
1615
1278
                    filename, content,
1616
1279
                    mode=a_bzrdir._get_file_mode())
1617
1280
        finally:
1618
 
            if lock_taken:
1619
 
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
 
1281
            control_files.unlock()
 
1282
        return self.open(a_bzrdir, _found=True)
1623
1283
 
1624
 
    def initialize(self, a_bzrdir, name=None):
1625
 
        """Create a branch of this format in a_bzrdir.
1626
 
        
1627
 
        :param name: Name of the colocated branch to create.
1628
 
        """
 
1284
    def initialize(self, a_bzrdir):
 
1285
        """Create a branch of this format in a_bzrdir."""
1629
1286
        raise NotImplementedError(self.initialize)
1630
1287
 
1631
1288
    def is_supported(self):
1661
1318
        """
1662
1319
        raise NotImplementedError(self.network_name)
1663
1320
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1321
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1665
1322
        """Return the branch object for a_bzrdir
1666
1323
 
1667
1324
        :param a_bzrdir: A BzrDir that contains a branch.
1668
 
        :param name: Name of colocated branch to open
1669
1325
        :param _found: a private parameter, do not use it. It is used to
1670
1326
            indicate if format probing has already be done.
1671
1327
        :param ignore_fallbacks: when set, no fallback branches will be opened
1685
1341
    def set_default_format(klass, format):
1686
1342
        klass._default_format = format
1687
1343
 
1688
 
    def supports_set_append_revisions_only(self):
1689
 
        """True if this format supports set_append_revisions_only."""
1690
 
        return False
1691
 
 
1692
1344
    def supports_stacking(self):
1693
1345
        """True if this format records a stacked-on branch."""
1694
1346
        return False
1756
1408
            "post_uncommit is called with (local, master, old_revno, "
1757
1409
            "old_revid, new_revno, new_revid) where local is the local branch "
1758
1410
            "or None, master is the target branch, and an empty branch "
1759
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1411
            "recieves new_revno of 0, new_revid of None.", (0, 15), None))
1760
1412
        self.create_hook(HookPoint('pre_change_branch_tip',
1761
1413
            "Called in bzr client and server before a change to the tip of a "
1762
1414
            "branch is made. pre_change_branch_tip is called with a "
1779
1431
            "multiple hooks installed for transform_fallback_location, "
1780
1432
            "all are called with the url returned from the previous hook."
1781
1433
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
1784
 
            "automatic_tag_name is called with (branch, revision_id) and "
1785
 
            "should return a tag name or None if no tag name could be "
1786
 
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
1789
 
            "Called after new branch initialization completes. "
1790
 
            "post_branch_init is called with a "
1791
 
            "bzrlib.branch.BranchInitHookParams. "
1792
 
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
1795
 
            "Called after a checkout switches branch. "
1796
 
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
 
 
1799
1434
 
1800
1435
 
1801
1436
# install the default hooks into the Branch class.
1840
1475
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1476
 
1842
1477
 
1843
 
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
1845
 
 
1846
 
    There are 4 fields that hooks may wish to access:
1847
 
 
1848
 
    :ivar format: the branch format
1849
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
 
    :ivar name: name of colocated branch, if any (or None)
1851
 
    :ivar branch: the branch created
1852
 
 
1853
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
 
    the checkout, hence they are different from the corresponding fields in
1855
 
    branch, which refer to the original branch.
1856
 
    """
1857
 
 
1858
 
    def __init__(self, format, a_bzrdir, name, branch):
1859
 
        """Create a group of BranchInitHook parameters.
1860
 
 
1861
 
        :param format: the branch format
1862
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1863
 
            initialized
1864
 
        :param name: name of colocated branch, if any (or None)
1865
 
        :param branch: the branch created
1866
 
 
1867
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1868
 
        to the checkout, hence they are different from the corresponding fields
1869
 
        in branch, which refer to the original branch.
1870
 
        """
1871
 
        self.format = format
1872
 
        self.bzrdir = a_bzrdir
1873
 
        self.name = name
1874
 
        self.branch = branch
1875
 
 
1876
 
    def __eq__(self, other):
1877
 
        return self.__dict__ == other.__dict__
1878
 
 
1879
 
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
1886
 
 
1887
 
 
1888
 
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
1890
 
 
1891
 
    There are 4 fields that hooks may wish to access:
1892
 
 
1893
 
    :ivar control_dir: BzrDir of the checkout to change
1894
 
    :ivar to_branch: branch that the checkout is to reference
1895
 
    :ivar force: skip the check for local commits in a heavy checkout
1896
 
    :ivar revision_id: revision ID to switch to (or None)
1897
 
    """
1898
 
 
1899
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1900
 
        """Create a group of SwitchHook parameters.
1901
 
 
1902
 
        :param control_dir: BzrDir of the checkout to change
1903
 
        :param to_branch: branch that the checkout is to reference
1904
 
        :param force: skip the check for local commits in a heavy checkout
1905
 
        :param revision_id: revision ID to switch to (or None)
1906
 
        """
1907
 
        self.control_dir = control_dir
1908
 
        self.to_branch = to_branch
1909
 
        self.force = force
1910
 
        self.revision_id = revision_id
1911
 
 
1912
 
    def __eq__(self, other):
1913
 
        return self.__dict__ == other.__dict__
1914
 
 
1915
 
    def __repr__(self):
1916
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
 
            self.control_dir, self.to_branch,
1918
 
            self.revision_id)
1919
 
 
1920
 
 
1921
1478
class BzrBranchFormat4(BranchFormat):
1922
1479
    """Bzr branch format 4.
1923
1480
 
1930
1487
        """See BranchFormat.get_format_description()."""
1931
1488
        return "Branch format 4"
1932
1489
 
1933
 
    def initialize(self, a_bzrdir, name=None):
 
1490
    def initialize(self, a_bzrdir):
1934
1491
        """Create a branch of this format in a_bzrdir."""
1935
1492
        utf8_files = [('revision-history', ''),
1936
1493
                      ('branch-name', ''),
1937
1494
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1495
        return self._initialize_helper(a_bzrdir, utf8_files,
1939
1496
                                       lock_type='branch4', set_format=False)
1940
1497
 
1941
1498
    def __init__(self):
1946
1503
        """The network name for this format is the control dirs disk label."""
1947
1504
        return self._matchingbzrdir.get_format_string()
1948
1505
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1506
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1950
1507
        """See BranchFormat.open()."""
1951
1508
        if not _found:
1952
1509
            # we are being called directly and must probe.
1954
1511
        return BzrBranch(_format=self,
1955
1512
                         _control_files=a_bzrdir._control_files,
1956
1513
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
1514
                         _repository=a_bzrdir.open_repository())
1959
1515
 
1960
1516
    def __str__(self):
1975
1531
        """
1976
1532
        return self.get_format_string()
1977
1533
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1534
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1535
        """See BranchFormat.open()."""
1980
1536
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1537
            format = BranchFormat.find_format(a_bzrdir)
1982
1538
            if format.__class__ != self.__class__:
1983
1539
                raise AssertionError("wrong format %r found for %r" %
1984
1540
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1541
        try:
 
1542
            transport = a_bzrdir.get_branch_transport(None)
1987
1543
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1544
                                                         lockdir.LockDir)
1989
1545
            return self._branch_class()(_format=self,
1990
1546
                              _control_files=control_files,
1991
 
                              name=name,
1992
1547
                              a_bzrdir=a_bzrdir,
1993
1548
                              _repository=a_bzrdir.find_repository(),
1994
1549
                              ignore_fallbacks=ignore_fallbacks)
1995
1550
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1551
            raise errors.NotBranchError(path=transport.base)
1997
1552
 
1998
1553
    def __init__(self):
1999
1554
        super(BranchFormatMetadir, self).__init__()
2028
1583
        """See BranchFormat.get_format_description()."""
2029
1584
        return "Branch format 5"
2030
1585
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
1586
    def initialize(self, a_bzrdir):
2032
1587
        """Create a branch of this format in a_bzrdir."""
2033
1588
        utf8_files = [('revision-history', ''),
2034
1589
                      ('branch-name', ''),
2035
1590
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1591
        return self._initialize_helper(a_bzrdir, utf8_files)
2037
1592
 
2038
1593
    def supports_tags(self):
2039
1594
        return False
2061
1616
        """See BranchFormat.get_format_description()."""
2062
1617
        return "Branch format 6"
2063
1618
 
2064
 
    def initialize(self, a_bzrdir, name=None):
2065
 
        """Create a branch of this format in a_bzrdir."""
2066
 
        utf8_files = [('last-revision', '0 null:\n'),
2067
 
                      ('branch.conf', ''),
2068
 
                      ('tags', ''),
2069
 
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2071
 
 
2072
 
    def make_tags(self, branch):
2073
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2074
 
        return BasicTags(branch)
2075
 
 
2076
 
    def supports_set_append_revisions_only(self):
2077
 
        return True
2078
 
 
2079
 
 
2080
 
class BzrBranchFormat8(BranchFormatMetadir):
2081
 
    """Metadir format supporting storing locations of subtree branches."""
2082
 
 
2083
 
    def _branch_class(self):
2084
 
        return BzrBranch8
2085
 
 
2086
 
    def get_format_string(self):
2087
 
        """See BranchFormat.get_format_string()."""
2088
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2089
 
 
2090
 
    def get_format_description(self):
2091
 
        """See BranchFormat.get_format_description()."""
2092
 
        return "Branch format 8"
2093
 
 
2094
 
    def initialize(self, a_bzrdir, name=None):
2095
 
        """Create a branch of this format in a_bzrdir."""
2096
 
        utf8_files = [('last-revision', '0 null:\n'),
2097
 
                      ('branch.conf', ''),
2098
 
                      ('tags', ''),
2099
 
                      ('references', '')
2100
 
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2102
 
 
2103
 
    def __init__(self):
2104
 
        super(BzrBranchFormat8, self).__init__()
2105
 
        self._matchingbzrdir.repository_format = \
2106
 
            RepositoryFormatKnitPack5RichRoot()
2107
 
 
2108
 
    def make_tags(self, branch):
2109
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2110
 
        return BasicTags(branch)
2111
 
 
2112
 
    def supports_set_append_revisions_only(self):
2113
 
        return True
2114
 
 
2115
 
    def supports_stacking(self):
2116
 
        return True
2117
 
 
2118
 
    supports_reference_locations = True
2119
 
 
2120
 
 
2121
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1619
    def initialize(self, a_bzrdir):
 
1620
        """Create a branch of this format in a_bzrdir."""
 
1621
        utf8_files = [('last-revision', '0 null:\n'),
 
1622
                      ('branch.conf', ''),
 
1623
                      ('tags', ''),
 
1624
                      ]
 
1625
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1626
 
 
1627
    def make_tags(self, branch):
 
1628
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1629
        return BasicTags(branch)
 
1630
 
 
1631
 
 
1632
 
 
1633
class BzrBranchFormat7(BranchFormatMetadir):
2122
1634
    """Branch format with last-revision, tags, and a stacked location pointer.
2123
1635
 
2124
1636
    The stacked location pointer is passed down to the repository and requires
2127
1639
    This format was introduced in bzr 1.6.
2128
1640
    """
2129
1641
 
2130
 
    def initialize(self, a_bzrdir, name=None):
2131
 
        """Create a branch of this format in a_bzrdir."""
2132
 
        utf8_files = [('last-revision', '0 null:\n'),
2133
 
                      ('branch.conf', ''),
2134
 
                      ('tags', ''),
2135
 
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2137
 
 
2138
1642
    def _branch_class(self):
2139
1643
        return BzrBranch7
2140
1644
 
2146
1650
        """See BranchFormat.get_format_description()."""
2147
1651
        return "Branch format 7"
2148
1652
 
2149
 
    def supports_set_append_revisions_only(self):
 
1653
    def initialize(self, a_bzrdir):
 
1654
        """Create a branch of this format in a_bzrdir."""
 
1655
        utf8_files = [('last-revision', '0 null:\n'),
 
1656
                      ('branch.conf', ''),
 
1657
                      ('tags', ''),
 
1658
                      ]
 
1659
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1660
 
 
1661
    def __init__(self):
 
1662
        super(BzrBranchFormat7, self).__init__()
 
1663
        self._matchingbzrdir.repository_format = \
 
1664
            RepositoryFormatKnitPack5RichRoot()
 
1665
 
 
1666
    def make_tags(self, branch):
 
1667
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1668
        return BasicTags(branch)
 
1669
 
 
1670
    def supports_stacking(self):
2150
1671
        return True
2151
1672
 
2152
 
    supports_reference_locations = False
2153
 
 
2154
1673
 
2155
1674
class BranchReferenceFormat(BranchFormat):
2156
1675
    """Bzr branch reference format.
2171
1690
        """See BranchFormat.get_format_description()."""
2172
1691
        return "Checkout reference format 1"
2173
1692
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
1693
    def get_reference(self, a_bzrdir):
2175
1694
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
 
1695
        transport = a_bzrdir.get_branch_transport(None)
 
1696
        return transport.get('location').read()
2178
1697
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1698
    def set_reference(self, a_bzrdir, to_branch):
2180
1699
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1700
        transport = a_bzrdir.get_branch_transport(None)
2182
1701
        location = transport.put_bytes('location', to_branch.base)
2183
1702
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1703
    def initialize(self, a_bzrdir, target_branch=None):
2185
1704
        """Create a branch of this format in a_bzrdir."""
2186
1705
        if target_branch is None:
2187
1706
            # this format does not implement branch itself, thus the implicit
2188
1707
            # creation contract must see it as uninitializable
2189
1708
            raise errors.UninitializableFormat(self)
2190
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1709
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1710
        branch_transport = a_bzrdir.get_branch_transport(self)
2192
1711
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
1712
            target_branch.bzrdir.root_transport.base)
2194
1713
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
 
1714
        return self.open(
 
1715
            a_bzrdir, _found=True,
2197
1716
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
1717
 
2201
1718
    def __init__(self):
2202
1719
        super(BranchReferenceFormat, self).__init__()
2208
1725
        def clone(to_bzrdir, revision_id=None,
2209
1726
            repository_policy=None):
2210
1727
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1728
            return format.initialize(to_bzrdir, a_branch)
2212
1729
            # cannot obey revision_id limits when cloning a reference ...
2213
1730
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1731
            # emit some sort of warning/error to the caller ?!
2215
1732
        return clone
2216
1733
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1734
    def open(self, a_bzrdir, _found=False, location=None,
2218
1735
             possible_transports=None, ignore_fallbacks=False):
2219
1736
        """Return the branch that the branch reference in a_bzrdir points at.
2220
1737
 
2221
1738
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
1739
        :param _found: a private parameter, do not use it. It is used to
2224
1740
            indicate if format probing has already be done.
2225
1741
        :param ignore_fallbacks: when set, no fallback branches will be opened
2230
1746
        :param possible_transports: An optional reusable transports list.
2231
1747
        """
2232
1748
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1749
            format = BranchFormat.find_format(a_bzrdir)
2234
1750
            if format.__class__ != self.__class__:
2235
1751
                raise AssertionError("wrong format %r found for %r" %
2236
1752
                    (format, self))
2237
1753
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
1754
            location = self.get_reference(a_bzrdir)
2239
1755
        real_bzrdir = bzrdir.BzrDir.open(
2240
1756
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
 
1757
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2243
1758
        # this changes the behaviour of result.clone to create a new reference
2244
1759
        # rather than a copy of the content of the branch.
2245
1760
        # I did not use a proxy object because that needs much more extensive
2266
1781
__format5 = BzrBranchFormat5()
2267
1782
__format6 = BzrBranchFormat6()
2268
1783
__format7 = BzrBranchFormat7()
2269
 
__format8 = BzrBranchFormat8()
2270
1784
BranchFormat.register_format(__format5)
2271
1785
BranchFormat.register_format(BranchReferenceFormat())
2272
1786
BranchFormat.register_format(__format6)
2273
1787
BranchFormat.register_format(__format7)
2274
 
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
 
1788
BranchFormat.set_default_format(__format6)
2276
1789
_legacy_formats = [BzrBranchFormat4(),
2277
1790
    ]
2278
1791
network_format_registry.register(
2279
1792
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
1793
 
2281
1794
 
2282
 
class BranchWriteLockResult(LogicalLockResult):
2283
 
    """The result of write locking a branch.
2284
 
 
2285
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2286
 
        None.
2287
 
    :ivar unlock: A callable which will unlock the lock.
2288
 
    """
2289
 
 
2290
 
    def __init__(self, unlock, branch_token):
2291
 
        LogicalLockResult.__init__(self, unlock)
2292
 
        self.branch_token = branch_token
2293
 
 
2294
 
    def __repr__(self):
2295
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
 
            self.unlock)
2297
 
 
2298
 
 
2299
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1795
class BzrBranch(Branch):
2300
1796
    """A branch stored in the actual filesystem.
2301
1797
 
2302
1798
    Note that it's "local" in the context of the filesystem; it doesn't
2308
1804
    :ivar repository: Repository for this branch.
2309
1805
    :ivar base: The url of the base directory for this branch; the one
2310
1806
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
1807
    """
2314
1808
 
2315
1809
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
 
1810
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1811
                 ignore_fallbacks=False):
2318
1812
        """Create new branch object at a particular location."""
2319
1813
        if a_bzrdir is None:
2320
1814
            raise ValueError('a_bzrdir must be supplied')
2321
1815
        else:
2322
1816
            self.bzrdir = a_bzrdir
2323
1817
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
1818
        # XXX: We should be able to just do
2326
1819
        #   self.base = self.bzrdir.root_transport.base
2327
1820
        # but this does not quite work yet -- mbp 20080522
2334
1827
        Branch.__init__(self)
2335
1828
 
2336
1829
    def __str__(self):
2337
 
        if self.name is None:
2338
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2339
 
        else:
2340
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2341
 
                self.name)
 
1830
        return '%s(%r)' % (self.__class__.__name__, self.base)
2342
1831
 
2343
1832
    __repr__ = __str__
2344
1833
 
2348
1837
 
2349
1838
    base = property(_get_base, doc="The URL for the root of this branch.")
2350
1839
 
2351
 
    def _get_config(self):
2352
 
        return TransportConfig(self._transport, 'branch.conf')
2353
 
 
2354
1840
    def is_locked(self):
2355
1841
        return self.control_files.is_locked()
2356
1842
 
2357
1843
    def lock_write(self, token=None):
2358
 
        """Lock the branch for write operations.
2359
 
 
2360
 
        :param token: A token to permit reacquiring a previously held and
2361
 
            preserved lock.
2362
 
        :return: A BranchWriteLockResult.
2363
 
        """
2364
 
        if not self.is_locked():
2365
 
            self._note_lock('w')
2366
 
        # All-in-one needs to always unlock/lock.
2367
 
        repo_control = getattr(self.repository, 'control_files', None)
2368
 
        if self.control_files == repo_control or not self.is_locked():
2369
 
            self.repository._warn_if_deprecated(self)
2370
 
            self.repository.lock_write()
2371
 
            took_lock = True
2372
 
        else:
2373
 
            took_lock = False
 
1844
        repo_token = self.repository.lock_write()
2374
1845
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
1846
            token = self.control_files.lock_write(token=token)
2377
1847
        except:
2378
 
            if took_lock:
2379
 
                self.repository.unlock()
 
1848
            self.repository.unlock()
2380
1849
            raise
 
1850
        return token
2381
1851
 
2382
1852
    def lock_read(self):
2383
 
        """Lock the branch for read operations.
2384
 
 
2385
 
        :return: A bzrlib.lock.LogicalLockResult.
2386
 
        """
2387
 
        if not self.is_locked():
2388
 
            self._note_lock('r')
2389
 
        # All-in-one needs to always unlock/lock.
2390
 
        repo_control = getattr(self.repository, 'control_files', None)
2391
 
        if self.control_files == repo_control or not self.is_locked():
2392
 
            self.repository._warn_if_deprecated(self)
2393
 
            self.repository.lock_read()
2394
 
            took_lock = True
2395
 
        else:
2396
 
            took_lock = False
 
1853
        self.repository.lock_read()
2397
1854
        try:
2398
1855
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
1856
        except:
2401
 
            if took_lock:
2402
 
                self.repository.unlock()
 
1857
            self.repository.unlock()
2403
1858
            raise
2404
1859
 
2405
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2406
1860
    def unlock(self):
 
1861
        # TODO: test for failed two phase locks. This is known broken.
2407
1862
        try:
2408
1863
            self.control_files.unlock()
2409
1864
        finally:
2410
 
            # All-in-one needs to always unlock/lock.
2411
 
            repo_control = getattr(self.repository, 'control_files', None)
2412
 
            if (self.control_files == repo_control or
2413
 
                not self.control_files.is_locked()):
2414
 
                self.repository.unlock()
2415
 
            if not self.control_files.is_locked():
2416
 
                # we just released the lock
2417
 
                self._clear_cached_state()
 
1865
            self.repository.unlock()
 
1866
        if not self.control_files.is_locked():
 
1867
            # we just released the lock
 
1868
            self._clear_cached_state()
2418
1869
 
2419
1870
    def peek_lock_mode(self):
2420
1871
        if self.control_files._lock_count == 0:
2539
1990
        """See Branch.basis_tree."""
2540
1991
        return self.repository.revision_tree(self.last_revision())
2541
1992
 
 
1993
    @needs_write_lock
 
1994
    def pull(self, source, overwrite=False, stop_revision=None,
 
1995
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1996
             _override_hook_target=None):
 
1997
        """See Branch.pull.
 
1998
 
 
1999
        :param _hook_master: Private parameter - set the branch to
 
2000
            be supplied as the master to pull hooks.
 
2001
        :param run_hooks: Private parameter - if false, this branch
 
2002
            is being called because it's the master of the primary branch,
 
2003
            so it should not run its hooks.
 
2004
        :param _override_hook_target: Private parameter - set the branch to be
 
2005
            supplied as the target_branch to pull hooks.
 
2006
        """
 
2007
        result = PullResult()
 
2008
        result.source_branch = source
 
2009
        if _override_hook_target is None:
 
2010
            result.target_branch = self
 
2011
        else:
 
2012
            result.target_branch = _override_hook_target
 
2013
        source.lock_read()
 
2014
        try:
 
2015
            # We assume that during 'pull' the local repository is closer than
 
2016
            # the remote one.
 
2017
            graph = self.repository.get_graph(source.repository)
 
2018
            result.old_revno, result.old_revid = self.last_revision_info()
 
2019
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2020
                                  graph=graph)
 
2021
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2022
            result.new_revno, result.new_revid = self.last_revision_info()
 
2023
            if _hook_master:
 
2024
                result.master_branch = _hook_master
 
2025
                result.local_branch = result.target_branch
 
2026
            else:
 
2027
                result.master_branch = result.target_branch
 
2028
                result.local_branch = None
 
2029
            if run_hooks:
 
2030
                for hook in Branch.hooks['post_pull']:
 
2031
                    hook(result)
 
2032
        finally:
 
2033
            source.unlock()
 
2034
        return result
 
2035
 
2542
2036
    def _get_parent_location(self):
2543
2037
        _locs = ['parent', 'pull', 'x-pull']
2544
2038
        for l in _locs:
2548
2042
                pass
2549
2043
        return None
2550
2044
 
 
2045
    @needs_read_lock
 
2046
    def push(self, target, overwrite=False, stop_revision=None,
 
2047
             _override_hook_source_branch=None):
 
2048
        """See Branch.push.
 
2049
 
 
2050
        This is the basic concrete implementation of push()
 
2051
 
 
2052
        :param _override_hook_source_branch: If specified, run
 
2053
        the hooks passing this Branch as the source, rather than self.
 
2054
        This is for use of RemoteBranch, where push is delegated to the
 
2055
        underlying vfs-based Branch.
 
2056
        """
 
2057
        # TODO: Public option to disable running hooks - should be trivial but
 
2058
        # needs tests.
 
2059
        return _run_with_write_locked_target(
 
2060
            target, self._push_with_bound_branches, target, overwrite,
 
2061
            stop_revision,
 
2062
            _override_hook_source_branch=_override_hook_source_branch)
 
2063
 
 
2064
    def _push_with_bound_branches(self, target, overwrite,
 
2065
            stop_revision,
 
2066
            _override_hook_source_branch=None):
 
2067
        """Push from self into target, and into target's master if any.
 
2068
 
 
2069
        This is on the base BzrBranch class even though it doesn't support
 
2070
        bound branches because the *target* might be bound.
 
2071
        """
 
2072
        def _run_hooks():
 
2073
            if _override_hook_source_branch:
 
2074
                result.source_branch = _override_hook_source_branch
 
2075
            for hook in Branch.hooks['post_push']:
 
2076
                hook(result)
 
2077
 
 
2078
        bound_location = target.get_bound_location()
 
2079
        if bound_location and target.base != bound_location:
 
2080
            # there is a master branch.
 
2081
            #
 
2082
            # XXX: Why the second check?  Is it even supported for a branch to
 
2083
            # be bound to itself? -- mbp 20070507
 
2084
            master_branch = target.get_master_branch()
 
2085
            master_branch.lock_write()
 
2086
            try:
 
2087
                # push into the master from this branch.
 
2088
                self._basic_push(master_branch, overwrite, stop_revision)
 
2089
                # and push into the target branch from this. Note that we push from
 
2090
                # this branch again, because its considered the highest bandwidth
 
2091
                # repository.
 
2092
                result = self._basic_push(target, overwrite, stop_revision)
 
2093
                result.master_branch = master_branch
 
2094
                result.local_branch = target
 
2095
                _run_hooks()
 
2096
                return result
 
2097
            finally:
 
2098
                master_branch.unlock()
 
2099
        else:
 
2100
            # no master branch
 
2101
            result = self._basic_push(target, overwrite, stop_revision)
 
2102
            # TODO: Why set master_branch and local_branch if there's no
 
2103
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2104
            # 20070504
 
2105
            result.master_branch = target
 
2106
            result.local_branch = None
 
2107
            _run_hooks()
 
2108
            return result
 
2109
 
2551
2110
    def _basic_push(self, target, overwrite, stop_revision):
2552
2111
        """Basic implementation of push without bound branches or hooks.
2553
2112
 
2554
 
        Must be called with source read locked and target write locked.
 
2113
        Must be called with self read locked and target write locked.
2555
2114
        """
2556
2115
        result = BranchPushResult()
2557
2116
        result.source_branch = self
2558
2117
        result.target_branch = target
2559
2118
        result.old_revno, result.old_revid = target.last_revision_info()
2560
 
        self.update_references(target)
2561
2119
        if result.old_revid != self.last_revision():
2562
2120
            # We assume that during 'push' this repository is closer than
2563
2121
            # the target.
2564
2122
            graph = self.repository.get_graph(target.repository)
2565
 
            target.update_revisions(self, stop_revision,
2566
 
                overwrite=overwrite, graph=graph)
 
2123
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2124
                                    graph=graph)
2567
2125
        if self._push_should_merge_tags():
2568
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2569
 
                overwrite)
 
2126
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2570
2127
        result.new_revno, result.new_revid = target.last_revision_info()
2571
2128
        return result
2572
2129
 
2573
2130
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2131
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2132
 
2576
2133
    def set_push_location(self, location):
2577
2134
        """See Branch.set_push_location."""
2579
2136
            'push_location', location,
2580
2137
            store=_mod_config.STORE_LOCATION_NORECURSE)
2581
2138
 
 
2139
    @needs_write_lock
 
2140
    def set_parent(self, url):
 
2141
        """See Branch.set_parent."""
 
2142
        # TODO: Maybe delete old location files?
 
2143
        # URLs should never be unicode, even on the local fs,
 
2144
        # FIXUP this and get_parent in a future branch format bump:
 
2145
        # read and rewrite the file. RBC 20060125
 
2146
        if url is not None:
 
2147
            if isinstance(url, unicode):
 
2148
                try:
 
2149
                    url = url.encode('ascii')
 
2150
                except UnicodeEncodeError:
 
2151
                    raise errors.InvalidURL(url,
 
2152
                        "Urls must be 7-bit ascii, "
 
2153
                        "use bzrlib.urlutils.escape")
 
2154
            url = urlutils.relative_url(self.base, url)
 
2155
        self._set_parent_location(url)
 
2156
 
2582
2157
    def _set_parent_location(self, url):
2583
2158
        if url is None:
2584
2159
            self._transport.delete('parent')
2586
2161
            self._transport.put_bytes('parent', url + '\n',
2587
2162
                mode=self.bzrdir._get_file_mode())
2588
2163
 
 
2164
    def set_stacked_on_url(self, url):
 
2165
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2166
 
2589
2167
 
2590
2168
class BzrBranch5(BzrBranch):
2591
2169
    """A format 5 branch. This supports new features over plain branches.
2593
2171
    It has support for a master_branch which is the data for bound branches.
2594
2172
    """
2595
2173
 
 
2174
    @needs_write_lock
 
2175
    def pull(self, source, overwrite=False, stop_revision=None,
 
2176
             run_hooks=True, possible_transports=None,
 
2177
             _override_hook_target=None):
 
2178
        """Pull from source into self, updating my master if any.
 
2179
 
 
2180
        :param run_hooks: Private parameter - if false, this branch
 
2181
            is being called because it's the master of the primary branch,
 
2182
            so it should not run its hooks.
 
2183
        """
 
2184
        bound_location = self.get_bound_location()
 
2185
        master_branch = None
 
2186
        if bound_location and source.base != bound_location:
 
2187
            # not pulling from master, so we need to update master.
 
2188
            master_branch = self.get_master_branch(possible_transports)
 
2189
            master_branch.lock_write()
 
2190
        try:
 
2191
            if master_branch:
 
2192
                # pull from source into master.
 
2193
                master_branch.pull(source, overwrite, stop_revision,
 
2194
                    run_hooks=False)
 
2195
            return super(BzrBranch5, self).pull(source, overwrite,
 
2196
                stop_revision, _hook_master=master_branch,
 
2197
                run_hooks=run_hooks,
 
2198
                _override_hook_target=_override_hook_target)
 
2199
        finally:
 
2200
            if master_branch:
 
2201
                master_branch.unlock()
 
2202
 
2596
2203
    def get_bound_location(self):
2597
2204
        try:
2598
2205
            return self._transport.get_bytes('bound')[:-1]
2685
2292
        return None
2686
2293
 
2687
2294
 
2688
 
class BzrBranch8(BzrBranch5):
2689
 
    """A branch that stores tree-reference locations."""
 
2295
class BzrBranch7(BzrBranch5):
 
2296
    """A branch with support for a fallback repository."""
 
2297
 
 
2298
    def _get_fallback_repository(self, url):
 
2299
        """Get the repository we fallback to at url."""
 
2300
        url = urlutils.join(self.base, url)
 
2301
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2302
                                      possible_transports=[self._transport])
 
2303
        return a_bzrdir.open_branch().repository
 
2304
 
 
2305
    def _activate_fallback_location(self, url):
 
2306
        """Activate the branch/repository from url as a fallback repository."""
 
2307
        self.repository.add_fallback_repository(
 
2308
            self._get_fallback_repository(url))
2690
2309
 
2691
2310
    def _open_hook(self):
2692
2311
        if self._ignore_fallbacks:
2706
2325
                        "None, not a URL." % hook_name)
2707
2326
            self._activate_fallback_location(url)
2708
2327
 
 
2328
    def _check_stackable_repo(self):
 
2329
        if not self.repository._format.supports_external_lookups:
 
2330
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2331
                self.repository.base)
 
2332
 
2709
2333
    def __init__(self, *args, **kwargs):
2710
2334
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2335
        super(BzrBranch7, self).__init__(*args, **kwargs)
2712
2336
        self._last_revision_info_cache = None
2713
 
        self._reference_info = None
 
2337
        self._partial_revision_history_cache = []
2714
2338
 
2715
2339
    def _clear_cached_state(self):
2716
 
        super(BzrBranch8, self)._clear_cached_state()
 
2340
        super(BzrBranch7, self)._clear_cached_state()
2717
2341
        self._last_revision_info_cache = None
2718
 
        self._reference_info = None
 
2342
        self._partial_revision_history_cache = []
2719
2343
 
2720
2344
    def _last_revision_info(self):
2721
2345
        revision_string = self._transport.get_bytes('last-revision')
2767
2391
        if _mod_revision.is_null(last_revision):
2768
2392
            return
2769
2393
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2394
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2395
 
2772
2396
    def _gen_revision_history(self):
2773
2397
        """Generate the revision history from last revision
2776
2400
        self._extend_partial_history(stop_index=last_revno-1)
2777
2401
        return list(reversed(self._partial_revision_history_cache))
2778
2402
 
 
2403
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2404
        """Extend the partial history to include a given index
 
2405
 
 
2406
        If a stop_index is supplied, stop when that index has been reached.
 
2407
        If a stop_revision is supplied, stop when that revision is
 
2408
        encountered.  Otherwise, stop when the beginning of history is
 
2409
        reached.
 
2410
 
 
2411
        :param stop_index: The index which should be present.  When it is
 
2412
            present, history extension will stop.
 
2413
        :param revision_id: The revision id which should be present.  When
 
2414
            it is encountered, history extension will stop.
 
2415
        """
 
2416
        repo = self.repository
 
2417
        if len(self._partial_revision_history_cache) == 0:
 
2418
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2419
        else:
 
2420
            start_revision = self._partial_revision_history_cache[-1]
 
2421
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2422
            #skip the last revision in the list
 
2423
            next_revision = iterator.next()
 
2424
        for revision_id in iterator:
 
2425
            self._partial_revision_history_cache.append(revision_id)
 
2426
            if (stop_index is not None and
 
2427
                len(self._partial_revision_history_cache) > stop_index):
 
2428
                break
 
2429
            if revision_id == stop_revision:
 
2430
                break
 
2431
 
2779
2432
    def _write_revision_history(self, history):
2780
2433
        """Factored out of set_revision_history.
2781
2434
 
2802
2455
        """Set the parent branch"""
2803
2456
        return self._get_config_location('parent_location')
2804
2457
 
2805
 
    @needs_write_lock
2806
 
    def _set_all_reference_info(self, info_dict):
2807
 
        """Replace all reference info stored in a branch.
2808
 
 
2809
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2810
 
        """
2811
 
        s = StringIO()
2812
 
        writer = rio.RioWriter(s)
2813
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2814
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
 
                                branch_location=branch_location)
2816
 
            writer.write_stanza(stanza)
2817
 
        self._transport.put_bytes('references', s.getvalue())
2818
 
        self._reference_info = info_dict
2819
 
 
2820
 
    @needs_read_lock
2821
 
    def _get_all_reference_info(self):
2822
 
        """Return all the reference info stored in a branch.
2823
 
 
2824
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2825
 
        """
2826
 
        if self._reference_info is not None:
2827
 
            return self._reference_info
2828
 
        rio_file = self._transport.get('references')
2829
 
        try:
2830
 
            stanzas = rio.read_stanzas(rio_file)
2831
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2832
 
                             s['branch_location'])) for s in stanzas)
2833
 
        finally:
2834
 
            rio_file.close()
2835
 
        self._reference_info = info_dict
2836
 
        return info_dict
2837
 
 
2838
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2839
 
        """Set the branch location to use for a tree reference.
2840
 
 
2841
 
        :param file_id: The file-id of the tree reference.
2842
 
        :param tree_path: The path of the tree reference in the tree.
2843
 
        :param branch_location: The location of the branch to retrieve tree
2844
 
            references from.
2845
 
        """
2846
 
        info_dict = self._get_all_reference_info()
2847
 
        info_dict[file_id] = (tree_path, branch_location)
2848
 
        if None in (tree_path, branch_location):
2849
 
            if tree_path is not None:
2850
 
                raise ValueError('tree_path must be None when branch_location'
2851
 
                                 ' is None.')
2852
 
            if branch_location is not None:
2853
 
                raise ValueError('branch_location must be None when tree_path'
2854
 
                                 ' is None.')
2855
 
            del info_dict[file_id]
2856
 
        self._set_all_reference_info(info_dict)
2857
 
 
2858
 
    def get_reference_info(self, file_id):
2859
 
        """Get the tree_path and branch_location for a tree reference.
2860
 
 
2861
 
        :return: a tuple of (tree_path, branch_location)
2862
 
        """
2863
 
        return self._get_all_reference_info().get(file_id, (None, None))
2864
 
 
2865
 
    def reference_parent(self, file_id, path, possible_transports=None):
2866
 
        """Return the parent branch for a tree-reference file_id.
2867
 
 
2868
 
        :param file_id: The file_id of the tree reference
2869
 
        :param path: The path of the file_id in the tree
2870
 
        :return: A branch associated with the file_id
2871
 
        """
2872
 
        branch_location = self.get_reference_info(file_id)[1]
2873
 
        if branch_location is None:
2874
 
            return Branch.reference_parent(self, file_id, path,
2875
 
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
2877
 
        return Branch.open(branch_location,
2878
 
                           possible_transports=possible_transports)
2879
 
 
2880
2458
    def set_push_location(self, location):
2881
2459
        """See Branch.set_push_location."""
2882
2460
        self._set_config_location('push_location', location)
2924
2502
            raise errors.NotStacked(self)
2925
2503
        return stacked_url
2926
2504
 
 
2505
    def set_append_revisions_only(self, enabled):
 
2506
        if enabled:
 
2507
            value = 'True'
 
2508
        else:
 
2509
            value = 'False'
 
2510
        self.get_config().set_user_option('append_revisions_only', value,
 
2511
            warn_masked=True)
 
2512
 
 
2513
    def set_stacked_on_url(self, url):
 
2514
        self._check_stackable_repo()
 
2515
        if not url:
 
2516
            try:
 
2517
                old_url = self.get_stacked_on_url()
 
2518
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2519
                errors.UnstackableRepositoryFormat):
 
2520
                return
 
2521
            url = ''
 
2522
            # repositories don't offer an interface to remove fallback
 
2523
            # repositories today; take the conceptually simpler option and just
 
2524
            # reopen it.
 
2525
            self.repository = self.bzrdir.find_repository()
 
2526
            # for every revision reference the branch has, ensure it is pulled
 
2527
            # in.
 
2528
            source_repository = self._get_fallback_repository(old_url)
 
2529
            for revision_id in chain([self.last_revision()],
 
2530
                self.tags.get_reverse_tag_dict()):
 
2531
                self.repository.fetch(source_repository, revision_id,
 
2532
                    find_ghosts=True)
 
2533
        else:
 
2534
            self._activate_fallback_location(url)
 
2535
        # write this out after the repository is stacked to avoid setting a
 
2536
        # stacked config that doesn't work.
 
2537
        self._set_config_location('stacked_on_location', url)
 
2538
 
2927
2539
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2540
        value = self.get_config().get_user_option('append_revisions_only')
 
2541
        return value == 'True'
2930
2542
 
2931
2543
    @needs_write_lock
2932
2544
    def generate_revision_history(self, revision_id, last_rev=None,
2972
2584
        return self.revno() - index
2973
2585
 
2974
2586
 
2975
 
class BzrBranch7(BzrBranch8):
2976
 
    """A branch with support for a fallback repository."""
2977
 
 
2978
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2979
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2980
 
 
2981
 
    def get_reference_info(self, file_id):
2982
 
        Branch.get_reference_info(self, file_id)
2983
 
 
2984
 
    def reference_parent(self, file_id, path, possible_transports=None):
2985
 
        return Branch.reference_parent(self, file_id, path,
2986
 
                                       possible_transports)
2987
 
 
2988
 
 
2989
2587
class BzrBranch6(BzrBranch7):
2990
2588
    """See BzrBranchFormat6 for the capabilities of this branch.
2991
2589
 
2994
2592
    """
2995
2593
 
2996
2594
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2595
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2596
 
 
2597
    def set_stacked_on_url(self, url):
 
2598
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2599
 
2999
2600
 
3000
2601
######################################################################
3079
2680
 
3080
2681
    def __init__(self, branch):
3081
2682
        self.branch = branch
3082
 
        self.errors = []
3083
2683
 
3084
2684
    def report_results(self, verbose):
3085
2685
        """Report the check results via trace.note.
3087
2687
        :param verbose: Requests more detailed display of what was checked,
3088
2688
            if any.
3089
2689
        """
3090
 
        note('checked branch %s format %s', self.branch.user_url,
3091
 
            self.branch._format)
3092
 
        for error in self.errors:
3093
 
            note('found error:%s', error)
 
2690
        note('checked branch %s format %s',
 
2691
             self.branch.base,
 
2692
             self.branch._format)
3094
2693
 
3095
2694
 
3096
2695
class Converter5to6(object):
3134
2733
        branch._transport.put_bytes('format', format.get_format_string())
3135
2734
 
3136
2735
 
3137
 
class Converter7to8(object):
3138
 
    """Perform an in-place upgrade of format 6 to format 7"""
3139
 
 
3140
 
    def convert(self, branch):
3141
 
        format = BzrBranchFormat8()
3142
 
        branch._transport.put_bytes('references', '')
3143
 
        # update target format
3144
 
        branch._transport.put_bytes('format', format.get_format_string())
3145
 
 
3146
2736
 
3147
2737
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3148
2738
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3191
2781
    @staticmethod
3192
2782
    def _get_branch_formats_to_test():
3193
2783
        """Return a tuple with the Branch formats to use when testing."""
3194
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3195
 
 
3196
 
    def pull(self, overwrite=False, stop_revision=None,
3197
 
             possible_transports=None, local=False):
3198
 
        """Mirror source into target branch.
3199
 
 
3200
 
        The target branch is considered to be 'local', having low latency.
3201
 
 
3202
 
        :returns: PullResult instance
3203
 
        """
3204
 
        raise NotImplementedError(self.pull)
 
2784
        raise NotImplementedError(self._get_branch_formats_to_test)
3205
2785
 
3206
2786
    def update_revisions(self, stop_revision=None, overwrite=False,
3207
2787
                         graph=None):
3216
2796
        """
3217
2797
        raise NotImplementedError(self.update_revisions)
3218
2798
 
3219
 
    def push(self, overwrite=False, stop_revision=None,
3220
 
             _override_hook_source_branch=None):
3221
 
        """Mirror the source branch into the target branch.
3222
 
 
3223
 
        The source branch is considered to be 'local', having low latency.
3224
 
        """
3225
 
        raise NotImplementedError(self.push)
3226
 
 
3227
2799
 
3228
2800
class GenericInterBranch(InterBranch):
3229
2801
    """InterBranch implementation that uses public Branch functions.
3276
2848
        finally:
3277
2849
            self.source.unlock()
3278
2850
 
3279
 
    def pull(self, overwrite=False, stop_revision=None,
3280
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3281
 
             _override_hook_target=None, local=False):
3282
 
        """See Branch.pull.
3283
 
 
3284
 
        :param _hook_master: Private parameter - set the branch to
3285
 
            be supplied as the master to pull hooks.
3286
 
        :param run_hooks: Private parameter - if false, this branch
3287
 
            is being called because it's the master of the primary branch,
3288
 
            so it should not run its hooks.
3289
 
        :param _override_hook_target: Private parameter - set the branch to be
3290
 
            supplied as the target_branch to pull hooks.
3291
 
        :param local: Only update the local branch, and not the bound branch.
3292
 
        """
3293
 
        # This type of branch can't be bound.
3294
 
        if local:
3295
 
            raise errors.LocalRequiresBoundBranch()
3296
 
        result = PullResult()
3297
 
        result.source_branch = self.source
3298
 
        if _override_hook_target is None:
3299
 
            result.target_branch = self.target
3300
 
        else:
3301
 
            result.target_branch = _override_hook_target
3302
 
        self.source.lock_read()
3303
 
        try:
3304
 
            # We assume that during 'pull' the target repository is closer than
3305
 
            # the source one.
3306
 
            self.source.update_references(self.target)
3307
 
            graph = self.target.repository.get_graph(self.source.repository)
3308
 
            # TODO: Branch formats should have a flag that indicates 
3309
 
            # that revno's are expensive, and pull() should honor that flag.
3310
 
            # -- JRV20090506
3311
 
            result.old_revno, result.old_revid = \
3312
 
                self.target.last_revision_info()
3313
 
            self.target.update_revisions(self.source, stop_revision,
3314
 
                overwrite=overwrite, graph=graph)
3315
 
            # TODO: The old revid should be specified when merging tags, 
3316
 
            # so a tags implementation that versions tags can only 
3317
 
            # pull in the most recent changes. -- JRV20090506
3318
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3319
 
                overwrite)
3320
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3321
 
            if _hook_master:
3322
 
                result.master_branch = _hook_master
3323
 
                result.local_branch = result.target_branch
3324
 
            else:
3325
 
                result.master_branch = result.target_branch
3326
 
                result.local_branch = None
3327
 
            if run_hooks:
3328
 
                for hook in Branch.hooks['post_pull']:
3329
 
                    hook(result)
3330
 
        finally:
3331
 
            self.source.unlock()
3332
 
        return result
3333
 
 
3334
 
    def push(self, overwrite=False, stop_revision=None,
3335
 
             _override_hook_source_branch=None):
3336
 
        """See InterBranch.push.
3337
 
 
3338
 
        This is the basic concrete implementation of push()
3339
 
 
3340
 
        :param _override_hook_source_branch: If specified, run
3341
 
        the hooks passing this Branch as the source, rather than self.
3342
 
        This is for use of RemoteBranch, where push is delegated to the
3343
 
        underlying vfs-based Branch.
3344
 
        """
3345
 
        # TODO: Public option to disable running hooks - should be trivial but
3346
 
        # needs tests.
3347
 
        self.source.lock_read()
3348
 
        try:
3349
 
            return _run_with_write_locked_target(
3350
 
                self.target, self._push_with_bound_branches, overwrite,
3351
 
                stop_revision,
3352
 
                _override_hook_source_branch=_override_hook_source_branch)
3353
 
        finally:
3354
 
            self.source.unlock()
3355
 
 
3356
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3357
 
            _override_hook_source_branch=None):
3358
 
        """Push from source into target, and into target's master if any.
3359
 
        """
3360
 
        def _run_hooks():
3361
 
            if _override_hook_source_branch:
3362
 
                result.source_branch = _override_hook_source_branch
3363
 
            for hook in Branch.hooks['post_push']:
3364
 
                hook(result)
3365
 
 
3366
 
        bound_location = self.target.get_bound_location()
3367
 
        if bound_location and self.target.base != bound_location:
3368
 
            # there is a master branch.
3369
 
            #
3370
 
            # XXX: Why the second check?  Is it even supported for a branch to
3371
 
            # be bound to itself? -- mbp 20070507
3372
 
            master_branch = self.target.get_master_branch()
3373
 
            master_branch.lock_write()
3374
 
            try:
3375
 
                # push into the master from the source branch.
3376
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3377
 
                # and push into the target branch from the source. Note that we
3378
 
                # push from the source branch again, because its considered the
3379
 
                # highest bandwidth repository.
3380
 
                result = self.source._basic_push(self.target, overwrite,
3381
 
                    stop_revision)
3382
 
                result.master_branch = master_branch
3383
 
                result.local_branch = self.target
3384
 
                _run_hooks()
3385
 
                return result
3386
 
            finally:
3387
 
                master_branch.unlock()
3388
 
        else:
3389
 
            # no master branch
3390
 
            result = self.source._basic_push(self.target, overwrite,
3391
 
                stop_revision)
3392
 
            # TODO: Why set master_branch and local_branch if there's no
3393
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3394
 
            # 20070504
3395
 
            result.master_branch = self.target
3396
 
            result.local_branch = None
3397
 
            _run_hooks()
3398
 
            return result
3399
 
 
3400
2851
    @classmethod
3401
2852
    def is_compatible(self, source, target):
3402
2853
        # GenericBranch uses the public API, so always compatible
3403
2854
        return True
3404
2855
 
3405
2856
 
3406
 
class InterToBranch5(GenericInterBranch):
3407
 
 
3408
 
    @staticmethod
3409
 
    def _get_branch_formats_to_test():
3410
 
        return BranchFormat._default_format, BzrBranchFormat5()
3411
 
 
3412
 
    def pull(self, overwrite=False, stop_revision=None,
3413
 
             possible_transports=None, run_hooks=True,
3414
 
             _override_hook_target=None, local=False):
3415
 
        """Pull from source into self, updating my master if any.
3416
 
 
3417
 
        :param run_hooks: Private parameter - if false, this branch
3418
 
            is being called because it's the master of the primary branch,
3419
 
            so it should not run its hooks.
3420
 
        """
3421
 
        bound_location = self.target.get_bound_location()
3422
 
        if local and not bound_location:
3423
 
            raise errors.LocalRequiresBoundBranch()
3424
 
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
3426
 
            # not pulling from master, so we need to update master.
3427
 
            master_branch = self.target.get_master_branch(possible_transports)
3428
 
            master_branch.lock_write()
3429
 
        try:
3430
 
            if master_branch:
3431
 
                # pull from source into master.
3432
 
                master_branch.pull(self.source, overwrite, stop_revision,
3433
 
                    run_hooks=False)
3434
 
            return super(InterToBranch5, self).pull(overwrite,
3435
 
                stop_revision, _hook_master=master_branch,
3436
 
                run_hooks=run_hooks,
3437
 
                _override_hook_target=_override_hook_target)
3438
 
        finally:
3439
 
            if master_branch:
3440
 
                master_branch.unlock()
3441
 
 
3442
 
 
3443
2857
InterBranch.register_optimiser(GenericInterBranch)
3444
 
InterBranch.register_optimiser(InterToBranch5)