/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: Martin Pool
  • Date: 2009-03-12 05:32:56 UTC
  • mfrom: (4124 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4140.
  • Revision ID: mbp@sourcefrog.net-20090312053256-071khr6k4wwuuyja
merge news

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
49
from bzrlib import registry
54
50
from bzrlib.symbol_versioning import (
55
51
    deprecated_in,
63
59
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
60
 
65
61
 
66
 
class Branch(bzrdir.ControlComponent):
 
62
# TODO: Maybe include checks for common corruption of newlines, etc?
 
63
 
 
64
# TODO: Some operations like log might retrieve the same revisions
 
65
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
66
# cache in memory to make this faster.  In general anything can be
 
67
# cached in memory between lock and unlock operations. .. nb thats
 
68
# what the transaction identity map provides
 
69
 
 
70
 
 
71
######################################################################
 
72
# branch objects
 
73
 
 
74
class Branch(object):
67
75
    """Branch holding a history of revisions.
68
76
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
77
    base
 
78
        Base directory/url of the branch.
72
79
 
73
80
    hooks: An instance of BranchHooks.
74
81
    """
76
83
    # - RBC 20060112
77
84
    base = None
78
85
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
86
    def __init__(self, *ignored, **ignored_too):
88
87
        self.tags = self._format.make_tags(self)
89
88
        self._revision_history_cache = None
90
89
        self._revision_id_to_revno_cache = None
91
90
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
91
        self._last_revision_info_cache = None
94
92
        self._merge_sorted_revisions_cache = None
95
93
        self._open_hook()
100
98
    def _open_hook(self):
101
99
        """Called by init to allow simpler extension of the base class."""
102
100
 
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
101
    def break_lock(self):
111
102
        """Break a lock if one is present from another instance.
112
103
 
121
112
        if master is not None:
122
113
            master.break_lock()
123
114
 
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
115
    @staticmethod
159
116
    def open(base, _unsupported=False, possible_transports=None):
160
117
        """Open the branch rooted at base.
164
121
        """
165
122
        control = bzrdir.BzrDir.open(base, _unsupported,
166
123
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
124
        return control.open_branch(_unsupported)
168
125
 
169
126
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
127
    def open_from_transport(transport, _unsupported=False):
171
128
        """Open the branch rooted at transport"""
172
129
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
130
        return control.open_branch(_unsupported)
174
131
 
175
132
    @staticmethod
176
133
    def open_containing(url, possible_transports=None):
199
156
    def get_config(self):
200
157
        return BranchConfig(self)
201
158
 
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
159
    def _get_tags_bytes(self):
222
160
        """Get the bytes of a serialised tags dict.
223
161
 
283
221
        new_history.reverse()
284
222
        return new_history
285
223
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
224
    def lock_write(self):
293
225
        raise NotImplementedError(self.lock_write)
294
226
 
295
227
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
228
        raise NotImplementedError(self.lock_read)
302
229
 
303
230
    def unlock(self):
428
355
            * 'include' - the stop revision is the last item in the result
429
356
            * 'with-merges' - include the stop revision and all of its
430
357
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
358
        :param direction: either 'reverse' or 'forward':
434
359
            * reverse means return the start_revision_id first, i.e.
435
360
              start at the most recent revision and go backwards in history
457
382
        # start_revision_id.
458
383
        if self._merge_sorted_revisions_cache is None:
459
384
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
385
            graph = self.repository.get_graph()
 
386
            parent_map = dict(((key, value) for key, value in
 
387
                     graph.iter_ancestry([last_revision]) if value is not None))
 
388
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
389
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
390
                generate_revno=True)
 
391
            # Drop the sequence # before caching
 
392
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
393
 
464
394
        filtered = self._filter_merge_sorted_revisions(
465
395
            self._merge_sorted_revisions_cache, start_revision_id,
466
396
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
397
        if direction == 'reverse':
471
398
            return filtered
472
399
        if direction == 'forward':
479
406
        """Iterate over an inclusive range of sorted revisions."""
480
407
        rev_iter = iter(merge_sorted_revisions)
481
408
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
409
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
410
                if rev_id != start_revision_id:
485
411
                    continue
486
412
                else:
487
413
                    # The decision to include the start or not
488
414
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
415
                    rev_iter = chain(
 
416
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
417
                        rev_iter)
491
418
                    break
492
419
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
420
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
421
                yield rev_id, depth, revno, end_of_merge
498
422
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
423
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
424
                if rev_id == stop_revision_id:
502
425
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
426
                yield rev_id, depth, revno, end_of_merge
505
427
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
428
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
429
                yield rev_id, depth, revno, end_of_merge
510
430
                if rev_id == stop_revision_id:
511
431
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
432
        elif stop_rule == 'with-merges':
525
433
            stop_rev = self.repository.get_revision(stop_revision_id)
526
434
            if stop_rev.parent_ids:
527
435
                left_parent = stop_rev.parent_ids[0]
528
436
            else:
529
437
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
438
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
439
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
440
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
441
                yield rev_id, depth, revno, end_of_merge
549
442
        else:
550
443
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
444
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
445
    def leave_lock_in_place(self):
598
446
        """Tell this branch object not to release the physical lock when this
599
447
        object is unlocked.
616
464
        :param other: The branch to bind to
617
465
        :type other: Branch
618
466
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
620
 
 
621
 
    def set_append_revisions_only(self, enabled):
622
 
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
624
 
        if enabled:
625
 
            value = 'True'
626
 
        else:
627
 
            value = 'False'
628
 
        self.get_config().set_user_option('append_revisions_only', value,
629
 
            warn_masked=True)
630
 
 
631
 
    def set_reference_info(self, file_id, tree_path, branch_location):
632
 
        """Set the branch location to use for a tree reference."""
633
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
634
 
 
635
 
    def get_reference_info(self, file_id):
636
 
        """Get the tree_path and branch_location for a tree reference."""
637
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
467
        raise errors.UpgradeRequired(self.base)
638
468
 
639
469
    @needs_write_lock
640
470
    def fetch(self, from_branch, last_revision=None, pb=None):
648
478
        """
649
479
        if self.base == from_branch.base:
650
480
            return (0, [])
651
 
        if pb is not None:
652
 
            symbol_versioning.warn(
653
 
                symbol_versioning.deprecated_in((1, 14, 0))
654
 
                % "pb parameter to fetch()")
 
481
        if pb is None:
 
482
            nested_pb = ui.ui_factory.nested_progress_bar()
 
483
            pb = nested_pb
 
484
        else:
 
485
            nested_pb = None
 
486
 
655
487
        from_branch.lock_read()
656
488
        try:
657
489
            if last_revision is None:
 
490
                pb.update('get source history')
658
491
                last_revision = from_branch.last_revision()
659
492
                last_revision = _mod_revision.ensure_null(last_revision)
660
493
            return self.repository.fetch(from_branch.repository,
661
494
                                         revision_id=last_revision,
662
 
                                         pb=pb)
 
495
                                         pb=nested_pb)
663
496
        finally:
 
497
            if nested_pb is not None:
 
498
                nested_pb.finished()
664
499
            from_branch.unlock()
665
500
 
666
501
    def get_bound_location(self):
674
509
    def get_old_bound_location(self):
675
510
        """Return the URL of the branch we used to be bound to
676
511
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
512
        raise errors.UpgradeRequired(self.base)
678
513
 
679
514
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
515
                           timezone=None, committer=None, revprops=None,
730
565
    def set_revision_history(self, rev_history):
731
566
        raise NotImplementedError(self.set_revision_history)
732
567
 
733
 
    @needs_write_lock
734
 
    def set_parent(self, url):
735
 
        """See Branch.set_parent."""
736
 
        # TODO: Maybe delete old location files?
737
 
        # URLs should never be unicode, even on the local fs,
738
 
        # FIXUP this and get_parent in a future branch format bump:
739
 
        # read and rewrite the file. RBC 20060125
740
 
        if url is not None:
741
 
            if isinstance(url, unicode):
742
 
                try:
743
 
                    url = url.encode('ascii')
744
 
                except UnicodeEncodeError:
745
 
                    raise errors.InvalidURL(url,
746
 
                        "Urls must be 7-bit ascii, "
747
 
                        "use bzrlib.urlutils.escape")
748
 
            url = urlutils.relative_url(self.base, url)
749
 
        self._set_parent_location(url)
750
 
 
751
 
    @needs_write_lock
752
568
    def set_stacked_on_url(self, url):
753
569
        """Set the URL this branch is stacked against.
754
570
 
757
573
        :raises UnstackableRepositoryFormat: If the repository does not support
758
574
            stacking.
759
575
        """
760
 
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
765
 
        self._check_stackable_repo()
766
 
        if not url:
767
 
            try:
768
 
                old_url = self.get_stacked_on_url()
769
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
 
                errors.UnstackableRepositoryFormat):
771
 
                return
772
 
            self._unstack()
773
 
        else:
774
 
            self._activate_fallback_location(url)
775
 
        # write this out after the repository is stacked to avoid setting a
776
 
        # stacked config that doesn't work.
777
 
        self._set_config_location('stacked_on_location', url)
778
 
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
 
576
        raise NotImplementedError(self.set_stacked_on_url)
833
577
 
834
578
    def _set_tags_bytes(self, bytes):
835
579
        """Mirror method for _get_tags_bytes.
871
615
        self._revision_id_to_revno_cache = None
872
616
        self._last_revision_info_cache = None
873
617
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
618
 
877
619
    def _gen_revision_history(self):
878
620
        """Return sequence of revision hashes on to this branch.
915
657
 
916
658
    def unbind(self):
917
659
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
660
        raise errors.UpgradeRequired(self.base)
 
661
 
 
662
    def set_append_revisions_only(self, enabled):
 
663
        """Older format branches are never restricted to append-only"""
 
664
        raise errors.UpgradeRequired(self.base)
919
665
 
920
666
    def last_revision(self):
921
667
        """Return last revision id, or NULL_REVISION."""
1002
748
        except ValueError:
1003
749
            raise errors.NoSuchRevision(self, revision_id)
1004
750
 
1005
 
    @needs_read_lock
1006
751
    def get_rev_id(self, revno, history=None):
1007
752
        """Find the revision id of the specified revno."""
1008
753
        if revno == 0:
1009
754
            return _mod_revision.NULL_REVISION
1010
 
        last_revno, last_revid = self.last_revision_info()
1011
 
        if revno == last_revno:
1012
 
            return last_revid
1013
 
        if revno <= 0 or revno > last_revno:
 
755
        if history is None:
 
756
            history = self.revision_history()
 
757
        if revno <= 0 or revno > len(history):
1014
758
            raise errors.NoSuchRevision(self, revno)
1015
 
        distance_from_last = last_revno - revno
1016
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1017
 
            self._extend_partial_history(distance_from_last)
1018
 
        return self._partial_revision_history_cache[distance_from_last]
 
759
        return history[revno - 1]
1019
760
 
1020
 
    @needs_write_lock
1021
761
    def pull(self, source, overwrite=False, stop_revision=None,
1022
 
             possible_transports=None, *args, **kwargs):
 
762
             possible_transports=None, _override_hook_target=None):
1023
763
        """Mirror source into this branch.
1024
764
 
1025
765
        This branch is considered to be 'local', having low latency.
1026
766
 
1027
767
        :returns: PullResult instance
1028
768
        """
1029
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
 
            stop_revision=stop_revision,
1031
 
            possible_transports=possible_transports, *args, **kwargs)
 
769
        raise NotImplementedError(self.pull)
1032
770
 
1033
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1034
 
        **kwargs):
 
771
    def push(self, target, overwrite=False, stop_revision=None):
1035
772
        """Mirror this branch into target.
1036
773
 
1037
774
        This branch is considered to be 'local', having low latency.
1038
775
        """
1039
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1040
 
            *args, **kwargs)
1041
 
 
1042
 
    def lossy_push(self, target, stop_revision=None):
1043
 
        """Push deltas into another branch.
1044
 
 
1045
 
        :note: This does not, like push, retain the revision ids from 
1046
 
            the source branch and will, rather than adding bzr-specific 
1047
 
            metadata, push only those semantics of the revision that can be 
1048
 
            natively represented by this branch' VCS.
1049
 
 
1050
 
        :param target: Target branch
1051
 
        :param stop_revision: Revision to push, defaults to last revision.
1052
 
        :return: BranchPushResult with an extra member revidmap: 
1053
 
            A dictionary mapping revision ids from the target branch 
1054
 
            to new revision ids in the target branch, for each 
1055
 
            revision that was pushed.
1056
 
        """
1057
 
        inter = InterBranch.get(self, target)
1058
 
        lossy_push = getattr(inter, "lossy_push", None)
1059
 
        if lossy_push is None:
1060
 
            raise errors.LossyPushToSameVCS(self, target)
1061
 
        return lossy_push(stop_revision)
 
776
        raise NotImplementedError(self.push)
1062
777
 
1063
778
    def basis_tree(self):
1064
779
        """Return `Tree` object for last revision."""
1081
796
        try:
1082
797
            return urlutils.join(self.base[:-1], parent)
1083
798
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
799
            raise errors.InaccessibleParent(parent, self.base)
1085
800
 
1086
801
    def _get_parent_location(self):
1087
802
        raise NotImplementedError(self._get_parent_location)
1104
819
            location = None
1105
820
        return location
1106
821
 
1107
 
    def get_child_submit_format(self):
1108
 
        """Return the preferred format of submissions to this branch."""
1109
 
        return self.get_config().get_user_option("child_submit_format")
1110
 
 
1111
822
    def get_submit_branch(self):
1112
823
        """Return the submit location of the branch.
1113
824
 
1130
841
    def get_public_branch(self):
1131
842
        """Return the public location of the branch.
1132
843
 
1133
 
        This is used by merge directives.
 
844
        This is is used by merge directives.
1134
845
        """
1135
846
        return self._get_config_location('public_branch')
1136
847
 
1172
883
        params = ChangeBranchTipParams(
1173
884
            self, old_revno, new_revno, old_revid, new_revid)
1174
885
        for hook in hooks:
1175
 
            hook(params)
 
886
            try:
 
887
                hook(params)
 
888
            except errors.TipChangeRejected:
 
889
                raise
 
890
            except Exception:
 
891
                exc_info = sys.exc_info()
 
892
                hook_name = Branch.hooks.get_hook_name(hook)
 
893
                raise errors.HookFailed(
 
894
                    'pre_change_branch_tip', hook_name, exc_info)
 
895
 
 
896
    def set_parent(self, url):
 
897
        raise NotImplementedError(self.set_parent)
1176
898
 
1177
899
    @needs_write_lock
1178
900
    def update(self):
1209
931
                     be truncated to end with revision_id.
1210
932
        """
1211
933
        result = to_bzrdir.create_branch()
1212
 
        result.lock_write()
1213
 
        try:
1214
 
            if repository_policy is not None:
1215
 
                repository_policy.configure_branch(result)
1216
 
            self.copy_content_into(result, revision_id=revision_id)
1217
 
        finally:
1218
 
            result.unlock()
1219
 
        return result
 
934
        if repository_policy is not None:
 
935
            repository_policy.configure_branch(result)
 
936
        self.copy_content_into(result, revision_id=revision_id)
 
937
        return  result
1220
938
 
1221
939
    @needs_read_lock
1222
940
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1227
945
        revision_id: if not None, the revision history in the new branch will
1228
946
                     be truncated to end with revision_id.
1229
947
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
948
        result = to_bzrdir.create_branch()
1234
 
        result.lock_write()
1235
 
        try:
1236
 
            if repository_policy is not None:
1237
 
                repository_policy.configure_branch(result)
1238
 
            self.copy_content_into(result, revision_id=revision_id)
1239
 
            result.set_parent(self.bzrdir.root_transport.base)
1240
 
        finally:
1241
 
            result.unlock()
 
949
        if repository_policy is not None:
 
950
            repository_policy.configure_branch(result)
 
951
        self.copy_content_into(result, revision_id=revision_id)
 
952
        result.set_parent(self.bzrdir.root_transport.base)
1242
953
        return result
1243
954
 
1244
955
    def _synchronize_history(self, destination, revision_id):
1256
967
        source_revno, source_revision_id = self.last_revision_info()
1257
968
        if revision_id is None:
1258
969
            revno, revision_id = source_revno, source_revision_id
 
970
        elif source_revision_id == revision_id:
 
971
            # we know the revno without needing to walk all of history
 
972
            revno = source_revno
1259
973
        else:
1260
 
            graph = self.repository.get_graph()
1261
 
            try:
1262
 
                revno = graph.find_distance_to_null(revision_id, 
1263
 
                    [(source_revision_id, source_revno)])
1264
 
            except errors.GhostRevisionsHaveNoRevno:
1265
 
                # Default to 1, if we can't find anything else
1266
 
                revno = 1
 
974
            # To figure out the revno for a random revision, we need to build
 
975
            # the revision history, and count its length.
 
976
            # We don't care about the order, just how long it is.
 
977
            # Alternatively, we could start at the current location, and count
 
978
            # backwards. But there is no guarantee that we will find it since
 
979
            # it may be a merged revision.
 
980
            revno = len(list(self.repository.iter_reverse_revision_history(
 
981
                                                                revision_id)))
1267
982
        destination.set_last_revision_info(revno, revision_id)
1268
983
 
1269
984
    @needs_read_lock
1273
988
        revision_id: if not None, the revision history in the new branch will
1274
989
                     be truncated to end with revision_id.
1275
990
        """
1276
 
        self.update_references(destination)
1277
991
        self._synchronize_history(destination, revision_id)
1278
992
        try:
1279
993
            parent = self.get_parent()
1285
999
        if self._push_should_merge_tags():
1286
1000
            self.tags.merge_to(destination.tags)
1287
1001
 
1288
 
    def update_references(self, target):
1289
 
        if not getattr(self._format, 'supports_reference_locations', False):
1290
 
            return
1291
 
        reference_dict = self._get_all_reference_info()
1292
 
        if len(reference_dict) == 0:
1293
 
            return
1294
 
        old_base = self.base
1295
 
        new_base = target.base
1296
 
        target_reference_dict = target._get_all_reference_info()
1297
 
        for file_id, (tree_path, branch_location) in (
1298
 
            reference_dict.items()):
1299
 
            branch_location = urlutils.rebase_url(branch_location,
1300
 
                                                  old_base, new_base)
1301
 
            target_reference_dict.setdefault(
1302
 
                file_id, (tree_path, branch_location))
1303
 
        target._set_all_reference_info(target_reference_dict)
1304
 
 
1305
1002
    @needs_read_lock
1306
 
    def check(self, refs):
 
1003
    def check(self):
1307
1004
        """Check consistency of the branch.
1308
1005
 
1309
1006
        In particular this checks that revisions given in the revision-history
1312
1009
 
1313
1010
        Callers will typically also want to check the repository.
1314
1011
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1012
        :return: A BranchCheckResult.
1318
1013
        """
1319
 
        result = BranchCheckResult(self)
 
1014
        mainline_parent_id = None
1320
1015
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
1016
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1017
                                last_revision_id))
 
1018
        real_rev_history.reverse()
 
1019
        if len(real_rev_history) != last_revno:
 
1020
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1021
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1022
        # TODO: We should probably also check that real_rev_history actually
 
1023
        #       matches self.revision_history()
 
1024
        for revision_id in real_rev_history:
 
1025
            try:
 
1026
                revision = self.repository.get_revision(revision_id)
 
1027
            except errors.NoSuchRevision, e:
 
1028
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1029
                            % revision_id)
 
1030
            # In general the first entry on the revision history has no parents.
 
1031
            # But it's not illegal for it to have parents listed; this can happen
 
1032
            # in imports from Arch when the parents weren't reachable.
 
1033
            if mainline_parent_id is not None:
 
1034
                if mainline_parent_id not in revision.parent_ids:
 
1035
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1036
                                        "parents of {%s}"
 
1037
                                        % (mainline_parent_id, revision_id))
 
1038
            mainline_parent_id = revision_id
 
1039
        return BranchCheckResult(self)
1332
1040
 
1333
1041
    def _get_checkout_format(self):
1334
1042
        """Return the most suitable metadir for a checkout of this branch.
1344
1052
        return format
1345
1053
 
1346
1054
    def create_clone_on_transport(self, to_transport, revision_id=None,
1347
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1055
        stacked_on=None):
1348
1056
        """Create a clone of this branch and its bzrdir.
1349
1057
 
1350
1058
        :param to_transport: The transport to clone onto.
1351
1059
        :param revision_id: The revision id to use as tip in the new branch.
1352
1060
            If None the tip is obtained from this branch.
1353
1061
        :param stacked_on: An optional URL to stack the clone on.
1354
 
        :param create_prefix: Create any missing directories leading up to
1355
 
            to_transport.
1356
 
        :param use_existing_dir: Use an existing directory if one exists.
1357
1062
        """
1358
1063
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1064
        # clone call. Or something. 20090224 RBC/spiv.
1360
 
        if revision_id is None:
1361
 
            revision_id = self.last_revision()
1362
1065
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1066
            revision_id=revision_id, stacked_on=stacked_on)
1365
1067
        return dir_to.open_branch()
1366
1068
 
1367
1069
    def create_checkout(self, to_location, revision_id=None,
1386
1088
        if lightweight:
1387
1089
            format = self._get_checkout_format()
1388
1090
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1091
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1092
        else:
1392
1093
            format = self._get_checkout_format()
1393
1094
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1422
1123
        reconciler.reconcile()
1423
1124
        return reconciler
1424
1125
 
1425
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1126
    def reference_parent(self, file_id, path):
1426
1127
        """Return the parent branch for a tree-reference file_id
1427
1128
        :param file_id: The file_id of the tree reference
1428
1129
        :param path: The path of the file_id in the tree
1429
1130
        :return: A branch associated with the file_id
1430
1131
        """
1431
1132
        # FIXME should provide multiple branches, based on config
1432
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
 
                           possible_transports=possible_transports)
 
1133
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1434
1134
 
1435
1135
    def supports_tags(self):
1436
1136
        return self._format.supports_tags()
1437
1137
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1138
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1139
                                         other_branch):
1452
1140
        """Ensure that revision_b is a descendant of revision_a.
1507
1195
    _formats = {}
1508
1196
    """The known formats."""
1509
1197
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1198
    def __eq__(self, other):
1513
1199
        return self.__class__ is other.__class__
1514
1200
 
1516
1202
        return not (self == other)
1517
1203
 
1518
1204
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1205
    def find_format(klass, a_bzrdir):
1520
1206
        """Return the format for the branch object in a_bzrdir."""
1521
1207
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1208
            transport = a_bzrdir.get_branch_transport(None)
 
1209
            format_string = transport.get("format").read()
1524
1210
            return klass._formats[format_string]
1525
1211
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1212
            raise errors.NotBranchError(path=transport.base)
1527
1213
        except KeyError:
1528
1214
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1215
 
1565
1251
        """Return the short format description for this format."""
1566
1252
        raise NotImplementedError(self.get_format_description)
1567
1253
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1254
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1255
                           set_format=True):
1578
1256
        """Initialize a branch in a bzrdir, with specified files
1579
1257
 
1580
1258
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1259
        :param utf8_files: The files to create as a list of
1582
1260
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1261
        :param set_format: If True, set the format with
1585
1262
            self.get_format_string.  (BzrBranch4 has its format set
1586
1263
            elsewhere)
1587
1264
        :return: a branch in this format
1588
1265
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1266
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1267
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1268
        lock_map = {
1592
1269
            'metadir': ('lock', lockdir.LockDir),
1593
1270
            'branch4': ('branch-lock', lockable_files.TransportLock),
1596
1273
        control_files = lockable_files.LockableFiles(branch_transport,
1597
1274
            lock_name, lock_class)
1598
1275
        control_files.create_lock()
1599
 
        try:
1600
 
            control_files.lock_write()
1601
 
        except errors.LockContention:
1602
 
            if lock_type != 'branch4':
1603
 
                raise
1604
 
            lock_taken = False
1605
 
        else:
1606
 
            lock_taken = True
 
1276
        control_files.lock_write()
1607
1277
        if set_format:
1608
1278
            utf8_files += [('format', self.get_format_string())]
1609
1279
        try:
1612
1282
                    filename, content,
1613
1283
                    mode=a_bzrdir._get_file_mode())
1614
1284
        finally:
1615
 
            if lock_taken:
1616
 
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1285
            control_files.unlock()
 
1286
        return self.open(a_bzrdir, _found=True)
1620
1287
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1288
    def initialize(self, a_bzrdir):
 
1289
        """Create a branch of this format in a_bzrdir."""
1626
1290
        raise NotImplementedError(self.initialize)
1627
1291
 
1628
1292
    def is_supported(self):
1658
1322
        """
1659
1323
        raise NotImplementedError(self.network_name)
1660
1324
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1325
    def open(self, a_bzrdir, _found=False):
1662
1326
        """Return the branch object for a_bzrdir
1663
1327
 
1664
 
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
 
        :param _found: a private parameter, do not use it. It is used to
1667
 
            indicate if format probing has already be done.
1668
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1669
 
            (if there are any).  Default is to open fallbacks.
 
1328
        _found is a private parameter, do not use it. It is used to indicate
 
1329
               if format probing has already be done.
1670
1330
        """
1671
1331
        raise NotImplementedError(self.open)
1672
1332
 
1682
1342
    def set_default_format(klass, format):
1683
1343
        klass._default_format = format
1684
1344
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1345
    def supports_stacking(self):
1690
1346
        """True if this format records a stacked-on branch."""
1691
1347
        return False
1716
1372
        notified.
1717
1373
        """
1718
1374
        Hooks.__init__(self)
1719
 
        self.create_hook(HookPoint('set_rh',
1720
 
            "Invoked whenever the revision history has been set via "
1721
 
            "set_revision_history. The api signature is (branch, "
1722
 
            "revision_history), and the branch will be write-locked. "
1723
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1724
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('open',
1726
 
            "Called with the Branch object that has been opened after a "
1727
 
            "branch is opened.", (1, 8), None))
1728
 
        self.create_hook(HookPoint('post_push',
1729
 
            "Called after a push operation completes. post_push is called "
1730
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
 
            "bzr client.", (0, 15), None))
1732
 
        self.create_hook(HookPoint('post_pull',
1733
 
            "Called after a pull operation completes. post_pull is called "
1734
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1735
 
            "bzr client.", (0, 15), None))
1736
 
        self.create_hook(HookPoint('pre_commit',
1737
 
            "Called after a commit is calculated but before it is is "
1738
 
            "completed. pre_commit is called with (local, master, old_revno, "
1739
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1741
 
            "tree_delta is a TreeDelta object describing changes from the "
1742
 
            "basis revision. hooks MUST NOT modify this delta. "
1743
 
            " future_tree is an in-memory tree obtained from "
1744
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
 
            "tree.", (0,91), None))
1746
 
        self.create_hook(HookPoint('post_commit',
1747
 
            "Called in the bzr client after a commit has completed. "
1748
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1749
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
 
            "commit to a branch.", (0, 15), None))
1751
 
        self.create_hook(HookPoint('post_uncommit',
1752
 
            "Called in the bzr client after an uncommit completes. "
1753
 
            "post_uncommit is called with (local, master, old_revno, "
1754
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1755
 
            "or None, master is the target branch, and an empty branch "
1756
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1758
 
            "Called in bzr client and server before a change to the tip of a "
1759
 
            "branch is made. pre_change_branch_tip is called with a "
1760
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1762
 
        self.create_hook(HookPoint('post_change_branch_tip',
1763
 
            "Called in bzr client and server after a change to the tip of a "
1764
 
            "branch is made. post_change_branch_tip is called with a "
1765
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1767
 
        self.create_hook(HookPoint('transform_fallback_location',
1768
 
            "Called when a stacked branch is activating its fallback "
1769
 
            "locations. transform_fallback_location is called with (branch, "
1770
 
            "url), and should return a new url. Returning the same url "
1771
 
            "allows it to be used as-is, returning a different one can be "
1772
 
            "used to cause the branch to stack on a closer copy of that "
1773
 
            "fallback_location. Note that the branch cannot have history "
1774
 
            "accessing methods called on it during this hook because the "
1775
 
            "fallback locations have not been activated. When there are "
1776
 
            "multiple hooks installed for transform_fallback_location, "
1777
 
            "all are called with the url returned from the previous hook."
1778
 
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
 
1375
        # Introduced in 0.15:
 
1376
        # invoked whenever the revision history has been set
 
1377
        # with set_revision_history. The api signature is
 
1378
        # (branch, revision_history), and the branch will
 
1379
        # be write-locked.
 
1380
        self['set_rh'] = []
 
1381
        # Invoked after a branch is opened. The api signature is (branch).
 
1382
        self['open'] = []
 
1383
        # invoked after a push operation completes.
 
1384
        # the api signature is
 
1385
        # (push_result)
 
1386
        # containing the members
 
1387
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1388
        # where local is the local target branch or None, master is the target
 
1389
        # master branch, and the rest should be self explanatory. The source
 
1390
        # is read locked and the target branches write locked. Source will
 
1391
        # be the local low-latency branch.
 
1392
        self['post_push'] = []
 
1393
        # invoked after a pull operation completes.
 
1394
        # the api signature is
 
1395
        # (pull_result)
 
1396
        # containing the members
 
1397
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1398
        # where local is the local branch or None, master is the target
 
1399
        # master branch, and the rest should be self explanatory. The source
 
1400
        # is read locked and the target branches write locked. The local
 
1401
        # branch is the low-latency branch.
 
1402
        self['post_pull'] = []
 
1403
        # invoked before a commit operation takes place.
 
1404
        # the api signature is
 
1405
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1406
        #  tree_delta, future_tree).
 
1407
        # old_revid is NULL_REVISION for the first commit to a branch
 
1408
        # tree_delta is a TreeDelta object describing changes from the basis
 
1409
        # revision, hooks MUST NOT modify this delta
 
1410
        # future_tree is an in-memory tree obtained from
 
1411
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1412
        self['pre_commit'] = []
 
1413
        # invoked after a commit operation completes.
 
1414
        # the api signature is
 
1415
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1416
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1417
        self['post_commit'] = []
 
1418
        # invoked after a uncommit operation completes.
 
1419
        # the api signature is
 
1420
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1421
        # local is the local branch or None, master is the target branch,
 
1422
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1423
        self['post_uncommit'] = []
 
1424
        # Introduced in 1.6
 
1425
        # Invoked before the tip of a branch changes.
 
1426
        # the api signature is
 
1427
        # (params) where params is a ChangeBranchTipParams with the members
 
1428
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1429
        self['pre_change_branch_tip'] = []
 
1430
        # Introduced in 1.4
 
1431
        # Invoked after the tip of a branch changes.
 
1432
        # the api signature is
 
1433
        # (params) where params is a ChangeBranchTipParams with the members
 
1434
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1435
        self['post_change_branch_tip'] = []
 
1436
        # Introduced in 1.9
 
1437
        # Invoked when a stacked branch activates its fallback locations and
 
1438
        # allows the transformation of the url of said location.
 
1439
        # the api signature is
 
1440
        # (branch, url) where branch is the branch having its fallback
 
1441
        # location activated and url is the url for the fallback location.
 
1442
        # The hook should return a url.
 
1443
        self['transform_fallback_location'] = []
1796
1444
 
1797
1445
 
1798
1446
# install the default hooks into the Branch class.
1837
1485
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1486
 
1839
1487
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1488
class BzrBranchFormat4(BranchFormat):
1919
1489
    """Bzr branch format 4.
1920
1490
 
1927
1497
        """See BranchFormat.get_format_description()."""
1928
1498
        return "Branch format 4"
1929
1499
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1500
    def initialize(self, a_bzrdir):
1931
1501
        """Create a branch of this format in a_bzrdir."""
1932
1502
        utf8_files = [('revision-history', ''),
1933
1503
                      ('branch-name', ''),
1934
1504
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1505
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1506
                                       lock_type='branch4', set_format=False)
1937
1507
 
1938
1508
    def __init__(self):
1943
1513
        """The network name for this format is the control dirs disk label."""
1944
1514
        return self._matchingbzrdir.get_format_string()
1945
1515
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
 
        """See BranchFormat.open()."""
 
1516
    def open(self, a_bzrdir, _found=False):
 
1517
        """Return the branch object for a_bzrdir
 
1518
 
 
1519
        _found is a private parameter, do not use it. It is used to indicate
 
1520
               if format probing has already be done.
 
1521
        """
1948
1522
        if not _found:
1949
1523
            # we are being called directly and must probe.
1950
1524
            raise NotImplementedError
1951
1525
        return BzrBranch(_format=self,
1952
1526
                         _control_files=a_bzrdir._control_files,
1953
1527
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1528
                         _repository=a_bzrdir.open_repository())
1956
1529
 
1957
1530
    def __str__(self):
1972
1545
        """
1973
1546
        return self.get_format_string()
1974
1547
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
 
        """See BranchFormat.open()."""
 
1548
    def open(self, a_bzrdir, _found=False):
 
1549
        """Return the branch object for a_bzrdir.
 
1550
 
 
1551
        _found is a private parameter, do not use it. It is used to indicate
 
1552
               if format probing has already be done.
 
1553
        """
1977
1554
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1555
            format = BranchFormat.find_format(a_bzrdir)
1979
1556
            if format.__class__ != self.__class__:
1980
1557
                raise AssertionError("wrong format %r found for %r" %
1981
1558
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1559
        try:
 
1560
            transport = a_bzrdir.get_branch_transport(None)
1984
1561
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1562
                                                         lockdir.LockDir)
1986
1563
            return self._branch_class()(_format=self,
1987
1564
                              _control_files=control_files,
1988
 
                              name=name,
1989
1565
                              a_bzrdir=a_bzrdir,
1990
 
                              _repository=a_bzrdir.find_repository(),
1991
 
                              ignore_fallbacks=ignore_fallbacks)
 
1566
                              _repository=a_bzrdir.find_repository())
1992
1567
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1568
            raise errors.NotBranchError(path=transport.base)
1994
1569
 
1995
1570
    def __init__(self):
1996
1571
        super(BranchFormatMetadir, self).__init__()
2025
1600
        """See BranchFormat.get_format_description()."""
2026
1601
        return "Branch format 5"
2027
1602
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1603
    def initialize(self, a_bzrdir):
2029
1604
        """Create a branch of this format in a_bzrdir."""
2030
1605
        utf8_files = [('revision-history', ''),
2031
1606
                      ('branch-name', ''),
2032
1607
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1608
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1609
 
2035
1610
    def supports_tags(self):
2036
1611
        return False
2058
1633
        """See BranchFormat.get_format_description()."""
2059
1634
        return "Branch format 6"
2060
1635
 
2061
 
    def initialize(self, a_bzrdir, name=None):
2062
 
        """Create a branch of this format in a_bzrdir."""
2063
 
        utf8_files = [('last-revision', '0 null:\n'),
2064
 
                      ('branch.conf', ''),
2065
 
                      ('tags', ''),
2066
 
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2068
 
 
2069
 
    def make_tags(self, branch):
2070
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
 
        return BasicTags(branch)
2072
 
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
 
 
2076
 
 
2077
 
class BzrBranchFormat8(BranchFormatMetadir):
2078
 
    """Metadir format supporting storing locations of subtree branches."""
2079
 
 
2080
 
    def _branch_class(self):
2081
 
        return BzrBranch8
2082
 
 
2083
 
    def get_format_string(self):
2084
 
        """See BranchFormat.get_format_string()."""
2085
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2086
 
 
2087
 
    def get_format_description(self):
2088
 
        """See BranchFormat.get_format_description()."""
2089
 
        return "Branch format 8"
2090
 
 
2091
 
    def initialize(self, a_bzrdir, name=None):
2092
 
        """Create a branch of this format in a_bzrdir."""
2093
 
        utf8_files = [('last-revision', '0 null:\n'),
2094
 
                      ('branch.conf', ''),
2095
 
                      ('tags', ''),
2096
 
                      ('references', '')
2097
 
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2099
 
 
2100
 
    def __init__(self):
2101
 
        super(BzrBranchFormat8, self).__init__()
2102
 
        self._matchingbzrdir.repository_format = \
2103
 
            RepositoryFormatKnitPack5RichRoot()
2104
 
 
2105
 
    def make_tags(self, branch):
2106
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
 
        return BasicTags(branch)
2108
 
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
 
    def supports_stacking(self):
2113
 
        return True
2114
 
 
2115
 
    supports_reference_locations = True
2116
 
 
2117
 
 
2118
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1636
    def initialize(self, a_bzrdir):
 
1637
        """Create a branch of this format in a_bzrdir."""
 
1638
        utf8_files = [('last-revision', '0 null:\n'),
 
1639
                      ('branch.conf', ''),
 
1640
                      ('tags', ''),
 
1641
                      ]
 
1642
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1643
 
 
1644
    def make_tags(self, branch):
 
1645
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1646
        return BasicTags(branch)
 
1647
 
 
1648
 
 
1649
 
 
1650
class BzrBranchFormat7(BranchFormatMetadir):
2119
1651
    """Branch format with last-revision, tags, and a stacked location pointer.
2120
1652
 
2121
1653
    The stacked location pointer is passed down to the repository and requires
2124
1656
    This format was introduced in bzr 1.6.
2125
1657
    """
2126
1658
 
2127
 
    def initialize(self, a_bzrdir, name=None):
2128
 
        """Create a branch of this format in a_bzrdir."""
2129
 
        utf8_files = [('last-revision', '0 null:\n'),
2130
 
                      ('branch.conf', ''),
2131
 
                      ('tags', ''),
2132
 
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2134
 
 
2135
1659
    def _branch_class(self):
2136
1660
        return BzrBranch7
2137
1661
 
2143
1667
        """See BranchFormat.get_format_description()."""
2144
1668
        return "Branch format 7"
2145
1669
 
2146
 
    def supports_set_append_revisions_only(self):
 
1670
    def initialize(self, a_bzrdir):
 
1671
        """Create a branch of this format in a_bzrdir."""
 
1672
        utf8_files = [('last-revision', '0 null:\n'),
 
1673
                      ('branch.conf', ''),
 
1674
                      ('tags', ''),
 
1675
                      ]
 
1676
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1677
 
 
1678
    def __init__(self):
 
1679
        super(BzrBranchFormat7, self).__init__()
 
1680
        self._matchingbzrdir.repository_format = \
 
1681
            RepositoryFormatKnitPack5RichRoot()
 
1682
 
 
1683
    def make_tags(self, branch):
 
1684
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1685
        return BasicTags(branch)
 
1686
 
 
1687
    def supports_stacking(self):
2147
1688
        return True
2148
1689
 
2149
 
    supports_reference_locations = False
2150
 
 
2151
1690
 
2152
1691
class BranchReferenceFormat(BranchFormat):
2153
1692
    """Bzr branch reference format.
2171
1710
    def get_reference(self, a_bzrdir):
2172
1711
        """See BranchFormat.get_reference()."""
2173
1712
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1713
        return transport.get('location').read()
2175
1714
 
2176
1715
    def set_reference(self, a_bzrdir, to_branch):
2177
1716
        """See BranchFormat.set_reference()."""
2178
1717
        transport = a_bzrdir.get_branch_transport(None)
2179
1718
        location = transport.put_bytes('location', to_branch.base)
2180
1719
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1720
    def initialize(self, a_bzrdir, target_branch=None):
2182
1721
        """Create a branch of this format in a_bzrdir."""
2183
1722
        if target_branch is None:
2184
1723
            # this format does not implement branch itself, thus the implicit
2185
1724
            # creation contract must see it as uninitializable
2186
1725
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1726
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1727
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1728
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1729
            target_branch.bzrdir.root_transport.base)
2191
1730
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1731
        return self.open(
 
1732
            a_bzrdir, _found=True,
2194
1733
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1734
 
2198
1735
    def __init__(self):
2199
1736
        super(BranchReferenceFormat, self).__init__()
2205
1742
        def clone(to_bzrdir, revision_id=None,
2206
1743
            repository_policy=None):
2207
1744
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1745
            return format.initialize(to_bzrdir, a_branch)
2209
1746
            # cannot obey revision_id limits when cloning a reference ...
2210
1747
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1748
            # emit some sort of warning/error to the caller ?!
2212
1749
        return clone
2213
1750
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
 
             possible_transports=None, ignore_fallbacks=False):
 
1751
    def open(self, a_bzrdir, _found=False, location=None,
 
1752
             possible_transports=None):
2216
1753
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1754
 
2218
 
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
 
        :param _found: a private parameter, do not use it. It is used to
2221
 
            indicate if format probing has already be done.
2222
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2223
 
            (if there are any).  Default is to open fallbacks.
2224
 
        :param location: The location of the referenced branch.  If
2225
 
            unspecified, this will be determined from the branch reference in
2226
 
            a_bzrdir.
2227
 
        :param possible_transports: An optional reusable transports list.
 
1755
        _found is a private parameter, do not use it. It is used to indicate
 
1756
               if format probing has already be done.
2228
1757
        """
2229
1758
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1759
            format = BranchFormat.find_format(a_bzrdir)
2231
1760
            if format.__class__ != self.__class__:
2232
1761
                raise AssertionError("wrong format %r found for %r" %
2233
1762
                    (format, self))
2235
1764
            location = self.get_reference(a_bzrdir)
2236
1765
        real_bzrdir = bzrdir.BzrDir.open(
2237
1766
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1767
        result = real_bzrdir.open_branch()
2240
1768
        # this changes the behaviour of result.clone to create a new reference
2241
1769
        # rather than a copy of the content of the branch.
2242
1770
        # I did not use a proxy object because that needs much more extensive
2263
1791
__format5 = BzrBranchFormat5()
2264
1792
__format6 = BzrBranchFormat6()
2265
1793
__format7 = BzrBranchFormat7()
2266
 
__format8 = BzrBranchFormat8()
2267
1794
BranchFormat.register_format(__format5)
2268
1795
BranchFormat.register_format(BranchReferenceFormat())
2269
1796
BranchFormat.register_format(__format6)
2270
1797
BranchFormat.register_format(__format7)
2271
 
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1798
BranchFormat.set_default_format(__format6)
2273
1799
_legacy_formats = [BzrBranchFormat4(),
2274
1800
    ]
2275
1801
network_format_registry.register(
2276
1802
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
1803
 
2278
1804
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1805
class BzrBranch(Branch):
2293
1806
    """A branch stored in the actual filesystem.
2294
1807
 
2295
1808
    Note that it's "local" in the context of the filesystem; it doesn't
2301
1814
    :ivar repository: Repository for this branch.
2302
1815
    :ivar base: The url of the base directory for this branch; the one
2303
1816
        containing the .bzr directory.
2304
 
    :ivar name: Optional colocated branch name as it exists in the control
2305
 
        directory.
2306
1817
    """
2307
1818
 
2308
1819
    def __init__(self, _format=None,
2309
 
                 _control_files=None, a_bzrdir=None, name=None,
2310
 
                 _repository=None, ignore_fallbacks=False):
 
1820
                 _control_files=None, a_bzrdir=None, _repository=None):
2311
1821
        """Create new branch object at a particular location."""
2312
1822
        if a_bzrdir is None:
2313
1823
            raise ValueError('a_bzrdir must be supplied')
2314
1824
        else:
2315
1825
            self.bzrdir = a_bzrdir
2316
1826
        self._base = self.bzrdir.transport.clone('..').base
2317
 
        self.name = name
2318
1827
        # XXX: We should be able to just do
2319
1828
        #   self.base = self.bzrdir.root_transport.base
2320
1829
        # but this does not quite work yet -- mbp 20080522
2327
1836
        Branch.__init__(self)
2328
1837
 
2329
1838
    def __str__(self):
2330
 
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2332
 
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
1839
        return '%s(%r)' % (self.__class__.__name__, self.base)
2335
1840
 
2336
1841
    __repr__ = __str__
2337
1842
 
2341
1846
 
2342
1847
    base = property(_get_base, doc="The URL for the root of this branch.")
2343
1848
 
2344
 
    def _get_config(self):
2345
 
        return TransportConfig(self._transport, 'branch.conf')
2346
 
 
2347
1849
    def is_locked(self):
2348
1850
        return self.control_files.is_locked()
2349
1851
 
2350
1852
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
 
        if not self.is_locked():
2358
 
            self._note_lock('w')
2359
 
        # All-in-one needs to always unlock/lock.
2360
 
        repo_control = getattr(self.repository, 'control_files', None)
2361
 
        if self.control_files == repo_control or not self.is_locked():
2362
 
            self.repository._warn_if_deprecated(self)
2363
 
            self.repository.lock_write()
2364
 
            took_lock = True
2365
 
        else:
2366
 
            took_lock = False
 
1853
        repo_token = self.repository.lock_write()
2367
1854
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
1855
            token = self.control_files.lock_write(token=token)
2370
1856
        except:
2371
 
            if took_lock:
2372
 
                self.repository.unlock()
 
1857
            self.repository.unlock()
2373
1858
            raise
 
1859
        return token
2374
1860
 
2375
1861
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
 
        if not self.is_locked():
2382
 
            self._note_lock('r')
2383
 
        # All-in-one needs to always unlock/lock.
2384
 
        repo_control = getattr(self.repository, 'control_files', None)
2385
 
        if self.control_files == repo_control or not self.is_locked():
2386
 
            self.repository._warn_if_deprecated(self)
2387
 
            self.repository.lock_read()
2388
 
            took_lock = True
2389
 
        else:
2390
 
            took_lock = False
 
1862
        self.repository.lock_read()
2391
1863
        try:
2392
1864
            self.control_files.lock_read()
2393
 
            return self
2394
1865
        except:
2395
 
            if took_lock:
2396
 
                self.repository.unlock()
 
1866
            self.repository.unlock()
2397
1867
            raise
2398
1868
 
2399
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1869
    def unlock(self):
 
1870
        # TODO: test for failed two phase locks. This is known broken.
2401
1871
        try:
2402
1872
            self.control_files.unlock()
2403
1873
        finally:
2404
 
            # All-in-one needs to always unlock/lock.
2405
 
            repo_control = getattr(self.repository, 'control_files', None)
2406
 
            if (self.control_files == repo_control or
2407
 
                not self.control_files.is_locked()):
2408
 
                self.repository.unlock()
2409
 
            if not self.control_files.is_locked():
2410
 
                # we just released the lock
2411
 
                self._clear_cached_state()
 
1874
            self.repository.unlock()
 
1875
        if not self.control_files.is_locked():
 
1876
            # we just released the lock
 
1877
            self._clear_cached_state()
2412
1878
 
2413
1879
    def peek_lock_mode(self):
2414
1880
        if self.control_files._lock_count == 0:
2533
1999
        """See Branch.basis_tree."""
2534
2000
        return self.repository.revision_tree(self.last_revision())
2535
2001
 
 
2002
    @needs_write_lock
 
2003
    def pull(self, source, overwrite=False, stop_revision=None,
 
2004
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2005
             _override_hook_target=None):
 
2006
        """See Branch.pull.
 
2007
 
 
2008
        :param _hook_master: Private parameter - set the branch to
 
2009
            be supplied as the master to pull hooks.
 
2010
        :param run_hooks: Private parameter - if false, this branch
 
2011
            is being called because it's the master of the primary branch,
 
2012
            so it should not run its hooks.
 
2013
        :param _override_hook_target: Private parameter - set the branch to be
 
2014
            supplied as the target_branch to pull hooks.
 
2015
        """
 
2016
        result = PullResult()
 
2017
        result.source_branch = source
 
2018
        if _override_hook_target is None:
 
2019
            result.target_branch = self
 
2020
        else:
 
2021
            result.target_branch = _override_hook_target
 
2022
        source.lock_read()
 
2023
        try:
 
2024
            # We assume that during 'pull' the local repository is closer than
 
2025
            # the remote one.
 
2026
            graph = self.repository.get_graph(source.repository)
 
2027
            result.old_revno, result.old_revid = self.last_revision_info()
 
2028
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2029
                                  graph=graph)
 
2030
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2031
            result.new_revno, result.new_revid = self.last_revision_info()
 
2032
            if _hook_master:
 
2033
                result.master_branch = _hook_master
 
2034
                result.local_branch = result.target_branch
 
2035
            else:
 
2036
                result.master_branch = result.target_branch
 
2037
                result.local_branch = None
 
2038
            if run_hooks:
 
2039
                for hook in Branch.hooks['post_pull']:
 
2040
                    hook(result)
 
2041
        finally:
 
2042
            source.unlock()
 
2043
        return result
 
2044
 
2536
2045
    def _get_parent_location(self):
2537
2046
        _locs = ['parent', 'pull', 'x-pull']
2538
2047
        for l in _locs:
2542
2051
                pass
2543
2052
        return None
2544
2053
 
 
2054
    @needs_read_lock
 
2055
    def push(self, target, overwrite=False, stop_revision=None,
 
2056
             _override_hook_source_branch=None):
 
2057
        """See Branch.push.
 
2058
 
 
2059
        This is the basic concrete implementation of push()
 
2060
 
 
2061
        :param _override_hook_source_branch: If specified, run
 
2062
        the hooks passing this Branch as the source, rather than self.
 
2063
        This is for use of RemoteBranch, where push is delegated to the
 
2064
        underlying vfs-based Branch.
 
2065
        """
 
2066
        # TODO: Public option to disable running hooks - should be trivial but
 
2067
        # needs tests.
 
2068
        return _run_with_write_locked_target(
 
2069
            target, self._push_with_bound_branches, target, overwrite,
 
2070
            stop_revision,
 
2071
            _override_hook_source_branch=_override_hook_source_branch)
 
2072
 
 
2073
    def _push_with_bound_branches(self, target, overwrite,
 
2074
            stop_revision,
 
2075
            _override_hook_source_branch=None):
 
2076
        """Push from self into target, and into target's master if any.
 
2077
 
 
2078
        This is on the base BzrBranch class even though it doesn't support
 
2079
        bound branches because the *target* might be bound.
 
2080
        """
 
2081
        def _run_hooks():
 
2082
            if _override_hook_source_branch:
 
2083
                result.source_branch = _override_hook_source_branch
 
2084
            for hook in Branch.hooks['post_push']:
 
2085
                hook(result)
 
2086
 
 
2087
        bound_location = target.get_bound_location()
 
2088
        if bound_location and target.base != bound_location:
 
2089
            # there is a master branch.
 
2090
            #
 
2091
            # XXX: Why the second check?  Is it even supported for a branch to
 
2092
            # be bound to itself? -- mbp 20070507
 
2093
            master_branch = target.get_master_branch()
 
2094
            master_branch.lock_write()
 
2095
            try:
 
2096
                # push into the master from this branch.
 
2097
                self._basic_push(master_branch, overwrite, stop_revision)
 
2098
                # and push into the target branch from this. Note that we push from
 
2099
                # this branch again, because its considered the highest bandwidth
 
2100
                # repository.
 
2101
                result = self._basic_push(target, overwrite, stop_revision)
 
2102
                result.master_branch = master_branch
 
2103
                result.local_branch = target
 
2104
                _run_hooks()
 
2105
                return result
 
2106
            finally:
 
2107
                master_branch.unlock()
 
2108
        else:
 
2109
            # no master branch
 
2110
            result = self._basic_push(target, overwrite, stop_revision)
 
2111
            # TODO: Why set master_branch and local_branch if there's no
 
2112
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2113
            # 20070504
 
2114
            result.master_branch = target
 
2115
            result.local_branch = None
 
2116
            _run_hooks()
 
2117
            return result
 
2118
 
2545
2119
    def _basic_push(self, target, overwrite, stop_revision):
2546
2120
        """Basic implementation of push without bound branches or hooks.
2547
2121
 
2548
 
        Must be called with source read locked and target write locked.
 
2122
        Must be called with self read locked and target write locked.
2549
2123
        """
2550
 
        result = BranchPushResult()
 
2124
        result = PushResult()
2551
2125
        result.source_branch = self
2552
2126
        result.target_branch = target
2553
2127
        result.old_revno, result.old_revid = target.last_revision_info()
2554
 
        self.update_references(target)
2555
2128
        if result.old_revid != self.last_revision():
2556
2129
            # We assume that during 'push' this repository is closer than
2557
2130
            # the target.
2558
2131
            graph = self.repository.get_graph(target.repository)
2559
 
            target.update_revisions(self, stop_revision,
2560
 
                overwrite=overwrite, graph=graph)
 
2132
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2133
                                    graph=graph)
2561
2134
        if self._push_should_merge_tags():
2562
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2563
 
                overwrite)
 
2135
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
2136
        result.new_revno, result.new_revid = target.last_revision_info()
2565
2137
        return result
2566
2138
 
2567
2139
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2140
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2141
 
2570
2142
    def set_push_location(self, location):
2571
2143
        """See Branch.set_push_location."""
2573
2145
            'push_location', location,
2574
2146
            store=_mod_config.STORE_LOCATION_NORECURSE)
2575
2147
 
 
2148
    @needs_write_lock
 
2149
    def set_parent(self, url):
 
2150
        """See Branch.set_parent."""
 
2151
        # TODO: Maybe delete old location files?
 
2152
        # URLs should never be unicode, even on the local fs,
 
2153
        # FIXUP this and get_parent in a future branch format bump:
 
2154
        # read and rewrite the file. RBC 20060125
 
2155
        if url is not None:
 
2156
            if isinstance(url, unicode):
 
2157
                try:
 
2158
                    url = url.encode('ascii')
 
2159
                except UnicodeEncodeError:
 
2160
                    raise errors.InvalidURL(url,
 
2161
                        "Urls must be 7-bit ascii, "
 
2162
                        "use bzrlib.urlutils.escape")
 
2163
            url = urlutils.relative_url(self.base, url)
 
2164
        self._set_parent_location(url)
 
2165
 
2576
2166
    def _set_parent_location(self, url):
2577
2167
        if url is None:
2578
2168
            self._transport.delete('parent')
2580
2170
            self._transport.put_bytes('parent', url + '\n',
2581
2171
                mode=self.bzrdir._get_file_mode())
2582
2172
 
 
2173
    def set_stacked_on_url(self, url):
 
2174
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2175
 
2583
2176
 
2584
2177
class BzrBranch5(BzrBranch):
2585
2178
    """A format 5 branch. This supports new features over plain branches.
2587
2180
    It has support for a master_branch which is the data for bound branches.
2588
2181
    """
2589
2182
 
 
2183
    @needs_write_lock
 
2184
    def pull(self, source, overwrite=False, stop_revision=None,
 
2185
             run_hooks=True, possible_transports=None,
 
2186
             _override_hook_target=None):
 
2187
        """Pull from source into self, updating my master if any.
 
2188
 
 
2189
        :param run_hooks: Private parameter - if false, this branch
 
2190
            is being called because it's the master of the primary branch,
 
2191
            so it should not run its hooks.
 
2192
        """
 
2193
        bound_location = self.get_bound_location()
 
2194
        master_branch = None
 
2195
        if bound_location and source.base != bound_location:
 
2196
            # not pulling from master, so we need to update master.
 
2197
            master_branch = self.get_master_branch(possible_transports)
 
2198
            master_branch.lock_write()
 
2199
        try:
 
2200
            if master_branch:
 
2201
                # pull from source into master.
 
2202
                master_branch.pull(source, overwrite, stop_revision,
 
2203
                    run_hooks=False)
 
2204
            return super(BzrBranch5, self).pull(source, overwrite,
 
2205
                stop_revision, _hook_master=master_branch,
 
2206
                run_hooks=run_hooks,
 
2207
                _override_hook_target=_override_hook_target)
 
2208
        finally:
 
2209
            if master_branch:
 
2210
                master_branch.unlock()
 
2211
 
2590
2212
    def get_bound_location(self):
2591
2213
        try:
2592
2214
            return self._transport.get_bytes('bound')[:-1]
2679
2301
        return None
2680
2302
 
2681
2303
 
2682
 
class BzrBranch8(BzrBranch5):
2683
 
    """A branch that stores tree-reference locations."""
 
2304
class BzrBranch7(BzrBranch5):
 
2305
    """A branch with support for a fallback repository."""
 
2306
 
 
2307
    def _get_fallback_repository(self, url):
 
2308
        """Get the repository we fallback to at url."""
 
2309
        url = urlutils.join(self.base, url)
 
2310
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2311
                                      possible_transports=[self._transport])
 
2312
        return a_bzrdir.open_branch().repository
 
2313
 
 
2314
    def _activate_fallback_location(self, url):
 
2315
        """Activate the branch/repository from url as a fallback repository."""
 
2316
        self.repository.add_fallback_repository(
 
2317
            self._get_fallback_repository(url))
2684
2318
 
2685
2319
    def _open_hook(self):
2686
 
        if self._ignore_fallbacks:
2687
 
            return
2688
2320
        try:
2689
2321
            url = self.get_stacked_on_url()
2690
2322
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2700
2332
                        "None, not a URL." % hook_name)
2701
2333
            self._activate_fallback_location(url)
2702
2334
 
 
2335
    def _check_stackable_repo(self):
 
2336
        if not self.repository._format.supports_external_lookups:
 
2337
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2338
                self.repository.base)
 
2339
 
2703
2340
    def __init__(self, *args, **kwargs):
2704
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2341
        super(BzrBranch7, self).__init__(*args, **kwargs)
2706
2342
        self._last_revision_info_cache = None
2707
 
        self._reference_info = None
 
2343
        self._partial_revision_history_cache = []
2708
2344
 
2709
2345
    def _clear_cached_state(self):
2710
 
        super(BzrBranch8, self)._clear_cached_state()
 
2346
        super(BzrBranch7, self)._clear_cached_state()
2711
2347
        self._last_revision_info_cache = None
2712
 
        self._reference_info = None
 
2348
        self._partial_revision_history_cache = []
2713
2349
 
2714
2350
    def _last_revision_info(self):
2715
2351
        revision_string = self._transport.get_bytes('last-revision')
2761
2397
        if _mod_revision.is_null(last_revision):
2762
2398
            return
2763
2399
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2400
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2401
 
2766
2402
    def _gen_revision_history(self):
2767
2403
        """Generate the revision history from last revision
2770
2406
        self._extend_partial_history(stop_index=last_revno-1)
2771
2407
        return list(reversed(self._partial_revision_history_cache))
2772
2408
 
 
2409
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2410
        """Extend the partial history to include a given index
 
2411
 
 
2412
        If a stop_index is supplied, stop when that index has been reached.
 
2413
        If a stop_revision is supplied, stop when that revision is
 
2414
        encountered.  Otherwise, stop when the beginning of history is
 
2415
        reached.
 
2416
 
 
2417
        :param stop_index: The index which should be present.  When it is
 
2418
            present, history extension will stop.
 
2419
        :param revision_id: The revision id which should be present.  When
 
2420
            it is encountered, history extension will stop.
 
2421
        """
 
2422
        repo = self.repository
 
2423
        if len(self._partial_revision_history_cache) == 0:
 
2424
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2425
        else:
 
2426
            start_revision = self._partial_revision_history_cache[-1]
 
2427
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2428
            #skip the last revision in the list
 
2429
            next_revision = iterator.next()
 
2430
        for revision_id in iterator:
 
2431
            self._partial_revision_history_cache.append(revision_id)
 
2432
            if (stop_index is not None and
 
2433
                len(self._partial_revision_history_cache) > stop_index):
 
2434
                break
 
2435
            if revision_id == stop_revision:
 
2436
                break
 
2437
 
2773
2438
    def _write_revision_history(self, history):
2774
2439
        """Factored out of set_revision_history.
2775
2440
 
2796
2461
        """Set the parent branch"""
2797
2462
        return self._get_config_location('parent_location')
2798
2463
 
2799
 
    @needs_write_lock
2800
 
    def _set_all_reference_info(self, info_dict):
2801
 
        """Replace all reference info stored in a branch.
2802
 
 
2803
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2804
 
        """
2805
 
        s = StringIO()
2806
 
        writer = rio.RioWriter(s)
2807
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2808
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
 
                                branch_location=branch_location)
2810
 
            writer.write_stanza(stanza)
2811
 
        self._transport.put_bytes('references', s.getvalue())
2812
 
        self._reference_info = info_dict
2813
 
 
2814
 
    @needs_read_lock
2815
 
    def _get_all_reference_info(self):
2816
 
        """Return all the reference info stored in a branch.
2817
 
 
2818
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2819
 
        """
2820
 
        if self._reference_info is not None:
2821
 
            return self._reference_info
2822
 
        rio_file = self._transport.get('references')
2823
 
        try:
2824
 
            stanzas = rio.read_stanzas(rio_file)
2825
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2826
 
                             s['branch_location'])) for s in stanzas)
2827
 
        finally:
2828
 
            rio_file.close()
2829
 
        self._reference_info = info_dict
2830
 
        return info_dict
2831
 
 
2832
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2833
 
        """Set the branch location to use for a tree reference.
2834
 
 
2835
 
        :param file_id: The file-id of the tree reference.
2836
 
        :param tree_path: The path of the tree reference in the tree.
2837
 
        :param branch_location: The location of the branch to retrieve tree
2838
 
            references from.
2839
 
        """
2840
 
        info_dict = self._get_all_reference_info()
2841
 
        info_dict[file_id] = (tree_path, branch_location)
2842
 
        if None in (tree_path, branch_location):
2843
 
            if tree_path is not None:
2844
 
                raise ValueError('tree_path must be None when branch_location'
2845
 
                                 ' is None.')
2846
 
            if branch_location is not None:
2847
 
                raise ValueError('branch_location must be None when tree_path'
2848
 
                                 ' is None.')
2849
 
            del info_dict[file_id]
2850
 
        self._set_all_reference_info(info_dict)
2851
 
 
2852
 
    def get_reference_info(self, file_id):
2853
 
        """Get the tree_path and branch_location for a tree reference.
2854
 
 
2855
 
        :return: a tuple of (tree_path, branch_location)
2856
 
        """
2857
 
        return self._get_all_reference_info().get(file_id, (None, None))
2858
 
 
2859
 
    def reference_parent(self, file_id, path, possible_transports=None):
2860
 
        """Return the parent branch for a tree-reference file_id.
2861
 
 
2862
 
        :param file_id: The file_id of the tree reference
2863
 
        :param path: The path of the file_id in the tree
2864
 
        :return: A branch associated with the file_id
2865
 
        """
2866
 
        branch_location = self.get_reference_info(file_id)[1]
2867
 
        if branch_location is None:
2868
 
            return Branch.reference_parent(self, file_id, path,
2869
 
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
2871
 
        return Branch.open(branch_location,
2872
 
                           possible_transports=possible_transports)
2873
 
 
2874
2464
    def set_push_location(self, location):
2875
2465
        """See Branch.set_push_location."""
2876
2466
        self._set_config_location('push_location', location)
2918
2508
            raise errors.NotStacked(self)
2919
2509
        return stacked_url
2920
2510
 
 
2511
    def set_append_revisions_only(self, enabled):
 
2512
        if enabled:
 
2513
            value = 'True'
 
2514
        else:
 
2515
            value = 'False'
 
2516
        self.get_config().set_user_option('append_revisions_only', value,
 
2517
            warn_masked=True)
 
2518
 
 
2519
    def set_stacked_on_url(self, url):
 
2520
        self._check_stackable_repo()
 
2521
        if not url:
 
2522
            try:
 
2523
                old_url = self.get_stacked_on_url()
 
2524
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2525
                errors.UnstackableRepositoryFormat):
 
2526
                return
 
2527
            url = ''
 
2528
            # repositories don't offer an interface to remove fallback
 
2529
            # repositories today; take the conceptually simpler option and just
 
2530
            # reopen it.
 
2531
            self.repository = self.bzrdir.find_repository()
 
2532
            # for every revision reference the branch has, ensure it is pulled
 
2533
            # in.
 
2534
            source_repository = self._get_fallback_repository(old_url)
 
2535
            for revision_id in chain([self.last_revision()],
 
2536
                self.tags.get_reverse_tag_dict()):
 
2537
                self.repository.fetch(source_repository, revision_id,
 
2538
                    find_ghosts=True)
 
2539
        else:
 
2540
            self._activate_fallback_location(url)
 
2541
        # write this out after the repository is stacked to avoid setting a
 
2542
        # stacked config that doesn't work.
 
2543
        self._set_config_location('stacked_on_location', url)
 
2544
 
2921
2545
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2546
        value = self.get_config().get_user_option('append_revisions_only')
 
2547
        return value == 'True'
2924
2548
 
2925
2549
    @needs_write_lock
2926
2550
    def generate_revision_history(self, revision_id, last_rev=None,
2966
2590
        return self.revno() - index
2967
2591
 
2968
2592
 
2969
 
class BzrBranch7(BzrBranch8):
2970
 
    """A branch with support for a fallback repository."""
2971
 
 
2972
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2973
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2974
 
 
2975
 
    def get_reference_info(self, file_id):
2976
 
        Branch.get_reference_info(self, file_id)
2977
 
 
2978
 
    def reference_parent(self, file_id, path, possible_transports=None):
2979
 
        return Branch.reference_parent(self, file_id, path,
2980
 
                                       possible_transports)
2981
 
 
2982
 
 
2983
2593
class BzrBranch6(BzrBranch7):
2984
2594
    """See BzrBranchFormat6 for the capabilities of this branch.
2985
2595
 
2988
2598
    """
2989
2599
 
2990
2600
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2601
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2602
 
 
2603
    def set_stacked_on_url(self, url):
 
2604
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2605
 
2993
2606
 
2994
2607
######################################################################
3012
2625
    :ivar new_revno: Revision number after pull.
3013
2626
    :ivar old_revid: Tip revision id before pull.
3014
2627
    :ivar new_revid: Tip revision id after pull.
3015
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2628
    :ivar source_branch: Source (local) branch object.
3016
2629
    :ivar master_branch: Master branch of the target, or the target if no
3017
2630
        Master
3018
2631
    :ivar local_branch: target branch if there is a Master, else None
3019
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2632
    :ivar target_branch: Target/destination branch object.
3020
2633
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3021
2634
    """
3022
2635
 
3033
2646
        self._show_tag_conficts(to_file)
3034
2647
 
3035
2648
 
3036
 
class BranchPushResult(_Result):
 
2649
class PushResult(_Result):
3037
2650
    """Result of a Branch.push operation.
3038
2651
 
3039
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3040
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3041
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3042
 
        before the push.
3043
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3044
 
        after the push.
3045
 
    :ivar source_branch: Source branch object that the push was from. This is
3046
 
        read locked, and generally is a local (and thus low latency) branch.
3047
 
    :ivar master_branch: If target is a bound branch, the master branch of
3048
 
        target, or target itself. Always write locked.
3049
 
    :ivar target_branch: The direct Branch where data is being sent (write
3050
 
        locked).
3051
 
    :ivar local_branch: If the target is a bound branch this will be the
3052
 
        target, otherwise it will be None.
 
2652
    :ivar old_revno: Revision number before push.
 
2653
    :ivar new_revno: Revision number after push.
 
2654
    :ivar old_revid: Tip revision id before push.
 
2655
    :ivar new_revid: Tip revision id after push.
 
2656
    :ivar source_branch: Source branch object.
 
2657
    :ivar master_branch: Master branch of the target, or None.
 
2658
    :ivar target_branch: Target/destination branch object.
3053
2659
    """
3054
2660
 
3055
2661
    def __int__(self):
3073
2679
 
3074
2680
    def __init__(self, branch):
3075
2681
        self.branch = branch
3076
 
        self.errors = []
3077
2682
 
3078
2683
    def report_results(self, verbose):
3079
2684
        """Report the check results via trace.note.
3081
2686
        :param verbose: Requests more detailed display of what was checked,
3082
2687
            if any.
3083
2688
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
3085
 
            self.branch._format)
3086
 
        for error in self.errors:
3087
 
            note('found error:%s', error)
 
2689
        note('checked branch %s format %s',
 
2690
             self.branch.base,
 
2691
             self.branch._format)
3088
2692
 
3089
2693
 
3090
2694
class Converter5to6(object):
3128
2732
        branch._transport.put_bytes('format', format.get_format_string())
3129
2733
 
3130
2734
 
3131
 
class Converter7to8(object):
3132
 
    """Perform an in-place upgrade of format 6 to format 7"""
3133
 
 
3134
 
    def convert(self, branch):
3135
 
        format = BzrBranchFormat8()
3136
 
        branch._transport.put_bytes('references', '')
3137
 
        # update target format
3138
 
        branch._transport.put_bytes('format', format.get_format_string())
3139
 
 
3140
2735
 
3141
2736
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3142
2737
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3185
2780
    @staticmethod
3186
2781
    def _get_branch_formats_to_test():
3187
2782
        """Return a tuple with the Branch formats to use when testing."""
3188
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3189
 
 
3190
 
    def pull(self, overwrite=False, stop_revision=None,
3191
 
             possible_transports=None, local=False):
3192
 
        """Mirror source into target branch.
3193
 
 
3194
 
        The target branch is considered to be 'local', having low latency.
3195
 
 
3196
 
        :returns: PullResult instance
3197
 
        """
3198
 
        raise NotImplementedError(self.pull)
 
2783
        raise NotImplementedError(self._get_branch_formats_to_test)
3199
2784
 
3200
2785
    def update_revisions(self, stop_revision=None, overwrite=False,
3201
2786
                         graph=None):
3210
2795
        """
3211
2796
        raise NotImplementedError(self.update_revisions)
3212
2797
 
3213
 
    def push(self, overwrite=False, stop_revision=None,
3214
 
             _override_hook_source_branch=None):
3215
 
        """Mirror the source branch into the target branch.
3216
 
 
3217
 
        The source branch is considered to be 'local', having low latency.
3218
 
        """
3219
 
        raise NotImplementedError(self.push)
3220
 
 
3221
2798
 
3222
2799
class GenericInterBranch(InterBranch):
3223
2800
    """InterBranch implementation that uses public Branch functions.
3270
2847
        finally:
3271
2848
            self.source.unlock()
3272
2849
 
3273
 
    def pull(self, overwrite=False, stop_revision=None,
3274
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3275
 
             _override_hook_target=None, local=False):
3276
 
        """See Branch.pull.
3277
 
 
3278
 
        :param _hook_master: Private parameter - set the branch to
3279
 
            be supplied as the master to pull hooks.
3280
 
        :param run_hooks: Private parameter - if false, this branch
3281
 
            is being called because it's the master of the primary branch,
3282
 
            so it should not run its hooks.
3283
 
        :param _override_hook_target: Private parameter - set the branch to be
3284
 
            supplied as the target_branch to pull hooks.
3285
 
        :param local: Only update the local branch, and not the bound branch.
3286
 
        """
3287
 
        # This type of branch can't be bound.
3288
 
        if local:
3289
 
            raise errors.LocalRequiresBoundBranch()
3290
 
        result = PullResult()
3291
 
        result.source_branch = self.source
3292
 
        if _override_hook_target is None:
3293
 
            result.target_branch = self.target
3294
 
        else:
3295
 
            result.target_branch = _override_hook_target
3296
 
        self.source.lock_read()
3297
 
        try:
3298
 
            # We assume that during 'pull' the target repository is closer than
3299
 
            # the source one.
3300
 
            self.source.update_references(self.target)
3301
 
            graph = self.target.repository.get_graph(self.source.repository)
3302
 
            # TODO: Branch formats should have a flag that indicates 
3303
 
            # that revno's are expensive, and pull() should honor that flag.
3304
 
            # -- JRV20090506
3305
 
            result.old_revno, result.old_revid = \
3306
 
                self.target.last_revision_info()
3307
 
            self.target.update_revisions(self.source, stop_revision,
3308
 
                overwrite=overwrite, graph=graph)
3309
 
            # TODO: The old revid should be specified when merging tags, 
3310
 
            # so a tags implementation that versions tags can only 
3311
 
            # pull in the most recent changes. -- JRV20090506
3312
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3313
 
                overwrite)
3314
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3315
 
            if _hook_master:
3316
 
                result.master_branch = _hook_master
3317
 
                result.local_branch = result.target_branch
3318
 
            else:
3319
 
                result.master_branch = result.target_branch
3320
 
                result.local_branch = None
3321
 
            if run_hooks:
3322
 
                for hook in Branch.hooks['post_pull']:
3323
 
                    hook(result)
3324
 
        finally:
3325
 
            self.source.unlock()
3326
 
        return result
3327
 
 
3328
 
    def push(self, overwrite=False, stop_revision=None,
3329
 
             _override_hook_source_branch=None):
3330
 
        """See InterBranch.push.
3331
 
 
3332
 
        This is the basic concrete implementation of push()
3333
 
 
3334
 
        :param _override_hook_source_branch: If specified, run
3335
 
        the hooks passing this Branch as the source, rather than self.
3336
 
        This is for use of RemoteBranch, where push is delegated to the
3337
 
        underlying vfs-based Branch.
3338
 
        """
3339
 
        # TODO: Public option to disable running hooks - should be trivial but
3340
 
        # needs tests.
3341
 
        self.source.lock_read()
3342
 
        try:
3343
 
            return _run_with_write_locked_target(
3344
 
                self.target, self._push_with_bound_branches, overwrite,
3345
 
                stop_revision,
3346
 
                _override_hook_source_branch=_override_hook_source_branch)
3347
 
        finally:
3348
 
            self.source.unlock()
3349
 
 
3350
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3351
 
            _override_hook_source_branch=None):
3352
 
        """Push from source into target, and into target's master if any.
3353
 
        """
3354
 
        def _run_hooks():
3355
 
            if _override_hook_source_branch:
3356
 
                result.source_branch = _override_hook_source_branch
3357
 
            for hook in Branch.hooks['post_push']:
3358
 
                hook(result)
3359
 
 
3360
 
        bound_location = self.target.get_bound_location()
3361
 
        if bound_location and self.target.base != bound_location:
3362
 
            # there is a master branch.
3363
 
            #
3364
 
            # XXX: Why the second check?  Is it even supported for a branch to
3365
 
            # be bound to itself? -- mbp 20070507
3366
 
            master_branch = self.target.get_master_branch()
3367
 
            master_branch.lock_write()
3368
 
            try:
3369
 
                # push into the master from the source branch.
3370
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3371
 
                # and push into the target branch from the source. Note that we
3372
 
                # push from the source branch again, because its considered the
3373
 
                # highest bandwidth repository.
3374
 
                result = self.source._basic_push(self.target, overwrite,
3375
 
                    stop_revision)
3376
 
                result.master_branch = master_branch
3377
 
                result.local_branch = self.target
3378
 
                _run_hooks()
3379
 
                return result
3380
 
            finally:
3381
 
                master_branch.unlock()
3382
 
        else:
3383
 
            # no master branch
3384
 
            result = self.source._basic_push(self.target, overwrite,
3385
 
                stop_revision)
3386
 
            # TODO: Why set master_branch and local_branch if there's no
3387
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3388
 
            # 20070504
3389
 
            result.master_branch = self.target
3390
 
            result.local_branch = None
3391
 
            _run_hooks()
3392
 
            return result
3393
 
 
3394
2850
    @classmethod
3395
2851
    def is_compatible(self, source, target):
3396
2852
        # GenericBranch uses the public API, so always compatible
3397
2853
        return True
3398
2854
 
3399
2855
 
3400
 
class InterToBranch5(GenericInterBranch):
3401
 
 
3402
 
    @staticmethod
3403
 
    def _get_branch_formats_to_test():
3404
 
        return BranchFormat._default_format, BzrBranchFormat5()
3405
 
 
3406
 
    def pull(self, overwrite=False, stop_revision=None,
3407
 
             possible_transports=None, run_hooks=True,
3408
 
             _override_hook_target=None, local=False):
3409
 
        """Pull from source into self, updating my master if any.
3410
 
 
3411
 
        :param run_hooks: Private parameter - if false, this branch
3412
 
            is being called because it's the master of the primary branch,
3413
 
            so it should not run its hooks.
3414
 
        """
3415
 
        bound_location = self.target.get_bound_location()
3416
 
        if local and not bound_location:
3417
 
            raise errors.LocalRequiresBoundBranch()
3418
 
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
3420
 
            # not pulling from master, so we need to update master.
3421
 
            master_branch = self.target.get_master_branch(possible_transports)
3422
 
            master_branch.lock_write()
3423
 
        try:
3424
 
            if master_branch:
3425
 
                # pull from source into master.
3426
 
                master_branch.pull(self.source, overwrite, stop_revision,
3427
 
                    run_hooks=False)
3428
 
            return super(InterToBranch5, self).pull(overwrite,
3429
 
                stop_revision, _hook_master=master_branch,
3430
 
                run_hooks=run_hooks,
3431
 
                _override_hook_target=_override_hook_target)
3432
 
        finally:
3433
 
            if master_branch:
3434
 
                master_branch.unlock()
3435
 
 
3436
 
 
3437
2856
InterBranch.register_optimiser(GenericInterBranch)
3438
 
InterBranch.register_optimiser(InterToBranch5)