~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2009-03-03 01:45:32 UTC
  • mto: (4070.4.5 gnu-changelog)
  • mto: This revision was merged to the branch mainline in revision 4081.
  • Revision ID: mbp@sourcefrog.net-20090303014532-d223fxy97cb1og8f
Recommend setting timestamp in BranchBuilder

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
283
211
        new_history.reverse()
284
212
        return new_history
285
213
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
214
    def lock_write(self):
293
215
        raise NotImplementedError(self.lock_write)
294
216
 
295
217
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
218
        raise NotImplementedError(self.lock_read)
302
219
 
303
220
    def unlock(self):
428
345
            * 'include' - the stop revision is the last item in the result
429
346
            * 'with-merges' - include the stop revision and all of its
430
347
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
348
        :param direction: either 'reverse' or 'forward':
434
349
            * reverse means return the start_revision_id first, i.e.
435
350
              start at the most recent revision and go backwards in history
457
372
        # start_revision_id.
458
373
        if self._merge_sorted_revisions_cache is None:
459
374
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
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
 
464
384
        filtered = self._filter_merge_sorted_revisions(
465
385
            self._merge_sorted_revisions_cache, start_revision_id,
466
386
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
387
        if direction == 'reverse':
471
388
            return filtered
472
389
        if direction == 'forward':
479
396
        """Iterate over an inclusive range of sorted revisions."""
480
397
        rev_iter = iter(merge_sorted_revisions)
481
398
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
399
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
400
                if rev_id != start_revision_id:
485
401
                    continue
486
402
                else:
487
403
                    # The decision to include the start or not
488
404
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
405
                    rev_iter = chain(
 
406
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
407
                        rev_iter)
491
408
                    break
492
409
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
411
                yield rev_id, depth, revno, end_of_merge
498
412
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
413
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
414
                if rev_id == stop_revision_id:
502
415
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
416
                yield rev_id, depth, revno, end_of_merge
505
417
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
418
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
419
                yield rev_id, depth, revno, end_of_merge
510
420
                if rev_id == stop_revision_id:
511
421
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
422
        elif stop_rule == 'with-merges':
525
423
            stop_rev = self.repository.get_revision(stop_revision_id)
526
424
            if stop_rev.parent_ids:
527
425
                left_parent = stop_rev.parent_ids[0]
528
426
            else:
529
427
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
428
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
429
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
430
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
431
                yield rev_id, depth, revno, end_of_merge
549
432
        else:
550
433
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
434
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
435
    def leave_lock_in_place(self):
598
436
        """Tell this branch object not to release the physical lock when this
599
437
        object is unlocked.
616
454
        :param other: The branch to bind to
617
455
        :type other: Branch
618
456
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
620
 
 
621
 
    def set_append_revisions_only(self, enabled):
622
 
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
624
 
        if enabled:
625
 
            value = 'True'
626
 
        else:
627
 
            value = 'False'
628
 
        self.get_config().set_user_option('append_revisions_only', value,
629
 
            warn_masked=True)
630
 
 
631
 
    def set_reference_info(self, file_id, tree_path, branch_location):
632
 
        """Set the branch location to use for a tree reference."""
633
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
634
 
 
635
 
    def get_reference_info(self, file_id):
636
 
        """Get the tree_path and branch_location for a tree reference."""
637
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
457
        raise errors.UpgradeRequired(self.base)
638
458
 
639
459
    @needs_write_lock
640
460
    def fetch(self, from_branch, last_revision=None, pb=None):
648
468
        """
649
469
        if self.base == from_branch.base:
650
470
            return (0, [])
651
 
        if pb is not None:
652
 
            symbol_versioning.warn(
653
 
                symbol_versioning.deprecated_in((1, 14, 0))
654
 
                % "pb parameter to fetch()")
 
471
        if pb is None:
 
472
            nested_pb = ui.ui_factory.nested_progress_bar()
 
473
            pb = nested_pb
 
474
        else:
 
475
            nested_pb = None
 
476
 
655
477
        from_branch.lock_read()
656
478
        try:
657
479
            if last_revision is None:
 
480
                pb.update('get source history')
658
481
                last_revision = from_branch.last_revision()
659
482
                last_revision = _mod_revision.ensure_null(last_revision)
660
483
            return self.repository.fetch(from_branch.repository,
661
484
                                         revision_id=last_revision,
662
 
                                         pb=pb)
 
485
                                         pb=nested_pb)
663
486
        finally:
 
487
            if nested_pb is not None:
 
488
                nested_pb.finished()
664
489
            from_branch.unlock()
665
490
 
666
491
    def get_bound_location(self):
674
499
    def get_old_bound_location(self):
675
500
        """Return the URL of the branch we used to be bound to
676
501
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
502
        raise errors.UpgradeRequired(self.base)
678
503
 
679
504
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
505
                           timezone=None, committer=None, revprops=None,
730
555
    def set_revision_history(self, rev_history):
731
556
        raise NotImplementedError(self.set_revision_history)
732
557
 
733
 
    @needs_write_lock
734
 
    def set_parent(self, url):
735
 
        """See Branch.set_parent."""
736
 
        # TODO: Maybe delete old location files?
737
 
        # URLs should never be unicode, even on the local fs,
738
 
        # FIXUP this and get_parent in a future branch format bump:
739
 
        # read and rewrite the file. RBC 20060125
740
 
        if url is not None:
741
 
            if isinstance(url, unicode):
742
 
                try:
743
 
                    url = url.encode('ascii')
744
 
                except UnicodeEncodeError:
745
 
                    raise errors.InvalidURL(url,
746
 
                        "Urls must be 7-bit ascii, "
747
 
                        "use bzrlib.urlutils.escape")
748
 
            url = urlutils.relative_url(self.base, url)
749
 
        self._set_parent_location(url)
750
 
 
751
 
    @needs_write_lock
752
558
    def set_stacked_on_url(self, url):
753
559
        """Set the URL this branch is stacked against.
754
560
 
757
563
        :raises UnstackableRepositoryFormat: If the repository does not support
758
564
            stacking.
759
565
        """
760
 
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
765
 
        self._check_stackable_repo()
766
 
        if not url:
767
 
            try:
768
 
                old_url = self.get_stacked_on_url()
769
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
 
                errors.UnstackableRepositoryFormat):
771
 
                return
772
 
            self._unstack()
773
 
        else:
774
 
            self._activate_fallback_location(url)
775
 
        # write this out after the repository is stacked to avoid setting a
776
 
        # stacked config that doesn't work.
777
 
        self._set_config_location('stacked_on_location', url)
778
 
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
 
 
834
 
    def _set_tags_bytes(self, bytes):
835
 
        """Mirror method for _get_tags_bytes.
836
 
 
837
 
        :seealso: Branch._get_tags_bytes.
838
 
        """
839
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
840
 
            'tags', bytes)
 
566
        raise NotImplementedError(self.set_stacked_on_url)
841
567
 
842
568
    def _cache_revision_history(self, rev_history):
843
569
        """Set the cached revision history to rev_history.
871
597
        self._revision_id_to_revno_cache = None
872
598
        self._last_revision_info_cache = None
873
599
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
600
 
877
601
    def _gen_revision_history(self):
878
602
        """Return sequence of revision hashes on to this branch.
915
639
 
916
640
    def unbind(self):
917
641
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
642
        raise errors.UpgradeRequired(self.base)
 
643
 
 
644
    def set_append_revisions_only(self, enabled):
 
645
        """Older format branches are never restricted to append-only"""
 
646
        raise errors.UpgradeRequired(self.base)
919
647
 
920
648
    def last_revision(self):
921
649
        """Return last revision id, or NULL_REVISION."""
978
706
        return InterBranch.get(other, self).update_revisions(stop_revision,
979
707
            overwrite, graph)
980
708
 
981
 
    def import_last_revision_info(self, source_repo, revno, revid):
982
 
        """Set the last revision info, importing from another repo if necessary.
983
 
 
984
 
        This is used by the bound branch code to upload a revision to
985
 
        the master branch first before updating the tip of the local branch.
986
 
 
987
 
        :param source_repo: Source repository to optionally fetch from
988
 
        :param revno: Revision number of the new tip
989
 
        :param revid: Revision id of the new tip
990
 
        """
991
 
        if not self.repository.has_same_location(source_repo):
992
 
            self.repository.fetch(source_repo, revision_id=revid)
993
 
        self.set_last_revision_info(revno, revid)
994
 
 
995
709
    def revision_id_to_revno(self, revision_id):
996
710
        """Given a revision id, return its revno"""
997
711
        if _mod_revision.is_null(revision_id):
1002
716
        except ValueError:
1003
717
            raise errors.NoSuchRevision(self, revision_id)
1004
718
 
1005
 
    @needs_read_lock
1006
719
    def get_rev_id(self, revno, history=None):
1007
720
        """Find the revision id of the specified revno."""
1008
721
        if revno == 0:
1009
722
            return _mod_revision.NULL_REVISION
1010
 
        last_revno, last_revid = self.last_revision_info()
1011
 
        if revno == last_revno:
1012
 
            return last_revid
1013
 
        if revno <= 0 or revno > last_revno:
 
723
        if history is None:
 
724
            history = self.revision_history()
 
725
        if revno <= 0 or revno > len(history):
1014
726
            raise errors.NoSuchRevision(self, revno)
1015
 
        distance_from_last = last_revno - revno
1016
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1017
 
            self._extend_partial_history(distance_from_last)
1018
 
        return self._partial_revision_history_cache[distance_from_last]
 
727
        return history[revno - 1]
1019
728
 
1020
 
    @needs_write_lock
1021
729
    def pull(self, source, overwrite=False, stop_revision=None,
1022
 
             possible_transports=None, *args, **kwargs):
 
730
             possible_transports=None, _override_hook_target=None):
1023
731
        """Mirror source into this branch.
1024
732
 
1025
733
        This branch is considered to be 'local', having low latency.
1026
734
 
1027
735
        :returns: PullResult instance
1028
736
        """
1029
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
 
            stop_revision=stop_revision,
1031
 
            possible_transports=possible_transports, *args, **kwargs)
 
737
        raise NotImplementedError(self.pull)
1032
738
 
1033
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1034
 
        **kwargs):
 
739
    def push(self, target, overwrite=False, stop_revision=None):
1035
740
        """Mirror this branch into target.
1036
741
 
1037
742
        This branch is considered to be 'local', having low latency.
1038
743
        """
1039
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1040
 
            *args, **kwargs)
1041
 
 
1042
 
    def lossy_push(self, target, stop_revision=None):
1043
 
        """Push deltas into another branch.
1044
 
 
1045
 
        :note: This does not, like push, retain the revision ids from 
1046
 
            the source branch and will, rather than adding bzr-specific 
1047
 
            metadata, push only those semantics of the revision that can be 
1048
 
            natively represented by this branch' VCS.
1049
 
 
1050
 
        :param target: Target branch
1051
 
        :param stop_revision: Revision to push, defaults to last revision.
1052
 
        :return: BranchPushResult with an extra member revidmap: 
1053
 
            A dictionary mapping revision ids from the target branch 
1054
 
            to new revision ids in the target branch, for each 
1055
 
            revision that was pushed.
1056
 
        """
1057
 
        inter = InterBranch.get(self, target)
1058
 
        lossy_push = getattr(inter, "lossy_push", None)
1059
 
        if lossy_push is None:
1060
 
            raise errors.LossyPushToSameVCS(self, target)
1061
 
        return lossy_push(stop_revision)
 
744
        raise NotImplementedError(self.push)
1062
745
 
1063
746
    def basis_tree(self):
1064
747
        """Return `Tree` object for last revision."""
1071
754
        pattern is that the user can override it by specifying a
1072
755
        location.
1073
756
        """
1074
 
        parent = self._get_parent_location()
1075
 
        if parent is None:
1076
 
            return parent
1077
 
        # This is an old-format absolute path to a local branch
1078
 
        # turn it into a url
1079
 
        if parent.startswith('/'):
1080
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1081
 
        try:
1082
 
            return urlutils.join(self.base[:-1], parent)
1083
 
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
1085
 
 
1086
 
    def _get_parent_location(self):
1087
 
        raise NotImplementedError(self._get_parent_location)
 
757
        raise NotImplementedError(self.get_parent)
1088
758
 
1089
759
    def _set_config_location(self, name, url, config=None,
1090
760
                             make_relative=False):
1104
774
            location = None
1105
775
        return location
1106
776
 
1107
 
    def get_child_submit_format(self):
1108
 
        """Return the preferred format of submissions to this branch."""
1109
 
        return self.get_config().get_user_option("child_submit_format")
1110
 
 
1111
777
    def get_submit_branch(self):
1112
778
        """Return the submit location of the branch.
1113
779
 
1130
796
    def get_public_branch(self):
1131
797
        """Return the public location of the branch.
1132
798
 
1133
 
        This is used by merge directives.
 
799
        This is is used by merge directives.
1134
800
        """
1135
801
        return self._get_config_location('public_branch')
1136
802
 
1172
838
        params = ChangeBranchTipParams(
1173
839
            self, old_revno, new_revno, old_revid, new_revid)
1174
840
        for hook in hooks:
1175
 
            hook(params)
 
841
            try:
 
842
                hook(params)
 
843
            except errors.TipChangeRejected:
 
844
                raise
 
845
            except Exception:
 
846
                exc_info = sys.exc_info()
 
847
                hook_name = Branch.hooks.get_hook_name(hook)
 
848
                raise errors.HookFailed(
 
849
                    'pre_change_branch_tip', hook_name, exc_info)
 
850
 
 
851
    def set_parent(self, url):
 
852
        raise NotImplementedError(self.set_parent)
1176
853
 
1177
854
    @needs_write_lock
1178
855
    def update(self):
1209
886
                     be truncated to end with revision_id.
1210
887
        """
1211
888
        result = to_bzrdir.create_branch()
1212
 
        result.lock_write()
1213
 
        try:
1214
 
            if repository_policy is not None:
1215
 
                repository_policy.configure_branch(result)
1216
 
            self.copy_content_into(result, revision_id=revision_id)
1217
 
        finally:
1218
 
            result.unlock()
1219
 
        return result
 
889
        if repository_policy is not None:
 
890
            repository_policy.configure_branch(result)
 
891
        self.copy_content_into(result, revision_id=revision_id)
 
892
        return  result
1220
893
 
1221
894
    @needs_read_lock
1222
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
895
    def sprout(self, to_bzrdir, revision_id=None):
1223
896
        """Create a new line of development from the branch, into to_bzrdir.
1224
897
 
1225
898
        to_bzrdir controls the branch format.
1227
900
        revision_id: if not None, the revision history in the new branch will
1228
901
                     be truncated to end with revision_id.
1229
902
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
903
        result = to_bzrdir.create_branch()
1234
 
        result.lock_write()
1235
 
        try:
1236
 
            if repository_policy is not None:
1237
 
                repository_policy.configure_branch(result)
1238
 
            self.copy_content_into(result, revision_id=revision_id)
1239
 
            result.set_parent(self.bzrdir.root_transport.base)
1240
 
        finally:
1241
 
            result.unlock()
 
904
        self.copy_content_into(result, revision_id=revision_id)
 
905
        result.set_parent(self.bzrdir.root_transport.base)
1242
906
        return result
1243
907
 
1244
908
    def _synchronize_history(self, destination, revision_id):
1256
920
        source_revno, source_revision_id = self.last_revision_info()
1257
921
        if revision_id is None:
1258
922
            revno, revision_id = source_revno, source_revision_id
 
923
        elif source_revision_id == revision_id:
 
924
            # we know the revno without needing to walk all of history
 
925
            revno = source_revno
1259
926
        else:
1260
 
            graph = self.repository.get_graph()
1261
 
            try:
1262
 
                revno = graph.find_distance_to_null(revision_id, 
1263
 
                    [(source_revision_id, source_revno)])
1264
 
            except errors.GhostRevisionsHaveNoRevno:
1265
 
                # Default to 1, if we can't find anything else
1266
 
                revno = 1
 
927
            # To figure out the revno for a random revision, we need to build
 
928
            # the revision history, and count its length.
 
929
            # We don't care about the order, just how long it is.
 
930
            # Alternatively, we could start at the current location, and count
 
931
            # backwards. But there is no guarantee that we will find it since
 
932
            # it may be a merged revision.
 
933
            revno = len(list(self.repository.iter_reverse_revision_history(
 
934
                                                                revision_id)))
1267
935
        destination.set_last_revision_info(revno, revision_id)
1268
936
 
1269
937
    @needs_read_lock
1273
941
        revision_id: if not None, the revision history in the new branch will
1274
942
                     be truncated to end with revision_id.
1275
943
        """
1276
 
        self.update_references(destination)
1277
944
        self._synchronize_history(destination, revision_id)
1278
945
        try:
1279
946
            parent = self.get_parent()
1285
952
        if self._push_should_merge_tags():
1286
953
            self.tags.merge_to(destination.tags)
1287
954
 
1288
 
    def update_references(self, target):
1289
 
        if not getattr(self._format, 'supports_reference_locations', False):
1290
 
            return
1291
 
        reference_dict = self._get_all_reference_info()
1292
 
        if len(reference_dict) == 0:
1293
 
            return
1294
 
        old_base = self.base
1295
 
        new_base = target.base
1296
 
        target_reference_dict = target._get_all_reference_info()
1297
 
        for file_id, (tree_path, branch_location) in (
1298
 
            reference_dict.items()):
1299
 
            branch_location = urlutils.rebase_url(branch_location,
1300
 
                                                  old_base, new_base)
1301
 
            target_reference_dict.setdefault(
1302
 
                file_id, (tree_path, branch_location))
1303
 
        target._set_all_reference_info(target_reference_dict)
1304
 
 
1305
955
    @needs_read_lock
1306
 
    def check(self, refs):
 
956
    def check(self):
1307
957
        """Check consistency of the branch.
1308
958
 
1309
959
        In particular this checks that revisions given in the revision-history
1312
962
 
1313
963
        Callers will typically also want to check the repository.
1314
964
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
965
        :return: A BranchCheckResult.
1318
966
        """
1319
 
        result = BranchCheckResult(self)
 
967
        mainline_parent_id = None
1320
968
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
969
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
970
                                last_revision_id))
 
971
        real_rev_history.reverse()
 
972
        if len(real_rev_history) != last_revno:
 
973
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
974
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
975
        # TODO: We should probably also check that real_rev_history actually
 
976
        #       matches self.revision_history()
 
977
        for revision_id in real_rev_history:
 
978
            try:
 
979
                revision = self.repository.get_revision(revision_id)
 
980
            except errors.NoSuchRevision, e:
 
981
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
982
                            % revision_id)
 
983
            # In general the first entry on the revision history has no parents.
 
984
            # But it's not illegal for it to have parents listed; this can happen
 
985
            # in imports from Arch when the parents weren't reachable.
 
986
            if mainline_parent_id is not None:
 
987
                if mainline_parent_id not in revision.parent_ids:
 
988
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
989
                                        "parents of {%s}"
 
990
                                        % (mainline_parent_id, revision_id))
 
991
            mainline_parent_id = revision_id
 
992
        return BranchCheckResult(self)
1332
993
 
1333
994
    def _get_checkout_format(self):
1334
995
        """Return the most suitable metadir for a checkout of this branch.
1344
1005
        return format
1345
1006
 
1346
1007
    def create_clone_on_transport(self, to_transport, revision_id=None,
1347
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1008
        stacked_on=None):
1348
1009
        """Create a clone of this branch and its bzrdir.
1349
1010
 
1350
1011
        :param to_transport: The transport to clone onto.
1351
1012
        :param revision_id: The revision id to use as tip in the new branch.
1352
1013
            If None the tip is obtained from this branch.
1353
1014
        :param stacked_on: An optional URL to stack the clone on.
1354
 
        :param create_prefix: Create any missing directories leading up to
1355
 
            to_transport.
1356
 
        :param use_existing_dir: Use an existing directory if one exists.
1357
1015
        """
1358
1016
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1017
        # clone call. Or something. 20090224 RBC/spiv.
1360
 
        if revision_id is None:
1361
 
            revision_id = self.last_revision()
1362
1018
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1019
            revision_id=revision_id, stacked_on=stacked_on)
1365
1020
        return dir_to.open_branch()
1366
1021
 
1367
1022
    def create_checkout(self, to_location, revision_id=None,
1386
1041
        if lightweight:
1387
1042
            format = self._get_checkout_format()
1388
1043
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1044
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1045
        else:
1392
1046
            format = self._get_checkout_format()
1393
1047
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1422
1076
        reconciler.reconcile()
1423
1077
        return reconciler
1424
1078
 
1425
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1079
    def reference_parent(self, file_id, path):
1426
1080
        """Return the parent branch for a tree-reference file_id
1427
1081
        :param file_id: The file_id of the tree reference
1428
1082
        :param path: The path of the file_id in the tree
1429
1083
        :return: A branch associated with the file_id
1430
1084
        """
1431
1085
        # FIXME should provide multiple branches, based on config
1432
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
 
                           possible_transports=possible_transports)
 
1086
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1434
1087
 
1435
1088
    def supports_tags(self):
1436
1089
        return self._format.supports_tags()
1437
1090
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1091
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1092
                                         other_branch):
1452
1093
        """Ensure that revision_b is a descendant of revision_a.
1507
1148
    _formats = {}
1508
1149
    """The known formats."""
1509
1150
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1151
    def __eq__(self, other):
1513
1152
        return self.__class__ is other.__class__
1514
1153
 
1516
1155
        return not (self == other)
1517
1156
 
1518
1157
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1158
    def find_format(klass, a_bzrdir):
1520
1159
        """Return the format for the branch object in a_bzrdir."""
1521
1160
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1161
            transport = a_bzrdir.get_branch_transport(None)
 
1162
            format_string = transport.get("format").read()
1524
1163
            return klass._formats[format_string]
1525
1164
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1165
            raise errors.NotBranchError(path=transport.base)
1527
1166
        except KeyError:
1528
1167
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1168
 
1565
1204
        """Return the short format description for this format."""
1566
1205
        raise NotImplementedError(self.get_format_description)
1567
1206
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1207
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1208
                           set_format=True):
1578
1209
        """Initialize a branch in a bzrdir, with specified files
1579
1210
 
1580
1211
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1212
        :param utf8_files: The files to create as a list of
1582
1213
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1214
        :param set_format: If True, set the format with
1585
1215
            self.get_format_string.  (BzrBranch4 has its format set
1586
1216
            elsewhere)
1587
1217
        :return: a branch in this format
1588
1218
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1219
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1220
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1221
        lock_map = {
1592
1222
            'metadir': ('lock', lockdir.LockDir),
1593
1223
            'branch4': ('branch-lock', lockable_files.TransportLock),
1596
1226
        control_files = lockable_files.LockableFiles(branch_transport,
1597
1227
            lock_name, lock_class)
1598
1228
        control_files.create_lock()
1599
 
        try:
1600
 
            control_files.lock_write()
1601
 
        except errors.LockContention:
1602
 
            if lock_type != 'branch4':
1603
 
                raise
1604
 
            lock_taken = False
1605
 
        else:
1606
 
            lock_taken = True
 
1229
        control_files.lock_write()
1607
1230
        if set_format:
1608
1231
            utf8_files += [('format', self.get_format_string())]
1609
1232
        try:
1612
1235
                    filename, content,
1613
1236
                    mode=a_bzrdir._get_file_mode())
1614
1237
        finally:
1615
 
            if lock_taken:
1616
 
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1238
            control_files.unlock()
 
1239
        return self.open(a_bzrdir, _found=True)
1620
1240
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1241
    def initialize(self, a_bzrdir):
 
1242
        """Create a branch of this format in a_bzrdir."""
1626
1243
        raise NotImplementedError(self.initialize)
1627
1244
 
1628
1245
    def is_supported(self):
1634
1251
        """
1635
1252
        return True
1636
1253
 
1637
 
    def make_tags(self, branch):
1638
 
        """Create a tags object for branch.
1639
 
 
1640
 
        This method is on BranchFormat, because BranchFormats are reflected
1641
 
        over the wire via network_name(), whereas full Branch instances require
1642
 
        multiple VFS method calls to operate at all.
1643
 
 
1644
 
        The default implementation returns a disabled-tags instance.
1645
 
 
1646
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1647
 
        on a RemoteBranch.
1648
 
        """
1649
 
        return DisabledTags(branch)
1650
 
 
1651
1254
    def network_name(self):
1652
1255
        """A simple byte string uniquely identifying this format for RPC calls.
1653
1256
 
1658
1261
        """
1659
1262
        raise NotImplementedError(self.network_name)
1660
1263
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1264
    def open(self, a_bzrdir, _found=False):
1662
1265
        """Return the branch object for a_bzrdir
1663
1266
 
1664
 
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
 
        :param _found: a private parameter, do not use it. It is used to
1667
 
            indicate if format probing has already be done.
1668
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1669
 
            (if there are any).  Default is to open fallbacks.
 
1267
        _found is a private parameter, do not use it. It is used to indicate
 
1268
               if format probing has already be done.
1670
1269
        """
1671
1270
        raise NotImplementedError(self.open)
1672
1271
 
1674
1273
    def register_format(klass, format):
1675
1274
        """Register a metadir format."""
1676
1275
        klass._formats[format.get_format_string()] = format
1677
 
        # Metadir formats have a network name of their format string, and get
1678
 
        # registered as class factories.
1679
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1276
        # Metadir formats have a network name of their format string.
 
1277
        network_format_registry.register(format.get_format_string(), format)
1680
1278
 
1681
1279
    @classmethod
1682
1280
    def set_default_format(klass, format):
1683
1281
        klass._default_format = format
1684
1282
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1283
    def supports_stacking(self):
1690
1284
        """True if this format records a stacked-on branch."""
1691
1285
        return False
1716
1310
        notified.
1717
1311
        """
1718
1312
        Hooks.__init__(self)
1719
 
        self.create_hook(HookPoint('set_rh',
1720
 
            "Invoked whenever the revision history has been set via "
1721
 
            "set_revision_history. The api signature is (branch, "
1722
 
            "revision_history), and the branch will be write-locked. "
1723
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1724
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('open',
1726
 
            "Called with the Branch object that has been opened after a "
1727
 
            "branch is opened.", (1, 8), None))
1728
 
        self.create_hook(HookPoint('post_push',
1729
 
            "Called after a push operation completes. post_push is called "
1730
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
 
            "bzr client.", (0, 15), None))
1732
 
        self.create_hook(HookPoint('post_pull',
1733
 
            "Called after a pull operation completes. post_pull is called "
1734
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1735
 
            "bzr client.", (0, 15), None))
1736
 
        self.create_hook(HookPoint('pre_commit',
1737
 
            "Called after a commit is calculated but before it is is "
1738
 
            "completed. pre_commit is called with (local, master, old_revno, "
1739
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1741
 
            "tree_delta is a TreeDelta object describing changes from the "
1742
 
            "basis revision. hooks MUST NOT modify this delta. "
1743
 
            " future_tree is an in-memory tree obtained from "
1744
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
 
            "tree.", (0,91), None))
1746
 
        self.create_hook(HookPoint('post_commit',
1747
 
            "Called in the bzr client after a commit has completed. "
1748
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1749
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
 
            "commit to a branch.", (0, 15), None))
1751
 
        self.create_hook(HookPoint('post_uncommit',
1752
 
            "Called in the bzr client after an uncommit completes. "
1753
 
            "post_uncommit is called with (local, master, old_revno, "
1754
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1755
 
            "or None, master is the target branch, and an empty branch "
1756
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1758
 
            "Called in bzr client and server before a change to the tip of a "
1759
 
            "branch is made. pre_change_branch_tip is called with a "
1760
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1762
 
        self.create_hook(HookPoint('post_change_branch_tip',
1763
 
            "Called in bzr client and server after a change to the tip of a "
1764
 
            "branch is made. post_change_branch_tip is called with a "
1765
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1767
 
        self.create_hook(HookPoint('transform_fallback_location',
1768
 
            "Called when a stacked branch is activating its fallback "
1769
 
            "locations. transform_fallback_location is called with (branch, "
1770
 
            "url), and should return a new url. Returning the same url "
1771
 
            "allows it to be used as-is, returning a different one can be "
1772
 
            "used to cause the branch to stack on a closer copy of that "
1773
 
            "fallback_location. Note that the branch cannot have history "
1774
 
            "accessing methods called on it during this hook because the "
1775
 
            "fallback locations have not been activated. When there are "
1776
 
            "multiple hooks installed for transform_fallback_location, "
1777
 
            "all are called with the url returned from the previous hook."
1778
 
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
 
1313
        # Introduced in 0.15:
 
1314
        # invoked whenever the revision history has been set
 
1315
        # with set_revision_history. The api signature is
 
1316
        # (branch, revision_history), and the branch will
 
1317
        # be write-locked.
 
1318
        self['set_rh'] = []
 
1319
        # Invoked after a branch is opened. The api signature is (branch).
 
1320
        self['open'] = []
 
1321
        # invoked after a push operation completes.
 
1322
        # the api signature is
 
1323
        # (push_result)
 
1324
        # containing the members
 
1325
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1326
        # where local is the local target branch or None, master is the target
 
1327
        # master branch, and the rest should be self explanatory. The source
 
1328
        # is read locked and the target branches write locked. Source will
 
1329
        # be the local low-latency branch.
 
1330
        self['post_push'] = []
 
1331
        # invoked after a pull operation completes.
 
1332
        # the api signature is
 
1333
        # (pull_result)
 
1334
        # containing the members
 
1335
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1336
        # where local is the local branch or None, master is the target
 
1337
        # master branch, and the rest should be self explanatory. The source
 
1338
        # is read locked and the target branches write locked. The local
 
1339
        # branch is the low-latency branch.
 
1340
        self['post_pull'] = []
 
1341
        # invoked before a commit operation takes place.
 
1342
        # the api signature is
 
1343
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1344
        #  tree_delta, future_tree).
 
1345
        # old_revid is NULL_REVISION for the first commit to a branch
 
1346
        # tree_delta is a TreeDelta object describing changes from the basis
 
1347
        # revision, hooks MUST NOT modify this delta
 
1348
        # future_tree is an in-memory tree obtained from
 
1349
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1350
        self['pre_commit'] = []
 
1351
        # invoked after a commit operation completes.
 
1352
        # the api signature is
 
1353
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1354
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1355
        self['post_commit'] = []
 
1356
        # invoked after a uncommit operation completes.
 
1357
        # the api signature is
 
1358
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1359
        # local is the local branch or None, master is the target branch,
 
1360
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1361
        self['post_uncommit'] = []
 
1362
        # Introduced in 1.6
 
1363
        # Invoked before the tip of a branch changes.
 
1364
        # the api signature is
 
1365
        # (params) where params is a ChangeBranchTipParams with the members
 
1366
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1367
        self['pre_change_branch_tip'] = []
 
1368
        # Introduced in 1.4
 
1369
        # Invoked after the tip of a branch changes.
 
1370
        # the api signature is
 
1371
        # (params) where params is a ChangeBranchTipParams with the members
 
1372
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1373
        self['post_change_branch_tip'] = []
 
1374
        # Introduced in 1.9
 
1375
        # Invoked when a stacked branch activates its fallback locations and
 
1376
        # allows the transformation of the url of said location.
 
1377
        # the api signature is
 
1378
        # (branch, url) where branch is the branch having its fallback
 
1379
        # location activated and url is the url for the fallback location.
 
1380
        # The hook should return a url.
 
1381
        self['transform_fallback_location'] = []
1796
1382
 
1797
1383
 
1798
1384
# install the default hooks into the Branch class.
1837
1423
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1424
 
1839
1425
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1426
class BzrBranchFormat4(BranchFormat):
1919
1427
    """Bzr branch format 4.
1920
1428
 
1927
1435
        """See BranchFormat.get_format_description()."""
1928
1436
        return "Branch format 4"
1929
1437
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1438
    def initialize(self, a_bzrdir):
1931
1439
        """Create a branch of this format in a_bzrdir."""
1932
1440
        utf8_files = [('revision-history', ''),
1933
1441
                      ('branch-name', ''),
1934
1442
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1443
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1444
                                       lock_type='branch4', set_format=False)
1937
1445
 
1938
1446
    def __init__(self):
1943
1451
        """The network name for this format is the control dirs disk label."""
1944
1452
        return self._matchingbzrdir.get_format_string()
1945
1453
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
 
        """See BranchFormat.open()."""
 
1454
    def open(self, a_bzrdir, _found=False):
 
1455
        """Return the branch object for a_bzrdir
 
1456
 
 
1457
        _found is a private parameter, do not use it. It is used to indicate
 
1458
               if format probing has already be done.
 
1459
        """
1948
1460
        if not _found:
1949
1461
            # we are being called directly and must probe.
1950
1462
            raise NotImplementedError
1951
1463
        return BzrBranch(_format=self,
1952
1464
                         _control_files=a_bzrdir._control_files,
1953
1465
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1466
                         _repository=a_bzrdir.open_repository())
1956
1467
 
1957
1468
    def __str__(self):
1972
1483
        """
1973
1484
        return self.get_format_string()
1974
1485
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
 
        """See BranchFormat.open()."""
 
1486
    def open(self, a_bzrdir, _found=False):
 
1487
        """Return the branch object for a_bzrdir.
 
1488
 
 
1489
        _found is a private parameter, do not use it. It is used to indicate
 
1490
               if format probing has already be done.
 
1491
        """
1977
1492
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1493
            format = BranchFormat.find_format(a_bzrdir)
1979
1494
            if format.__class__ != self.__class__:
1980
1495
                raise AssertionError("wrong format %r found for %r" %
1981
1496
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1497
        try:
 
1498
            transport = a_bzrdir.get_branch_transport(None)
1984
1499
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1500
                                                         lockdir.LockDir)
1986
1501
            return self._branch_class()(_format=self,
1987
1502
                              _control_files=control_files,
1988
 
                              name=name,
1989
1503
                              a_bzrdir=a_bzrdir,
1990
 
                              _repository=a_bzrdir.find_repository(),
1991
 
                              ignore_fallbacks=ignore_fallbacks)
 
1504
                              _repository=a_bzrdir.find_repository())
1992
1505
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1506
            raise errors.NotBranchError(path=transport.base)
1994
1507
 
1995
1508
    def __init__(self):
1996
1509
        super(BranchFormatMetadir, self).__init__()
2025
1538
        """See BranchFormat.get_format_description()."""
2026
1539
        return "Branch format 5"
2027
1540
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1541
    def initialize(self, a_bzrdir):
2029
1542
        """Create a branch of this format in a_bzrdir."""
2030
1543
        utf8_files = [('revision-history', ''),
2031
1544
                      ('branch-name', ''),
2032
1545
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1546
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1547
 
2035
1548
    def supports_tags(self):
2036
1549
        return False
2058
1571
        """See BranchFormat.get_format_description()."""
2059
1572
        return "Branch format 6"
2060
1573
 
2061
 
    def initialize(self, a_bzrdir, name=None):
2062
 
        """Create a branch of this format in a_bzrdir."""
2063
 
        utf8_files = [('last-revision', '0 null:\n'),
2064
 
                      ('branch.conf', ''),
2065
 
                      ('tags', ''),
2066
 
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2068
 
 
2069
 
    def make_tags(self, branch):
2070
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
 
        return BasicTags(branch)
2072
 
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
 
 
2076
 
 
2077
 
class BzrBranchFormat8(BranchFormatMetadir):
2078
 
    """Metadir format supporting storing locations of subtree branches."""
2079
 
 
2080
 
    def _branch_class(self):
2081
 
        return BzrBranch8
2082
 
 
2083
 
    def get_format_string(self):
2084
 
        """See BranchFormat.get_format_string()."""
2085
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2086
 
 
2087
 
    def get_format_description(self):
2088
 
        """See BranchFormat.get_format_description()."""
2089
 
        return "Branch format 8"
2090
 
 
2091
 
    def initialize(self, a_bzrdir, name=None):
2092
 
        """Create a branch of this format in a_bzrdir."""
2093
 
        utf8_files = [('last-revision', '0 null:\n'),
2094
 
                      ('branch.conf', ''),
2095
 
                      ('tags', ''),
2096
 
                      ('references', '')
2097
 
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2099
 
 
2100
 
    def __init__(self):
2101
 
        super(BzrBranchFormat8, self).__init__()
2102
 
        self._matchingbzrdir.repository_format = \
2103
 
            RepositoryFormatKnitPack5RichRoot()
2104
 
 
2105
 
    def make_tags(self, branch):
2106
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
 
        return BasicTags(branch)
2108
 
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
 
    def supports_stacking(self):
2113
 
        return True
2114
 
 
2115
 
    supports_reference_locations = True
2116
 
 
2117
 
 
2118
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1574
    def initialize(self, a_bzrdir):
 
1575
        """Create a branch of this format in a_bzrdir."""
 
1576
        utf8_files = [('last-revision', '0 null:\n'),
 
1577
                      ('branch.conf', ''),
 
1578
                      ('tags', ''),
 
1579
                      ]
 
1580
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1581
 
 
1582
 
 
1583
class BzrBranchFormat7(BranchFormatMetadir):
2119
1584
    """Branch format with last-revision, tags, and a stacked location pointer.
2120
1585
 
2121
1586
    The stacked location pointer is passed down to the repository and requires
2124
1589
    This format was introduced in bzr 1.6.
2125
1590
    """
2126
1591
 
2127
 
    def initialize(self, a_bzrdir, name=None):
2128
 
        """Create a branch of this format in a_bzrdir."""
2129
 
        utf8_files = [('last-revision', '0 null:\n'),
2130
 
                      ('branch.conf', ''),
2131
 
                      ('tags', ''),
2132
 
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2134
 
 
2135
1592
    def _branch_class(self):
2136
1593
        return BzrBranch7
2137
1594
 
2143
1600
        """See BranchFormat.get_format_description()."""
2144
1601
        return "Branch format 7"
2145
1602
 
2146
 
    def supports_set_append_revisions_only(self):
 
1603
    def initialize(self, a_bzrdir):
 
1604
        """Create a branch of this format in a_bzrdir."""
 
1605
        utf8_files = [('last-revision', '0 null:\n'),
 
1606
                      ('branch.conf', ''),
 
1607
                      ('tags', ''),
 
1608
                      ]
 
1609
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1610
 
 
1611
    def __init__(self):
 
1612
        super(BzrBranchFormat7, self).__init__()
 
1613
        self._matchingbzrdir.repository_format = \
 
1614
            RepositoryFormatKnitPack5RichRoot()
 
1615
 
 
1616
    def supports_stacking(self):
2147
1617
        return True
2148
1618
 
2149
 
    supports_reference_locations = False
2150
 
 
2151
1619
 
2152
1620
class BranchReferenceFormat(BranchFormat):
2153
1621
    """Bzr branch reference format.
2171
1639
    def get_reference(self, a_bzrdir):
2172
1640
        """See BranchFormat.get_reference()."""
2173
1641
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1642
        return transport.get('location').read()
2175
1643
 
2176
1644
    def set_reference(self, a_bzrdir, to_branch):
2177
1645
        """See BranchFormat.set_reference()."""
2178
1646
        transport = a_bzrdir.get_branch_transport(None)
2179
1647
        location = transport.put_bytes('location', to_branch.base)
2180
1648
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1649
    def initialize(self, a_bzrdir, target_branch=None):
2182
1650
        """Create a branch of this format in a_bzrdir."""
2183
1651
        if target_branch is None:
2184
1652
            # this format does not implement branch itself, thus the implicit
2185
1653
            # creation contract must see it as uninitializable
2186
1654
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1655
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1656
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1657
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1658
            target_branch.bzrdir.root_transport.base)
2191
1659
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1660
        return self.open(
 
1661
            a_bzrdir, _found=True,
2194
1662
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1663
 
2198
1664
    def __init__(self):
2199
1665
        super(BranchReferenceFormat, self).__init__()
2205
1671
        def clone(to_bzrdir, revision_id=None,
2206
1672
            repository_policy=None):
2207
1673
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1674
            return format.initialize(to_bzrdir, a_branch)
2209
1675
            # cannot obey revision_id limits when cloning a reference ...
2210
1676
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1677
            # emit some sort of warning/error to the caller ?!
2212
1678
        return clone
2213
1679
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
 
             possible_transports=None, ignore_fallbacks=False):
 
1680
    def open(self, a_bzrdir, _found=False, location=None,
 
1681
             possible_transports=None):
2216
1682
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1683
 
2218
 
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
 
        :param _found: a private parameter, do not use it. It is used to
2221
 
            indicate if format probing has already be done.
2222
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2223
 
            (if there are any).  Default is to open fallbacks.
2224
 
        :param location: The location of the referenced branch.  If
2225
 
            unspecified, this will be determined from the branch reference in
2226
 
            a_bzrdir.
2227
 
        :param possible_transports: An optional reusable transports list.
 
1684
        _found is a private parameter, do not use it. It is used to indicate
 
1685
               if format probing has already be done.
2228
1686
        """
2229
1687
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1688
            format = BranchFormat.find_format(a_bzrdir)
2231
1689
            if format.__class__ != self.__class__:
2232
1690
                raise AssertionError("wrong format %r found for %r" %
2233
1691
                    (format, self))
2235
1693
            location = self.get_reference(a_bzrdir)
2236
1694
        real_bzrdir = bzrdir.BzrDir.open(
2237
1695
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1696
        result = real_bzrdir.open_branch()
2240
1697
        # this changes the behaviour of result.clone to create a new reference
2241
1698
        # rather than a copy of the content of the branch.
2242
1699
        # I did not use a proxy object because that needs much more extensive
2252
1709
network_format_registry = registry.FormatRegistry()
2253
1710
"""Registry of formats indexed by their network name.
2254
1711
 
2255
 
The network name for a branch format is an identifier that can be used when
 
1712
The network name for a repository format is an identifier that can be used when
2256
1713
referring to formats with smart server operations. See
2257
1714
BranchFormat.network_name() for more detail.
2258
1715
"""
2263
1720
__format5 = BzrBranchFormat5()
2264
1721
__format6 = BzrBranchFormat6()
2265
1722
__format7 = BzrBranchFormat7()
2266
 
__format8 = BzrBranchFormat8()
2267
1723
BranchFormat.register_format(__format5)
2268
1724
BranchFormat.register_format(BranchReferenceFormat())
2269
1725
BranchFormat.register_format(__format6)
2270
1726
BranchFormat.register_format(__format7)
2271
 
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1727
BranchFormat.set_default_format(__format6)
2273
1728
_legacy_formats = [BzrBranchFormat4(),
2274
1729
    ]
2275
1730
network_format_registry.register(
2276
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
 
 
2278
 
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
    def __str__(self):
2292
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
 
            self.unlock)
2294
 
 
2295
 
 
2296
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1731
    _legacy_formats[0].network_name(), _legacy_formats[0])
 
1732
 
 
1733
 
 
1734
class BzrBranch(Branch):
2297
1735
    """A branch stored in the actual filesystem.
2298
1736
 
2299
1737
    Note that it's "local" in the context of the filesystem; it doesn't
2305
1743
    :ivar repository: Repository for this branch.
2306
1744
    :ivar base: The url of the base directory for this branch; the one
2307
1745
        containing the .bzr directory.
2308
 
    :ivar name: Optional colocated branch name as it exists in the control
2309
 
        directory.
2310
1746
    """
2311
1747
 
2312
1748
    def __init__(self, _format=None,
2313
 
                 _control_files=None, a_bzrdir=None, name=None,
2314
 
                 _repository=None, ignore_fallbacks=False):
 
1749
                 _control_files=None, a_bzrdir=None, _repository=None):
2315
1750
        """Create new branch object at a particular location."""
2316
1751
        if a_bzrdir is None:
2317
1752
            raise ValueError('a_bzrdir must be supplied')
2318
1753
        else:
2319
1754
            self.bzrdir = a_bzrdir
2320
1755
        self._base = self.bzrdir.transport.clone('..').base
2321
 
        self.name = name
2322
1756
        # XXX: We should be able to just do
2323
1757
        #   self.base = self.bzrdir.root_transport.base
2324
1758
        # but this does not quite work yet -- mbp 20080522
2331
1765
        Branch.__init__(self)
2332
1766
 
2333
1767
    def __str__(self):
2334
 
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
 
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
1768
        return '%s(%r)' % (self.__class__.__name__, self.base)
2339
1769
 
2340
1770
    __repr__ = __str__
2341
1771
 
2345
1775
 
2346
1776
    base = property(_get_base, doc="The URL for the root of this branch.")
2347
1777
 
2348
 
    def _get_config(self):
2349
 
        return TransportConfig(self._transport, 'branch.conf')
2350
 
 
2351
1778
    def is_locked(self):
2352
1779
        return self.control_files.is_locked()
2353
1780
 
2354
1781
    def lock_write(self, token=None):
2355
 
        """Lock the branch for write operations.
2356
 
 
2357
 
        :param token: A token to permit reacquiring a previously held and
2358
 
            preserved lock.
2359
 
        :return: A BranchWriteLockResult.
2360
 
        """
2361
 
        if not self.is_locked():
2362
 
            self._note_lock('w')
2363
 
        # All-in-one needs to always unlock/lock.
2364
 
        repo_control = getattr(self.repository, 'control_files', None)
2365
 
        if self.control_files == repo_control or not self.is_locked():
2366
 
            self.repository._warn_if_deprecated(self)
2367
 
            self.repository.lock_write()
2368
 
            took_lock = True
2369
 
        else:
2370
 
            took_lock = False
 
1782
        repo_token = self.repository.lock_write()
2371
1783
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
1784
            token = self.control_files.lock_write(token=token)
2374
1785
        except:
2375
 
            if took_lock:
2376
 
                self.repository.unlock()
 
1786
            self.repository.unlock()
2377
1787
            raise
 
1788
        return token
2378
1789
 
2379
1790
    def lock_read(self):
2380
 
        """Lock the branch for read operations.
2381
 
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
2384
 
        """
2385
 
        if not self.is_locked():
2386
 
            self._note_lock('r')
2387
 
        # All-in-one needs to always unlock/lock.
2388
 
        repo_control = getattr(self.repository, 'control_files', None)
2389
 
        if self.control_files == repo_control or not self.is_locked():
2390
 
            self.repository._warn_if_deprecated(self)
2391
 
            self.repository.lock_read()
2392
 
            took_lock = True
2393
 
        else:
2394
 
            took_lock = False
 
1791
        self.repository.lock_read()
2395
1792
        try:
2396
1793
            self.control_files.lock_read()
2397
 
            return self
2398
1794
        except:
2399
 
            if took_lock:
2400
 
                self.repository.unlock()
 
1795
            self.repository.unlock()
2401
1796
            raise
2402
1797
 
2403
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2404
1798
    def unlock(self):
 
1799
        # TODO: test for failed two phase locks. This is known broken.
2405
1800
        try:
2406
1801
            self.control_files.unlock()
2407
1802
        finally:
2408
 
            # All-in-one needs to always unlock/lock.
2409
 
            repo_control = getattr(self.repository, 'control_files', None)
2410
 
            if (self.control_files == repo_control or
2411
 
                not self.control_files.is_locked()):
2412
 
                self.repository.unlock()
2413
 
            if not self.control_files.is_locked():
2414
 
                # we just released the lock
2415
 
                self._clear_cached_state()
 
1803
            self.repository.unlock()
 
1804
        if not self.control_files.is_locked():
 
1805
            # we just released the lock
 
1806
            self._clear_cached_state()
2416
1807
 
2417
1808
    def peek_lock_mode(self):
2418
1809
        if self.control_files._lock_count == 0:
2537
1928
        """See Branch.basis_tree."""
2538
1929
        return self.repository.revision_tree(self.last_revision())
2539
1930
 
 
1931
    @needs_write_lock
 
1932
    def pull(self, source, overwrite=False, stop_revision=None,
 
1933
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1934
             _override_hook_target=None):
 
1935
        """See Branch.pull.
 
1936
 
 
1937
        :param _hook_master: Private parameter - set the branch to
 
1938
            be supplied as the master to pull hooks.
 
1939
        :param run_hooks: Private parameter - if false, this branch
 
1940
            is being called because it's the master of the primary branch,
 
1941
            so it should not run its hooks.
 
1942
        :param _override_hook_target: Private parameter - set the branch to be
 
1943
            supplied as the target_branch to pull hooks.
 
1944
        """
 
1945
        result = PullResult()
 
1946
        result.source_branch = source
 
1947
        if _override_hook_target is None:
 
1948
            result.target_branch = self
 
1949
        else:
 
1950
            result.target_branch = _override_hook_target
 
1951
        source.lock_read()
 
1952
        try:
 
1953
            # We assume that during 'pull' the local repository is closer than
 
1954
            # the remote one.
 
1955
            graph = self.repository.get_graph(source.repository)
 
1956
            result.old_revno, result.old_revid = self.last_revision_info()
 
1957
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1958
                                  graph=graph)
 
1959
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1960
            result.new_revno, result.new_revid = self.last_revision_info()
 
1961
            if _hook_master:
 
1962
                result.master_branch = _hook_master
 
1963
                result.local_branch = result.target_branch
 
1964
            else:
 
1965
                result.master_branch = result.target_branch
 
1966
                result.local_branch = None
 
1967
            if run_hooks:
 
1968
                for hook in Branch.hooks['post_pull']:
 
1969
                    hook(result)
 
1970
        finally:
 
1971
            source.unlock()
 
1972
        return result
 
1973
 
2540
1974
    def _get_parent_location(self):
2541
1975
        _locs = ['parent', 'pull', 'x-pull']
2542
1976
        for l in _locs:
2546
1980
                pass
2547
1981
        return None
2548
1982
 
 
1983
    @needs_read_lock
 
1984
    def push(self, target, overwrite=False, stop_revision=None,
 
1985
             _override_hook_source_branch=None):
 
1986
        """See Branch.push.
 
1987
 
 
1988
        This is the basic concrete implementation of push()
 
1989
 
 
1990
        :param _override_hook_source_branch: If specified, run
 
1991
        the hooks passing this Branch as the source, rather than self.
 
1992
        This is for use of RemoteBranch, where push is delegated to the
 
1993
        underlying vfs-based Branch.
 
1994
        """
 
1995
        # TODO: Public option to disable running hooks - should be trivial but
 
1996
        # needs tests.
 
1997
        return _run_with_write_locked_target(
 
1998
            target, self._push_with_bound_branches, target, overwrite,
 
1999
            stop_revision,
 
2000
            _override_hook_source_branch=_override_hook_source_branch)
 
2001
 
 
2002
    def _push_with_bound_branches(self, target, overwrite,
 
2003
            stop_revision,
 
2004
            _override_hook_source_branch=None):
 
2005
        """Push from self into target, and into target's master if any.
 
2006
 
 
2007
        This is on the base BzrBranch class even though it doesn't support
 
2008
        bound branches because the *target* might be bound.
 
2009
        """
 
2010
        def _run_hooks():
 
2011
            if _override_hook_source_branch:
 
2012
                result.source_branch = _override_hook_source_branch
 
2013
            for hook in Branch.hooks['post_push']:
 
2014
                hook(result)
 
2015
 
 
2016
        bound_location = target.get_bound_location()
 
2017
        if bound_location and target.base != bound_location:
 
2018
            # there is a master branch.
 
2019
            #
 
2020
            # XXX: Why the second check?  Is it even supported for a branch to
 
2021
            # be bound to itself? -- mbp 20070507
 
2022
            master_branch = target.get_master_branch()
 
2023
            master_branch.lock_write()
 
2024
            try:
 
2025
                # push into the master from this branch.
 
2026
                self._basic_push(master_branch, overwrite, stop_revision)
 
2027
                # and push into the target branch from this. Note that we push from
 
2028
                # this branch again, because its considered the highest bandwidth
 
2029
                # repository.
 
2030
                result = self._basic_push(target, overwrite, stop_revision)
 
2031
                result.master_branch = master_branch
 
2032
                result.local_branch = target
 
2033
                _run_hooks()
 
2034
                return result
 
2035
            finally:
 
2036
                master_branch.unlock()
 
2037
        else:
 
2038
            # no master branch
 
2039
            result = self._basic_push(target, overwrite, stop_revision)
 
2040
            # TODO: Why set master_branch and local_branch if there's no
 
2041
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2042
            # 20070504
 
2043
            result.master_branch = target
 
2044
            result.local_branch = None
 
2045
            _run_hooks()
 
2046
            return result
 
2047
 
2549
2048
    def _basic_push(self, target, overwrite, stop_revision):
2550
2049
        """Basic implementation of push without bound branches or hooks.
2551
2050
 
2552
 
        Must be called with source read locked and target write locked.
 
2051
        Must be called with self read locked and target write locked.
2553
2052
        """
2554
 
        result = BranchPushResult()
 
2053
        result = PushResult()
2555
2054
        result.source_branch = self
2556
2055
        result.target_branch = target
2557
2056
        result.old_revno, result.old_revid = target.last_revision_info()
2558
 
        self.update_references(target)
2559
2057
        if result.old_revid != self.last_revision():
2560
2058
            # We assume that during 'push' this repository is closer than
2561
2059
            # the target.
2562
2060
            graph = self.repository.get_graph(target.repository)
2563
 
            target.update_revisions(self, stop_revision,
2564
 
                overwrite=overwrite, graph=graph)
 
2061
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2062
                                    graph=graph)
2565
2063
        if self._push_should_merge_tags():
2566
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2567
 
                overwrite)
 
2064
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2568
2065
        result.new_revno, result.new_revid = target.last_revision_info()
2569
2066
        return result
2570
2067
 
 
2068
    def get_parent(self):
 
2069
        """See Branch.get_parent."""
 
2070
        parent = self._get_parent_location()
 
2071
        if parent is None:
 
2072
            return parent
 
2073
        # This is an old-format absolute path to a local branch
 
2074
        # turn it into a url
 
2075
        if parent.startswith('/'):
 
2076
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2077
        try:
 
2078
            return urlutils.join(self.base[:-1], parent)
 
2079
        except errors.InvalidURLJoin, e:
 
2080
            raise errors.InaccessibleParent(parent, self.base)
 
2081
 
2571
2082
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2083
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2084
 
2574
2085
    def set_push_location(self, location):
2575
2086
        """See Branch.set_push_location."""
2577
2088
            'push_location', location,
2578
2089
            store=_mod_config.STORE_LOCATION_NORECURSE)
2579
2090
 
 
2091
    @needs_write_lock
 
2092
    def set_parent(self, url):
 
2093
        """See Branch.set_parent."""
 
2094
        # TODO: Maybe delete old location files?
 
2095
        # URLs should never be unicode, even on the local fs,
 
2096
        # FIXUP this and get_parent in a future branch format bump:
 
2097
        # read and rewrite the file. RBC 20060125
 
2098
        if url is not None:
 
2099
            if isinstance(url, unicode):
 
2100
                try:
 
2101
                    url = url.encode('ascii')
 
2102
                except UnicodeEncodeError:
 
2103
                    raise errors.InvalidURL(url,
 
2104
                        "Urls must be 7-bit ascii, "
 
2105
                        "use bzrlib.urlutils.escape")
 
2106
            url = urlutils.relative_url(self.base, url)
 
2107
        self._set_parent_location(url)
 
2108
 
2580
2109
    def _set_parent_location(self, url):
2581
2110
        if url is None:
2582
2111
            self._transport.delete('parent')
2584
2113
            self._transport.put_bytes('parent', url + '\n',
2585
2114
                mode=self.bzrdir._get_file_mode())
2586
2115
 
 
2116
    def set_stacked_on_url(self, url):
 
2117
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2118
 
2587
2119
 
2588
2120
class BzrBranch5(BzrBranch):
2589
2121
    """A format 5 branch. This supports new features over plain branches.
2591
2123
    It has support for a master_branch which is the data for bound branches.
2592
2124
    """
2593
2125
 
 
2126
    @needs_write_lock
 
2127
    def pull(self, source, overwrite=False, stop_revision=None,
 
2128
             run_hooks=True, possible_transports=None,
 
2129
             _override_hook_target=None):
 
2130
        """Pull from source into self, updating my master if any.
 
2131
 
 
2132
        :param run_hooks: Private parameter - if false, this branch
 
2133
            is being called because it's the master of the primary branch,
 
2134
            so it should not run its hooks.
 
2135
        """
 
2136
        bound_location = self.get_bound_location()
 
2137
        master_branch = None
 
2138
        if bound_location and source.base != bound_location:
 
2139
            # not pulling from master, so we need to update master.
 
2140
            master_branch = self.get_master_branch(possible_transports)
 
2141
            master_branch.lock_write()
 
2142
        try:
 
2143
            if master_branch:
 
2144
                # pull from source into master.
 
2145
                master_branch.pull(source, overwrite, stop_revision,
 
2146
                    run_hooks=False)
 
2147
            return super(BzrBranch5, self).pull(source, overwrite,
 
2148
                stop_revision, _hook_master=master_branch,
 
2149
                run_hooks=run_hooks,
 
2150
                _override_hook_target=_override_hook_target)
 
2151
        finally:
 
2152
            if master_branch:
 
2153
                master_branch.unlock()
 
2154
 
2594
2155
    def get_bound_location(self):
2595
2156
        try:
2596
2157
            return self._transport.get_bytes('bound')[:-1]
2683
2244
        return None
2684
2245
 
2685
2246
 
2686
 
class BzrBranch8(BzrBranch5):
2687
 
    """A branch that stores tree-reference locations."""
 
2247
class BzrBranch7(BzrBranch5):
 
2248
    """A branch with support for a fallback repository."""
 
2249
 
 
2250
    def _get_fallback_repository(self, url):
 
2251
        """Get the repository we fallback to at url."""
 
2252
        url = urlutils.join(self.base, url)
 
2253
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2254
                                      possible_transports=[self._transport])
 
2255
        return a_bzrdir.open_branch().repository
 
2256
 
 
2257
    def _activate_fallback_location(self, url):
 
2258
        """Activate the branch/repository from url as a fallback repository."""
 
2259
        self.repository.add_fallback_repository(
 
2260
            self._get_fallback_repository(url))
2688
2261
 
2689
2262
    def _open_hook(self):
2690
 
        if self._ignore_fallbacks:
2691
 
            return
2692
2263
        try:
2693
2264
            url = self.get_stacked_on_url()
2694
2265
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2704
2275
                        "None, not a URL." % hook_name)
2705
2276
            self._activate_fallback_location(url)
2706
2277
 
 
2278
    def _check_stackable_repo(self):
 
2279
        if not self.repository._format.supports_external_lookups:
 
2280
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2281
                self.repository.base)
 
2282
 
2707
2283
    def __init__(self, *args, **kwargs):
2708
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2284
        super(BzrBranch7, self).__init__(*args, **kwargs)
2710
2285
        self._last_revision_info_cache = None
2711
 
        self._reference_info = None
 
2286
        self._partial_revision_history_cache = []
2712
2287
 
2713
2288
    def _clear_cached_state(self):
2714
 
        super(BzrBranch8, self)._clear_cached_state()
 
2289
        super(BzrBranch7, self)._clear_cached_state()
2715
2290
        self._last_revision_info_cache = None
2716
 
        self._reference_info = None
 
2291
        self._partial_revision_history_cache = []
2717
2292
 
2718
2293
    def _last_revision_info(self):
2719
2294
        revision_string = self._transport.get_bytes('last-revision')
2765
2340
        if _mod_revision.is_null(last_revision):
2766
2341
            return
2767
2342
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2343
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2344
 
2770
2345
    def _gen_revision_history(self):
2771
2346
        """Generate the revision history from last revision
2774
2349
        self._extend_partial_history(stop_index=last_revno-1)
2775
2350
        return list(reversed(self._partial_revision_history_cache))
2776
2351
 
 
2352
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2353
        """Extend the partial history to include a given index
 
2354
 
 
2355
        If a stop_index is supplied, stop when that index has been reached.
 
2356
        If a stop_revision is supplied, stop when that revision is
 
2357
        encountered.  Otherwise, stop when the beginning of history is
 
2358
        reached.
 
2359
 
 
2360
        :param stop_index: The index which should be present.  When it is
 
2361
            present, history extension will stop.
 
2362
        :param revision_id: The revision id which should be present.  When
 
2363
            it is encountered, history extension will stop.
 
2364
        """
 
2365
        repo = self.repository
 
2366
        if len(self._partial_revision_history_cache) == 0:
 
2367
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2368
        else:
 
2369
            start_revision = self._partial_revision_history_cache[-1]
 
2370
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2371
            #skip the last revision in the list
 
2372
            next_revision = iterator.next()
 
2373
        for revision_id in iterator:
 
2374
            self._partial_revision_history_cache.append(revision_id)
 
2375
            if (stop_index is not None and
 
2376
                len(self._partial_revision_history_cache) > stop_index):
 
2377
                break
 
2378
            if revision_id == stop_revision:
 
2379
                break
 
2380
 
2777
2381
    def _write_revision_history(self, history):
2778
2382
        """Factored out of set_revision_history.
2779
2383
 
2800
2404
        """Set the parent branch"""
2801
2405
        return self._get_config_location('parent_location')
2802
2406
 
2803
 
    @needs_write_lock
2804
 
    def _set_all_reference_info(self, info_dict):
2805
 
        """Replace all reference info stored in a branch.
2806
 
 
2807
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2808
 
        """
2809
 
        s = StringIO()
2810
 
        writer = rio.RioWriter(s)
2811
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2812
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2813
 
                                branch_location=branch_location)
2814
 
            writer.write_stanza(stanza)
2815
 
        self._transport.put_bytes('references', s.getvalue())
2816
 
        self._reference_info = info_dict
2817
 
 
2818
 
    @needs_read_lock
2819
 
    def _get_all_reference_info(self):
2820
 
        """Return all the reference info stored in a branch.
2821
 
 
2822
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2823
 
        """
2824
 
        if self._reference_info is not None:
2825
 
            return self._reference_info
2826
 
        rio_file = self._transport.get('references')
2827
 
        try:
2828
 
            stanzas = rio.read_stanzas(rio_file)
2829
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2830
 
                             s['branch_location'])) for s in stanzas)
2831
 
        finally:
2832
 
            rio_file.close()
2833
 
        self._reference_info = info_dict
2834
 
        return info_dict
2835
 
 
2836
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2837
 
        """Set the branch location to use for a tree reference.
2838
 
 
2839
 
        :param file_id: The file-id of the tree reference.
2840
 
        :param tree_path: The path of the tree reference in the tree.
2841
 
        :param branch_location: The location of the branch to retrieve tree
2842
 
            references from.
2843
 
        """
2844
 
        info_dict = self._get_all_reference_info()
2845
 
        info_dict[file_id] = (tree_path, branch_location)
2846
 
        if None in (tree_path, branch_location):
2847
 
            if tree_path is not None:
2848
 
                raise ValueError('tree_path must be None when branch_location'
2849
 
                                 ' is None.')
2850
 
            if branch_location is not None:
2851
 
                raise ValueError('branch_location must be None when tree_path'
2852
 
                                 ' is None.')
2853
 
            del info_dict[file_id]
2854
 
        self._set_all_reference_info(info_dict)
2855
 
 
2856
 
    def get_reference_info(self, file_id):
2857
 
        """Get the tree_path and branch_location for a tree reference.
2858
 
 
2859
 
        :return: a tuple of (tree_path, branch_location)
2860
 
        """
2861
 
        return self._get_all_reference_info().get(file_id, (None, None))
2862
 
 
2863
 
    def reference_parent(self, file_id, path, possible_transports=None):
2864
 
        """Return the parent branch for a tree-reference file_id.
2865
 
 
2866
 
        :param file_id: The file_id of the tree reference
2867
 
        :param path: The path of the file_id in the tree
2868
 
        :return: A branch associated with the file_id
2869
 
        """
2870
 
        branch_location = self.get_reference_info(file_id)[1]
2871
 
        if branch_location is None:
2872
 
            return Branch.reference_parent(self, file_id, path,
2873
 
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
2875
 
        return Branch.open(branch_location,
2876
 
                           possible_transports=possible_transports)
2877
 
 
2878
2407
    def set_push_location(self, location):
2879
2408
        """See Branch.set_push_location."""
2880
2409
        self._set_config_location('push_location', location)
2922
2451
            raise errors.NotStacked(self)
2923
2452
        return stacked_url
2924
2453
 
 
2454
    def set_append_revisions_only(self, enabled):
 
2455
        if enabled:
 
2456
            value = 'True'
 
2457
        else:
 
2458
            value = 'False'
 
2459
        self.get_config().set_user_option('append_revisions_only', value,
 
2460
            warn_masked=True)
 
2461
 
 
2462
    def set_stacked_on_url(self, url):
 
2463
        self._check_stackable_repo()
 
2464
        if not url:
 
2465
            try:
 
2466
                old_url = self.get_stacked_on_url()
 
2467
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2468
                errors.UnstackableRepositoryFormat):
 
2469
                return
 
2470
            url = ''
 
2471
            # repositories don't offer an interface to remove fallback
 
2472
            # repositories today; take the conceptually simpler option and just
 
2473
            # reopen it.
 
2474
            self.repository = self.bzrdir.find_repository()
 
2475
            # for every revision reference the branch has, ensure it is pulled
 
2476
            # in.
 
2477
            source_repository = self._get_fallback_repository(old_url)
 
2478
            for revision_id in chain([self.last_revision()],
 
2479
                self.tags.get_reverse_tag_dict()):
 
2480
                self.repository.fetch(source_repository, revision_id,
 
2481
                    find_ghosts=True)
 
2482
        else:
 
2483
            self._activate_fallback_location(url)
 
2484
        # write this out after the repository is stacked to avoid setting a
 
2485
        # stacked config that doesn't work.
 
2486
        self._set_config_location('stacked_on_location', url)
 
2487
 
2925
2488
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2489
        value = self.get_config().get_user_option('append_revisions_only')
 
2490
        return value == 'True'
 
2491
 
 
2492
    def _make_tags(self):
 
2493
        return BasicTags(self)
2928
2494
 
2929
2495
    @needs_write_lock
2930
2496
    def generate_revision_history(self, revision_id, last_rev=None,
2970
2536
        return self.revno() - index
2971
2537
 
2972
2538
 
2973
 
class BzrBranch7(BzrBranch8):
2974
 
    """A branch with support for a fallback repository."""
2975
 
 
2976
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2977
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2978
 
 
2979
 
    def get_reference_info(self, file_id):
2980
 
        Branch.get_reference_info(self, file_id)
2981
 
 
2982
 
    def reference_parent(self, file_id, path, possible_transports=None):
2983
 
        return Branch.reference_parent(self, file_id, path,
2984
 
                                       possible_transports)
2985
 
 
2986
 
 
2987
2539
class BzrBranch6(BzrBranch7):
2988
2540
    """See BzrBranchFormat6 for the capabilities of this branch.
2989
2541
 
2992
2544
    """
2993
2545
 
2994
2546
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2547
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2548
 
 
2549
    def set_stacked_on_url(self, url):
 
2550
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2551
 
2997
2552
 
2998
2553
######################################################################
3016
2571
    :ivar new_revno: Revision number after pull.
3017
2572
    :ivar old_revid: Tip revision id before pull.
3018
2573
    :ivar new_revid: Tip revision id after pull.
3019
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2574
    :ivar source_branch: Source (local) branch object.
3020
2575
    :ivar master_branch: Master branch of the target, or the target if no
3021
2576
        Master
3022
2577
    :ivar local_branch: target branch if there is a Master, else None
3023
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2578
    :ivar target_branch: Target/destination branch object.
3024
2579
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3025
2580
    """
3026
2581
 
3037
2592
        self._show_tag_conficts(to_file)
3038
2593
 
3039
2594
 
3040
 
class BranchPushResult(_Result):
 
2595
class PushResult(_Result):
3041
2596
    """Result of a Branch.push operation.
3042
2597
 
3043
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3044
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3045
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3046
 
        before the push.
3047
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3048
 
        after the push.
3049
 
    :ivar source_branch: Source branch object that the push was from. This is
3050
 
        read locked, and generally is a local (and thus low latency) branch.
3051
 
    :ivar master_branch: If target is a bound branch, the master branch of
3052
 
        target, or target itself. Always write locked.
3053
 
    :ivar target_branch: The direct Branch where data is being sent (write
3054
 
        locked).
3055
 
    :ivar local_branch: If the target is a bound branch this will be the
3056
 
        target, otherwise it will be None.
 
2598
    :ivar old_revno: Revision number before push.
 
2599
    :ivar new_revno: Revision number after push.
 
2600
    :ivar old_revid: Tip revision id before push.
 
2601
    :ivar new_revid: Tip revision id after push.
 
2602
    :ivar source_branch: Source branch object.
 
2603
    :ivar master_branch: Master branch of the target, or None.
 
2604
    :ivar target_branch: Target/destination branch object.
3057
2605
    """
3058
2606
 
3059
2607
    def __int__(self):
3077
2625
 
3078
2626
    def __init__(self, branch):
3079
2627
        self.branch = branch
3080
 
        self.errors = []
3081
2628
 
3082
2629
    def report_results(self, verbose):
3083
2630
        """Report the check results via trace.note.
3085
2632
        :param verbose: Requests more detailed display of what was checked,
3086
2633
            if any.
3087
2634
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
3089
 
            self.branch._format)
3090
 
        for error in self.errors:
3091
 
            note('found error:%s', error)
 
2635
        note('checked branch %s format %s',
 
2636
             self.branch.base,
 
2637
             self.branch._format)
3092
2638
 
3093
2639
 
3094
2640
class Converter5to6(object):
3132
2678
        branch._transport.put_bytes('format', format.get_format_string())
3133
2679
 
3134
2680
 
3135
 
class Converter7to8(object):
3136
 
    """Perform an in-place upgrade of format 6 to format 7"""
3137
 
 
3138
 
    def convert(self, branch):
3139
 
        format = BzrBranchFormat8()
3140
 
        branch._transport.put_bytes('references', '')
3141
 
        # update target format
3142
 
        branch._transport.put_bytes('format', format.get_format_string())
3143
 
 
3144
2681
 
3145
2682
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3146
2683
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3189
2726
    @staticmethod
3190
2727
    def _get_branch_formats_to_test():
3191
2728
        """Return a tuple with the Branch formats to use when testing."""
3192
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3193
 
 
3194
 
    def pull(self, overwrite=False, stop_revision=None,
3195
 
             possible_transports=None, local=False):
3196
 
        """Mirror source into target branch.
3197
 
 
3198
 
        The target branch is considered to be 'local', having low latency.
3199
 
 
3200
 
        :returns: PullResult instance
3201
 
        """
3202
 
        raise NotImplementedError(self.pull)
 
2729
        raise NotImplementedError(self._get_branch_formats_to_test)
3203
2730
 
3204
2731
    def update_revisions(self, stop_revision=None, overwrite=False,
3205
2732
                         graph=None):
3214
2741
        """
3215
2742
        raise NotImplementedError(self.update_revisions)
3216
2743
 
3217
 
    def push(self, overwrite=False, stop_revision=None,
3218
 
             _override_hook_source_branch=None):
3219
 
        """Mirror the source branch into the target branch.
3220
 
 
3221
 
        The source branch is considered to be 'local', having low latency.
3222
 
        """
3223
 
        raise NotImplementedError(self.push)
3224
 
 
3225
2744
 
3226
2745
class GenericInterBranch(InterBranch):
3227
2746
    """InterBranch implementation that uses public Branch functions.
3274
2793
        finally:
3275
2794
            self.source.unlock()
3276
2795
 
3277
 
    def pull(self, overwrite=False, stop_revision=None,
3278
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3279
 
             _override_hook_target=None, local=False):
3280
 
        """See Branch.pull.
3281
 
 
3282
 
        :param _hook_master: Private parameter - set the branch to
3283
 
            be supplied as the master to pull hooks.
3284
 
        :param run_hooks: Private parameter - if false, this branch
3285
 
            is being called because it's the master of the primary branch,
3286
 
            so it should not run its hooks.
3287
 
        :param _override_hook_target: Private parameter - set the branch to be
3288
 
            supplied as the target_branch to pull hooks.
3289
 
        :param local: Only update the local branch, and not the bound branch.
3290
 
        """
3291
 
        # This type of branch can't be bound.
3292
 
        if local:
3293
 
            raise errors.LocalRequiresBoundBranch()
3294
 
        result = PullResult()
3295
 
        result.source_branch = self.source
3296
 
        if _override_hook_target is None:
3297
 
            result.target_branch = self.target
3298
 
        else:
3299
 
            result.target_branch = _override_hook_target
3300
 
        self.source.lock_read()
3301
 
        try:
3302
 
            # We assume that during 'pull' the target repository is closer than
3303
 
            # the source one.
3304
 
            self.source.update_references(self.target)
3305
 
            graph = self.target.repository.get_graph(self.source.repository)
3306
 
            # TODO: Branch formats should have a flag that indicates 
3307
 
            # that revno's are expensive, and pull() should honor that flag.
3308
 
            # -- JRV20090506
3309
 
            result.old_revno, result.old_revid = \
3310
 
                self.target.last_revision_info()
3311
 
            self.target.update_revisions(self.source, stop_revision,
3312
 
                overwrite=overwrite, graph=graph)
3313
 
            # TODO: The old revid should be specified when merging tags, 
3314
 
            # so a tags implementation that versions tags can only 
3315
 
            # pull in the most recent changes. -- JRV20090506
3316
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3317
 
                overwrite)
3318
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3319
 
            if _hook_master:
3320
 
                result.master_branch = _hook_master
3321
 
                result.local_branch = result.target_branch
3322
 
            else:
3323
 
                result.master_branch = result.target_branch
3324
 
                result.local_branch = None
3325
 
            if run_hooks:
3326
 
                for hook in Branch.hooks['post_pull']:
3327
 
                    hook(result)
3328
 
        finally:
3329
 
            self.source.unlock()
3330
 
        return result
3331
 
 
3332
 
    def push(self, overwrite=False, stop_revision=None,
3333
 
             _override_hook_source_branch=None):
3334
 
        """See InterBranch.push.
3335
 
 
3336
 
        This is the basic concrete implementation of push()
3337
 
 
3338
 
        :param _override_hook_source_branch: If specified, run
3339
 
        the hooks passing this Branch as the source, rather than self.
3340
 
        This is for use of RemoteBranch, where push is delegated to the
3341
 
        underlying vfs-based Branch.
3342
 
        """
3343
 
        # TODO: Public option to disable running hooks - should be trivial but
3344
 
        # needs tests.
3345
 
        self.source.lock_read()
3346
 
        try:
3347
 
            return _run_with_write_locked_target(
3348
 
                self.target, self._push_with_bound_branches, overwrite,
3349
 
                stop_revision,
3350
 
                _override_hook_source_branch=_override_hook_source_branch)
3351
 
        finally:
3352
 
            self.source.unlock()
3353
 
 
3354
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3355
 
            _override_hook_source_branch=None):
3356
 
        """Push from source into target, and into target's master if any.
3357
 
        """
3358
 
        def _run_hooks():
3359
 
            if _override_hook_source_branch:
3360
 
                result.source_branch = _override_hook_source_branch
3361
 
            for hook in Branch.hooks['post_push']:
3362
 
                hook(result)
3363
 
 
3364
 
        bound_location = self.target.get_bound_location()
3365
 
        if bound_location and self.target.base != bound_location:
3366
 
            # there is a master branch.
3367
 
            #
3368
 
            # XXX: Why the second check?  Is it even supported for a branch to
3369
 
            # be bound to itself? -- mbp 20070507
3370
 
            master_branch = self.target.get_master_branch()
3371
 
            master_branch.lock_write()
3372
 
            try:
3373
 
                # push into the master from the source branch.
3374
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3375
 
                # and push into the target branch from the source. Note that we
3376
 
                # push from the source branch again, because its considered the
3377
 
                # highest bandwidth repository.
3378
 
                result = self.source._basic_push(self.target, overwrite,
3379
 
                    stop_revision)
3380
 
                result.master_branch = master_branch
3381
 
                result.local_branch = self.target
3382
 
                _run_hooks()
3383
 
                return result
3384
 
            finally:
3385
 
                master_branch.unlock()
3386
 
        else:
3387
 
            # no master branch
3388
 
            result = self.source._basic_push(self.target, overwrite,
3389
 
                stop_revision)
3390
 
            # TODO: Why set master_branch and local_branch if there's no
3391
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3392
 
            # 20070504
3393
 
            result.master_branch = self.target
3394
 
            result.local_branch = None
3395
 
            _run_hooks()
3396
 
            return result
3397
 
 
3398
2796
    @classmethod
3399
2797
    def is_compatible(self, source, target):
3400
2798
        # GenericBranch uses the public API, so always compatible
3401
2799
        return True
3402
2800
 
3403
2801
 
3404
 
class InterToBranch5(GenericInterBranch):
3405
 
 
3406
 
    @staticmethod
3407
 
    def _get_branch_formats_to_test():
3408
 
        return BranchFormat._default_format, BzrBranchFormat5()
3409
 
 
3410
 
    def pull(self, overwrite=False, stop_revision=None,
3411
 
             possible_transports=None, run_hooks=True,
3412
 
             _override_hook_target=None, local=False):
3413
 
        """Pull from source into self, updating my master if any.
3414
 
 
3415
 
        :param run_hooks: Private parameter - if false, this branch
3416
 
            is being called because it's the master of the primary branch,
3417
 
            so it should not run its hooks.
3418
 
        """
3419
 
        bound_location = self.target.get_bound_location()
3420
 
        if local and not bound_location:
3421
 
            raise errors.LocalRequiresBoundBranch()
3422
 
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
3424
 
            # not pulling from master, so we need to update master.
3425
 
            master_branch = self.target.get_master_branch(possible_transports)
3426
 
            master_branch.lock_write()
3427
 
        try:
3428
 
            if master_branch:
3429
 
                # pull from source into master.
3430
 
                master_branch.pull(self.source, overwrite, stop_revision,
3431
 
                    run_hooks=False)
3432
 
            return super(InterToBranch5, self).pull(overwrite,
3433
 
                stop_revision, _hook_master=master_branch,
3434
 
                run_hooks=run_hooks,
3435
 
                _override_hook_target=_override_hook_target)
3436
 
        finally:
3437
 
            if master_branch:
3438
 
                master_branch.unlock()
3439
 
 
3440
 
 
3441
2802
InterBranch.register_optimiser(GenericInterBranch)
3442
 
InterBranch.register_optimiser(InterToBranch5)