/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
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
417
336
            * 'include' - the stop revision is the last item in the result
418
337
            * 'with-merges' - include the stop revision and all of its
419
338
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
339
        :param direction: either 'reverse' or 'forward':
423
340
            * reverse means return the start_revision_id first, i.e.
424
341
              start at the most recent revision and go backwards in history
446
363
        # start_revision_id.
447
364
        if self._merge_sorted_revisions_cache is None:
448
365
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
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
 
453
375
        filtered = self._filter_merge_sorted_revisions(
454
376
            self._merge_sorted_revisions_cache, start_revision_id,
455
377
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
378
        if direction == 'reverse':
460
379
            return filtered
461
380
        if direction == 'forward':
468
387
        """Iterate over an inclusive range of sorted revisions."""
469
388
        rev_iter = iter(merge_sorted_revisions)
470
389
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
390
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
391
                if rev_id != start_revision_id:
474
392
                    continue
475
393
                else:
476
394
                    # The decision to include the start or not
477
395
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
396
                    rev_iter = chain(
 
397
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
398
                        rev_iter)
480
399
                    break
481
400
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
401
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
402
                yield rev_id, depth, revno, end_of_merge
487
403
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
404
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
405
                if rev_id == stop_revision_id:
491
406
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
407
                yield rev_id, depth, revno, end_of_merge
494
408
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
409
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
410
                yield rev_id, depth, revno, end_of_merge
499
411
                if rev_id == stop_revision_id:
500
412
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
413
        elif stop_rule == 'with-merges':
514
414
            stop_rev = self.repository.get_revision(stop_revision_id)
515
415
            if stop_rev.parent_ids:
516
416
                left_parent = stop_rev.parent_ids[0]
517
417
            else:
518
418
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
419
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
420
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
421
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
422
                yield rev_id, depth, revno, end_of_merge
538
423
        else:
539
424
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
425
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
426
    def leave_lock_in_place(self):
587
427
        """Tell this branch object not to release the physical lock when this
588
428
        object is unlocked.
605
445
        :param other: The branch to bind to
606
446
        :type other: Branch
607
447
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
609
 
 
610
 
    def set_append_revisions_only(self, enabled):
611
 
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
613
 
        if enabled:
614
 
            value = 'True'
615
 
        else:
616
 
            value = 'False'
617
 
        self.get_config().set_user_option('append_revisions_only', value,
618
 
            warn_masked=True)
619
 
 
620
 
    def set_reference_info(self, file_id, tree_path, branch_location):
621
 
        """Set the branch location to use for a tree reference."""
622
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
623
 
 
624
 
    def get_reference_info(self, file_id):
625
 
        """Get the tree_path and branch_location for a tree reference."""
626
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
448
        raise errors.UpgradeRequired(self.base)
627
449
 
628
450
    @needs_write_lock
629
451
    def fetch(self, from_branch, last_revision=None, pb=None):
633
455
        :param last_revision: What revision to stop at (None for at the end
634
456
                              of the branch.
635
457
        :param pb: An optional progress bar to use.
636
 
        :return: None
 
458
 
 
459
        Returns the copied revision count and the failed revisions in a tuple:
 
460
        (copied, failures).
637
461
        """
638
462
        if self.base == from_branch.base:
639
463
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "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
 
644
470
        from_branch.lock_read()
645
471
        try:
646
472
            if last_revision is None:
 
473
                pb.update('get source history')
647
474
                last_revision = from_branch.last_revision()
648
475
                last_revision = _mod_revision.ensure_null(last_revision)
649
476
            return self.repository.fetch(from_branch.repository,
650
477
                                         revision_id=last_revision,
651
 
                                         pb=pb)
 
478
                                         pb=nested_pb)
652
479
        finally:
 
480
            if nested_pb is not None:
 
481
                nested_pb.finished()
653
482
            from_branch.unlock()
654
483
 
655
484
    def get_bound_location(self):
663
492
    def get_old_bound_location(self):
664
493
        """Return the URL of the branch we used to be bound to
665
494
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
495
        raise errors.UpgradeRequired(self.base)
667
496
 
668
497
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
498
                           timezone=None, committer=None, revprops=None,
719
548
    def set_revision_history(self, rev_history):
720
549
        raise NotImplementedError(self.set_revision_history)
721
550
 
722
 
    @needs_write_lock
723
 
    def set_parent(self, url):
724
 
        """See Branch.set_parent."""
725
 
        # TODO: Maybe delete old location files?
726
 
        # URLs should never be unicode, even on the local fs,
727
 
        # FIXUP this and get_parent in a future branch format bump:
728
 
        # read and rewrite the file. RBC 20060125
729
 
        if url is not None:
730
 
            if isinstance(url, unicode):
731
 
                try:
732
 
                    url = url.encode('ascii')
733
 
                except UnicodeEncodeError:
734
 
                    raise errors.InvalidURL(url,
735
 
                        "Urls must be 7-bit ascii, "
736
 
                        "use bzrlib.urlutils.escape")
737
 
            url = urlutils.relative_url(self.base, url)
738
 
        self._set_parent_location(url)
739
 
 
740
 
    @needs_write_lock
741
551
    def set_stacked_on_url(self, url):
742
552
        """Set the URL this branch is stacked against.
743
553
 
746
556
        :raises UnstackableRepositoryFormat: If the repository does not support
747
557
            stacking.
748
558
        """
749
 
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
 
        # XXX: Changing from one fallback repository to another does not check
752
 
        # that all the data you need is present in the new fallback.
753
 
        # Possibly it should.
754
 
        self._check_stackable_repo()
755
 
        if not url:
756
 
            try:
757
 
                old_url = self.get_stacked_on_url()
758
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
 
                errors.UnstackableRepositoryFormat):
760
 
                return
761
 
            self._unstack()
762
 
        else:
763
 
            self._activate_fallback_location(url)
764
 
        # write this out after the repository is stacked to avoid setting a
765
 
        # stacked config that doesn't work.
766
 
        self._set_config_location('stacked_on_location', url)
767
 
 
768
 
    def _unstack(self):
769
 
        """Change a branch to be unstacked, copying data as needed.
770
 
        
771
 
        Don't call this directly, use set_stacked_on_url(None).
772
 
        """
773
 
        pb = ui.ui_factory.nested_progress_bar()
774
 
        try:
775
 
            pb.update("Unstacking")
776
 
            # The basic approach here is to fetch the tip of the branch,
777
 
            # including all available ghosts, from the existing stacked
778
 
            # repository into a new repository object without the fallbacks. 
779
 
            #
780
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
 
            # correct for CHKMap repostiories
782
 
            old_repository = self.repository
783
 
            if len(old_repository._fallback_repositories) != 1:
784
 
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
787
 
            old_repository.unlock()
788
 
            old_repository.lock_read()
789
 
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
 
                # XXX: If you unstack a branch while it has a working tree
809
 
                # with a pending merge, the pending-merged revisions will no
810
 
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
818
 
            finally:
819
 
                old_repository.unlock()
820
 
        finally:
821
 
            pb.finished()
822
 
 
823
 
    def _set_tags_bytes(self, bytes):
824
 
        """Mirror method for _get_tags_bytes.
825
 
 
826
 
        :seealso: Branch._get_tags_bytes.
827
 
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
559
        raise NotImplementedError(self.set_stacked_on_url)
830
560
 
831
561
    def _cache_revision_history(self, rev_history):
832
562
        """Set the cached revision history to rev_history.
860
590
        self._revision_id_to_revno_cache = None
861
591
        self._last_revision_info_cache = None
862
592
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
593
 
866
594
    def _gen_revision_history(self):
867
595
        """Return sequence of revision hashes on to this branch.
904
632
 
905
633
    def unbind(self):
906
634
        """Older format branches cannot bind or unbind."""
907
 
        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)
908
640
 
909
641
    def last_revision(self):
910
642
        """Return last revision id, or NULL_REVISION."""
967
699
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
700
            overwrite, graph)
969
701
 
970
 
    def import_last_revision_info(self, source_repo, revno, revid):
971
 
        """Set the last revision info, importing from another repo if necessary.
972
 
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
 
        :param source_repo: Source repository to optionally fetch from
977
 
        :param revno: Revision number of the new tip
978
 
        :param revid: Revision id of the new tip
979
 
        """
980
 
        if not self.repository.has_same_location(source_repo):
981
 
            self.repository.fetch(source_repo, revision_id=revid)
982
 
        self.set_last_revision_info(revno, revid)
983
 
 
984
702
    def revision_id_to_revno(self, revision_id):
985
703
        """Given a revision id, return its revno"""
986
704
        if _mod_revision.is_null(revision_id):
991
709
        except ValueError:
992
710
            raise errors.NoSuchRevision(self, revision_id)
993
711
 
994
 
    @needs_read_lock
995
712
    def get_rev_id(self, revno, history=None):
996
713
        """Find the revision id of the specified revno."""
997
714
        if revno == 0:
998
715
            return _mod_revision.NULL_REVISION
999
 
        last_revno, last_revid = self.last_revision_info()
1000
 
        if revno == last_revno:
1001
 
            return last_revid
1002
 
        if revno <= 0 or revno > last_revno:
 
716
        if history is None:
 
717
            history = self.revision_history()
 
718
        if revno <= 0 or revno > len(history):
1003
719
            raise errors.NoSuchRevision(self, revno)
1004
 
        distance_from_last = last_revno - revno
1005
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1006
 
            self._extend_partial_history(distance_from_last)
1007
 
        return self._partial_revision_history_cache[distance_from_last]
 
720
        return history[revno - 1]
1008
721
 
1009
 
    @needs_write_lock
1010
722
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
723
             possible_transports=None, _override_hook_target=None):
1012
724
        """Mirror source into this branch.
1013
725
 
1014
726
        This branch is considered to be 'local', having low latency.
1015
727
 
1016
728
        :returns: PullResult instance
1017
729
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
730
        raise NotImplementedError(self.pull)
1021
731
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
732
    def push(self, target, overwrite=False, stop_revision=None):
1024
733
        """Mirror this branch into target.
1025
734
 
1026
735
        This branch is considered to be 'local', having low latency.
1027
736
        """
1028
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
737
        raise NotImplementedError(self.push)
1051
738
 
1052
739
    def basis_tree(self):
1053
740
        """Return `Tree` object for last revision."""
1060
747
        pattern is that the user can override it by specifying a
1061
748
        location.
1062
749
        """
1063
 
        parent = self._get_parent_location()
1064
 
        if parent is None:
1065
 
            return parent
1066
 
        # This is an old-format absolute path to a local branch
1067
 
        # turn it into a url
1068
 
        if parent.startswith('/'):
1069
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1070
 
        try:
1071
 
            return urlutils.join(self.base[:-1], parent)
1072
 
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
1074
 
 
1075
 
    def _get_parent_location(self):
1076
 
        raise NotImplementedError(self._get_parent_location)
 
750
        raise NotImplementedError(self.get_parent)
1077
751
 
1078
752
    def _set_config_location(self, name, url, config=None,
1079
753
                             make_relative=False):
1093
767
            location = None
1094
768
        return location
1095
769
 
1096
 
    def get_child_submit_format(self):
1097
 
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
1099
 
 
1100
770
    def get_submit_branch(self):
1101
771
        """Return the submit location of the branch.
1102
772
 
1119
789
    def get_public_branch(self):
1120
790
        """Return the public location of the branch.
1121
791
 
1122
 
        This is used by merge directives.
 
792
        This is is used by merge directives.
1123
793
        """
1124
794
        return self._get_config_location('public_branch')
1125
795
 
1161
831
        params = ChangeBranchTipParams(
1162
832
            self, old_revno, new_revno, old_revid, new_revid)
1163
833
        for hook in hooks:
1164
 
            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)
1165
846
 
1166
847
    @needs_write_lock
1167
848
    def update(self):
1188
869
            raise errors.InvalidRevisionNumber(revno)
1189
870
 
1190
871
    @needs_read_lock
1191
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
872
    def clone(self, to_bzrdir, revision_id=None):
1192
873
        """Clone this branch into to_bzrdir preserving all semantic values.
1193
874
 
1194
 
        Most API users will want 'create_clone_on_transport', which creates a
1195
 
        new bzrdir and branch on the fly.
1196
 
 
1197
875
        revision_id: if not None, the revision history in the new branch will
1198
876
                     be truncated to end with revision_id.
1199
877
        """
1200
878
        result = to_bzrdir.create_branch()
1201
 
        result.lock_write()
1202
 
        try:
1203
 
            if repository_policy is not None:
1204
 
                repository_policy.configure_branch(result)
1205
 
            self.copy_content_into(result, revision_id=revision_id)
1206
 
        finally:
1207
 
            result.unlock()
1208
 
        return result
 
879
        self.copy_content_into(result, revision_id=revision_id)
 
880
        return  result
1209
881
 
1210
882
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
883
    def sprout(self, to_bzrdir, revision_id=None):
1212
884
        """Create a new line of development from the branch, into to_bzrdir.
1213
885
 
1214
886
        to_bzrdir controls the branch format.
1216
888
        revision_id: if not None, the revision history in the new branch will
1217
889
                     be truncated to end with revision_id.
1218
890
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
891
        result = to_bzrdir.create_branch()
1223
 
        result.lock_write()
1224
 
        try:
1225
 
            if repository_policy is not None:
1226
 
                repository_policy.configure_branch(result)
1227
 
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
1229
 
        finally:
1230
 
            result.unlock()
 
892
        self.copy_content_into(result, revision_id=revision_id)
 
893
        result.set_parent(self.bzrdir.root_transport.base)
1231
894
        return result
1232
895
 
1233
896
    def _synchronize_history(self, destination, revision_id):
1245
908
        source_revno, source_revision_id = self.last_revision_info()
1246
909
        if revision_id is None:
1247
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
1248
914
        else:
1249
 
            graph = self.repository.get_graph()
1250
 
            try:
1251
 
                revno = graph.find_distance_to_null(revision_id, 
1252
 
                    [(source_revision_id, source_revno)])
1253
 
            except errors.GhostRevisionsHaveNoRevno:
1254
 
                # Default to 1, if we can't find anything else
1255
 
                revno = 1
 
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)))
1256
923
        destination.set_last_revision_info(revno, revision_id)
1257
924
 
1258
925
    @needs_read_lock
1262
929
        revision_id: if not None, the revision history in the new branch will
1263
930
                     be truncated to end with revision_id.
1264
931
        """
1265
 
        self.update_references(destination)
1266
932
        self._synchronize_history(destination, revision_id)
1267
933
        try:
1268
934
            parent = self.get_parent()
1271
937
        else:
1272
938
            if parent:
1273
939
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
1276
 
 
1277
 
    def update_references(self, target):
1278
 
        if not getattr(self._format, 'supports_reference_locations', False):
1279
 
            return
1280
 
        reference_dict = self._get_all_reference_info()
1281
 
        if len(reference_dict) == 0:
1282
 
            return
1283
 
        old_base = self.base
1284
 
        new_base = target.base
1285
 
        target_reference_dict = target._get_all_reference_info()
1286
 
        for file_id, (tree_path, branch_location) in (
1287
 
            reference_dict.items()):
1288
 
            branch_location = urlutils.rebase_url(branch_location,
1289
 
                                                  old_base, new_base)
1290
 
            target_reference_dict.setdefault(
1291
 
                file_id, (tree_path, branch_location))
1292
 
        target._set_all_reference_info(target_reference_dict)
 
940
        self.tags.merge_to(destination.tags)
1293
941
 
1294
942
    @needs_read_lock
1295
 
    def check(self, refs):
 
943
    def check(self):
1296
944
        """Check consistency of the branch.
1297
945
 
1298
946
        In particular this checks that revisions given in the revision-history
1301
949
 
1302
950
        Callers will typically also want to check the repository.
1303
951
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
952
        :return: A BranchCheckResult.
1307
953
        """
1308
 
        result = BranchCheckResult(self)
 
954
        mainline_parent_id = None
1309
955
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
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)
1321
980
 
1322
981
    def _get_checkout_format(self):
1323
982
        """Return the most suitable metadir for a checkout of this branch.
1332
991
            format.set_branch_format(self._format)
1333
992
        return format
1334
993
 
1335
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1337
 
        """Create a clone of this branch and its bzrdir.
1338
 
 
1339
 
        :param to_transport: The transport to clone onto.
1340
 
        :param revision_id: The revision id to use as tip in the new branch.
1341
 
            If None the tip is obtained from this branch.
1342
 
        :param stacked_on: An optional URL to stack the clone on.
1343
 
        :param create_prefix: Create any missing directories leading up to
1344
 
            to_transport.
1345
 
        :param use_existing_dir: Use an existing directory if one exists.
1346
 
        """
1347
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
 
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1354
 
        return dir_to.open_branch()
1355
 
 
1356
994
    def create_checkout(self, to_location, revision_id=None,
1357
995
                        lightweight=False, accelerator_tree=None,
1358
996
                        hardlink=False):
1375
1013
        if lightweight:
1376
1014
            format = self._get_checkout_format()
1377
1015
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1016
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1017
        else:
1381
1018
            format = self._get_checkout_format()
1382
1019
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1048
        reconciler.reconcile()
1412
1049
        return reconciler
1413
1050
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1051
    def reference_parent(self, file_id, path):
1415
1052
        """Return the parent branch for a tree-reference file_id
1416
1053
        :param file_id: The file_id of the tree reference
1417
1054
        :param path: The path of the file_id in the tree
1418
1055
        :return: A branch associated with the file_id
1419
1056
        """
1420
1057
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1058
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1059
 
1424
1060
    def supports_tags(self):
1425
1061
        return self._format.supports_tags()
1426
1062
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1063
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1064
                                         other_branch):
1441
1065
        """Ensure that revision_b is a descendant of revision_a.
1496
1120
    _formats = {}
1497
1121
    """The known formats."""
1498
1122
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1123
    def __eq__(self, other):
1502
1124
        return self.__class__ is other.__class__
1503
1125
 
1505
1127
        return not (self == other)
1506
1128
 
1507
1129
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1130
    def find_format(klass, a_bzrdir):
1509
1131
        """Return the format for the branch object in a_bzrdir."""
1510
1132
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1133
            transport = a_bzrdir.get_branch_transport(None)
 
1134
            format_string = transport.get("format").read()
1513
1135
            return klass._formats[format_string]
1514
1136
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1137
            raise errors.NotBranchError(path=transport.base)
1516
1138
        except KeyError:
1517
1139
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1140
 
1554
1176
        """Return the short format description for this format."""
1555
1177
        raise NotImplementedError(self.get_format_description)
1556
1178
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1179
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1180
                           set_format=True):
1567
1181
        """Initialize a branch in a bzrdir, with specified files
1568
1182
 
1569
1183
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1184
        :param utf8_files: The files to create as a list of
1571
1185
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1186
        :param set_format: If True, set the format with
1574
1187
            self.get_format_string.  (BzrBranch4 has its format set
1575
1188
            elsewhere)
1576
1189
        :return: a branch in this format
1577
1190
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        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)
1580
1193
        lock_map = {
1581
1194
            'metadir': ('lock', lockdir.LockDir),
1582
1195
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1198
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1199
            lock_name, lock_class)
1587
1200
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
 
1201
        control_files.lock_write()
1596
1202
        if set_format:
1597
1203
            utf8_files += [('format', self.get_format_string())]
1598
1204
        try:
1601
1207
                    filename, content,
1602
1208
                    mode=a_bzrdir._get_file_mode())
1603
1209
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1210
            control_files.unlock()
 
1211
        return self.open(a_bzrdir, _found=True)
1609
1212
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1213
    def initialize(self, a_bzrdir):
 
1214
        """Create a branch of this format in a_bzrdir."""
1615
1215
        raise NotImplementedError(self.initialize)
1616
1216
 
1617
1217
    def is_supported(self):
1623
1223
        """
1624
1224
        return True
1625
1225
 
1626
 
    def make_tags(self, branch):
1627
 
        """Create a tags object for branch.
1628
 
 
1629
 
        This method is on BranchFormat, because BranchFormats are reflected
1630
 
        over the wire via network_name(), whereas full Branch instances require
1631
 
        multiple VFS method calls to operate at all.
1632
 
 
1633
 
        The default implementation returns a disabled-tags instance.
1634
 
 
1635
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
 
        on a RemoteBranch.
1637
 
        """
1638
 
        return DisabledTags(branch)
1639
 
 
1640
 
    def network_name(self):
1641
 
        """A simple byte string uniquely identifying this format for RPC calls.
1642
 
 
1643
 
        MetaDir branch formats use their disk format string to identify the
1644
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1645
 
        foreign formats like svn/git and hg should use some marker which is
1646
 
        unique and immutable.
1647
 
        """
1648
 
        raise NotImplementedError(self.network_name)
1649
 
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1226
    def open(self, a_bzrdir, _found=False):
1651
1227
        """Return the branch object for a_bzrdir
1652
1228
 
1653
 
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
 
        :param _found: a private parameter, do not use it. It is used to
1656
 
            indicate if format probing has already be done.
1657
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1658
 
            (if there are any).  Default is to open fallbacks.
 
1229
        _found is a private parameter, do not use it. It is used to indicate
 
1230
               if format probing has already be done.
1659
1231
        """
1660
1232
        raise NotImplementedError(self.open)
1661
1233
 
1662
1234
    @classmethod
1663
1235
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
1665
1236
        klass._formats[format.get_format_string()] = format
1666
 
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1669
1237
 
1670
1238
    @classmethod
1671
1239
    def set_default_format(klass, format):
1672
1240
        klass._default_format = format
1673
1241
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1242
    def supports_stacking(self):
1679
1243
        """True if this format records a stacked-on branch."""
1680
1244
        return False
1684
1248
        del klass._formats[format.get_format_string()]
1685
1249
 
1686
1250
    def __str__(self):
1687
 
        return self.get_format_description().rstrip()
 
1251
        return self.get_format_string().rstrip()
1688
1252
 
1689
1253
    def supports_tags(self):
1690
1254
        """True if this format supports tags stored in the branch"""
1705
1269
        notified.
1706
1270
        """
1707
1271
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
1709
 
            "Invoked whenever the revision history has been set via "
1710
 
            "set_revision_history. The api signature is (branch, "
1711
 
            "revision_history), and the branch will be write-locked. "
1712
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1713
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
 
        self.create_hook(HookPoint('open',
1715
 
            "Called with the Branch object that has been opened after a "
1716
 
            "branch is opened.", (1, 8), None))
1717
 
        self.create_hook(HookPoint('post_push',
1718
 
            "Called after a push operation completes. post_push is called "
1719
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
1722
 
            "Called after a pull operation completes. post_pull is called "
1723
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
 
            "bzr client.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
1727
 
            "completed. pre_commit is called with (local, master, old_revno, "
1728
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1730
 
            "tree_delta is a TreeDelta object describing changes from the "
1731
 
            "basis revision. hooks MUST NOT modify this delta. "
1732
 
            " future_tree is an in-memory tree obtained from "
1733
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
1736
 
            "Called in the bzr client after a commit has completed. "
1737
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
 
            "commit to a branch.", (0, 15), None))
1740
 
        self.create_hook(HookPoint('post_uncommit',
1741
 
            "Called in the bzr client after an uncommit completes. "
1742
 
            "post_uncommit is called with (local, master, old_revno, "
1743
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
 
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1747
 
            "Called in bzr client and server before a change to the tip of a "
1748
 
            "branch is made. pre_change_branch_tip is called with a "
1749
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1751
 
        self.create_hook(HookPoint('post_change_branch_tip',
1752
 
            "Called in bzr client and server after a change to the tip of a "
1753
 
            "branch is made. post_change_branch_tip is called with a "
1754
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1756
 
        self.create_hook(HookPoint('transform_fallback_location',
1757
 
            "Called when a stacked branch is activating its fallback "
1758
 
            "locations. transform_fallback_location is called with (branch, "
1759
 
            "url), and should return a new url. Returning the same url "
1760
 
            "allows it to be used as-is, returning a different one can be "
1761
 
            "used to cause the branch to stack on a closer copy of that "
1762
 
            "fallback_location. Note that the branch cannot have history "
1763
 
            "accessing methods called on it during this hook because the "
1764
 
            "fallback locations have not been activated. When there are "
1765
 
            "multiple hooks installed for transform_fallback_location, "
1766
 
            "all are called with the url returned from the previous hook."
1767
 
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
 
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'] = []
1785
1341
 
1786
1342
 
1787
1343
# install the default hooks into the Branch class.
1826
1382
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1383
 
1828
1384
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1385
class BzrBranchFormat4(BranchFormat):
1908
1386
    """Bzr branch format 4.
1909
1387
 
1916
1394
        """See BranchFormat.get_format_description()."""
1917
1395
        return "Branch format 4"
1918
1396
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1397
    def initialize(self, a_bzrdir):
1920
1398
        """Create a branch of this format in a_bzrdir."""
1921
1399
        utf8_files = [('revision-history', ''),
1922
1400
                      ('branch-name', ''),
1923
1401
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1402
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1403
                                       lock_type='branch4', set_format=False)
1926
1404
 
1927
1405
    def __init__(self):
1928
1406
        super(BzrBranchFormat4, self).__init__()
1929
1407
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1930
1408
 
1931
 
    def network_name(self):
1932
 
        """The network name for this format is the control dirs disk label."""
1933
 
        return self._matchingbzrdir.get_format_string()
 
1409
    def open(self, a_bzrdir, _found=False):
 
1410
        """Return the branch object for a_bzrdir
1934
1411
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """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
        """
1937
1415
        if not _found:
1938
1416
            # we are being called directly and must probe.
1939
1417
            raise NotImplementedError
1940
1418
        return BzrBranch(_format=self,
1941
1419
                         _control_files=a_bzrdir._control_files,
1942
1420
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1421
                         _repository=a_bzrdir.open_repository())
1945
1422
 
1946
1423
    def __str__(self):
1954
1431
        """What class to instantiate on open calls."""
1955
1432
        raise NotImplementedError(self._branch_class)
1956
1433
 
1957
 
    def network_name(self):
1958
 
        """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.
1959
1436
 
1960
 
        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.
1961
1439
        """
1962
 
        return self.get_format_string()
1963
 
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
 
        """See BranchFormat.open()."""
1966
1440
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1441
            format = BranchFormat.find_format(a_bzrdir)
1968
1442
            if format.__class__ != self.__class__:
1969
1443
                raise AssertionError("wrong format %r found for %r" %
1970
1444
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1445
        try:
 
1446
            transport = a_bzrdir.get_branch_transport(None)
1973
1447
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1448
                                                         lockdir.LockDir)
1975
1449
            return self._branch_class()(_format=self,
1976
1450
                              _control_files=control_files,
1977
 
                              name=name,
1978
1451
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
1452
                              _repository=a_bzrdir.find_repository())
1981
1453
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1454
            raise errors.NotBranchError(path=transport.base)
1983
1455
 
1984
1456
    def __init__(self):
1985
1457
        super(BranchFormatMetadir, self).__init__()
2014
1486
        """See BranchFormat.get_format_description()."""
2015
1487
        return "Branch format 5"
2016
1488
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1489
    def initialize(self, a_bzrdir):
2018
1490
        """Create a branch of this format in a_bzrdir."""
2019
1491
        utf8_files = [('revision-history', ''),
2020
1492
                      ('branch-name', ''),
2021
1493
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1494
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1495
 
2024
1496
    def supports_tags(self):
2025
1497
        return False
2047
1519
        """See BranchFormat.get_format_description()."""
2048
1520
        return "Branch format 6"
2049
1521
 
2050
 
    def initialize(self, a_bzrdir, name=None):
2051
 
        """Create a branch of this format in a_bzrdir."""
2052
 
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
2054
 
                      ('tags', ''),
2055
 
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2057
 
 
2058
 
    def make_tags(self, branch):
2059
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
2061
 
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
 
 
2065
 
 
2066
 
class BzrBranchFormat8(BranchFormatMetadir):
2067
 
    """Metadir format supporting storing locations of subtree branches."""
2068
 
 
2069
 
    def _branch_class(self):
2070
 
        return BzrBranch8
2071
 
 
2072
 
    def get_format_string(self):
2073
 
        """See BranchFormat.get_format_string()."""
2074
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
 
 
2076
 
    def get_format_description(self):
2077
 
        """See BranchFormat.get_format_description()."""
2078
 
        return "Branch format 8"
2079
 
 
2080
 
    def initialize(self, a_bzrdir, name=None):
2081
 
        """Create a branch of this format in a_bzrdir."""
2082
 
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
2084
 
                      ('tags', ''),
2085
 
                      ('references', '')
2086
 
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
2093
 
 
2094
 
    def make_tags(self, branch):
2095
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
2097
 
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
 
    def supports_stacking(self):
2102
 
        return True
2103
 
 
2104
 
    supports_reference_locations = True
2105
 
 
2106
 
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
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):
2108
1532
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1533
 
2110
1534
    The stacked location pointer is passed down to the repository and requires
2113
1537
    This format was introduced in bzr 1.6.
2114
1538
    """
2115
1539
 
2116
 
    def initialize(self, a_bzrdir, name=None):
2117
 
        """Create a branch of this format in a_bzrdir."""
2118
 
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
2120
 
                      ('tags', ''),
2121
 
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2123
 
 
2124
1540
    def _branch_class(self):
2125
1541
        return BzrBranch7
2126
1542
 
2132
1548
        """See BranchFormat.get_format_description()."""
2133
1549
        return "Branch format 7"
2134
1550
 
2135
 
    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):
2136
1565
        return True
2137
1566
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1567
 
2141
1568
class BranchReferenceFormat(BranchFormat):
2142
1569
    """Bzr branch reference format.
2160
1587
    def get_reference(self, a_bzrdir):
2161
1588
        """See BranchFormat.get_reference()."""
2162
1589
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1590
        return transport.get('location').read()
2164
1591
 
2165
1592
    def set_reference(self, a_bzrdir, to_branch):
2166
1593
        """See BranchFormat.set_reference()."""
2167
1594
        transport = a_bzrdir.get_branch_transport(None)
2168
1595
        location = transport.put_bytes('location', to_branch.base)
2169
1596
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1597
    def initialize(self, a_bzrdir, target_branch=None):
2171
1598
        """Create a branch of this format in a_bzrdir."""
2172
1599
        if target_branch is None:
2173
1600
            # this format does not implement branch itself, thus the implicit
2174
1601
            # creation contract must see it as uninitializable
2175
1602
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1603
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1604
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1605
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1606
            target_branch.bzrdir.root_transport.base)
2180
1607
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1608
        return self.open(
 
1609
            a_bzrdir, _found=True,
2183
1610
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1611
 
2187
1612
    def __init__(self):
2188
1613
        super(BranchReferenceFormat, self).__init__()
2191
1616
 
2192
1617
    def _make_reference_clone_function(format, a_branch):
2193
1618
        """Create a clone() routine for a branch dynamically."""
2194
 
        def clone(to_bzrdir, revision_id=None,
2195
 
            repository_policy=None):
 
1619
        def clone(to_bzrdir, revision_id=None):
2196
1620
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1621
            return format.initialize(to_bzrdir, a_branch)
2198
1622
            # cannot obey revision_id limits when cloning a reference ...
2199
1623
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1624
            # emit some sort of warning/error to the caller ?!
2201
1625
        return clone
2202
1626
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
1627
    def open(self, a_bzrdir, _found=False, location=None,
 
1628
             possible_transports=None):
2205
1629
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1630
 
2207
 
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
 
        :param _found: a private parameter, do not use it. It is used to
2210
 
            indicate if format probing has already be done.
2211
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2212
 
            (if there are any).  Default is to open fallbacks.
2213
 
        :param location: The location of the referenced branch.  If
2214
 
            unspecified, this will be determined from the branch reference in
2215
 
            a_bzrdir.
2216
 
        :param possible_transports: An optional reusable transports list.
 
1631
        _found is a private parameter, do not use it. It is used to indicate
 
1632
               if format probing has already be done.
2217
1633
        """
2218
1634
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1635
            format = BranchFormat.find_format(a_bzrdir)
2220
1636
            if format.__class__ != self.__class__:
2221
1637
                raise AssertionError("wrong format %r found for %r" %
2222
1638
                    (format, self))
2224
1640
            location = self.get_reference(a_bzrdir)
2225
1641
        real_bzrdir = bzrdir.BzrDir.open(
2226
1642
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1643
        result = real_bzrdir.open_branch()
2229
1644
        # this changes the behaviour of result.clone to create a new reference
2230
1645
        # rather than a copy of the content of the branch.
2231
1646
        # I did not use a proxy object because that needs much more extensive
2238
1653
        return result
2239
1654
 
2240
1655
 
2241
 
network_format_registry = registry.FormatRegistry()
2242
 
"""Registry of formats indexed by their network name.
2243
 
 
2244
 
The network name for a branch format is an identifier that can be used when
2245
 
referring to formats with smart server operations. See
2246
 
BranchFormat.network_name() for more detail.
2247
 
"""
2248
 
 
2249
 
 
2250
1656
# formats which have no format string are not discoverable
2251
1657
# and not independently creatable, so are not registered.
2252
1658
__format5 = BzrBranchFormat5()
2253
1659
__format6 = BzrBranchFormat6()
2254
1660
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1661
BranchFormat.register_format(__format5)
2257
1662
BranchFormat.register_format(BranchReferenceFormat())
2258
1663
BranchFormat.register_format(__format6)
2259
1664
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1665
BranchFormat.set_default_format(__format6)
2262
1666
_legacy_formats = [BzrBranchFormat4(),
2263
 
    ]
2264
 
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
 
 
2267
 
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1667
                   ]
 
1668
 
 
1669
class BzrBranch(Branch):
2269
1670
    """A branch stored in the actual filesystem.
2270
1671
 
2271
1672
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1678
    :ivar repository: Repository for this branch.
2278
1679
    :ivar base: The url of the base directory for this branch; the one
2279
1680
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1681
    """
2283
1682
 
2284
1683
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1684
                 _control_files=None, a_bzrdir=None, _repository=None):
2287
1685
        """Create new branch object at a particular location."""
2288
1686
        if a_bzrdir is None:
2289
1687
            raise ValueError('a_bzrdir must be supplied')
2290
1688
        else:
2291
1689
            self.bzrdir = a_bzrdir
2292
1690
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1691
        # XXX: We should be able to just do
2295
1692
        #   self.base = self.bzrdir.root_transport.base
2296
1693
        # but this does not quite work yet -- mbp 20080522
2303
1700
        Branch.__init__(self)
2304
1701
 
2305
1702
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
1703
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1704
 
2312
1705
    __repr__ = __str__
2313
1706
 
2317
1710
 
2318
1711
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
1712
 
2320
 
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
2322
 
 
2323
1713
    def is_locked(self):
2324
1714
        return self.control_files.is_locked()
2325
1715
 
2326
1716
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
 
        # All-in-one needs to always unlock/lock.
2330
 
        repo_control = getattr(self.repository, 'control_files', None)
2331
 
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
 
            self.repository.lock_write()
2334
 
            took_lock = True
2335
 
        else:
2336
 
            took_lock = False
 
1717
        repo_token = self.repository.lock_write()
2337
1718
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1719
            token = self.control_files.lock_write(token=token)
2339
1720
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1721
            self.repository.unlock()
2342
1722
            raise
 
1723
        return token
2343
1724
 
2344
1725
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
 
        # All-in-one needs to always unlock/lock.
2348
 
        repo_control = getattr(self.repository, 'control_files', None)
2349
 
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
 
            self.repository.lock_read()
2352
 
            took_lock = True
2353
 
        else:
2354
 
            took_lock = False
 
1726
        self.repository.lock_read()
2355
1727
        try:
2356
1728
            self.control_files.lock_read()
2357
1729
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1730
            self.repository.unlock()
2360
1731
            raise
2361
1732
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1733
    def unlock(self):
 
1734
        # TODO: test for failed two phase locks. This is known broken.
2364
1735
        try:
2365
1736
            self.control_files.unlock()
2366
1737
        finally:
2367
 
            # All-in-one needs to always unlock/lock.
2368
 
            repo_control = getattr(self.repository, 'control_files', None)
2369
 
            if (self.control_files == repo_control or
2370
 
                not self.control_files.is_locked()):
2371
 
                self.repository.unlock()
2372
 
            if not self.control_files.is_locked():
2373
 
                # we just released the lock
2374
 
                self._clear_cached_state()
 
1738
            self.repository.unlock()
 
1739
        if not self.control_files.is_locked():
 
1740
            # we just released the lock
 
1741
            self._clear_cached_state()
2375
1742
 
2376
1743
    def peek_lock_mode(self):
2377
1744
        if self.control_files._lock_count == 0:
2496
1863
        """See Branch.basis_tree."""
2497
1864
        return self.repository.revision_tree(self.last_revision())
2498
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
 
2499
1909
    def _get_parent_location(self):
2500
1910
        _locs = ['parent', 'pull', 'x-pull']
2501
1911
        for l in _locs:
2505
1915
                pass
2506
1916
        return None
2507
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
 
2508
1983
    def _basic_push(self, target, overwrite, stop_revision):
2509
1984
        """Basic implementation of push without bound branches or hooks.
2510
1985
 
2511
 
        Must be called with source read locked and target write locked.
 
1986
        Must be called with self read locked and target write locked.
2512
1987
        """
2513
 
        result = BranchPushResult()
 
1988
        result = PushResult()
2514
1989
        result.source_branch = self
2515
1990
        result.target_branch = target
2516
1991
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
1992
        if result.old_revid != self.last_revision():
2519
1993
            # We assume that during 'push' this repository is closer than
2520
1994
            # the target.
2521
1995
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
1996
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
1997
                                    graph=graph)
2524
1998
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
1999
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2000
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2001
        return result
2529
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
 
2530
2025
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2026
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2027
 
2533
2028
    def set_push_location(self, location):
2534
2029
        """See Branch.set_push_location."""
2536
2031
            'push_location', location,
2537
2032
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
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
 
2539
2052
    def _set_parent_location(self, url):
2540
2053
        if url is None:
2541
2054
            self._transport.delete('parent')
2543
2056
            self._transport.put_bytes('parent', url + '\n',
2544
2057
                mode=self.bzrdir._get_file_mode())
2545
2058
 
 
2059
    def set_stacked_on_url(self, url):
 
2060
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2061
 
2546
2062
 
2547
2063
class BzrBranch5(BzrBranch):
2548
2064
    """A format 5 branch. This supports new features over plain branches.
2550
2066
    It has support for a master_branch which is the data for bound branches.
2551
2067
    """
2552
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
 
2553
2098
    def get_bound_location(self):
2554
2099
        try:
2555
2100
            return self._transport.get_bytes('bound')[:-1]
2642
2187
        return None
2643
2188
 
2644
2189
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """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))
2647
2204
 
2648
2205
    def _open_hook(self):
2649
 
        if self._ignore_fallbacks:
2650
 
            return
2651
2206
        try:
2652
2207
            url = self.get_stacked_on_url()
2653
2208
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2663
2218
                        "None, not a URL." % hook_name)
2664
2219
            self._activate_fallback_location(url)
2665
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
 
2666
2226
    def __init__(self, *args, **kwargs):
2667
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2227
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2228
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2229
        self._partial_revision_history_cache = []
2671
2230
 
2672
2231
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2232
        super(BzrBranch7, self)._clear_cached_state()
2674
2233
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2234
        self._partial_revision_history_cache = []
2676
2235
 
2677
2236
    def _last_revision_info(self):
2678
2237
        revision_string = self._transport.get_bytes('last-revision')
2724
2283
        if _mod_revision.is_null(last_revision):
2725
2284
            return
2726
2285
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2286
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2287
 
2729
2288
    def _gen_revision_history(self):
2730
2289
        """Generate the revision history from last revision
2733
2292
        self._extend_partial_history(stop_index=last_revno-1)
2734
2293
        return list(reversed(self._partial_revision_history_cache))
2735
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
 
2736
2324
    def _write_revision_history(self, history):
2737
2325
        """Factored out of set_revision_history.
2738
2326
 
2759
2347
        """Set the parent branch"""
2760
2348
        return self._get_config_location('parent_location')
2761
2349
 
2762
 
    @needs_write_lock
2763
 
    def _set_all_reference_info(self, info_dict):
2764
 
        """Replace all reference info stored in a branch.
2765
 
 
2766
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2767
 
        """
2768
 
        s = StringIO()
2769
 
        writer = rio.RioWriter(s)
2770
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2771
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
 
                                branch_location=branch_location)
2773
 
            writer.write_stanza(stanza)
2774
 
        self._transport.put_bytes('references', s.getvalue())
2775
 
        self._reference_info = info_dict
2776
 
 
2777
 
    @needs_read_lock
2778
 
    def _get_all_reference_info(self):
2779
 
        """Return all the reference info stored in a branch.
2780
 
 
2781
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2782
 
        """
2783
 
        if self._reference_info is not None:
2784
 
            return self._reference_info
2785
 
        rio_file = self._transport.get('references')
2786
 
        try:
2787
 
            stanzas = rio.read_stanzas(rio_file)
2788
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2789
 
                             s['branch_location'])) for s in stanzas)
2790
 
        finally:
2791
 
            rio_file.close()
2792
 
        self._reference_info = info_dict
2793
 
        return info_dict
2794
 
 
2795
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2796
 
        """Set the branch location to use for a tree reference.
2797
 
 
2798
 
        :param file_id: The file-id of the tree reference.
2799
 
        :param tree_path: The path of the tree reference in the tree.
2800
 
        :param branch_location: The location of the branch to retrieve tree
2801
 
            references from.
2802
 
        """
2803
 
        info_dict = self._get_all_reference_info()
2804
 
        info_dict[file_id] = (tree_path, branch_location)
2805
 
        if None in (tree_path, branch_location):
2806
 
            if tree_path is not None:
2807
 
                raise ValueError('tree_path must be None when branch_location'
2808
 
                                 ' is None.')
2809
 
            if branch_location is not None:
2810
 
                raise ValueError('branch_location must be None when tree_path'
2811
 
                                 ' is None.')
2812
 
            del info_dict[file_id]
2813
 
        self._set_all_reference_info(info_dict)
2814
 
 
2815
 
    def get_reference_info(self, file_id):
2816
 
        """Get the tree_path and branch_location for a tree reference.
2817
 
 
2818
 
        :return: a tuple of (tree_path, branch_location)
2819
 
        """
2820
 
        return self._get_all_reference_info().get(file_id, (None, None))
2821
 
 
2822
 
    def reference_parent(self, file_id, path, possible_transports=None):
2823
 
        """Return the parent branch for a tree-reference file_id.
2824
 
 
2825
 
        :param file_id: The file_id of the tree reference
2826
 
        :param path: The path of the file_id in the tree
2827
 
        :return: A branch associated with the file_id
2828
 
        """
2829
 
        branch_location = self.get_reference_info(file_id)[1]
2830
 
        if branch_location is None:
2831
 
            return Branch.reference_parent(self, file_id, path,
2832
 
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
2834
 
        return Branch.open(branch_location,
2835
 
                           possible_transports=possible_transports)
2836
 
 
2837
2350
    def set_push_location(self, location):
2838
2351
        """See Branch.set_push_location."""
2839
2352
        self._set_config_location('push_location', location)
2881
2394
            raise errors.NotStacked(self)
2882
2395
        return stacked_url
2883
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
 
2884
2431
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).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)
2887
2437
 
2888
2438
    @needs_write_lock
2889
2439
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2479
        return self.revno() - index
2930
2480
 
2931
2481
 
2932
 
class BzrBranch7(BzrBranch8):
2933
 
    """A branch with support for a fallback repository."""
2934
 
 
2935
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2936
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2937
 
 
2938
 
    def get_reference_info(self, file_id):
2939
 
        Branch.get_reference_info(self, file_id)
2940
 
 
2941
 
    def reference_parent(self, file_id, path, possible_transports=None):
2942
 
        return Branch.reference_parent(self, file_id, path,
2943
 
                                       possible_transports)
2944
 
 
2945
 
 
2946
2482
class BzrBranch6(BzrBranch7):
2947
2483
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2484
 
2951
2487
    """
2952
2488
 
2953
2489
    def get_stacked_on_url(self):
2954
 
        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)
2955
2494
 
2956
2495
 
2957
2496
######################################################################
2975
2514
    :ivar new_revno: Revision number after pull.
2976
2515
    :ivar old_revid: Tip revision id before pull.
2977
2516
    :ivar new_revid: Tip revision id after pull.
2978
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2517
    :ivar source_branch: Source (local) branch object.
2979
2518
    :ivar master_branch: Master branch of the target, or the target if no
2980
2519
        Master
2981
2520
    :ivar local_branch: target branch if there is a Master, else None
2982
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2521
    :ivar target_branch: Target/destination branch object.
2983
2522
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
2523
    """
2985
2524
 
2996
2535
        self._show_tag_conficts(to_file)
2997
2536
 
2998
2537
 
2999
 
class BranchPushResult(_Result):
 
2538
class PushResult(_Result):
3000
2539
    """Result of a Branch.push operation.
3001
2540
 
3002
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3003
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3004
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3005
 
        before the push.
3006
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3007
 
        after the push.
3008
 
    :ivar source_branch: Source branch object that the push was from. This is
3009
 
        read locked, and generally is a local (and thus low latency) branch.
3010
 
    :ivar master_branch: If target is a bound branch, the master branch of
3011
 
        target, or target itself. Always write locked.
3012
 
    :ivar target_branch: The direct Branch where data is being sent (write
3013
 
        locked).
3014
 
    :ivar local_branch: If the target is a bound branch this will be the
3015
 
        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.
3016
2548
    """
3017
2549
 
3018
2550
    def __int__(self):
3022
2554
    def report(self, to_file):
3023
2555
        """Write a human-readable description of the result."""
3024
2556
        if self.old_revid == self.new_revid:
3025
 
            note('No new revisions to push.')
 
2557
            to_file.write('No new revisions to push.\n')
3026
2558
        else:
3027
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2559
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3028
2560
        self._show_tag_conficts(to_file)
3029
2561
 
3030
2562
 
3036
2568
 
3037
2569
    def __init__(self, branch):
3038
2570
        self.branch = branch
3039
 
        self.errors = []
3040
2571
 
3041
2572
    def report_results(self, verbose):
3042
2573
        """Report the check results via trace.note.
3044
2575
        :param verbose: Requests more detailed display of what was checked,
3045
2576
            if any.
3046
2577
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
3049
 
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
2578
        note('checked branch %s format %s',
 
2579
             self.branch.base,
 
2580
             self.branch._format)
3051
2581
 
3052
2582
 
3053
2583
class Converter5to6(object):
3091
2621
        branch._transport.put_bytes('format', format.get_format_string())
3092
2622
 
3093
2623
 
3094
 
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
3096
 
 
3097
 
    def convert(self, branch):
3098
 
        format = BzrBranchFormat8()
3099
 
        branch._transport.put_bytes('references', '')
3100
 
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
2624
 
3104
2625
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2626
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3146
2667
    """The available optimised InterBranch types."""
3147
2668
 
3148
2669
    @staticmethod
3149
 
    def _get_branch_formats_to_test():
3150
 
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3152
 
 
3153
 
    def pull(self, overwrite=False, stop_revision=None,
3154
 
             possible_transports=None, local=False):
3155
 
        """Mirror source into target branch.
3156
 
 
3157
 
        The target branch is considered to be 'local', having low latency.
3158
 
 
3159
 
        :returns: PullResult instance
3160
 
        """
3161
 
        raise NotImplementedError(self.pull)
 
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)
3162
2673
 
3163
2674
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2675
                         graph=None):
3173
2684
        """
3174
2685
        raise NotImplementedError(self.update_revisions)
3175
2686
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
3177
 
             _override_hook_source_branch=None):
3178
 
        """Mirror the source branch into the target branch.
3179
 
 
3180
 
        The source branch is considered to be 'local', having low latency.
3181
 
        """
3182
 
        raise NotImplementedError(self.push)
3183
 
 
3184
2687
 
3185
2688
class GenericInterBranch(InterBranch):
3186
2689
    """InterBranch implementation that uses public Branch functions.
3187
2690
    """
3188
2691
 
3189
2692
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
 
2693
    def _get_branch_format_to_test():
 
2694
        return BranchFormat._default_format
3192
2695
 
3193
2696
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
2697
        graph=None):
3233
2736
        finally:
3234
2737
            self.source.unlock()
3235
2738
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
2739
    @classmethod
3358
2740
    def is_compatible(self, source, target):
3359
2741
        # GenericBranch uses the public API, so always compatible
3360
2742
        return True
3361
2743
 
3362
2744
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
 
 
3400
2745
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)