/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: Jelmer Vernooij
  • Date: 2009-02-25 02:05:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4053.
  • Revision ID: jelmer@samba.org-20090225020535-qw7udfz9ploqzosn
Add tests for InterBranch.

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 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
42
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
40
from bzrlib.tag import (
44
41
    BasicTags,
46
43
    )
47
44
""")
48
45
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
51
48
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
 
from bzrlib import registry
54
49
from bzrlib.symbol_versioning import (
55
50
    deprecated_in,
56
51
    deprecated_method,
63
58
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
59
 
65
60
 
66
 
class Branch(bzrdir.ControlComponent):
 
61
# TODO: Maybe include checks for common corruption of newlines, etc?
 
62
 
 
63
# TODO: Some operations like log might retrieve the same revisions
 
64
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
65
# cache in memory to make this faster.  In general anything can be
 
66
# cached in memory between lock and unlock operations. .. nb thats
 
67
# what the transaction identity map provides
 
68
 
 
69
 
 
70
######################################################################
 
71
# branch objects
 
72
 
 
73
class Branch(object):
67
74
    """Branch holding a history of revisions.
68
75
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
76
    base
 
77
        Base directory/url of the branch.
72
78
 
73
79
    hooks: An instance of BranchHooks.
74
80
    """
76
82
    # - RBC 20060112
77
83
    base = None
78
84
 
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
 
85
    # override this to set the strategy for storing tags
 
86
    def _make_tags(self):
 
87
        return DisabledTags(self)
86
88
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
90
        self.tags = self._make_tags()
89
91
        self._revision_history_cache = None
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
94
        self._last_revision_info_cache = None
94
95
        self._merge_sorted_revisions_cache = None
95
96
        self._open_hook()
100
101
    def _open_hook(self):
101
102
        """Called by init to allow simpler extension of the base class."""
102
103
 
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
104
    def break_lock(self):
111
105
        """Break a lock if one is present from another instance.
112
106
 
121
115
        if master is not None:
122
116
            master.break_lock()
123
117
 
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
118
    @staticmethod
159
119
    def open(base, _unsupported=False, possible_transports=None):
160
120
        """Open the branch rooted at base.
164
124
        """
165
125
        control = bzrdir.BzrDir.open(base, _unsupported,
166
126
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
127
        return control.open_branch(_unsupported)
168
128
 
169
129
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
130
    def open_from_transport(transport, _unsupported=False):
171
131
        """Open the branch rooted at transport"""
172
132
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
133
        return control.open_branch(_unsupported)
174
134
 
175
135
    @staticmethod
176
136
    def open_containing(url, possible_transports=None):
188
148
                                                         possible_transports)
189
149
        return control.open_branch(), relpath
190
150
 
191
 
    def _push_should_merge_tags(self):
192
 
        """Should _basic_push merge this branch's tags into the target?
193
 
 
194
 
        The default implementation returns False if this branch has no tags,
195
 
        and True the rest of the time.  Subclasses may override this.
196
 
        """
197
 
        return self.supports_tags() and self.tags.get_tag_dict()
198
 
 
199
151
    def get_config(self):
200
152
        return BranchConfig(self)
201
153
 
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
 
    def _get_tags_bytes(self):
222
 
        """Get the bytes of a serialised tags dict.
223
 
 
224
 
        Note that not all branches support tags, nor do all use the same tags
225
 
        logic: this method is specific to BasicTags. Other tag implementations
226
 
        may use the same method name and behave differently, safely, because
227
 
        of the double-dispatch via
228
 
        format.make_tags->tags_instance->get_tags_dict.
229
 
 
230
 
        :return: The bytes of the tags file.
231
 
        :seealso: Branch._set_tags_bytes.
232
 
        """
233
 
        return self._transport.get_bytes('tags')
234
 
 
235
154
    def _get_nick(self, local=False, possible_transports=None):
236
155
        config = self.get_config()
237
156
        # explicit overrides master, but don't look for master if local is True
283
202
        new_history.reverse()
284
203
        return new_history
285
204
 
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
 
        """
 
205
    def lock_write(self):
293
206
        raise NotImplementedError(self.lock_write)
294
207
 
295
208
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
209
        raise NotImplementedError(self.lock_read)
301
210
 
302
211
    def unlock(self):
427
336
            * 'include' - the stop revision is the last item in the result
428
337
            * 'with-merges' - include the stop revision and all of its
429
338
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
339
        :param direction: either 'reverse' or 'forward':
433
340
            * reverse means return the start_revision_id first, i.e.
434
341
              start at the most recent revision and go backwards in history
456
363
        # start_revision_id.
457
364
        if self._merge_sorted_revisions_cache is None:
458
365
            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)
 
366
            graph = self.repository.get_graph()
 
367
            parent_map = dict(((key, value) for key, value in
 
368
                     graph.iter_ancestry([last_revision]) if value is not None))
 
369
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
370
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
371
                generate_revno=True)
 
372
            # Drop the sequence # before caching
 
373
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
374
 
463
375
        filtered = self._filter_merge_sorted_revisions(
464
376
            self._merge_sorted_revisions_cache, start_revision_id,
465
377
            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
378
        if direction == 'reverse':
470
379
            return filtered
471
380
        if direction == 'forward':
478
387
        """Iterate over an inclusive range of sorted revisions."""
479
388
        rev_iter = iter(merge_sorted_revisions)
480
389
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
390
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
391
                if rev_id != start_revision_id:
484
392
                    continue
485
393
                else:
486
394
                    # The decision to include the start or not
487
395
                    # 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)
 
396
                    rev_iter = chain(
 
397
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
398
                        rev_iter)
490
399
                    break
491
400
        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)
 
401
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
402
                yield rev_id, depth, revno, end_of_merge
497
403
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
404
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
405
                if rev_id == stop_revision_id:
501
406
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
407
                yield rev_id, depth, revno, end_of_merge
504
408
        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)
 
409
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
410
                yield rev_id, depth, revno, end_of_merge
509
411
                if rev_id == stop_revision_id:
510
412
                    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
413
        elif stop_rule == 'with-merges':
524
414
            stop_rev = self.repository.get_revision(stop_revision_id)
525
415
            if stop_rev.parent_ids:
526
416
                left_parent = stop_rev.parent_ids[0]
527
417
            else:
528
418
                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]
 
419
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
420
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
421
                    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)
 
422
                yield rev_id, depth, revno, end_of_merge
548
423
        else:
549
424
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
425
 
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
426
    def leave_lock_in_place(self):
597
427
        """Tell this branch object not to release the physical lock when this
598
428
        object is unlocked.
615
445
        :param other: The branch to bind to
616
446
        :type other: Branch
617
447
        """
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)
 
448
        raise errors.UpgradeRequired(self.base)
637
449
 
638
450
    @needs_write_lock
639
451
    def fetch(self, from_branch, last_revision=None, pb=None):
643
455
        :param last_revision: What revision to stop at (None for at the end
644
456
                              of the branch.
645
457
        :param pb: An optional progress bar to use.
646
 
        :return: None
 
458
 
 
459
        Returns the copied revision count and the failed revisions in a tuple:
 
460
        (copied, failures).
647
461
        """
648
462
        if self.base == from_branch.base:
649
463
            return (0, [])
650
 
        if pb is not None:
651
 
            symbol_versioning.warn(
652
 
                symbol_versioning.deprecated_in((1, 14, 0))
653
 
                % "pb parameter to fetch()")
 
464
        if pb is None:
 
465
            nested_pb = ui.ui_factory.nested_progress_bar()
 
466
            pb = nested_pb
 
467
        else:
 
468
            nested_pb = None
 
469
 
654
470
        from_branch.lock_read()
655
471
        try:
656
472
            if last_revision is None:
 
473
                pb.update('get source history')
657
474
                last_revision = from_branch.last_revision()
658
475
                last_revision = _mod_revision.ensure_null(last_revision)
659
476
            return self.repository.fetch(from_branch.repository,
660
477
                                         revision_id=last_revision,
661
 
                                         pb=pb)
 
478
                                         pb=nested_pb)
662
479
        finally:
 
480
            if nested_pb is not None:
 
481
                nested_pb.finished()
663
482
            from_branch.unlock()
664
483
 
665
484
    def get_bound_location(self):
673
492
    def get_old_bound_location(self):
674
493
        """Return the URL of the branch we used to be bound to
675
494
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
495
        raise errors.UpgradeRequired(self.base)
677
496
 
678
497
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
498
                           timezone=None, committer=None, revprops=None,
729
548
    def set_revision_history(self, rev_history):
730
549
        raise NotImplementedError(self.set_revision_history)
731
550
 
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
551
    def set_stacked_on_url(self, url):
752
552
        """Set the URL this branch is stacked against.
753
553
 
756
556
        :raises UnstackableRepositoryFormat: If the repository does not support
757
557
            stacking.
758
558
        """
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()
832
 
 
833
 
    def _set_tags_bytes(self, bytes):
834
 
        """Mirror method for _get_tags_bytes.
835
 
 
836
 
        :seealso: Branch._get_tags_bytes.
837
 
        """
838
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
839
 
            'tags', bytes)
 
559
        raise NotImplementedError(self.set_stacked_on_url)
840
560
 
841
561
    def _cache_revision_history(self, rev_history):
842
562
        """Set the cached revision history to rev_history.
870
590
        self._revision_id_to_revno_cache = None
871
591
        self._last_revision_info_cache = None
872
592
        self._merge_sorted_revisions_cache = None
873
 
        self._partial_revision_history_cache = []
874
 
        self._partial_revision_id_to_revno_cache = {}
875
593
 
876
594
    def _gen_revision_history(self):
877
595
        """Return sequence of revision hashes on to this branch.
914
632
 
915
633
    def unbind(self):
916
634
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
635
        raise errors.UpgradeRequired(self.base)
 
636
 
 
637
    def set_append_revisions_only(self, enabled):
 
638
        """Older format branches are never restricted to append-only"""
 
639
        raise errors.UpgradeRequired(self.base)
918
640
 
919
641
    def last_revision(self):
920
642
        """Return last revision id, or NULL_REVISION."""
977
699
        return InterBranch.get(other, self).update_revisions(stop_revision,
978
700
            overwrite, graph)
979
701
 
980
 
    def import_last_revision_info(self, source_repo, revno, revid):
981
 
        """Set the last revision info, importing from another repo if necessary.
982
 
 
983
 
        This is used by the bound branch code to upload a revision to
984
 
        the master branch first before updating the tip of the local branch.
985
 
 
986
 
        :param source_repo: Source repository to optionally fetch from
987
 
        :param revno: Revision number of the new tip
988
 
        :param revid: Revision id of the new tip
989
 
        """
990
 
        if not self.repository.has_same_location(source_repo):
991
 
            self.repository.fetch(source_repo, revision_id=revid)
992
 
        self.set_last_revision_info(revno, revid)
993
 
 
994
702
    def revision_id_to_revno(self, revision_id):
995
703
        """Given a revision id, return its revno"""
996
704
        if _mod_revision.is_null(revision_id):
1001
709
        except ValueError:
1002
710
            raise errors.NoSuchRevision(self, revision_id)
1003
711
 
1004
 
    @needs_read_lock
1005
712
    def get_rev_id(self, revno, history=None):
1006
713
        """Find the revision id of the specified revno."""
1007
714
        if revno == 0:
1008
715
            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:
 
716
        if history is None:
 
717
            history = self.revision_history()
 
718
        if revno <= 0 or revno > len(history):
1013
719
            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]
 
720
        return history[revno - 1]
1018
721
 
1019
 
    @needs_write_lock
1020
722
    def pull(self, source, overwrite=False, stop_revision=None,
1021
 
             possible_transports=None, *args, **kwargs):
 
723
             possible_transports=None, _override_hook_target=None):
1022
724
        """Mirror source into this branch.
1023
725
 
1024
726
        This branch is considered to be 'local', having low latency.
1025
727
 
1026
728
        :returns: PullResult instance
1027
729
        """
1028
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
 
            stop_revision=stop_revision,
1030
 
            possible_transports=possible_transports, *args, **kwargs)
 
730
        raise NotImplementedError(self.pull)
1031
731
 
1032
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1033
 
        **kwargs):
 
732
    def push(self, target, overwrite=False, stop_revision=None):
1034
733
        """Mirror this branch into target.
1035
734
 
1036
735
        This branch is considered to be 'local', having low latency.
1037
736
        """
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)
 
737
        raise NotImplementedError(self.push)
1061
738
 
1062
739
    def basis_tree(self):
1063
740
        """Return `Tree` object for last revision."""
1070
747
        pattern is that the user can override it by specifying a
1071
748
        location.
1072
749
        """
1073
 
        parent = self._get_parent_location()
1074
 
        if parent is None:
1075
 
            return parent
1076
 
        # This is an old-format absolute path to a local branch
1077
 
        # turn it into a url
1078
 
        if parent.startswith('/'):
1079
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1080
 
        try:
1081
 
            return urlutils.join(self.base[:-1], parent)
1082
 
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
1084
 
 
1085
 
    def _get_parent_location(self):
1086
 
        raise NotImplementedError(self._get_parent_location)
 
750
        raise NotImplementedError(self.get_parent)
1087
751
 
1088
752
    def _set_config_location(self, name, url, config=None,
1089
753
                             make_relative=False):
1103
767
            location = None
1104
768
        return location
1105
769
 
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
770
    def get_submit_branch(self):
1111
771
        """Return the submit location of the branch.
1112
772
 
1129
789
    def get_public_branch(self):
1130
790
        """Return the public location of the branch.
1131
791
 
1132
 
        This is used by merge directives.
 
792
        This is is used by merge directives.
1133
793
        """
1134
794
        return self._get_config_location('public_branch')
1135
795
 
1171
831
        params = ChangeBranchTipParams(
1172
832
            self, old_revno, new_revno, old_revid, new_revid)
1173
833
        for hook in hooks:
1174
 
            hook(params)
 
834
            try:
 
835
                hook(params)
 
836
            except errors.TipChangeRejected:
 
837
                raise
 
838
            except Exception:
 
839
                exc_info = sys.exc_info()
 
840
                hook_name = Branch.hooks.get_hook_name(hook)
 
841
                raise errors.HookFailed(
 
842
                    'pre_change_branch_tip', hook_name, exc_info)
 
843
 
 
844
    def set_parent(self, url):
 
845
        raise NotImplementedError(self.set_parent)
1175
846
 
1176
847
    @needs_write_lock
1177
848
    def update(self):
1198
869
            raise errors.InvalidRevisionNumber(revno)
1199
870
 
1200
871
    @needs_read_lock
1201
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
872
    def clone(self, to_bzrdir, revision_id=None):
1202
873
        """Clone this branch into to_bzrdir preserving all semantic values.
1203
874
 
1204
 
        Most API users will want 'create_clone_on_transport', which creates a
1205
 
        new bzrdir and branch on the fly.
1206
 
 
1207
875
        revision_id: if not None, the revision history in the new branch will
1208
876
                     be truncated to end with revision_id.
1209
877
        """
1210
878
        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
 
879
        self.copy_content_into(result, revision_id=revision_id)
 
880
        return  result
1219
881
 
1220
882
    @needs_read_lock
1221
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
883
    def sprout(self, to_bzrdir, revision_id=None):
1222
884
        """Create a new line of development from the branch, into to_bzrdir.
1223
885
 
1224
886
        to_bzrdir controls the branch format.
1226
888
        revision_id: if not None, the revision history in the new branch will
1227
889
                     be truncated to end with revision_id.
1228
890
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
891
        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()
 
892
        self.copy_content_into(result, revision_id=revision_id)
 
893
        result.set_parent(self.bzrdir.root_transport.base)
1241
894
        return result
1242
895
 
1243
896
    def _synchronize_history(self, destination, revision_id):
1255
908
        source_revno, source_revision_id = self.last_revision_info()
1256
909
        if revision_id is None:
1257
910
            revno, revision_id = source_revno, source_revision_id
 
911
        elif source_revision_id == revision_id:
 
912
            # we know the revno without needing to walk all of history
 
913
            revno = source_revno
1258
914
        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
 
915
            # To figure out the revno for a random revision, we need to build
 
916
            # the revision history, and count its length.
 
917
            # We don't care about the order, just how long it is.
 
918
            # Alternatively, we could start at the current location, and count
 
919
            # backwards. But there is no guarantee that we will find it since
 
920
            # it may be a merged revision.
 
921
            revno = len(list(self.repository.iter_reverse_revision_history(
 
922
                                                                revision_id)))
1266
923
        destination.set_last_revision_info(revno, revision_id)
1267
924
 
1268
925
    @needs_read_lock
1272
929
        revision_id: if not None, the revision history in the new branch will
1273
930
                     be truncated to end with revision_id.
1274
931
        """
1275
 
        self.update_references(destination)
1276
932
        self._synchronize_history(destination, revision_id)
1277
933
        try:
1278
934
            parent = self.get_parent()
1281
937
        else:
1282
938
            if parent:
1283
939
                destination.set_parent(parent)
1284
 
        if self._push_should_merge_tags():
1285
 
            self.tags.merge_to(destination.tags)
1286
 
 
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)
 
940
        self.tags.merge_to(destination.tags)
1303
941
 
1304
942
    @needs_read_lock
1305
 
    def check(self, refs):
 
943
    def check(self):
1306
944
        """Check consistency of the branch.
1307
945
 
1308
946
        In particular this checks that revisions given in the revision-history
1311
949
 
1312
950
        Callers will typically also want to check the repository.
1313
951
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
952
        :return: A BranchCheckResult.
1317
953
        """
1318
 
        result = BranchCheckResult(self)
 
954
        mainline_parent_id = None
1319
955
        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
 
956
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
957
                                last_revision_id))
 
958
        real_rev_history.reverse()
 
959
        if len(real_rev_history) != last_revno:
 
960
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
961
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
962
        # TODO: We should probably also check that real_rev_history actually
 
963
        #       matches self.revision_history()
 
964
        for revision_id in real_rev_history:
 
965
            try:
 
966
                revision = self.repository.get_revision(revision_id)
 
967
            except errors.NoSuchRevision, e:
 
968
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
969
                            % revision_id)
 
970
            # In general the first entry on the revision history has no parents.
 
971
            # But it's not illegal for it to have parents listed; this can happen
 
972
            # in imports from Arch when the parents weren't reachable.
 
973
            if mainline_parent_id is not None:
 
974
                if mainline_parent_id not in revision.parent_ids:
 
975
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
976
                                        "parents of {%s}"
 
977
                                        % (mainline_parent_id, revision_id))
 
978
            mainline_parent_id = revision_id
 
979
        return BranchCheckResult(self)
1331
980
 
1332
981
    def _get_checkout_format(self):
1333
982
        """Return the most suitable metadir for a checkout of this branch.
1342
991
            format.set_branch_format(self._format)
1343
992
        return format
1344
993
 
1345
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1346
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
 
        """Create a clone of this branch and its bzrdir.
1348
 
 
1349
 
        :param to_transport: The transport to clone onto.
1350
 
        :param revision_id: The revision id to use as tip in the new branch.
1351
 
            If None the tip is obtained from this branch.
1352
 
        :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
 
        """
1357
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
 
        # 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
 
        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)
1366
 
        return dir_to.open_branch()
1367
 
 
1368
994
    def create_checkout(self, to_location, revision_id=None,
1369
995
                        lightweight=False, accelerator_tree=None,
1370
996
                        hardlink=False):
1387
1013
        if lightweight:
1388
1014
            format = self._get_checkout_format()
1389
1015
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1016
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1392
1017
        else:
1393
1018
            format = self._get_checkout_format()
1394
1019
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1423
1048
        reconciler.reconcile()
1424
1049
        return reconciler
1425
1050
 
1426
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1051
    def reference_parent(self, file_id, path):
1427
1052
        """Return the parent branch for a tree-reference file_id
1428
1053
        :param file_id: The file_id of the tree reference
1429
1054
        :param path: The path of the file_id in the tree
1430
1055
        :return: A branch associated with the file_id
1431
1056
        """
1432
1057
        # FIXME should provide multiple branches, based on config
1433
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1434
 
                           possible_transports=possible_transports)
 
1058
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1435
1059
 
1436
1060
    def supports_tags(self):
1437
1061
        return self._format.supports_tags()
1438
1062
 
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
1063
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1064
                                         other_branch):
1453
1065
        """Ensure that revision_b is a descendant of revision_a.
1508
1120
    _formats = {}
1509
1121
    """The known formats."""
1510
1122
 
1511
 
    can_set_append_revisions_only = True
1512
 
 
1513
1123
    def __eq__(self, other):
1514
1124
        return self.__class__ is other.__class__
1515
1125
 
1517
1127
        return not (self == other)
1518
1128
 
1519
1129
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
 
1130
    def find_format(klass, a_bzrdir):
1521
1131
        """Return the format for the branch object in a_bzrdir."""
1522
1132
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
 
1133
            transport = a_bzrdir.get_branch_transport(None)
 
1134
            format_string = transport.get("format").read()
1525
1135
            return klass._formats[format_string]
1526
1136
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1137
            raise errors.NotBranchError(path=transport.base)
1528
1138
        except KeyError:
1529
1139
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
1140
 
1533
1143
        """Return the current default format."""
1534
1144
        return klass._default_format
1535
1145
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1146
    def get_reference(self, a_bzrdir):
1537
1147
        """Get the target reference of the branch in a_bzrdir.
1538
1148
 
1539
1149
        format probing must have been completed before calling
1541
1151
        in a_bzrdir is correct.
1542
1152
 
1543
1153
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1154
        :return: None if the branch is not a reference branch.
1546
1155
        """
1547
1156
        return None
1548
1157
 
1549
1158
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1159
    def set_reference(self, a_bzrdir, to_branch):
1551
1160
        """Set the target reference of the branch in a_bzrdir.
1552
1161
 
1553
1162
        format probing must have been completed before calling
1555
1164
        in a_bzrdir is correct.
1556
1165
 
1557
1166
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1167
        :param to_branch: branch that the checkout is to reference
1560
1168
        """
1561
1169
        raise NotImplementedError(self.set_reference)
1568
1176
        """Return the short format description for this format."""
1569
1177
        raise NotImplementedError(self.get_format_description)
1570
1178
 
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):
 
1179
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1180
                           set_format=True):
1581
1181
        """Initialize a branch in a bzrdir, with specified files
1582
1182
 
1583
1183
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
1184
        :param utf8_files: The files to create as a list of
1585
1185
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
1186
        :param set_format: If True, set the format with
1588
1187
            self.get_format_string.  (BzrBranch4 has its format set
1589
1188
            elsewhere)
1590
1189
        :return: a branch in this format
1591
1190
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1191
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1192
        branch_transport = a_bzrdir.get_branch_transport(self)
1594
1193
        lock_map = {
1595
1194
            'metadir': ('lock', lockdir.LockDir),
1596
1195
            'branch4': ('branch-lock', lockable_files.TransportLock),
1599
1198
        control_files = lockable_files.LockableFiles(branch_transport,
1600
1199
            lock_name, lock_class)
1601
1200
        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
 
1201
        control_files.lock_write()
1610
1202
        if set_format:
1611
1203
            utf8_files += [('format', self.get_format_string())]
1612
1204
        try:
1615
1207
                    filename, content,
1616
1208
                    mode=a_bzrdir._get_file_mode())
1617
1209
        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
 
1210
            control_files.unlock()
 
1211
        return self.open(a_bzrdir, _found=True)
1623
1212
 
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
 
        """
 
1213
    def initialize(self, a_bzrdir):
 
1214
        """Create a branch of this format in a_bzrdir."""
1629
1215
        raise NotImplementedError(self.initialize)
1630
1216
 
1631
1217
    def is_supported(self):
1637
1223
        """
1638
1224
        return True
1639
1225
 
1640
 
    def make_tags(self, branch):
1641
 
        """Create a tags object for branch.
1642
 
 
1643
 
        This method is on BranchFormat, because BranchFormats are reflected
1644
 
        over the wire via network_name(), whereas full Branch instances require
1645
 
        multiple VFS method calls to operate at all.
1646
 
 
1647
 
        The default implementation returns a disabled-tags instance.
1648
 
 
1649
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1650
 
        on a RemoteBranch.
1651
 
        """
1652
 
        return DisabledTags(branch)
1653
 
 
1654
 
    def network_name(self):
1655
 
        """A simple byte string uniquely identifying this format for RPC calls.
1656
 
 
1657
 
        MetaDir branch formats use their disk format string to identify the
1658
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1659
 
        foreign formats like svn/git and hg should use some marker which is
1660
 
        unique and immutable.
1661
 
        """
1662
 
        raise NotImplementedError(self.network_name)
1663
 
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1226
    def open(self, a_bzrdir, _found=False):
1665
1227
        """Return the branch object for a_bzrdir
1666
1228
 
1667
 
        :param a_bzrdir: A BzrDir that contains a branch.
1668
 
        :param name: Name of colocated branch to open
1669
 
        :param _found: a private parameter, do not use it. It is used to
1670
 
            indicate if format probing has already be done.
1671
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1672
 
            (if there are any).  Default is to open fallbacks.
 
1229
        _found is a private parameter, do not use it. It is used to indicate
 
1230
               if format probing has already be done.
1673
1231
        """
1674
1232
        raise NotImplementedError(self.open)
1675
1233
 
1676
1234
    @classmethod
1677
1235
    def register_format(klass, format):
1678
 
        """Register a metadir format."""
1679
1236
        klass._formats[format.get_format_string()] = format
1680
 
        # Metadir formats have a network name of their format string, and get
1681
 
        # registered as class factories.
1682
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1683
1237
 
1684
1238
    @classmethod
1685
1239
    def set_default_format(klass, format):
1686
1240
        klass._default_format = format
1687
1241
 
1688
 
    def supports_set_append_revisions_only(self):
1689
 
        """True if this format supports set_append_revisions_only."""
1690
 
        return False
1691
 
 
1692
1242
    def supports_stacking(self):
1693
1243
        """True if this format records a stacked-on branch."""
1694
1244
        return False
1698
1248
        del klass._formats[format.get_format_string()]
1699
1249
 
1700
1250
    def __str__(self):
1701
 
        return self.get_format_description().rstrip()
 
1251
        return self.get_format_string().rstrip()
1702
1252
 
1703
1253
    def supports_tags(self):
1704
1254
        """True if this format supports tags stored in the branch"""
1719
1269
        notified.
1720
1270
        """
1721
1271
        Hooks.__init__(self)
1722
 
        self.create_hook(HookPoint('set_rh',
1723
 
            "Invoked whenever the revision history has been set via "
1724
 
            "set_revision_history. The api signature is (branch, "
1725
 
            "revision_history), and the branch will be write-locked. "
1726
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1727
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
 
        self.create_hook(HookPoint('open',
1729
 
            "Called with the Branch object that has been opened after a "
1730
 
            "branch is opened.", (1, 8), None))
1731
 
        self.create_hook(HookPoint('post_push',
1732
 
            "Called after a push operation completes. post_push is called "
1733
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
 
            "bzr client.", (0, 15), None))
1735
 
        self.create_hook(HookPoint('post_pull',
1736
 
            "Called after a pull operation completes. post_pull is called "
1737
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1738
 
            "bzr client.", (0, 15), None))
1739
 
        self.create_hook(HookPoint('pre_commit',
1740
 
            "Called after a commit is calculated but before it is is "
1741
 
            "completed. pre_commit is called with (local, master, old_revno, "
1742
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1744
 
            "tree_delta is a TreeDelta object describing changes from the "
1745
 
            "basis revision. hooks MUST NOT modify this delta. "
1746
 
            " future_tree is an in-memory tree obtained from "
1747
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
 
            "tree.", (0,91), None))
1749
 
        self.create_hook(HookPoint('post_commit',
1750
 
            "Called in the bzr client after a commit has completed. "
1751
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1752
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
 
            "commit to a branch.", (0, 15), None))
1754
 
        self.create_hook(HookPoint('post_uncommit',
1755
 
            "Called in the bzr client after an uncommit completes. "
1756
 
            "post_uncommit is called with (local, master, old_revno, "
1757
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1758
 
            "or None, master is the target branch, and an empty branch "
1759
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1761
 
            "Called in bzr client and server before a change to the tip of a "
1762
 
            "branch is made. pre_change_branch_tip is called with a "
1763
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1765
 
        self.create_hook(HookPoint('post_change_branch_tip',
1766
 
            "Called in bzr client and server after a change to the tip of a "
1767
 
            "branch is made. post_change_branch_tip is called with a "
1768
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1770
 
        self.create_hook(HookPoint('transform_fallback_location',
1771
 
            "Called when a stacked branch is activating its fallback "
1772
 
            "locations. transform_fallback_location is called with (branch, "
1773
 
            "url), and should return a new url. Returning the same url "
1774
 
            "allows it to be used as-is, returning a different one can be "
1775
 
            "used to cause the branch to stack on a closer copy of that "
1776
 
            "fallback_location. Note that the branch cannot have history "
1777
 
            "accessing methods called on it during this hook because the "
1778
 
            "fallback locations have not been activated. When there are "
1779
 
            "multiple hooks installed for transform_fallback_location, "
1780
 
            "all are called with the url returned from the previous hook."
1781
 
            "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
 
 
 
1272
        # Introduced in 0.15:
 
1273
        # invoked whenever the revision history has been set
 
1274
        # with set_revision_history. The api signature is
 
1275
        # (branch, revision_history), and the branch will
 
1276
        # be write-locked.
 
1277
        self['set_rh'] = []
 
1278
        # Invoked after a branch is opened. The api signature is (branch).
 
1279
        self['open'] = []
 
1280
        # invoked after a push operation completes.
 
1281
        # the api signature is
 
1282
        # (push_result)
 
1283
        # containing the members
 
1284
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1285
        # where local is the local target branch or None, master is the target
 
1286
        # master branch, and the rest should be self explanatory. The source
 
1287
        # is read locked and the target branches write locked. Source will
 
1288
        # be the local low-latency branch.
 
1289
        self['post_push'] = []
 
1290
        # invoked after a pull operation completes.
 
1291
        # the api signature is
 
1292
        # (pull_result)
 
1293
        # containing the members
 
1294
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1295
        # where local is the local branch or None, master is the target
 
1296
        # master branch, and the rest should be self explanatory. The source
 
1297
        # is read locked and the target branches write locked. The local
 
1298
        # branch is the low-latency branch.
 
1299
        self['post_pull'] = []
 
1300
        # invoked before a commit operation takes place.
 
1301
        # the api signature is
 
1302
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1303
        #  tree_delta, future_tree).
 
1304
        # old_revid is NULL_REVISION for the first commit to a branch
 
1305
        # tree_delta is a TreeDelta object describing changes from the basis
 
1306
        # revision, hooks MUST NOT modify this delta
 
1307
        # future_tree is an in-memory tree obtained from
 
1308
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1309
        self['pre_commit'] = []
 
1310
        # invoked after a commit operation completes.
 
1311
        # the api signature is
 
1312
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1313
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1314
        self['post_commit'] = []
 
1315
        # invoked after a uncommit operation completes.
 
1316
        # the api signature is
 
1317
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1318
        # local is the local branch or None, master is the target branch,
 
1319
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1320
        self['post_uncommit'] = []
 
1321
        # Introduced in 1.6
 
1322
        # Invoked before the tip of a branch changes.
 
1323
        # the api signature is
 
1324
        # (params) where params is a ChangeBranchTipParams with the members
 
1325
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1326
        self['pre_change_branch_tip'] = []
 
1327
        # Introduced in 1.4
 
1328
        # Invoked after the tip of a branch changes.
 
1329
        # the api signature is
 
1330
        # (params) where params is a ChangeBranchTipParams with the members
 
1331
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1332
        self['post_change_branch_tip'] = []
 
1333
        # Introduced in 1.9
 
1334
        # Invoked when a stacked branch activates its fallback locations and
 
1335
        # allows the transformation of the url of said location.
 
1336
        # the api signature is
 
1337
        # (branch, url) where branch is the branch having its fallback
 
1338
        # location activated and url is the url for the fallback location.
 
1339
        # The hook should return a url.
 
1340
        self['transform_fallback_location'] = []
1799
1341
 
1800
1342
 
1801
1343
# install the default hooks into the Branch class.
1840
1382
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1383
 
1842
1384
 
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
1385
class BzrBranchFormat4(BranchFormat):
1922
1386
    """Bzr branch format 4.
1923
1387
 
1930
1394
        """See BranchFormat.get_format_description()."""
1931
1395
        return "Branch format 4"
1932
1396
 
1933
 
    def initialize(self, a_bzrdir, name=None):
 
1397
    def initialize(self, a_bzrdir):
1934
1398
        """Create a branch of this format in a_bzrdir."""
1935
1399
        utf8_files = [('revision-history', ''),
1936
1400
                      ('branch-name', ''),
1937
1401
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1402
        return self._initialize_helper(a_bzrdir, utf8_files,
1939
1403
                                       lock_type='branch4', set_format=False)
1940
1404
 
1941
1405
    def __init__(self):
1942
1406
        super(BzrBranchFormat4, self).__init__()
1943
1407
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1944
1408
 
1945
 
    def network_name(self):
1946
 
        """The network name for this format is the control dirs disk label."""
1947
 
        return self._matchingbzrdir.get_format_string()
 
1409
    def open(self, a_bzrdir, _found=False):
 
1410
        """Return the branch object for a_bzrdir
1948
1411
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
 
        """See BranchFormat.open()."""
 
1412
        _found is a private parameter, do not use it. It is used to indicate
 
1413
               if format probing has already be done.
 
1414
        """
1951
1415
        if not _found:
1952
1416
            # we are being called directly and must probe.
1953
1417
            raise NotImplementedError
1954
1418
        return BzrBranch(_format=self,
1955
1419
                         _control_files=a_bzrdir._control_files,
1956
1420
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
1421
                         _repository=a_bzrdir.open_repository())
1959
1422
 
1960
1423
    def __str__(self):
1968
1431
        """What class to instantiate on open calls."""
1969
1432
        raise NotImplementedError(self._branch_class)
1970
1433
 
1971
 
    def network_name(self):
1972
 
        """A simple byte string uniquely identifying this format for RPC calls.
 
1434
    def open(self, a_bzrdir, _found=False):
 
1435
        """Return the branch object for a_bzrdir.
1973
1436
 
1974
 
        Metadir branch formats use their format string.
 
1437
        _found is a private parameter, do not use it. It is used to indicate
 
1438
               if format probing has already be done.
1975
1439
        """
1976
 
        return self.get_format_string()
1977
 
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1979
 
        """See BranchFormat.open()."""
1980
1440
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1441
            format = BranchFormat.find_format(a_bzrdir)
1982
1442
            if format.__class__ != self.__class__:
1983
1443
                raise AssertionError("wrong format %r found for %r" %
1984
1444
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1445
        try:
 
1446
            transport = a_bzrdir.get_branch_transport(None)
1987
1447
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1448
                                                         lockdir.LockDir)
1989
1449
            return self._branch_class()(_format=self,
1990
1450
                              _control_files=control_files,
1991
 
                              name=name,
1992
1451
                              a_bzrdir=a_bzrdir,
1993
 
                              _repository=a_bzrdir.find_repository(),
1994
 
                              ignore_fallbacks=ignore_fallbacks)
 
1452
                              _repository=a_bzrdir.find_repository())
1995
1453
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1454
            raise errors.NotBranchError(path=transport.base)
1997
1455
 
1998
1456
    def __init__(self):
1999
1457
        super(BranchFormatMetadir, self).__init__()
2028
1486
        """See BranchFormat.get_format_description()."""
2029
1487
        return "Branch format 5"
2030
1488
 
2031
 
    def initialize(self, a_bzrdir, name=None):
 
1489
    def initialize(self, a_bzrdir):
2032
1490
        """Create a branch of this format in a_bzrdir."""
2033
1491
        utf8_files = [('revision-history', ''),
2034
1492
                      ('branch-name', ''),
2035
1493
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1494
        return self._initialize_helper(a_bzrdir, utf8_files)
2037
1495
 
2038
1496
    def supports_tags(self):
2039
1497
        return False
2061
1519
        """See BranchFormat.get_format_description()."""
2062
1520
        return "Branch format 6"
2063
1521
 
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):
 
1522
    def initialize(self, a_bzrdir):
 
1523
        """Create a branch of this format in a_bzrdir."""
 
1524
        utf8_files = [('last-revision', '0 null:\n'),
 
1525
                      ('branch.conf', ''),
 
1526
                      ('tags', ''),
 
1527
                      ]
 
1528
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1529
 
 
1530
 
 
1531
class BzrBranchFormat7(BranchFormatMetadir):
2122
1532
    """Branch format with last-revision, tags, and a stacked location pointer.
2123
1533
 
2124
1534
    The stacked location pointer is passed down to the repository and requires
2127
1537
    This format was introduced in bzr 1.6.
2128
1538
    """
2129
1539
 
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
1540
    def _branch_class(self):
2139
1541
        return BzrBranch7
2140
1542
 
2146
1548
        """See BranchFormat.get_format_description()."""
2147
1549
        return "Branch format 7"
2148
1550
 
2149
 
    def supports_set_append_revisions_only(self):
 
1551
    def initialize(self, a_bzrdir):
 
1552
        """Create a branch of this format in a_bzrdir."""
 
1553
        utf8_files = [('last-revision', '0 null:\n'),
 
1554
                      ('branch.conf', ''),
 
1555
                      ('tags', ''),
 
1556
                      ]
 
1557
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1558
 
 
1559
    def __init__(self):
 
1560
        super(BzrBranchFormat7, self).__init__()
 
1561
        self._matchingbzrdir.repository_format = \
 
1562
            RepositoryFormatKnitPack5RichRoot()
 
1563
 
 
1564
    def supports_stacking(self):
2150
1565
        return True
2151
1566
 
2152
 
    supports_reference_locations = False
2153
 
 
2154
1567
 
2155
1568
class BranchReferenceFormat(BranchFormat):
2156
1569
    """Bzr branch reference format.
2171
1584
        """See BranchFormat.get_format_description()."""
2172
1585
        return "Checkout reference format 1"
2173
1586
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
1587
    def get_reference(self, a_bzrdir):
2175
1588
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
 
1589
        transport = a_bzrdir.get_branch_transport(None)
 
1590
        return transport.get('location').read()
2178
1591
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1592
    def set_reference(self, a_bzrdir, to_branch):
2180
1593
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1594
        transport = a_bzrdir.get_branch_transport(None)
2182
1595
        location = transport.put_bytes('location', to_branch.base)
2183
1596
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1597
    def initialize(self, a_bzrdir, target_branch=None):
2185
1598
        """Create a branch of this format in a_bzrdir."""
2186
1599
        if target_branch is None:
2187
1600
            # this format does not implement branch itself, thus the implicit
2188
1601
            # creation contract must see it as uninitializable
2189
1602
            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)
 
1603
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1604
        branch_transport = a_bzrdir.get_branch_transport(self)
2192
1605
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
1606
            target_branch.bzrdir.root_transport.base)
2194
1607
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
 
1608
        return self.open(
 
1609
            a_bzrdir, _found=True,
2197
1610
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
1611
 
2201
1612
    def __init__(self):
2202
1613
        super(BranchReferenceFormat, self).__init__()
2205
1616
 
2206
1617
    def _make_reference_clone_function(format, a_branch):
2207
1618
        """Create a clone() routine for a branch dynamically."""
2208
 
        def clone(to_bzrdir, revision_id=None,
2209
 
            repository_policy=None):
 
1619
        def clone(to_bzrdir, revision_id=None):
2210
1620
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1621
            return format.initialize(to_bzrdir, a_branch)
2212
1622
            # cannot obey revision_id limits when cloning a reference ...
2213
1623
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1624
            # emit some sort of warning/error to the caller ?!
2215
1625
        return clone
2216
1626
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
 
             possible_transports=None, ignore_fallbacks=False):
 
1627
    def open(self, a_bzrdir, _found=False, location=None,
 
1628
             possible_transports=None):
2219
1629
        """Return the branch that the branch reference in a_bzrdir points at.
2220
1630
 
2221
 
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
 
        :param _found: a private parameter, do not use it. It is used to
2224
 
            indicate if format probing has already be done.
2225
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2226
 
            (if there are any).  Default is to open fallbacks.
2227
 
        :param location: The location of the referenced branch.  If
2228
 
            unspecified, this will be determined from the branch reference in
2229
 
            a_bzrdir.
2230
 
        :param possible_transports: An optional reusable transports list.
 
1631
        _found is a private parameter, do not use it. It is used to indicate
 
1632
               if format probing has already be done.
2231
1633
        """
2232
1634
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1635
            format = BranchFormat.find_format(a_bzrdir)
2234
1636
            if format.__class__ != self.__class__:
2235
1637
                raise AssertionError("wrong format %r found for %r" %
2236
1638
                    (format, self))
2237
1639
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
1640
            location = self.get_reference(a_bzrdir)
2239
1641
        real_bzrdir = bzrdir.BzrDir.open(
2240
1642
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
 
1643
        result = real_bzrdir.open_branch()
2243
1644
        # this changes the behaviour of result.clone to create a new reference
2244
1645
        # rather than a copy of the content of the branch.
2245
1646
        # I did not use a proxy object because that needs much more extensive
2252
1653
        return result
2253
1654
 
2254
1655
 
2255
 
network_format_registry = registry.FormatRegistry()
2256
 
"""Registry of formats indexed by their network name.
2257
 
 
2258
 
The network name for a branch format is an identifier that can be used when
2259
 
referring to formats with smart server operations. See
2260
 
BranchFormat.network_name() for more detail.
2261
 
"""
2262
 
 
2263
 
 
2264
1656
# formats which have no format string are not discoverable
2265
1657
# and not independently creatable, so are not registered.
2266
1658
__format5 = BzrBranchFormat5()
2267
1659
__format6 = BzrBranchFormat6()
2268
1660
__format7 = BzrBranchFormat7()
2269
 
__format8 = BzrBranchFormat8()
2270
1661
BranchFormat.register_format(__format5)
2271
1662
BranchFormat.register_format(BranchReferenceFormat())
2272
1663
BranchFormat.register_format(__format6)
2273
1664
BranchFormat.register_format(__format7)
2274
 
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
 
1665
BranchFormat.set_default_format(__format6)
2276
1666
_legacy_formats = [BzrBranchFormat4(),
2277
 
    ]
2278
 
network_format_registry.register(
2279
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
 
 
2281
 
 
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):
 
1667
                   ]
 
1668
 
 
1669
class BzrBranch(Branch):
2300
1670
    """A branch stored in the actual filesystem.
2301
1671
 
2302
1672
    Note that it's "local" in the context of the filesystem; it doesn't
2308
1678
    :ivar repository: Repository for this branch.
2309
1679
    :ivar base: The url of the base directory for this branch; the one
2310
1680
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
1681
    """
2314
1682
 
2315
1683
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
 
1684
                 _control_files=None, a_bzrdir=None, _repository=None):
2318
1685
        """Create new branch object at a particular location."""
2319
1686
        if a_bzrdir is None:
2320
1687
            raise ValueError('a_bzrdir must be supplied')
2321
1688
        else:
2322
1689
            self.bzrdir = a_bzrdir
2323
1690
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
1691
        # XXX: We should be able to just do
2326
1692
        #   self.base = self.bzrdir.root_transport.base
2327
1693
        # but this does not quite work yet -- mbp 20080522
2334
1700
        Branch.__init__(self)
2335
1701
 
2336
1702
    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)
 
1703
        return '%s(%r)' % (self.__class__.__name__, self.base)
2342
1704
 
2343
1705
    __repr__ = __str__
2344
1706
 
2348
1710
 
2349
1711
    base = property(_get_base, doc="The URL for the root of this branch.")
2350
1712
 
2351
 
    def _get_config(self):
2352
 
        return TransportConfig(self._transport, 'branch.conf')
2353
 
 
2354
1713
    def is_locked(self):
2355
1714
        return self.control_files.is_locked()
2356
1715
 
2357
1716
    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
 
1717
        repo_token = self.repository.lock_write()
2374
1718
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
1719
            token = self.control_files.lock_write(token=token)
2377
1720
        except:
2378
 
            if took_lock:
2379
 
                self.repository.unlock()
 
1721
            self.repository.unlock()
2380
1722
            raise
 
1723
        return token
2381
1724
 
2382
1725
    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
 
1726
        self.repository.lock_read()
2397
1727
        try:
2398
1728
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
1729
        except:
2401
 
            if took_lock:
2402
 
                self.repository.unlock()
 
1730
            self.repository.unlock()
2403
1731
            raise
2404
1732
 
2405
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2406
1733
    def unlock(self):
 
1734
        # TODO: test for failed two phase locks. This is known broken.
2407
1735
        try:
2408
1736
            self.control_files.unlock()
2409
1737
        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()
 
1738
            self.repository.unlock()
 
1739
        if not self.control_files.is_locked():
 
1740
            # we just released the lock
 
1741
            self._clear_cached_state()
2418
1742
 
2419
1743
    def peek_lock_mode(self):
2420
1744
        if self.control_files._lock_count == 0:
2539
1863
        """See Branch.basis_tree."""
2540
1864
        return self.repository.revision_tree(self.last_revision())
2541
1865
 
 
1866
    @needs_write_lock
 
1867
    def pull(self, source, overwrite=False, stop_revision=None,
 
1868
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1869
             _override_hook_target=None):
 
1870
        """See Branch.pull.
 
1871
 
 
1872
        :param _hook_master: Private parameter - set the branch to
 
1873
            be supplied as the master to pull hooks.
 
1874
        :param run_hooks: Private parameter - if false, this branch
 
1875
            is being called because it's the master of the primary branch,
 
1876
            so it should not run its hooks.
 
1877
        :param _override_hook_target: Private parameter - set the branch to be
 
1878
            supplied as the target_branch to pull hooks.
 
1879
        """
 
1880
        result = PullResult()
 
1881
        result.source_branch = source
 
1882
        if _override_hook_target is None:
 
1883
            result.target_branch = self
 
1884
        else:
 
1885
            result.target_branch = _override_hook_target
 
1886
        source.lock_read()
 
1887
        try:
 
1888
            # We assume that during 'pull' the local repository is closer than
 
1889
            # the remote one.
 
1890
            graph = self.repository.get_graph(source.repository)
 
1891
            result.old_revno, result.old_revid = self.last_revision_info()
 
1892
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1893
                                  graph=graph)
 
1894
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1895
            result.new_revno, result.new_revid = self.last_revision_info()
 
1896
            if _hook_master:
 
1897
                result.master_branch = _hook_master
 
1898
                result.local_branch = result.target_branch
 
1899
            else:
 
1900
                result.master_branch = result.target_branch
 
1901
                result.local_branch = None
 
1902
            if run_hooks:
 
1903
                for hook in Branch.hooks['post_pull']:
 
1904
                    hook(result)
 
1905
        finally:
 
1906
            source.unlock()
 
1907
        return result
 
1908
 
2542
1909
    def _get_parent_location(self):
2543
1910
        _locs = ['parent', 'pull', 'x-pull']
2544
1911
        for l in _locs:
2548
1915
                pass
2549
1916
        return None
2550
1917
 
 
1918
    @needs_read_lock
 
1919
    def push(self, target, overwrite=False, stop_revision=None,
 
1920
             _override_hook_source_branch=None):
 
1921
        """See Branch.push.
 
1922
 
 
1923
        This is the basic concrete implementation of push()
 
1924
 
 
1925
        :param _override_hook_source_branch: If specified, run
 
1926
        the hooks passing this Branch as the source, rather than self.
 
1927
        This is for use of RemoteBranch, where push is delegated to the
 
1928
        underlying vfs-based Branch.
 
1929
        """
 
1930
        # TODO: Public option to disable running hooks - should be trivial but
 
1931
        # needs tests.
 
1932
        return _run_with_write_locked_target(
 
1933
            target, self._push_with_bound_branches, target, overwrite,
 
1934
            stop_revision,
 
1935
            _override_hook_source_branch=_override_hook_source_branch)
 
1936
 
 
1937
    def _push_with_bound_branches(self, target, overwrite,
 
1938
            stop_revision,
 
1939
            _override_hook_source_branch=None):
 
1940
        """Push from self into target, and into target's master if any.
 
1941
 
 
1942
        This is on the base BzrBranch class even though it doesn't support
 
1943
        bound branches because the *target* might be bound.
 
1944
        """
 
1945
        def _run_hooks():
 
1946
            if _override_hook_source_branch:
 
1947
                result.source_branch = _override_hook_source_branch
 
1948
            for hook in Branch.hooks['post_push']:
 
1949
                hook(result)
 
1950
 
 
1951
        bound_location = target.get_bound_location()
 
1952
        if bound_location and target.base != bound_location:
 
1953
            # there is a master branch.
 
1954
            #
 
1955
            # XXX: Why the second check?  Is it even supported for a branch to
 
1956
            # be bound to itself? -- mbp 20070507
 
1957
            master_branch = target.get_master_branch()
 
1958
            master_branch.lock_write()
 
1959
            try:
 
1960
                # push into the master from this branch.
 
1961
                self._basic_push(master_branch, overwrite, stop_revision)
 
1962
                # and push into the target branch from this. Note that we push from
 
1963
                # this branch again, because its considered the highest bandwidth
 
1964
                # repository.
 
1965
                result = self._basic_push(target, overwrite, stop_revision)
 
1966
                result.master_branch = master_branch
 
1967
                result.local_branch = target
 
1968
                _run_hooks()
 
1969
                return result
 
1970
            finally:
 
1971
                master_branch.unlock()
 
1972
        else:
 
1973
            # no master branch
 
1974
            result = self._basic_push(target, overwrite, stop_revision)
 
1975
            # TODO: Why set master_branch and local_branch if there's no
 
1976
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
1977
            # 20070504
 
1978
            result.master_branch = target
 
1979
            result.local_branch = None
 
1980
            _run_hooks()
 
1981
            return result
 
1982
 
2551
1983
    def _basic_push(self, target, overwrite, stop_revision):
2552
1984
        """Basic implementation of push without bound branches or hooks.
2553
1985
 
2554
 
        Must be called with source read locked and target write locked.
 
1986
        Must be called with self read locked and target write locked.
2555
1987
        """
2556
 
        result = BranchPushResult()
 
1988
        result = PushResult()
2557
1989
        result.source_branch = self
2558
1990
        result.target_branch = target
2559
1991
        result.old_revno, result.old_revid = target.last_revision_info()
2560
 
        self.update_references(target)
2561
1992
        if result.old_revid != self.last_revision():
2562
1993
            # We assume that during 'push' this repository is closer than
2563
1994
            # the target.
2564
1995
            graph = self.repository.get_graph(target.repository)
2565
 
            target.update_revisions(self, stop_revision,
2566
 
                overwrite=overwrite, graph=graph)
 
1996
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
1997
                                    graph=graph)
2567
1998
        if self._push_should_merge_tags():
2568
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2569
 
                overwrite)
 
1999
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2570
2000
        result.new_revno, result.new_revid = target.last_revision_info()
2571
2001
        return result
2572
2002
 
 
2003
    def _push_should_merge_tags(self):
 
2004
        """Should _basic_push merge this branch's tags into the target?
 
2005
 
 
2006
        The default implementation returns False if this branch has no tags,
 
2007
        and True the rest of the time.  Subclasses may override this.
 
2008
        """
 
2009
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
2010
 
 
2011
    def get_parent(self):
 
2012
        """See Branch.get_parent."""
 
2013
        parent = self._get_parent_location()
 
2014
        if parent is None:
 
2015
            return parent
 
2016
        # This is an old-format absolute path to a local branch
 
2017
        # turn it into a url
 
2018
        if parent.startswith('/'):
 
2019
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2020
        try:
 
2021
            return urlutils.join(self.base[:-1], parent)
 
2022
        except errors.InvalidURLJoin, e:
 
2023
            raise errors.InaccessibleParent(parent, self.base)
 
2024
 
2573
2025
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2026
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2027
 
2576
2028
    def set_push_location(self, location):
2577
2029
        """See Branch.set_push_location."""
2579
2031
            'push_location', location,
2580
2032
            store=_mod_config.STORE_LOCATION_NORECURSE)
2581
2033
 
 
2034
    @needs_write_lock
 
2035
    def set_parent(self, url):
 
2036
        """See Branch.set_parent."""
 
2037
        # TODO: Maybe delete old location files?
 
2038
        # URLs should never be unicode, even on the local fs,
 
2039
        # FIXUP this and get_parent in a future branch format bump:
 
2040
        # read and rewrite the file. RBC 20060125
 
2041
        if url is not None:
 
2042
            if isinstance(url, unicode):
 
2043
                try:
 
2044
                    url = url.encode('ascii')
 
2045
                except UnicodeEncodeError:
 
2046
                    raise errors.InvalidURL(url,
 
2047
                        "Urls must be 7-bit ascii, "
 
2048
                        "use bzrlib.urlutils.escape")
 
2049
            url = urlutils.relative_url(self.base, url)
 
2050
        self._set_parent_location(url)
 
2051
 
2582
2052
    def _set_parent_location(self, url):
2583
2053
        if url is None:
2584
2054
            self._transport.delete('parent')
2586
2056
            self._transport.put_bytes('parent', url + '\n',
2587
2057
                mode=self.bzrdir._get_file_mode())
2588
2058
 
 
2059
    def set_stacked_on_url(self, url):
 
2060
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2061
 
2589
2062
 
2590
2063
class BzrBranch5(BzrBranch):
2591
2064
    """A format 5 branch. This supports new features over plain branches.
2593
2066
    It has support for a master_branch which is the data for bound branches.
2594
2067
    """
2595
2068
 
 
2069
    @needs_write_lock
 
2070
    def pull(self, source, overwrite=False, stop_revision=None,
 
2071
             run_hooks=True, possible_transports=None,
 
2072
             _override_hook_target=None):
 
2073
        """Pull from source into self, updating my master if any.
 
2074
 
 
2075
        :param run_hooks: Private parameter - if false, this branch
 
2076
            is being called because it's the master of the primary branch,
 
2077
            so it should not run its hooks.
 
2078
        """
 
2079
        bound_location = self.get_bound_location()
 
2080
        master_branch = None
 
2081
        if bound_location and source.base != bound_location:
 
2082
            # not pulling from master, so we need to update master.
 
2083
            master_branch = self.get_master_branch(possible_transports)
 
2084
            master_branch.lock_write()
 
2085
        try:
 
2086
            if master_branch:
 
2087
                # pull from source into master.
 
2088
                master_branch.pull(source, overwrite, stop_revision,
 
2089
                    run_hooks=False)
 
2090
            return super(BzrBranch5, self).pull(source, overwrite,
 
2091
                stop_revision, _hook_master=master_branch,
 
2092
                run_hooks=run_hooks,
 
2093
                _override_hook_target=_override_hook_target)
 
2094
        finally:
 
2095
            if master_branch:
 
2096
                master_branch.unlock()
 
2097
 
2596
2098
    def get_bound_location(self):
2597
2099
        try:
2598
2100
            return self._transport.get_bytes('bound')[:-1]
2685
2187
        return None
2686
2188
 
2687
2189
 
2688
 
class BzrBranch8(BzrBranch5):
2689
 
    """A branch that stores tree-reference locations."""
 
2190
class BzrBranch7(BzrBranch5):
 
2191
    """A branch with support for a fallback repository."""
 
2192
 
 
2193
    def _get_fallback_repository(self, url):
 
2194
        """Get the repository we fallback to at url."""
 
2195
        url = urlutils.join(self.base, url)
 
2196
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2197
                                      possible_transports=[self._transport])
 
2198
        return a_bzrdir.open_branch().repository
 
2199
 
 
2200
    def _activate_fallback_location(self, url):
 
2201
        """Activate the branch/repository from url as a fallback repository."""
 
2202
        self.repository.add_fallback_repository(
 
2203
            self._get_fallback_repository(url))
2690
2204
 
2691
2205
    def _open_hook(self):
2692
 
        if self._ignore_fallbacks:
2693
 
            return
2694
2206
        try:
2695
2207
            url = self.get_stacked_on_url()
2696
2208
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2706
2218
                        "None, not a URL." % hook_name)
2707
2219
            self._activate_fallback_location(url)
2708
2220
 
 
2221
    def _check_stackable_repo(self):
 
2222
        if not self.repository._format.supports_external_lookups:
 
2223
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2224
                self.repository.base)
 
2225
 
2709
2226
    def __init__(self, *args, **kwargs):
2710
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2227
        super(BzrBranch7, self).__init__(*args, **kwargs)
2712
2228
        self._last_revision_info_cache = None
2713
 
        self._reference_info = None
 
2229
        self._partial_revision_history_cache = []
2714
2230
 
2715
2231
    def _clear_cached_state(self):
2716
 
        super(BzrBranch8, self)._clear_cached_state()
 
2232
        super(BzrBranch7, self)._clear_cached_state()
2717
2233
        self._last_revision_info_cache = None
2718
 
        self._reference_info = None
 
2234
        self._partial_revision_history_cache = []
2719
2235
 
2720
2236
    def _last_revision_info(self):
2721
2237
        revision_string = self._transport.get_bytes('last-revision')
2767
2283
        if _mod_revision.is_null(last_revision):
2768
2284
            return
2769
2285
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2286
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2287
 
2772
2288
    def _gen_revision_history(self):
2773
2289
        """Generate the revision history from last revision
2776
2292
        self._extend_partial_history(stop_index=last_revno-1)
2777
2293
        return list(reversed(self._partial_revision_history_cache))
2778
2294
 
 
2295
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2296
        """Extend the partial history to include a given index
 
2297
 
 
2298
        If a stop_index is supplied, stop when that index has been reached.
 
2299
        If a stop_revision is supplied, stop when that revision is
 
2300
        encountered.  Otherwise, stop when the beginning of history is
 
2301
        reached.
 
2302
 
 
2303
        :param stop_index: The index which should be present.  When it is
 
2304
            present, history extension will stop.
 
2305
        :param revision_id: The revision id which should be present.  When
 
2306
            it is encountered, history extension will stop.
 
2307
        """
 
2308
        repo = self.repository
 
2309
        if len(self._partial_revision_history_cache) == 0:
 
2310
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2311
        else:
 
2312
            start_revision = self._partial_revision_history_cache[-1]
 
2313
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2314
            #skip the last revision in the list
 
2315
            next_revision = iterator.next()
 
2316
        for revision_id in iterator:
 
2317
            self._partial_revision_history_cache.append(revision_id)
 
2318
            if (stop_index is not None and
 
2319
                len(self._partial_revision_history_cache) > stop_index):
 
2320
                break
 
2321
            if revision_id == stop_revision:
 
2322
                break
 
2323
 
2779
2324
    def _write_revision_history(self, history):
2780
2325
        """Factored out of set_revision_history.
2781
2326
 
2802
2347
        """Set the parent branch"""
2803
2348
        return self._get_config_location('parent_location')
2804
2349
 
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
2350
    def set_push_location(self, location):
2881
2351
        """See Branch.set_push_location."""
2882
2352
        self._set_config_location('push_location', location)
2924
2394
            raise errors.NotStacked(self)
2925
2395
        return stacked_url
2926
2396
 
 
2397
    def set_append_revisions_only(self, enabled):
 
2398
        if enabled:
 
2399
            value = 'True'
 
2400
        else:
 
2401
            value = 'False'
 
2402
        self.get_config().set_user_option('append_revisions_only', value,
 
2403
            warn_masked=True)
 
2404
 
 
2405
    def set_stacked_on_url(self, url):
 
2406
        self._check_stackable_repo()
 
2407
        if not url:
 
2408
            try:
 
2409
                old_url = self.get_stacked_on_url()
 
2410
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2411
                errors.UnstackableRepositoryFormat):
 
2412
                return
 
2413
            url = ''
 
2414
            # repositories don't offer an interface to remove fallback
 
2415
            # repositories today; take the conceptually simpler option and just
 
2416
            # reopen it.
 
2417
            self.repository = self.bzrdir.find_repository()
 
2418
            # for every revision reference the branch has, ensure it is pulled
 
2419
            # in.
 
2420
            source_repository = self._get_fallback_repository(old_url)
 
2421
            for revision_id in chain([self.last_revision()],
 
2422
                self.tags.get_reverse_tag_dict()):
 
2423
                self.repository.fetch(source_repository, revision_id,
 
2424
                    find_ghosts=True)
 
2425
        else:
 
2426
            self._activate_fallback_location(url)
 
2427
        # write this out after the repository is stacked to avoid setting a
 
2428
        # stacked config that doesn't work.
 
2429
        self._set_config_location('stacked_on_location', url)
 
2430
 
2927
2431
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2432
        value = self.get_config().get_user_option('append_revisions_only')
 
2433
        return value == 'True'
 
2434
 
 
2435
    def _make_tags(self):
 
2436
        return BasicTags(self)
2930
2437
 
2931
2438
    @needs_write_lock
2932
2439
    def generate_revision_history(self, revision_id, last_rev=None,
2972
2479
        return self.revno() - index
2973
2480
 
2974
2481
 
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
2482
class BzrBranch6(BzrBranch7):
2990
2483
    """See BzrBranchFormat6 for the capabilities of this branch.
2991
2484
 
2994
2487
    """
2995
2488
 
2996
2489
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2490
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2491
 
 
2492
    def set_stacked_on_url(self, url):
 
2493
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2494
 
2999
2495
 
3000
2496
######################################################################
3018
2514
    :ivar new_revno: Revision number after pull.
3019
2515
    :ivar old_revid: Tip revision id before pull.
3020
2516
    :ivar new_revid: Tip revision id after pull.
3021
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2517
    :ivar source_branch: Source (local) branch object.
3022
2518
    :ivar master_branch: Master branch of the target, or the target if no
3023
2519
        Master
3024
2520
    :ivar local_branch: target branch if there is a Master, else None
3025
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2521
    :ivar target_branch: Target/destination branch object.
3026
2522
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3027
2523
    """
3028
2524
 
3039
2535
        self._show_tag_conficts(to_file)
3040
2536
 
3041
2537
 
3042
 
class BranchPushResult(_Result):
 
2538
class PushResult(_Result):
3043
2539
    """Result of a Branch.push operation.
3044
2540
 
3045
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3046
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3047
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3048
 
        before the push.
3049
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3050
 
        after the push.
3051
 
    :ivar source_branch: Source branch object that the push was from. This is
3052
 
        read locked, and generally is a local (and thus low latency) branch.
3053
 
    :ivar master_branch: If target is a bound branch, the master branch of
3054
 
        target, or target itself. Always write locked.
3055
 
    :ivar target_branch: The direct Branch where data is being sent (write
3056
 
        locked).
3057
 
    :ivar local_branch: If the target is a bound branch this will be the
3058
 
        target, otherwise it will be None.
 
2541
    :ivar old_revno: Revision number before push.
 
2542
    :ivar new_revno: Revision number after push.
 
2543
    :ivar old_revid: Tip revision id before push.
 
2544
    :ivar new_revid: Tip revision id after push.
 
2545
    :ivar source_branch: Source branch object.
 
2546
    :ivar master_branch: Master branch of the target, or None.
 
2547
    :ivar target_branch: Target/destination branch object.
3059
2548
    """
3060
2549
 
3061
2550
    def __int__(self):
3065
2554
    def report(self, to_file):
3066
2555
        """Write a human-readable description of the result."""
3067
2556
        if self.old_revid == self.new_revid:
3068
 
            note('No new revisions to push.')
 
2557
            to_file.write('No new revisions to push.\n')
3069
2558
        else:
3070
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2559
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3071
2560
        self._show_tag_conficts(to_file)
3072
2561
 
3073
2562
 
3079
2568
 
3080
2569
    def __init__(self, branch):
3081
2570
        self.branch = branch
3082
 
        self.errors = []
3083
2571
 
3084
2572
    def report_results(self, verbose):
3085
2573
        """Report the check results via trace.note.
3087
2575
        :param verbose: Requests more detailed display of what was checked,
3088
2576
            if any.
3089
2577
        """
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)
 
2578
        note('checked branch %s format %s',
 
2579
             self.branch.base,
 
2580
             self.branch._format)
3094
2581
 
3095
2582
 
3096
2583
class Converter5to6(object):
3134
2621
        branch._transport.put_bytes('format', format.get_format_string())
3135
2622
 
3136
2623
 
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
2624
 
3147
2625
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3148
2626
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3189
2667
    """The available optimised InterBranch types."""
3190
2668
 
3191
2669
    @staticmethod
3192
 
    def _get_branch_formats_to_test():
3193
 
        """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)
 
2670
    def _get_branch_format_to_test():
 
2671
        """Return the Branch format to use when testing this InterBranch."""
 
2672
        raise NotImplementedError(self._get_branch_format_to_test)
3205
2673
 
3206
2674
    def update_revisions(self, stop_revision=None, overwrite=False,
3207
2675
                         graph=None):
3216
2684
        """
3217
2685
        raise NotImplementedError(self.update_revisions)
3218
2686
 
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
2687
 
3228
2688
class GenericInterBranch(InterBranch):
3229
2689
    """InterBranch implementation that uses public Branch functions.
3230
2690
    """
3231
2691
 
3232
2692
    @staticmethod
3233
 
    def _get_branch_formats_to_test():
3234
 
        return BranchFormat._default_format, BranchFormat._default_format
 
2693
    def _get_branch_format_to_test():
 
2694
        return BranchFormat._default_format
3235
2695
 
3236
2696
    def update_revisions(self, stop_revision=None, overwrite=False,
3237
2697
        graph=None):
3276
2736
        finally:
3277
2737
            self.source.unlock()
3278
2738
 
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
2739
    @classmethod
3401
2740
    def is_compatible(self, source, target):
3402
2741
        # GenericBranch uses the public API, so always compatible
3403
2742
        return True
3404
2743
 
3405
2744
 
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
2745
InterBranch.register_optimiser(GenericInterBranch)
3444
 
InterBranch.register_optimiser(InterToBranch5)