/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: James Westby
  • Date: 2009-03-12 06:04:54 UTC
  • mto: This revision was merged to the branch mainline in revision 4139.
  • Revision ID: james.westby@canonical.com-20090312060454-f04pmpufns32zyk6
Move the shelve docs from bzrtools to the main help.

Also change them to document the new "shelve" rather than the old one.

Show diffs side-by-side

added added

removed removed

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