~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Ian Clatworthy
  • Date: 2009-02-27 01:11:27 UTC
  • mfrom: (4054.2.1 bzr.views-help)
  • mto: This revision was merged to the branch mainline in revision 4059.
  • Revision ID: ian.clatworthy@canonical.com-20090227011127-bhz450zx8nqxxbnv
add Filtered Views section to User Guide (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
42
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
40
from bzrlib.tag import (
44
41
    BasicTags,
46
43
    )
47
44
""")
48
45
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
51
48
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
49
from bzrlib import registry
54
50
from bzrlib.symbol_versioning import (
55
51
    deprecated_in,
63
59
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
60
 
65
61
 
66
 
class Branch(bzrdir.ControlComponent):
 
62
# TODO: Maybe include checks for common corruption of newlines, etc?
 
63
 
 
64
# TODO: Some operations like log might retrieve the same revisions
 
65
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
66
# cache in memory to make this faster.  In general anything can be
 
67
# cached in memory between lock and unlock operations. .. nb thats
 
68
# what the transaction identity map provides
 
69
 
 
70
 
 
71
######################################################################
 
72
# branch objects
 
73
 
 
74
class Branch(object):
67
75
    """Branch holding a history of revisions.
68
76
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
77
    base
 
78
        Base directory/url of the branch.
72
79
 
73
80
    hooks: An instance of BranchHooks.
74
81
    """
76
83
    # - RBC 20060112
77
84
    base = None
78
85
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
 
86
    # override this to set the strategy for storing tags
 
87
    def _make_tags(self):
 
88
        return DisabledTags(self)
86
89
 
87
90
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
91
        self.tags = self._make_tags()
89
92
        self._revision_history_cache = None
90
93
        self._revision_id_to_revno_cache = None
91
94
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
95
        self._last_revision_info_cache = None
94
96
        self._merge_sorted_revisions_cache = None
95
97
        self._open_hook()
100
102
    def _open_hook(self):
101
103
        """Called by init to allow simpler extension of the base class."""
102
104
 
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
105
    def break_lock(self):
111
106
        """Break a lock if one is present from another instance.
112
107
 
121
116
        if master is not None:
122
117
            master.break_lock()
123
118
 
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
119
    @staticmethod
159
120
    def open(base, _unsupported=False, possible_transports=None):
160
121
        """Open the branch rooted at base.
164
125
        """
165
126
        control = bzrdir.BzrDir.open(base, _unsupported,
166
127
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
128
        return control.open_branch(_unsupported)
168
129
 
169
130
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
131
    def open_from_transport(transport, _unsupported=False):
171
132
        """Open the branch rooted at transport"""
172
133
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
134
        return control.open_branch(_unsupported)
174
135
 
175
136
    @staticmethod
176
137
    def open_containing(url, possible_transports=None):
194
155
        The default implementation returns False if this branch has no tags,
195
156
        and True the rest of the time.  Subclasses may override this.
196
157
        """
197
 
        return self.supports_tags() and self.tags.get_tag_dict()
 
158
        return self.tags.supports_tags() and self.tags.get_tag_dict()
198
159
 
199
160
    def get_config(self):
200
161
        return BranchConfig(self)
201
162
 
202
 
    def _get_config(self):
203
 
        """Get the concrete config for just the config in this branch.
204
 
 
205
 
        This is not intended for client use; see Branch.get_config for the
206
 
        public API.
207
 
 
208
 
        Added in 1.14.
209
 
 
210
 
        :return: An object supporting get_option and set_option.
211
 
        """
212
 
        raise NotImplementedError(self._get_config)
213
 
 
214
 
    def _get_fallback_repository(self, url):
215
 
        """Get the repository we fallback to at url."""
216
 
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
220
 
 
221
 
    def _get_tags_bytes(self):
222
 
        """Get the bytes of a serialised tags dict.
223
 
 
224
 
        Note that not all branches support tags, nor do all use the same tags
225
 
        logic: this method is specific to BasicTags. Other tag implementations
226
 
        may use the same method name and behave differently, safely, because
227
 
        of the double-dispatch via
228
 
        format.make_tags->tags_instance->get_tags_dict.
229
 
 
230
 
        :return: The bytes of the tags file.
231
 
        :seealso: Branch._set_tags_bytes.
232
 
        """
233
 
        return self._transport.get_bytes('tags')
234
 
 
235
163
    def _get_nick(self, local=False, possible_transports=None):
236
164
        config = self.get_config()
237
165
        # explicit overrides master, but don't look for master if local is True
417
345
            * 'include' - the stop revision is the last item in the result
418
346
            * 'with-merges' - include the stop revision and all of its
419
347
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
348
        :param direction: either 'reverse' or 'forward':
423
349
            * reverse means return the start_revision_id first, i.e.
424
350
              start at the most recent revision and go backwards in history
446
372
        # start_revision_id.
447
373
        if self._merge_sorted_revisions_cache is None:
448
374
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
375
            graph = self.repository.get_graph()
 
376
            parent_map = dict(((key, value) for key, value in
 
377
                     graph.iter_ancestry([last_revision]) if value is not None))
 
378
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
379
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
380
                generate_revno=True)
 
381
            # Drop the sequence # before caching
 
382
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
383
 
453
384
        filtered = self._filter_merge_sorted_revisions(
454
385
            self._merge_sorted_revisions_cache, start_revision_id,
455
386
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
387
        if direction == 'reverse':
460
388
            return filtered
461
389
        if direction == 'forward':
468
396
        """Iterate over an inclusive range of sorted revisions."""
469
397
        rev_iter = iter(merge_sorted_revisions)
470
398
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
399
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
400
                if rev_id != start_revision_id:
474
401
                    continue
475
402
                else:
476
403
                    # The decision to include the start or not
477
404
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
405
                    rev_iter = chain(
 
406
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
407
                        rev_iter)
480
408
                    break
481
409
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
411
                yield rev_id, depth, revno, end_of_merge
487
412
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
413
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
414
                if rev_id == stop_revision_id:
491
415
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
416
                yield rev_id, depth, revno, end_of_merge
494
417
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
418
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
419
                yield rev_id, depth, revno, end_of_merge
499
420
                if rev_id == stop_revision_id:
500
421
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
422
        elif stop_rule == 'with-merges':
514
423
            stop_rev = self.repository.get_revision(stop_revision_id)
515
424
            if stop_rev.parent_ids:
516
425
                left_parent = stop_rev.parent_ids[0]
517
426
            else:
518
427
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
428
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
429
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
430
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
431
                yield rev_id, depth, revno, end_of_merge
538
432
        else:
539
433
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
434
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
435
    def leave_lock_in_place(self):
587
436
        """Tell this branch object not to release the physical lock when this
588
437
        object is unlocked.
605
454
        :param other: The branch to bind to
606
455
        :type other: Branch
607
456
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
609
 
 
610
 
    def set_append_revisions_only(self, enabled):
611
 
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
613
 
        if enabled:
614
 
            value = 'True'
615
 
        else:
616
 
            value = 'False'
617
 
        self.get_config().set_user_option('append_revisions_only', value,
618
 
            warn_masked=True)
619
 
 
620
 
    def set_reference_info(self, file_id, tree_path, branch_location):
621
 
        """Set the branch location to use for a tree reference."""
622
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
623
 
 
624
 
    def get_reference_info(self, file_id):
625
 
        """Get the tree_path and branch_location for a tree reference."""
626
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
457
        raise errors.UpgradeRequired(self.base)
627
458
 
628
459
    @needs_write_lock
629
460
    def fetch(self, from_branch, last_revision=None, pb=None):
633
464
        :param last_revision: What revision to stop at (None for at the end
634
465
                              of the branch.
635
466
        :param pb: An optional progress bar to use.
636
 
        :return: None
 
467
 
 
468
        Returns the copied revision count and the failed revisions in a tuple:
 
469
        (copied, failures).
637
470
        """
638
471
        if self.base == from_branch.base:
639
472
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "pb parameter to fetch()")
 
473
        if pb is None:
 
474
            nested_pb = ui.ui_factory.nested_progress_bar()
 
475
            pb = nested_pb
 
476
        else:
 
477
            nested_pb = None
 
478
 
644
479
        from_branch.lock_read()
645
480
        try:
646
481
            if last_revision is None:
 
482
                pb.update('get source history')
647
483
                last_revision = from_branch.last_revision()
648
484
                last_revision = _mod_revision.ensure_null(last_revision)
649
485
            return self.repository.fetch(from_branch.repository,
650
486
                                         revision_id=last_revision,
651
 
                                         pb=pb)
 
487
                                         pb=nested_pb)
652
488
        finally:
 
489
            if nested_pb is not None:
 
490
                nested_pb.finished()
653
491
            from_branch.unlock()
654
492
 
655
493
    def get_bound_location(self):
663
501
    def get_old_bound_location(self):
664
502
        """Return the URL of the branch we used to be bound to
665
503
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
504
        raise errors.UpgradeRequired(self.base)
667
505
 
668
506
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
507
                           timezone=None, committer=None, revprops=None,
719
557
    def set_revision_history(self, rev_history):
720
558
        raise NotImplementedError(self.set_revision_history)
721
559
 
722
 
    @needs_write_lock
723
 
    def set_parent(self, url):
724
 
        """See Branch.set_parent."""
725
 
        # TODO: Maybe delete old location files?
726
 
        # URLs should never be unicode, even on the local fs,
727
 
        # FIXUP this and get_parent in a future branch format bump:
728
 
        # read and rewrite the file. RBC 20060125
729
 
        if url is not None:
730
 
            if isinstance(url, unicode):
731
 
                try:
732
 
                    url = url.encode('ascii')
733
 
                except UnicodeEncodeError:
734
 
                    raise errors.InvalidURL(url,
735
 
                        "Urls must be 7-bit ascii, "
736
 
                        "use bzrlib.urlutils.escape")
737
 
            url = urlutils.relative_url(self.base, url)
738
 
        self._set_parent_location(url)
739
 
 
740
 
    @needs_write_lock
741
560
    def set_stacked_on_url(self, url):
742
561
        """Set the URL this branch is stacked against.
743
562
 
746
565
        :raises UnstackableRepositoryFormat: If the repository does not support
747
566
            stacking.
748
567
        """
749
 
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
 
        # XXX: Changing from one fallback repository to another does not check
752
 
        # that all the data you need is present in the new fallback.
753
 
        # Possibly it should.
754
 
        self._check_stackable_repo()
755
 
        if not url:
756
 
            try:
757
 
                old_url = self.get_stacked_on_url()
758
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
 
                errors.UnstackableRepositoryFormat):
760
 
                return
761
 
            self._unstack()
762
 
        else:
763
 
            self._activate_fallback_location(url)
764
 
        # write this out after the repository is stacked to avoid setting a
765
 
        # stacked config that doesn't work.
766
 
        self._set_config_location('stacked_on_location', url)
767
 
 
768
 
    def _unstack(self):
769
 
        """Change a branch to be unstacked, copying data as needed.
770
 
        
771
 
        Don't call this directly, use set_stacked_on_url(None).
772
 
        """
773
 
        pb = ui.ui_factory.nested_progress_bar()
774
 
        try:
775
 
            pb.update("Unstacking")
776
 
            # The basic approach here is to fetch the tip of the branch,
777
 
            # including all available ghosts, from the existing stacked
778
 
            # repository into a new repository object without the fallbacks. 
779
 
            #
780
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
 
            # correct for CHKMap repostiories
782
 
            old_repository = self.repository
783
 
            if len(old_repository._fallback_repositories) != 1:
784
 
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
787
 
            old_repository.unlock()
788
 
            old_repository.lock_read()
789
 
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
 
                # XXX: If you unstack a branch while it has a working tree
809
 
                # with a pending merge, the pending-merged revisions will no
810
 
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
818
 
            finally:
819
 
                old_repository.unlock()
820
 
        finally:
821
 
            pb.finished()
822
 
 
823
 
    def _set_tags_bytes(self, bytes):
824
 
        """Mirror method for _get_tags_bytes.
825
 
 
826
 
        :seealso: Branch._get_tags_bytes.
827
 
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
568
        raise NotImplementedError(self.set_stacked_on_url)
830
569
 
831
570
    def _cache_revision_history(self, rev_history):
832
571
        """Set the cached revision history to rev_history.
860
599
        self._revision_id_to_revno_cache = None
861
600
        self._last_revision_info_cache = None
862
601
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
602
 
866
603
    def _gen_revision_history(self):
867
604
        """Return sequence of revision hashes on to this branch.
904
641
 
905
642
    def unbind(self):
906
643
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
644
        raise errors.UpgradeRequired(self.base)
 
645
 
 
646
    def set_append_revisions_only(self, enabled):
 
647
        """Older format branches are never restricted to append-only"""
 
648
        raise errors.UpgradeRequired(self.base)
908
649
 
909
650
    def last_revision(self):
910
651
        """Return last revision id, or NULL_REVISION."""
967
708
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
709
            overwrite, graph)
969
710
 
970
 
    def import_last_revision_info(self, source_repo, revno, revid):
971
 
        """Set the last revision info, importing from another repo if necessary.
972
 
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
 
        :param source_repo: Source repository to optionally fetch from
977
 
        :param revno: Revision number of the new tip
978
 
        :param revid: Revision id of the new tip
979
 
        """
980
 
        if not self.repository.has_same_location(source_repo):
981
 
            self.repository.fetch(source_repo, revision_id=revid)
982
 
        self.set_last_revision_info(revno, revid)
983
 
 
984
711
    def revision_id_to_revno(self, revision_id):
985
712
        """Given a revision id, return its revno"""
986
713
        if _mod_revision.is_null(revision_id):
991
718
        except ValueError:
992
719
            raise errors.NoSuchRevision(self, revision_id)
993
720
 
994
 
    @needs_read_lock
995
721
    def get_rev_id(self, revno, history=None):
996
722
        """Find the revision id of the specified revno."""
997
723
        if revno == 0:
998
724
            return _mod_revision.NULL_REVISION
999
 
        last_revno, last_revid = self.last_revision_info()
1000
 
        if revno == last_revno:
1001
 
            return last_revid
1002
 
        if revno <= 0 or revno > last_revno:
 
725
        if history is None:
 
726
            history = self.revision_history()
 
727
        if revno <= 0 or revno > len(history):
1003
728
            raise errors.NoSuchRevision(self, revno)
1004
 
        distance_from_last = last_revno - revno
1005
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1006
 
            self._extend_partial_history(distance_from_last)
1007
 
        return self._partial_revision_history_cache[distance_from_last]
 
729
        return history[revno - 1]
1008
730
 
1009
 
    @needs_write_lock
1010
731
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
732
             possible_transports=None, _override_hook_target=None):
1012
733
        """Mirror source into this branch.
1013
734
 
1014
735
        This branch is considered to be 'local', having low latency.
1015
736
 
1016
737
        :returns: PullResult instance
1017
738
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
739
        raise NotImplementedError(self.pull)
1021
740
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
741
    def push(self, target, overwrite=False, stop_revision=None):
1024
742
        """Mirror this branch into target.
1025
743
 
1026
744
        This branch is considered to be 'local', having low latency.
1027
745
        """
1028
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
746
        raise NotImplementedError(self.push)
1051
747
 
1052
748
    def basis_tree(self):
1053
749
        """Return `Tree` object for last revision."""
1060
756
        pattern is that the user can override it by specifying a
1061
757
        location.
1062
758
        """
1063
 
        parent = self._get_parent_location()
1064
 
        if parent is None:
1065
 
            return parent
1066
 
        # This is an old-format absolute path to a local branch
1067
 
        # turn it into a url
1068
 
        if parent.startswith('/'):
1069
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1070
 
        try:
1071
 
            return urlutils.join(self.base[:-1], parent)
1072
 
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
1074
 
 
1075
 
    def _get_parent_location(self):
1076
 
        raise NotImplementedError(self._get_parent_location)
 
759
        raise NotImplementedError(self.get_parent)
1077
760
 
1078
761
    def _set_config_location(self, name, url, config=None,
1079
762
                             make_relative=False):
1093
776
            location = None
1094
777
        return location
1095
778
 
1096
 
    def get_child_submit_format(self):
1097
 
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
1099
 
 
1100
779
    def get_submit_branch(self):
1101
780
        """Return the submit location of the branch.
1102
781
 
1119
798
    def get_public_branch(self):
1120
799
        """Return the public location of the branch.
1121
800
 
1122
 
        This is used by merge directives.
 
801
        This is is used by merge directives.
1123
802
        """
1124
803
        return self._get_config_location('public_branch')
1125
804
 
1161
840
        params = ChangeBranchTipParams(
1162
841
            self, old_revno, new_revno, old_revid, new_revid)
1163
842
        for hook in hooks:
1164
 
            hook(params)
 
843
            try:
 
844
                hook(params)
 
845
            except errors.TipChangeRejected:
 
846
                raise
 
847
            except Exception:
 
848
                exc_info = sys.exc_info()
 
849
                hook_name = Branch.hooks.get_hook_name(hook)
 
850
                raise errors.HookFailed(
 
851
                    'pre_change_branch_tip', hook_name, exc_info)
 
852
 
 
853
    def set_parent(self, url):
 
854
        raise NotImplementedError(self.set_parent)
1165
855
 
1166
856
    @needs_write_lock
1167
857
    def update(self):
1198
888
                     be truncated to end with revision_id.
1199
889
        """
1200
890
        result = to_bzrdir.create_branch()
1201
 
        result.lock_write()
1202
 
        try:
1203
 
            if repository_policy is not None:
1204
 
                repository_policy.configure_branch(result)
1205
 
            self.copy_content_into(result, revision_id=revision_id)
1206
 
        finally:
1207
 
            result.unlock()
1208
 
        return result
 
891
        if repository_policy is not None:
 
892
            repository_policy.configure_branch(result)
 
893
        self.copy_content_into(result, revision_id=revision_id)
 
894
        return  result
1209
895
 
1210
896
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
897
    def sprout(self, to_bzrdir, revision_id=None):
1212
898
        """Create a new line of development from the branch, into to_bzrdir.
1213
899
 
1214
900
        to_bzrdir controls the branch format.
1216
902
        revision_id: if not None, the revision history in the new branch will
1217
903
                     be truncated to end with revision_id.
1218
904
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
905
        result = to_bzrdir.create_branch()
1223
 
        result.lock_write()
1224
 
        try:
1225
 
            if repository_policy is not None:
1226
 
                repository_policy.configure_branch(result)
1227
 
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
1229
 
        finally:
1230
 
            result.unlock()
 
906
        self.copy_content_into(result, revision_id=revision_id)
 
907
        result.set_parent(self.bzrdir.root_transport.base)
1231
908
        return result
1232
909
 
1233
910
    def _synchronize_history(self, destination, revision_id):
1245
922
        source_revno, source_revision_id = self.last_revision_info()
1246
923
        if revision_id is None:
1247
924
            revno, revision_id = source_revno, source_revision_id
 
925
        elif source_revision_id == revision_id:
 
926
            # we know the revno without needing to walk all of history
 
927
            revno = source_revno
1248
928
        else:
1249
 
            graph = self.repository.get_graph()
1250
 
            try:
1251
 
                revno = graph.find_distance_to_null(revision_id, 
1252
 
                    [(source_revision_id, source_revno)])
1253
 
            except errors.GhostRevisionsHaveNoRevno:
1254
 
                # Default to 1, if we can't find anything else
1255
 
                revno = 1
 
929
            # To figure out the revno for a random revision, we need to build
 
930
            # the revision history, and count its length.
 
931
            # We don't care about the order, just how long it is.
 
932
            # Alternatively, we could start at the current location, and count
 
933
            # backwards. But there is no guarantee that we will find it since
 
934
            # it may be a merged revision.
 
935
            revno = len(list(self.repository.iter_reverse_revision_history(
 
936
                                                                revision_id)))
1256
937
        destination.set_last_revision_info(revno, revision_id)
1257
938
 
1258
939
    @needs_read_lock
1262
943
        revision_id: if not None, the revision history in the new branch will
1263
944
                     be truncated to end with revision_id.
1264
945
        """
1265
 
        self.update_references(destination)
1266
946
        self._synchronize_history(destination, revision_id)
1267
947
        try:
1268
948
            parent = self.get_parent()
1274
954
        if self._push_should_merge_tags():
1275
955
            self.tags.merge_to(destination.tags)
1276
956
 
1277
 
    def update_references(self, target):
1278
 
        if not getattr(self._format, 'supports_reference_locations', False):
1279
 
            return
1280
 
        reference_dict = self._get_all_reference_info()
1281
 
        if len(reference_dict) == 0:
1282
 
            return
1283
 
        old_base = self.base
1284
 
        new_base = target.base
1285
 
        target_reference_dict = target._get_all_reference_info()
1286
 
        for file_id, (tree_path, branch_location) in (
1287
 
            reference_dict.items()):
1288
 
            branch_location = urlutils.rebase_url(branch_location,
1289
 
                                                  old_base, new_base)
1290
 
            target_reference_dict.setdefault(
1291
 
                file_id, (tree_path, branch_location))
1292
 
        target._set_all_reference_info(target_reference_dict)
1293
 
 
1294
957
    @needs_read_lock
1295
 
    def check(self, refs):
 
958
    def check(self):
1296
959
        """Check consistency of the branch.
1297
960
 
1298
961
        In particular this checks that revisions given in the revision-history
1301
964
 
1302
965
        Callers will typically also want to check the repository.
1303
966
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
967
        :return: A BranchCheckResult.
1307
968
        """
1308
 
        result = BranchCheckResult(self)
 
969
        mainline_parent_id = None
1309
970
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
971
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
972
                                last_revision_id))
 
973
        real_rev_history.reverse()
 
974
        if len(real_rev_history) != last_revno:
 
975
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
976
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
977
        # TODO: We should probably also check that real_rev_history actually
 
978
        #       matches self.revision_history()
 
979
        for revision_id in real_rev_history:
 
980
            try:
 
981
                revision = self.repository.get_revision(revision_id)
 
982
            except errors.NoSuchRevision, e:
 
983
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
984
                            % revision_id)
 
985
            # In general the first entry on the revision history has no parents.
 
986
            # But it's not illegal for it to have parents listed; this can happen
 
987
            # in imports from Arch when the parents weren't reachable.
 
988
            if mainline_parent_id is not None:
 
989
                if mainline_parent_id not in revision.parent_ids:
 
990
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
991
                                        "parents of {%s}"
 
992
                                        % (mainline_parent_id, revision_id))
 
993
            mainline_parent_id = revision_id
 
994
        return BranchCheckResult(self)
1321
995
 
1322
996
    def _get_checkout_format(self):
1323
997
        """Return the most suitable metadir for a checkout of this branch.
1333
1007
        return format
1334
1008
 
1335
1009
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1010
        stacked_on=None):
1337
1011
        """Create a clone of this branch and its bzrdir.
1338
1012
 
1339
1013
        :param to_transport: The transport to clone onto.
1340
1014
        :param revision_id: The revision id to use as tip in the new branch.
1341
1015
            If None the tip is obtained from this branch.
1342
1016
        :param stacked_on: An optional URL to stack the clone on.
1343
 
        :param create_prefix: Create any missing directories leading up to
1344
 
            to_transport.
1345
 
        :param use_existing_dir: Use an existing directory if one exists.
1346
1017
        """
1347
1018
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1019
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1020
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1021
            revision_id=revision_id, stacked_on=stacked_on)
1354
1022
        return dir_to.open_branch()
1355
1023
 
1356
1024
    def create_checkout(self, to_location, revision_id=None,
1375
1043
        if lightweight:
1376
1044
            format = self._get_checkout_format()
1377
1045
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1046
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1047
        else:
1381
1048
            format = self._get_checkout_format()
1382
1049
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1078
        reconciler.reconcile()
1412
1079
        return reconciler
1413
1080
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1081
    def reference_parent(self, file_id, path):
1415
1082
        """Return the parent branch for a tree-reference file_id
1416
1083
        :param file_id: The file_id of the tree reference
1417
1084
        :param path: The path of the file_id in the tree
1418
1085
        :return: A branch associated with the file_id
1419
1086
        """
1420
1087
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1088
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1089
 
1424
1090
    def supports_tags(self):
1425
1091
        return self._format.supports_tags()
1426
1092
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1093
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1094
                                         other_branch):
1441
1095
        """Ensure that revision_b is a descendant of revision_a.
1496
1150
    _formats = {}
1497
1151
    """The known formats."""
1498
1152
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1153
    def __eq__(self, other):
1502
1154
        return self.__class__ is other.__class__
1503
1155
 
1505
1157
        return not (self == other)
1506
1158
 
1507
1159
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1160
    def find_format(klass, a_bzrdir):
1509
1161
        """Return the format for the branch object in a_bzrdir."""
1510
1162
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1163
            transport = a_bzrdir.get_branch_transport(None)
 
1164
            format_string = transport.get("format").read()
1513
1165
            return klass._formats[format_string]
1514
1166
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1167
            raise errors.NotBranchError(path=transport.base)
1516
1168
        except KeyError:
1517
1169
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1170
 
1554
1206
        """Return the short format description for this format."""
1555
1207
        raise NotImplementedError(self.get_format_description)
1556
1208
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1209
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1210
                           set_format=True):
1567
1211
        """Initialize a branch in a bzrdir, with specified files
1568
1212
 
1569
1213
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1214
        :param utf8_files: The files to create as a list of
1571
1215
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1216
        :param set_format: If True, set the format with
1574
1217
            self.get_format_string.  (BzrBranch4 has its format set
1575
1218
            elsewhere)
1576
1219
        :return: a branch in this format
1577
1220
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1221
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1222
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1223
        lock_map = {
1581
1224
            'metadir': ('lock', lockdir.LockDir),
1582
1225
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1228
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1229
            lock_name, lock_class)
1587
1230
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
 
1231
        control_files.lock_write()
1596
1232
        if set_format:
1597
1233
            utf8_files += [('format', self.get_format_string())]
1598
1234
        try:
1601
1237
                    filename, content,
1602
1238
                    mode=a_bzrdir._get_file_mode())
1603
1239
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1240
            control_files.unlock()
 
1241
        return self.open(a_bzrdir, _found=True)
1609
1242
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1243
    def initialize(self, a_bzrdir):
 
1244
        """Create a branch of this format in a_bzrdir."""
1615
1245
        raise NotImplementedError(self.initialize)
1616
1246
 
1617
1247
    def is_supported(self):
1623
1253
        """
1624
1254
        return True
1625
1255
 
1626
 
    def make_tags(self, branch):
1627
 
        """Create a tags object for branch.
1628
 
 
1629
 
        This method is on BranchFormat, because BranchFormats are reflected
1630
 
        over the wire via network_name(), whereas full Branch instances require
1631
 
        multiple VFS method calls to operate at all.
1632
 
 
1633
 
        The default implementation returns a disabled-tags instance.
1634
 
 
1635
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
 
        on a RemoteBranch.
1637
 
        """
1638
 
        return DisabledTags(branch)
1639
 
 
1640
1256
    def network_name(self):
1641
1257
        """A simple byte string uniquely identifying this format for RPC calls.
1642
1258
 
1647
1263
        """
1648
1264
        raise NotImplementedError(self.network_name)
1649
1265
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1266
    def open(self, a_bzrdir, _found=False):
1651
1267
        """Return the branch object for a_bzrdir
1652
1268
 
1653
 
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
 
        :param _found: a private parameter, do not use it. It is used to
1656
 
            indicate if format probing has already be done.
1657
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1658
 
            (if there are any).  Default is to open fallbacks.
 
1269
        _found is a private parameter, do not use it. It is used to indicate
 
1270
               if format probing has already be done.
1659
1271
        """
1660
1272
        raise NotImplementedError(self.open)
1661
1273
 
1663
1275
    def register_format(klass, format):
1664
1276
        """Register a metadir format."""
1665
1277
        klass._formats[format.get_format_string()] = format
1666
 
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1278
        # Metadir formats have a network name of their format string.
 
1279
        network_format_registry.register(format.get_format_string(), format)
1669
1280
 
1670
1281
    @classmethod
1671
1282
    def set_default_format(klass, format):
1672
1283
        klass._default_format = format
1673
1284
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1285
    def supports_stacking(self):
1679
1286
        """True if this format records a stacked-on branch."""
1680
1287
        return False
1705
1312
        notified.
1706
1313
        """
1707
1314
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
1709
 
            "Invoked whenever the revision history has been set via "
1710
 
            "set_revision_history. The api signature is (branch, "
1711
 
            "revision_history), and the branch will be write-locked. "
1712
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1713
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
 
        self.create_hook(HookPoint('open',
1715
 
            "Called with the Branch object that has been opened after a "
1716
 
            "branch is opened.", (1, 8), None))
1717
 
        self.create_hook(HookPoint('post_push',
1718
 
            "Called after a push operation completes. post_push is called "
1719
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
1722
 
            "Called after a pull operation completes. post_pull is called "
1723
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
 
            "bzr client.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
1727
 
            "completed. pre_commit is called with (local, master, old_revno, "
1728
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1730
 
            "tree_delta is a TreeDelta object describing changes from the "
1731
 
            "basis revision. hooks MUST NOT modify this delta. "
1732
 
            " future_tree is an in-memory tree obtained from "
1733
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
1736
 
            "Called in the bzr client after a commit has completed. "
1737
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
 
            "commit to a branch.", (0, 15), None))
1740
 
        self.create_hook(HookPoint('post_uncommit',
1741
 
            "Called in the bzr client after an uncommit completes. "
1742
 
            "post_uncommit is called with (local, master, old_revno, "
1743
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
 
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1747
 
            "Called in bzr client and server before a change to the tip of a "
1748
 
            "branch is made. pre_change_branch_tip is called with a "
1749
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1751
 
        self.create_hook(HookPoint('post_change_branch_tip',
1752
 
            "Called in bzr client and server after a change to the tip of a "
1753
 
            "branch is made. post_change_branch_tip is called with a "
1754
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1756
 
        self.create_hook(HookPoint('transform_fallback_location',
1757
 
            "Called when a stacked branch is activating its fallback "
1758
 
            "locations. transform_fallback_location is called with (branch, "
1759
 
            "url), and should return a new url. Returning the same url "
1760
 
            "allows it to be used as-is, returning a different one can be "
1761
 
            "used to cause the branch to stack on a closer copy of that "
1762
 
            "fallback_location. Note that the branch cannot have history "
1763
 
            "accessing methods called on it during this hook because the "
1764
 
            "fallback locations have not been activated. When there are "
1765
 
            "multiple hooks installed for transform_fallback_location, "
1766
 
            "all are called with the url returned from the previous hook."
1767
 
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
 
1315
        # Introduced in 0.15:
 
1316
        # invoked whenever the revision history has been set
 
1317
        # with set_revision_history. The api signature is
 
1318
        # (branch, revision_history), and the branch will
 
1319
        # be write-locked.
 
1320
        self['set_rh'] = []
 
1321
        # Invoked after a branch is opened. The api signature is (branch).
 
1322
        self['open'] = []
 
1323
        # invoked after a push operation completes.
 
1324
        # the api signature is
 
1325
        # (push_result)
 
1326
        # containing the members
 
1327
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1328
        # where local is the local target branch or None, master is the target
 
1329
        # master branch, and the rest should be self explanatory. The source
 
1330
        # is read locked and the target branches write locked. Source will
 
1331
        # be the local low-latency branch.
 
1332
        self['post_push'] = []
 
1333
        # invoked after a pull operation completes.
 
1334
        # the api signature is
 
1335
        # (pull_result)
 
1336
        # containing the members
 
1337
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1338
        # where local is the local branch or None, master is the target
 
1339
        # master branch, and the rest should be self explanatory. The source
 
1340
        # is read locked and the target branches write locked. The local
 
1341
        # branch is the low-latency branch.
 
1342
        self['post_pull'] = []
 
1343
        # invoked before a commit operation takes place.
 
1344
        # the api signature is
 
1345
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1346
        #  tree_delta, future_tree).
 
1347
        # old_revid is NULL_REVISION for the first commit to a branch
 
1348
        # tree_delta is a TreeDelta object describing changes from the basis
 
1349
        # revision, hooks MUST NOT modify this delta
 
1350
        # future_tree is an in-memory tree obtained from
 
1351
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1352
        self['pre_commit'] = []
 
1353
        # invoked after a commit operation completes.
 
1354
        # the api signature is
 
1355
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1356
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1357
        self['post_commit'] = []
 
1358
        # invoked after a uncommit operation completes.
 
1359
        # the api signature is
 
1360
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1361
        # local is the local branch or None, master is the target branch,
 
1362
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1363
        self['post_uncommit'] = []
 
1364
        # Introduced in 1.6
 
1365
        # Invoked before the tip of a branch changes.
 
1366
        # the api signature is
 
1367
        # (params) where params is a ChangeBranchTipParams with the members
 
1368
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1369
        self['pre_change_branch_tip'] = []
 
1370
        # Introduced in 1.4
 
1371
        # Invoked after the tip of a branch changes.
 
1372
        # the api signature is
 
1373
        # (params) where params is a ChangeBranchTipParams with the members
 
1374
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1375
        self['post_change_branch_tip'] = []
 
1376
        # Introduced in 1.9
 
1377
        # Invoked when a stacked branch activates its fallback locations and
 
1378
        # allows the transformation of the url of said location.
 
1379
        # the api signature is
 
1380
        # (branch, url) where branch is the branch having its fallback
 
1381
        # location activated and url is the url for the fallback location.
 
1382
        # The hook should return a url.
 
1383
        self['transform_fallback_location'] = []
1785
1384
 
1786
1385
 
1787
1386
# install the default hooks into the Branch class.
1826
1425
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1426
 
1828
1427
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1428
class BzrBranchFormat4(BranchFormat):
1908
1429
    """Bzr branch format 4.
1909
1430
 
1916
1437
        """See BranchFormat.get_format_description()."""
1917
1438
        return "Branch format 4"
1918
1439
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1440
    def initialize(self, a_bzrdir):
1920
1441
        """Create a branch of this format in a_bzrdir."""
1921
1442
        utf8_files = [('revision-history', ''),
1922
1443
                      ('branch-name', ''),
1923
1444
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1445
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1446
                                       lock_type='branch4', set_format=False)
1926
1447
 
1927
1448
    def __init__(self):
1932
1453
        """The network name for this format is the control dirs disk label."""
1933
1454
        return self._matchingbzrdir.get_format_string()
1934
1455
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
 
1456
    def open(self, a_bzrdir, _found=False):
 
1457
        """Return the branch object for a_bzrdir
 
1458
 
 
1459
        _found is a private parameter, do not use it. It is used to indicate
 
1460
               if format probing has already be done.
 
1461
        """
1937
1462
        if not _found:
1938
1463
            # we are being called directly and must probe.
1939
1464
            raise NotImplementedError
1940
1465
        return BzrBranch(_format=self,
1941
1466
                         _control_files=a_bzrdir._control_files,
1942
1467
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1468
                         _repository=a_bzrdir.open_repository())
1945
1469
 
1946
1470
    def __str__(self):
1961
1485
        """
1962
1486
        return self.get_format_string()
1963
1487
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
 
        """See BranchFormat.open()."""
 
1488
    def open(self, a_bzrdir, _found=False):
 
1489
        """Return the branch object for a_bzrdir.
 
1490
 
 
1491
        _found is a private parameter, do not use it. It is used to indicate
 
1492
               if format probing has already be done.
 
1493
        """
1966
1494
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1495
            format = BranchFormat.find_format(a_bzrdir)
1968
1496
            if format.__class__ != self.__class__:
1969
1497
                raise AssertionError("wrong format %r found for %r" %
1970
1498
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1499
        try:
 
1500
            transport = a_bzrdir.get_branch_transport(None)
1973
1501
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1502
                                                         lockdir.LockDir)
1975
1503
            return self._branch_class()(_format=self,
1976
1504
                              _control_files=control_files,
1977
 
                              name=name,
1978
1505
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
1506
                              _repository=a_bzrdir.find_repository())
1981
1507
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1508
            raise errors.NotBranchError(path=transport.base)
1983
1509
 
1984
1510
    def __init__(self):
1985
1511
        super(BranchFormatMetadir, self).__init__()
2014
1540
        """See BranchFormat.get_format_description()."""
2015
1541
        return "Branch format 5"
2016
1542
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1543
    def initialize(self, a_bzrdir):
2018
1544
        """Create a branch of this format in a_bzrdir."""
2019
1545
        utf8_files = [('revision-history', ''),
2020
1546
                      ('branch-name', ''),
2021
1547
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1548
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1549
 
2024
1550
    def supports_tags(self):
2025
1551
        return False
2047
1573
        """See BranchFormat.get_format_description()."""
2048
1574
        return "Branch format 6"
2049
1575
 
2050
 
    def initialize(self, a_bzrdir, name=None):
2051
 
        """Create a branch of this format in a_bzrdir."""
2052
 
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
2054
 
                      ('tags', ''),
2055
 
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2057
 
 
2058
 
    def make_tags(self, branch):
2059
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
2061
 
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
 
 
2065
 
 
2066
 
class BzrBranchFormat8(BranchFormatMetadir):
2067
 
    """Metadir format supporting storing locations of subtree branches."""
2068
 
 
2069
 
    def _branch_class(self):
2070
 
        return BzrBranch8
2071
 
 
2072
 
    def get_format_string(self):
2073
 
        """See BranchFormat.get_format_string()."""
2074
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
 
 
2076
 
    def get_format_description(self):
2077
 
        """See BranchFormat.get_format_description()."""
2078
 
        return "Branch format 8"
2079
 
 
2080
 
    def initialize(self, a_bzrdir, name=None):
2081
 
        """Create a branch of this format in a_bzrdir."""
2082
 
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
2084
 
                      ('tags', ''),
2085
 
                      ('references', '')
2086
 
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
2093
 
 
2094
 
    def make_tags(self, branch):
2095
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
2097
 
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
 
    def supports_stacking(self):
2102
 
        return True
2103
 
 
2104
 
    supports_reference_locations = True
2105
 
 
2106
 
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1576
    def initialize(self, a_bzrdir):
 
1577
        """Create a branch of this format in a_bzrdir."""
 
1578
        utf8_files = [('last-revision', '0 null:\n'),
 
1579
                      ('branch.conf', ''),
 
1580
                      ('tags', ''),
 
1581
                      ]
 
1582
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1583
 
 
1584
 
 
1585
class BzrBranchFormat7(BranchFormatMetadir):
2108
1586
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1587
 
2110
1588
    The stacked location pointer is passed down to the repository and requires
2113
1591
    This format was introduced in bzr 1.6.
2114
1592
    """
2115
1593
 
2116
 
    def initialize(self, a_bzrdir, name=None):
2117
 
        """Create a branch of this format in a_bzrdir."""
2118
 
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
2120
 
                      ('tags', ''),
2121
 
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2123
 
 
2124
1594
    def _branch_class(self):
2125
1595
        return BzrBranch7
2126
1596
 
2132
1602
        """See BranchFormat.get_format_description()."""
2133
1603
        return "Branch format 7"
2134
1604
 
2135
 
    def supports_set_append_revisions_only(self):
 
1605
    def initialize(self, a_bzrdir):
 
1606
        """Create a branch of this format in a_bzrdir."""
 
1607
        utf8_files = [('last-revision', '0 null:\n'),
 
1608
                      ('branch.conf', ''),
 
1609
                      ('tags', ''),
 
1610
                      ]
 
1611
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1612
 
 
1613
    def __init__(self):
 
1614
        super(BzrBranchFormat7, self).__init__()
 
1615
        self._matchingbzrdir.repository_format = \
 
1616
            RepositoryFormatKnitPack5RichRoot()
 
1617
 
 
1618
    def supports_stacking(self):
2136
1619
        return True
2137
1620
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1621
 
2141
1622
class BranchReferenceFormat(BranchFormat):
2142
1623
    """Bzr branch reference format.
2160
1641
    def get_reference(self, a_bzrdir):
2161
1642
        """See BranchFormat.get_reference()."""
2162
1643
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1644
        return transport.get('location').read()
2164
1645
 
2165
1646
    def set_reference(self, a_bzrdir, to_branch):
2166
1647
        """See BranchFormat.set_reference()."""
2167
1648
        transport = a_bzrdir.get_branch_transport(None)
2168
1649
        location = transport.put_bytes('location', to_branch.base)
2169
1650
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1651
    def initialize(self, a_bzrdir, target_branch=None):
2171
1652
        """Create a branch of this format in a_bzrdir."""
2172
1653
        if target_branch is None:
2173
1654
            # this format does not implement branch itself, thus the implicit
2174
1655
            # creation contract must see it as uninitializable
2175
1656
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1657
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1658
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1659
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1660
            target_branch.bzrdir.root_transport.base)
2180
1661
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1662
        return self.open(
 
1663
            a_bzrdir, _found=True,
2183
1664
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1665
 
2187
1666
    def __init__(self):
2188
1667
        super(BranchReferenceFormat, self).__init__()
2194
1673
        def clone(to_bzrdir, revision_id=None,
2195
1674
            repository_policy=None):
2196
1675
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1676
            return format.initialize(to_bzrdir, a_branch)
2198
1677
            # cannot obey revision_id limits when cloning a reference ...
2199
1678
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1679
            # emit some sort of warning/error to the caller ?!
2201
1680
        return clone
2202
1681
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
1682
    def open(self, a_bzrdir, _found=False, location=None,
 
1683
             possible_transports=None):
2205
1684
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1685
 
2207
 
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
 
        :param _found: a private parameter, do not use it. It is used to
2210
 
            indicate if format probing has already be done.
2211
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2212
 
            (if there are any).  Default is to open fallbacks.
2213
 
        :param location: The location of the referenced branch.  If
2214
 
            unspecified, this will be determined from the branch reference in
2215
 
            a_bzrdir.
2216
 
        :param possible_transports: An optional reusable transports list.
 
1686
        _found is a private parameter, do not use it. It is used to indicate
 
1687
               if format probing has already be done.
2217
1688
        """
2218
1689
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1690
            format = BranchFormat.find_format(a_bzrdir)
2220
1691
            if format.__class__ != self.__class__:
2221
1692
                raise AssertionError("wrong format %r found for %r" %
2222
1693
                    (format, self))
2224
1695
            location = self.get_reference(a_bzrdir)
2225
1696
        real_bzrdir = bzrdir.BzrDir.open(
2226
1697
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1698
        result = real_bzrdir.open_branch()
2229
1699
        # this changes the behaviour of result.clone to create a new reference
2230
1700
        # rather than a copy of the content of the branch.
2231
1701
        # I did not use a proxy object because that needs much more extensive
2241
1711
network_format_registry = registry.FormatRegistry()
2242
1712
"""Registry of formats indexed by their network name.
2243
1713
 
2244
 
The network name for a branch format is an identifier that can be used when
 
1714
The network name for a repository format is an identifier that can be used when
2245
1715
referring to formats with smart server operations. See
2246
1716
BranchFormat.network_name() for more detail.
2247
1717
"""
2252
1722
__format5 = BzrBranchFormat5()
2253
1723
__format6 = BzrBranchFormat6()
2254
1724
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1725
BranchFormat.register_format(__format5)
2257
1726
BranchFormat.register_format(BranchReferenceFormat())
2258
1727
BranchFormat.register_format(__format6)
2259
1728
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1729
BranchFormat.set_default_format(__format6)
2262
1730
_legacy_formats = [BzrBranchFormat4(),
2263
1731
    ]
2264
1732
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
 
 
2267
 
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1733
    _legacy_formats[0].network_name(), _legacy_formats[0])
 
1734
 
 
1735
 
 
1736
class BzrBranch(Branch):
2269
1737
    """A branch stored in the actual filesystem.
2270
1738
 
2271
1739
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1745
    :ivar repository: Repository for this branch.
2278
1746
    :ivar base: The url of the base directory for this branch; the one
2279
1747
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1748
    """
2283
1749
 
2284
1750
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1751
                 _control_files=None, a_bzrdir=None, _repository=None):
2287
1752
        """Create new branch object at a particular location."""
2288
1753
        if a_bzrdir is None:
2289
1754
            raise ValueError('a_bzrdir must be supplied')
2290
1755
        else:
2291
1756
            self.bzrdir = a_bzrdir
2292
1757
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1758
        # XXX: We should be able to just do
2295
1759
        #   self.base = self.bzrdir.root_transport.base
2296
1760
        # but this does not quite work yet -- mbp 20080522
2303
1767
        Branch.__init__(self)
2304
1768
 
2305
1769
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
1770
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1771
 
2312
1772
    __repr__ = __str__
2313
1773
 
2317
1777
 
2318
1778
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
1779
 
2320
 
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
2322
 
 
2323
1780
    def is_locked(self):
2324
1781
        return self.control_files.is_locked()
2325
1782
 
2326
1783
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
 
        # All-in-one needs to always unlock/lock.
2330
 
        repo_control = getattr(self.repository, 'control_files', None)
2331
 
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
 
            self.repository.lock_write()
2334
 
            took_lock = True
2335
 
        else:
2336
 
            took_lock = False
 
1784
        repo_token = self.repository.lock_write()
2337
1785
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1786
            token = self.control_files.lock_write(token=token)
2339
1787
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1788
            self.repository.unlock()
2342
1789
            raise
 
1790
        return token
2343
1791
 
2344
1792
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
 
        # All-in-one needs to always unlock/lock.
2348
 
        repo_control = getattr(self.repository, 'control_files', None)
2349
 
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
 
            self.repository.lock_read()
2352
 
            took_lock = True
2353
 
        else:
2354
 
            took_lock = False
 
1793
        self.repository.lock_read()
2355
1794
        try:
2356
1795
            self.control_files.lock_read()
2357
1796
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1797
            self.repository.unlock()
2360
1798
            raise
2361
1799
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1800
    def unlock(self):
 
1801
        # TODO: test for failed two phase locks. This is known broken.
2364
1802
        try:
2365
1803
            self.control_files.unlock()
2366
1804
        finally:
2367
 
            # All-in-one needs to always unlock/lock.
2368
 
            repo_control = getattr(self.repository, 'control_files', None)
2369
 
            if (self.control_files == repo_control or
2370
 
                not self.control_files.is_locked()):
2371
 
                self.repository.unlock()
2372
 
            if not self.control_files.is_locked():
2373
 
                # we just released the lock
2374
 
                self._clear_cached_state()
 
1805
            self.repository.unlock()
 
1806
        if not self.control_files.is_locked():
 
1807
            # we just released the lock
 
1808
            self._clear_cached_state()
2375
1809
 
2376
1810
    def peek_lock_mode(self):
2377
1811
        if self.control_files._lock_count == 0:
2496
1930
        """See Branch.basis_tree."""
2497
1931
        return self.repository.revision_tree(self.last_revision())
2498
1932
 
 
1933
    @needs_write_lock
 
1934
    def pull(self, source, overwrite=False, stop_revision=None,
 
1935
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1936
             _override_hook_target=None):
 
1937
        """See Branch.pull.
 
1938
 
 
1939
        :param _hook_master: Private parameter - set the branch to
 
1940
            be supplied as the master to pull hooks.
 
1941
        :param run_hooks: Private parameter - if false, this branch
 
1942
            is being called because it's the master of the primary branch,
 
1943
            so it should not run its hooks.
 
1944
        :param _override_hook_target: Private parameter - set the branch to be
 
1945
            supplied as the target_branch to pull hooks.
 
1946
        """
 
1947
        result = PullResult()
 
1948
        result.source_branch = source
 
1949
        if _override_hook_target is None:
 
1950
            result.target_branch = self
 
1951
        else:
 
1952
            result.target_branch = _override_hook_target
 
1953
        source.lock_read()
 
1954
        try:
 
1955
            # We assume that during 'pull' the local repository is closer than
 
1956
            # the remote one.
 
1957
            graph = self.repository.get_graph(source.repository)
 
1958
            result.old_revno, result.old_revid = self.last_revision_info()
 
1959
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1960
                                  graph=graph)
 
1961
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1962
            result.new_revno, result.new_revid = self.last_revision_info()
 
1963
            if _hook_master:
 
1964
                result.master_branch = _hook_master
 
1965
                result.local_branch = result.target_branch
 
1966
            else:
 
1967
                result.master_branch = result.target_branch
 
1968
                result.local_branch = None
 
1969
            if run_hooks:
 
1970
                for hook in Branch.hooks['post_pull']:
 
1971
                    hook(result)
 
1972
        finally:
 
1973
            source.unlock()
 
1974
        return result
 
1975
 
2499
1976
    def _get_parent_location(self):
2500
1977
        _locs = ['parent', 'pull', 'x-pull']
2501
1978
        for l in _locs:
2505
1982
                pass
2506
1983
        return None
2507
1984
 
 
1985
    @needs_read_lock
 
1986
    def push(self, target, overwrite=False, stop_revision=None,
 
1987
             _override_hook_source_branch=None):
 
1988
        """See Branch.push.
 
1989
 
 
1990
        This is the basic concrete implementation of push()
 
1991
 
 
1992
        :param _override_hook_source_branch: If specified, run
 
1993
        the hooks passing this Branch as the source, rather than self.
 
1994
        This is for use of RemoteBranch, where push is delegated to the
 
1995
        underlying vfs-based Branch.
 
1996
        """
 
1997
        # TODO: Public option to disable running hooks - should be trivial but
 
1998
        # needs tests.
 
1999
        return _run_with_write_locked_target(
 
2000
            target, self._push_with_bound_branches, target, overwrite,
 
2001
            stop_revision,
 
2002
            _override_hook_source_branch=_override_hook_source_branch)
 
2003
 
 
2004
    def _push_with_bound_branches(self, target, overwrite,
 
2005
            stop_revision,
 
2006
            _override_hook_source_branch=None):
 
2007
        """Push from self into target, and into target's master if any.
 
2008
 
 
2009
        This is on the base BzrBranch class even though it doesn't support
 
2010
        bound branches because the *target* might be bound.
 
2011
        """
 
2012
        def _run_hooks():
 
2013
            if _override_hook_source_branch:
 
2014
                result.source_branch = _override_hook_source_branch
 
2015
            for hook in Branch.hooks['post_push']:
 
2016
                hook(result)
 
2017
 
 
2018
        bound_location = target.get_bound_location()
 
2019
        if bound_location and target.base != bound_location:
 
2020
            # there is a master branch.
 
2021
            #
 
2022
            # XXX: Why the second check?  Is it even supported for a branch to
 
2023
            # be bound to itself? -- mbp 20070507
 
2024
            master_branch = target.get_master_branch()
 
2025
            master_branch.lock_write()
 
2026
            try:
 
2027
                # push into the master from this branch.
 
2028
                self._basic_push(master_branch, overwrite, stop_revision)
 
2029
                # and push into the target branch from this. Note that we push from
 
2030
                # this branch again, because its considered the highest bandwidth
 
2031
                # repository.
 
2032
                result = self._basic_push(target, overwrite, stop_revision)
 
2033
                result.master_branch = master_branch
 
2034
                result.local_branch = target
 
2035
                _run_hooks()
 
2036
                return result
 
2037
            finally:
 
2038
                master_branch.unlock()
 
2039
        else:
 
2040
            # no master branch
 
2041
            result = self._basic_push(target, overwrite, stop_revision)
 
2042
            # TODO: Why set master_branch and local_branch if there's no
 
2043
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2044
            # 20070504
 
2045
            result.master_branch = target
 
2046
            result.local_branch = None
 
2047
            _run_hooks()
 
2048
            return result
 
2049
 
2508
2050
    def _basic_push(self, target, overwrite, stop_revision):
2509
2051
        """Basic implementation of push without bound branches or hooks.
2510
2052
 
2511
 
        Must be called with source read locked and target write locked.
 
2053
        Must be called with self read locked and target write locked.
2512
2054
        """
2513
 
        result = BranchPushResult()
 
2055
        result = PushResult()
2514
2056
        result.source_branch = self
2515
2057
        result.target_branch = target
2516
2058
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2059
        if result.old_revid != self.last_revision():
2519
2060
            # We assume that during 'push' this repository is closer than
2520
2061
            # the target.
2521
2062
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2063
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2064
                                    graph=graph)
2524
2065
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2066
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2067
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2068
        return result
2529
2069
 
 
2070
    def get_parent(self):
 
2071
        """See Branch.get_parent."""
 
2072
        parent = self._get_parent_location()
 
2073
        if parent is None:
 
2074
            return parent
 
2075
        # This is an old-format absolute path to a local branch
 
2076
        # turn it into a url
 
2077
        if parent.startswith('/'):
 
2078
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2079
        try:
 
2080
            return urlutils.join(self.base[:-1], parent)
 
2081
        except errors.InvalidURLJoin, e:
 
2082
            raise errors.InaccessibleParent(parent, self.base)
 
2083
 
2530
2084
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2085
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2086
 
2533
2087
    def set_push_location(self, location):
2534
2088
        """See Branch.set_push_location."""
2536
2090
            'push_location', location,
2537
2091
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2092
 
 
2093
    @needs_write_lock
 
2094
    def set_parent(self, url):
 
2095
        """See Branch.set_parent."""
 
2096
        # TODO: Maybe delete old location files?
 
2097
        # URLs should never be unicode, even on the local fs,
 
2098
        # FIXUP this and get_parent in a future branch format bump:
 
2099
        # read and rewrite the file. RBC 20060125
 
2100
        if url is not None:
 
2101
            if isinstance(url, unicode):
 
2102
                try:
 
2103
                    url = url.encode('ascii')
 
2104
                except UnicodeEncodeError:
 
2105
                    raise errors.InvalidURL(url,
 
2106
                        "Urls must be 7-bit ascii, "
 
2107
                        "use bzrlib.urlutils.escape")
 
2108
            url = urlutils.relative_url(self.base, url)
 
2109
        self._set_parent_location(url)
 
2110
 
2539
2111
    def _set_parent_location(self, url):
2540
2112
        if url is None:
2541
2113
            self._transport.delete('parent')
2543
2115
            self._transport.put_bytes('parent', url + '\n',
2544
2116
                mode=self.bzrdir._get_file_mode())
2545
2117
 
 
2118
    def set_stacked_on_url(self, url):
 
2119
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2120
 
2546
2121
 
2547
2122
class BzrBranch5(BzrBranch):
2548
2123
    """A format 5 branch. This supports new features over plain branches.
2550
2125
    It has support for a master_branch which is the data for bound branches.
2551
2126
    """
2552
2127
 
 
2128
    @needs_write_lock
 
2129
    def pull(self, source, overwrite=False, stop_revision=None,
 
2130
             run_hooks=True, possible_transports=None,
 
2131
             _override_hook_target=None):
 
2132
        """Pull from source into self, updating my master if any.
 
2133
 
 
2134
        :param run_hooks: Private parameter - if false, this branch
 
2135
            is being called because it's the master of the primary branch,
 
2136
            so it should not run its hooks.
 
2137
        """
 
2138
        bound_location = self.get_bound_location()
 
2139
        master_branch = None
 
2140
        if bound_location and source.base != bound_location:
 
2141
            # not pulling from master, so we need to update master.
 
2142
            master_branch = self.get_master_branch(possible_transports)
 
2143
            master_branch.lock_write()
 
2144
        try:
 
2145
            if master_branch:
 
2146
                # pull from source into master.
 
2147
                master_branch.pull(source, overwrite, stop_revision,
 
2148
                    run_hooks=False)
 
2149
            return super(BzrBranch5, self).pull(source, overwrite,
 
2150
                stop_revision, _hook_master=master_branch,
 
2151
                run_hooks=run_hooks,
 
2152
                _override_hook_target=_override_hook_target)
 
2153
        finally:
 
2154
            if master_branch:
 
2155
                master_branch.unlock()
 
2156
 
2553
2157
    def get_bound_location(self):
2554
2158
        try:
2555
2159
            return self._transport.get_bytes('bound')[:-1]
2642
2246
        return None
2643
2247
 
2644
2248
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
2249
class BzrBranch7(BzrBranch5):
 
2250
    """A branch with support for a fallback repository."""
 
2251
 
 
2252
    def _get_fallback_repository(self, url):
 
2253
        """Get the repository we fallback to at url."""
 
2254
        url = urlutils.join(self.base, url)
 
2255
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2256
                                      possible_transports=[self._transport])
 
2257
        return a_bzrdir.open_branch().repository
 
2258
 
 
2259
    def _activate_fallback_location(self, url):
 
2260
        """Activate the branch/repository from url as a fallback repository."""
 
2261
        self.repository.add_fallback_repository(
 
2262
            self._get_fallback_repository(url))
2647
2263
 
2648
2264
    def _open_hook(self):
2649
 
        if self._ignore_fallbacks:
2650
 
            return
2651
2265
        try:
2652
2266
            url = self.get_stacked_on_url()
2653
2267
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2663
2277
                        "None, not a URL." % hook_name)
2664
2278
            self._activate_fallback_location(url)
2665
2279
 
 
2280
    def _check_stackable_repo(self):
 
2281
        if not self.repository._format.supports_external_lookups:
 
2282
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2283
                self.repository.base)
 
2284
 
2666
2285
    def __init__(self, *args, **kwargs):
2667
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2286
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2287
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2288
        self._partial_revision_history_cache = []
2671
2289
 
2672
2290
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2291
        super(BzrBranch7, self)._clear_cached_state()
2674
2292
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2293
        self._partial_revision_history_cache = []
2676
2294
 
2677
2295
    def _last_revision_info(self):
2678
2296
        revision_string = self._transport.get_bytes('last-revision')
2724
2342
        if _mod_revision.is_null(last_revision):
2725
2343
            return
2726
2344
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2345
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2346
 
2729
2347
    def _gen_revision_history(self):
2730
2348
        """Generate the revision history from last revision
2733
2351
        self._extend_partial_history(stop_index=last_revno-1)
2734
2352
        return list(reversed(self._partial_revision_history_cache))
2735
2353
 
 
2354
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2355
        """Extend the partial history to include a given index
 
2356
 
 
2357
        If a stop_index is supplied, stop when that index has been reached.
 
2358
        If a stop_revision is supplied, stop when that revision is
 
2359
        encountered.  Otherwise, stop when the beginning of history is
 
2360
        reached.
 
2361
 
 
2362
        :param stop_index: The index which should be present.  When it is
 
2363
            present, history extension will stop.
 
2364
        :param revision_id: The revision id which should be present.  When
 
2365
            it is encountered, history extension will stop.
 
2366
        """
 
2367
        repo = self.repository
 
2368
        if len(self._partial_revision_history_cache) == 0:
 
2369
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2370
        else:
 
2371
            start_revision = self._partial_revision_history_cache[-1]
 
2372
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2373
            #skip the last revision in the list
 
2374
            next_revision = iterator.next()
 
2375
        for revision_id in iterator:
 
2376
            self._partial_revision_history_cache.append(revision_id)
 
2377
            if (stop_index is not None and
 
2378
                len(self._partial_revision_history_cache) > stop_index):
 
2379
                break
 
2380
            if revision_id == stop_revision:
 
2381
                break
 
2382
 
2736
2383
    def _write_revision_history(self, history):
2737
2384
        """Factored out of set_revision_history.
2738
2385
 
2759
2406
        """Set the parent branch"""
2760
2407
        return self._get_config_location('parent_location')
2761
2408
 
2762
 
    @needs_write_lock
2763
 
    def _set_all_reference_info(self, info_dict):
2764
 
        """Replace all reference info stored in a branch.
2765
 
 
2766
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2767
 
        """
2768
 
        s = StringIO()
2769
 
        writer = rio.RioWriter(s)
2770
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2771
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
 
                                branch_location=branch_location)
2773
 
            writer.write_stanza(stanza)
2774
 
        self._transport.put_bytes('references', s.getvalue())
2775
 
        self._reference_info = info_dict
2776
 
 
2777
 
    @needs_read_lock
2778
 
    def _get_all_reference_info(self):
2779
 
        """Return all the reference info stored in a branch.
2780
 
 
2781
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2782
 
        """
2783
 
        if self._reference_info is not None:
2784
 
            return self._reference_info
2785
 
        rio_file = self._transport.get('references')
2786
 
        try:
2787
 
            stanzas = rio.read_stanzas(rio_file)
2788
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2789
 
                             s['branch_location'])) for s in stanzas)
2790
 
        finally:
2791
 
            rio_file.close()
2792
 
        self._reference_info = info_dict
2793
 
        return info_dict
2794
 
 
2795
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2796
 
        """Set the branch location to use for a tree reference.
2797
 
 
2798
 
        :param file_id: The file-id of the tree reference.
2799
 
        :param tree_path: The path of the tree reference in the tree.
2800
 
        :param branch_location: The location of the branch to retrieve tree
2801
 
            references from.
2802
 
        """
2803
 
        info_dict = self._get_all_reference_info()
2804
 
        info_dict[file_id] = (tree_path, branch_location)
2805
 
        if None in (tree_path, branch_location):
2806
 
            if tree_path is not None:
2807
 
                raise ValueError('tree_path must be None when branch_location'
2808
 
                                 ' is None.')
2809
 
            if branch_location is not None:
2810
 
                raise ValueError('branch_location must be None when tree_path'
2811
 
                                 ' is None.')
2812
 
            del info_dict[file_id]
2813
 
        self._set_all_reference_info(info_dict)
2814
 
 
2815
 
    def get_reference_info(self, file_id):
2816
 
        """Get the tree_path and branch_location for a tree reference.
2817
 
 
2818
 
        :return: a tuple of (tree_path, branch_location)
2819
 
        """
2820
 
        return self._get_all_reference_info().get(file_id, (None, None))
2821
 
 
2822
 
    def reference_parent(self, file_id, path, possible_transports=None):
2823
 
        """Return the parent branch for a tree-reference file_id.
2824
 
 
2825
 
        :param file_id: The file_id of the tree reference
2826
 
        :param path: The path of the file_id in the tree
2827
 
        :return: A branch associated with the file_id
2828
 
        """
2829
 
        branch_location = self.get_reference_info(file_id)[1]
2830
 
        if branch_location is None:
2831
 
            return Branch.reference_parent(self, file_id, path,
2832
 
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
2834
 
        return Branch.open(branch_location,
2835
 
                           possible_transports=possible_transports)
2836
 
 
2837
2409
    def set_push_location(self, location):
2838
2410
        """See Branch.set_push_location."""
2839
2411
        self._set_config_location('push_location', location)
2881
2453
            raise errors.NotStacked(self)
2882
2454
        return stacked_url
2883
2455
 
 
2456
    def set_append_revisions_only(self, enabled):
 
2457
        if enabled:
 
2458
            value = 'True'
 
2459
        else:
 
2460
            value = 'False'
 
2461
        self.get_config().set_user_option('append_revisions_only', value,
 
2462
            warn_masked=True)
 
2463
 
 
2464
    def set_stacked_on_url(self, url):
 
2465
        self._check_stackable_repo()
 
2466
        if not url:
 
2467
            try:
 
2468
                old_url = self.get_stacked_on_url()
 
2469
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2470
                errors.UnstackableRepositoryFormat):
 
2471
                return
 
2472
            url = ''
 
2473
            # repositories don't offer an interface to remove fallback
 
2474
            # repositories today; take the conceptually simpler option and just
 
2475
            # reopen it.
 
2476
            self.repository = self.bzrdir.find_repository()
 
2477
            # for every revision reference the branch has, ensure it is pulled
 
2478
            # in.
 
2479
            source_repository = self._get_fallback_repository(old_url)
 
2480
            for revision_id in chain([self.last_revision()],
 
2481
                self.tags.get_reverse_tag_dict()):
 
2482
                self.repository.fetch(source_repository, revision_id,
 
2483
                    find_ghosts=True)
 
2484
        else:
 
2485
            self._activate_fallback_location(url)
 
2486
        # write this out after the repository is stacked to avoid setting a
 
2487
        # stacked config that doesn't work.
 
2488
        self._set_config_location('stacked_on_location', url)
 
2489
 
2884
2490
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2491
        value = self.get_config().get_user_option('append_revisions_only')
 
2492
        return value == 'True'
 
2493
 
 
2494
    def _make_tags(self):
 
2495
        return BasicTags(self)
2887
2496
 
2888
2497
    @needs_write_lock
2889
2498
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2538
        return self.revno() - index
2930
2539
 
2931
2540
 
2932
 
class BzrBranch7(BzrBranch8):
2933
 
    """A branch with support for a fallback repository."""
2934
 
 
2935
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2936
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2937
 
 
2938
 
    def get_reference_info(self, file_id):
2939
 
        Branch.get_reference_info(self, file_id)
2940
 
 
2941
 
    def reference_parent(self, file_id, path, possible_transports=None):
2942
 
        return Branch.reference_parent(self, file_id, path,
2943
 
                                       possible_transports)
2944
 
 
2945
 
 
2946
2541
class BzrBranch6(BzrBranch7):
2947
2542
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2543
 
2951
2546
    """
2952
2547
 
2953
2548
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2549
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2550
 
 
2551
    def set_stacked_on_url(self, url):
 
2552
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2553
 
2956
2554
 
2957
2555
######################################################################
2975
2573
    :ivar new_revno: Revision number after pull.
2976
2574
    :ivar old_revid: Tip revision id before pull.
2977
2575
    :ivar new_revid: Tip revision id after pull.
2978
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2576
    :ivar source_branch: Source (local) branch object.
2979
2577
    :ivar master_branch: Master branch of the target, or the target if no
2980
2578
        Master
2981
2579
    :ivar local_branch: target branch if there is a Master, else None
2982
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2580
    :ivar target_branch: Target/destination branch object.
2983
2581
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
2582
    """
2985
2583
 
2996
2594
        self._show_tag_conficts(to_file)
2997
2595
 
2998
2596
 
2999
 
class BranchPushResult(_Result):
 
2597
class PushResult(_Result):
3000
2598
    """Result of a Branch.push operation.
3001
2599
 
3002
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3003
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3004
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3005
 
        before the push.
3006
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3007
 
        after the push.
3008
 
    :ivar source_branch: Source branch object that the push was from. This is
3009
 
        read locked, and generally is a local (and thus low latency) branch.
3010
 
    :ivar master_branch: If target is a bound branch, the master branch of
3011
 
        target, or target itself. Always write locked.
3012
 
    :ivar target_branch: The direct Branch where data is being sent (write
3013
 
        locked).
3014
 
    :ivar local_branch: If the target is a bound branch this will be the
3015
 
        target, otherwise it will be None.
 
2600
    :ivar old_revno: Revision number before push.
 
2601
    :ivar new_revno: Revision number after push.
 
2602
    :ivar old_revid: Tip revision id before push.
 
2603
    :ivar new_revid: Tip revision id after push.
 
2604
    :ivar source_branch: Source branch object.
 
2605
    :ivar master_branch: Master branch of the target, or None.
 
2606
    :ivar target_branch: Target/destination branch object.
3016
2607
    """
3017
2608
 
3018
2609
    def __int__(self):
3036
2627
 
3037
2628
    def __init__(self, branch):
3038
2629
        self.branch = branch
3039
 
        self.errors = []
3040
2630
 
3041
2631
    def report_results(self, verbose):
3042
2632
        """Report the check results via trace.note.
3044
2634
        :param verbose: Requests more detailed display of what was checked,
3045
2635
            if any.
3046
2636
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
3049
 
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
2637
        note('checked branch %s format %s',
 
2638
             self.branch.base,
 
2639
             self.branch._format)
3051
2640
 
3052
2641
 
3053
2642
class Converter5to6(object):
3091
2680
        branch._transport.put_bytes('format', format.get_format_string())
3092
2681
 
3093
2682
 
3094
 
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
3096
 
 
3097
 
    def convert(self, branch):
3098
 
        format = BzrBranchFormat8()
3099
 
        branch._transport.put_bytes('references', '')
3100
 
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
2683
 
3104
2684
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2685
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2728
    @staticmethod
3149
2729
    def _get_branch_formats_to_test():
3150
2730
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3152
 
 
3153
 
    def pull(self, overwrite=False, stop_revision=None,
3154
 
             possible_transports=None, local=False):
3155
 
        """Mirror source into target branch.
3156
 
 
3157
 
        The target branch is considered to be 'local', having low latency.
3158
 
 
3159
 
        :returns: PullResult instance
3160
 
        """
3161
 
        raise NotImplementedError(self.pull)
 
2731
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2732
 
3163
2733
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2734
                         graph=None):
3173
2743
        """
3174
2744
        raise NotImplementedError(self.update_revisions)
3175
2745
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
3177
 
             _override_hook_source_branch=None):
3178
 
        """Mirror the source branch into the target branch.
3179
 
 
3180
 
        The source branch is considered to be 'local', having low latency.
3181
 
        """
3182
 
        raise NotImplementedError(self.push)
3183
 
 
3184
2746
 
3185
2747
class GenericInterBranch(InterBranch):
3186
2748
    """InterBranch implementation that uses public Branch functions.
3233
2795
        finally:
3234
2796
            self.source.unlock()
3235
2797
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
2798
    @classmethod
3358
2799
    def is_compatible(self, source, target):
3359
2800
        # GenericBranch uses the public API, so always compatible
3360
2801
        return True
3361
2802
 
3362
2803
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
 
 
3400
2804
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)