~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

Add a NEWS entry and prepare submission.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
16
16
 
17
17
 
18
18
from cStringIO import StringIO
 
19
import sys
19
20
 
20
21
from bzrlib.lazy_import import lazy_import
21
22
lazy_import(globals(), """
22
 
import itertools
 
23
from itertools import chain
23
24
from bzrlib import (
24
25
        bzrdir,
25
26
        cache_utf8,
26
 
        cleanup,
27
27
        config as _mod_config,
28
28
        debug,
29
29
        errors,
30
 
        fetch,
31
 
        graph as _mod_graph,
32
30
        lockdir,
33
31
        lockable_files,
34
 
        remote,
35
32
        repository,
36
33
        revision as _mod_revision,
37
34
        rio,
38
 
        tag as _mod_tag,
 
35
        symbol_versioning,
39
36
        transport,
 
37
        tsort,
40
38
        ui,
41
39
        urlutils,
42
40
        )
43
 
from bzrlib.i18n import gettext, ngettext
 
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
43
from bzrlib.tag import (
 
44
    BasicTags,
 
45
    DisabledTags,
 
46
    )
44
47
""")
45
48
 
46
 
from bzrlib import (
47
 
    controldir,
48
 
    )
49
 
from bzrlib.decorators import (
50
 
    needs_read_lock,
51
 
    needs_write_lock,
52
 
    only_raises,
53
 
    )
54
 
from bzrlib.hooks import Hooks
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.hooks import HookPoint, Hooks
55
51
from bzrlib.inter import InterObject
56
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
57
53
from bzrlib import registry
58
54
from bzrlib.symbol_versioning import (
59
55
    deprecated_in,
62
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
63
59
 
64
60
 
65
 
class Branch(controldir.ControlComponent):
 
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
64
 
 
65
 
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
66
79
    """Branch holding a history of revisions.
67
80
 
68
 
    :ivar base:
69
 
        Base directory/url of the branch; using control_url and
70
 
        control_transport is more standardized.
71
 
    :ivar hooks: An instance of BranchHooks.
72
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
73
 
        _clear_cached_state.
 
81
    base
 
82
        Base directory/url of the branch.
 
83
 
 
84
    hooks: An instance of BranchHooks.
74
85
    """
75
86
    # this is really an instance variable - FIXME move it there
76
87
    # - RBC 20060112
77
88
    base = None
78
89
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
90
    def __init__(self, *ignored, **ignored_too):
88
91
        self.tags = self._format.make_tags(self)
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
95
        self._partial_revision_history_cache = []
93
 
        self._tags_bytes = None
94
96
        self._last_revision_info_cache = None
95
 
        self._master_branch_cache = None
96
97
        self._merge_sorted_revisions_cache = None
97
98
        self._open_hook()
98
99
        hooks = Branch.hooks['open']
104
105
 
105
106
    def _activate_fallback_location(self, url):
106
107
        """Activate the branch/repository from url as a fallback repository."""
107
 
        for existing_fallback_repo in self.repository._fallback_repositories:
108
 
            if existing_fallback_repo.user_url == url:
109
 
                # This fallback is already configured.  This probably only
110
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
111
 
                # confusing _unstack we don't add this a second time.
112
 
                mutter('duplicate activation of fallback %r on %r', url, self)
113
 
                return
114
108
        repo = self._get_fallback_repository(url)
115
109
        if repo.has_same_location(self.repository):
116
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
117
111
        self.repository.add_fallback_repository(repo)
118
112
 
119
113
    def break_lock(self):
173
167
        """
174
168
        control = bzrdir.BzrDir.open(base, _unsupported,
175
169
                                     possible_transports=possible_transports)
176
 
        return control.open_branch(unsupported=_unsupported)
 
170
        return control.open_branch(_unsupported)
177
171
 
178
172
    @staticmethod
179
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
173
    def open_from_transport(transport, _unsupported=False):
180
174
        """Open the branch rooted at transport"""
181
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
182
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
176
        return control.open_branch(_unsupported)
183
177
 
184
178
    @staticmethod
185
179
    def open_containing(url, possible_transports=None):
206
200
        return self.supports_tags() and self.tags.get_tag_dict()
207
201
 
208
202
    def get_config(self):
209
 
        """Get a bzrlib.config.BranchConfig for this Branch.
210
 
 
211
 
        This can then be used to get and set configuration options for the
212
 
        branch.
213
 
 
214
 
        :return: A bzrlib.config.BranchConfig.
215
 
        """
216
 
        return _mod_config.BranchConfig(self)
217
 
 
218
 
    def get_config_stack(self):
219
 
        """Get a bzrlib.config.BranchStack for this Branch.
220
 
 
221
 
        This can then be used to get and set configuration options for the
222
 
        branch.
223
 
 
224
 
        :return: A bzrlib.config.BranchStack.
225
 
        """
226
 
        return _mod_config.BranchStack(self)
 
203
        return BranchConfig(self)
227
204
 
228
205
    def _get_config(self):
229
206
        """Get the concrete config for just the config in this branch.
240
217
    def _get_fallback_repository(self, url):
241
218
        """Get the repository we fallback to at url."""
242
219
        url = urlutils.join(self.base, url)
243
 
        a_branch = Branch.open(url,
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
244
221
            possible_transports=[self.bzrdir.root_transport])
245
 
        return a_branch.repository
 
222
        return a_bzrdir.open_branch().repository
246
223
 
247
 
    @needs_read_lock
248
224
    def _get_tags_bytes(self):
249
225
        """Get the bytes of a serialised tags dict.
250
226
 
257
233
        :return: The bytes of the tags file.
258
234
        :seealso: Branch._set_tags_bytes.
259
235
        """
260
 
        if self._tags_bytes is None:
261
 
            self._tags_bytes = self._transport.get_bytes('tags')
262
 
        return self._tags_bytes
 
236
        return self._transport.get_bytes('tags')
263
237
 
264
238
    def _get_nick(self, local=False, possible_transports=None):
265
239
        config = self.get_config()
267
241
        if not local and not config.has_explicit_nickname():
268
242
            try:
269
243
                master = self.get_master_branch(possible_transports)
270
 
                if master and self.user_url == master.user_url:
271
 
                    raise errors.RecursiveBind(self.user_url)
272
244
                if master is not None:
273
245
                    # return the master branch value
274
246
                    return master.nick
275
 
            except errors.RecursiveBind, e:
276
 
                raise e
277
247
            except errors.BzrError, e:
278
248
                # Silently fall back to local implicit nick if the master is
279
249
                # unavailable
316
286
        new_history.reverse()
317
287
        return new_history
318
288
 
319
 
    def lock_write(self, token=None):
320
 
        """Lock the branch for write operations.
321
 
 
322
 
        :param token: A token to permit reacquiring a previously held and
323
 
            preserved lock.
324
 
        :return: A BranchWriteLockResult.
325
 
        """
 
289
    def lock_write(self):
326
290
        raise NotImplementedError(self.lock_write)
327
291
 
328
292
    def lock_read(self):
329
 
        """Lock the branch for read operations.
330
 
 
331
 
        :return: A bzrlib.lock.LogicalLockResult.
332
 
        """
333
293
        raise NotImplementedError(self.lock_read)
334
294
 
335
295
    def unlock(self):
456
416
            after. If None, the rest of history is included.
457
417
        :param stop_rule: if stop_revision_id is not None, the precise rule
458
418
            to use for termination:
459
 
 
460
419
            * 'exclude' - leave the stop revision out of the result (default)
461
420
            * 'include' - the stop revision is the last item in the result
462
421
            * 'with-merges' - include the stop revision and all of its
463
422
              merged revisions in the result
464
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
465
 
              that are in both ancestries
466
423
        :param direction: either 'reverse' or 'forward':
467
 
 
468
424
            * reverse means return the start_revision_id first, i.e.
469
425
              start at the most recent revision and go backwards in history
470
426
            * forward returns tuples in the opposite order to reverse.
491
447
        # start_revision_id.
492
448
        if self._merge_sorted_revisions_cache is None:
493
449
            last_revision = self.last_revision()
494
 
            known_graph = self.repository.get_known_graph_ancestry(
495
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
496
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
497
 
                last_revision)
 
454
                last_key)
498
455
        filtered = self._filter_merge_sorted_revisions(
499
456
            self._merge_sorted_revisions_cache, start_revision_id,
500
457
            stop_revision_id, stop_rule)
501
 
        # Make sure we don't return revisions that are not part of the
502
 
        # start_revision_id ancestry.
503
 
        filtered = self._filter_start_non_ancestors(filtered)
504
458
        if direction == 'reverse':
505
459
            return filtered
506
460
        if direction == 'forward':
514
468
        rev_iter = iter(merge_sorted_revisions)
515
469
        if start_revision_id is not None:
516
470
            for node in rev_iter:
517
 
                rev_id = node.key
 
471
                rev_id = node.key[-1]
518
472
                if rev_id != start_revision_id:
519
473
                    continue
520
474
                else:
521
475
                    # The decision to include the start or not
522
476
                    # depends on the stop_rule if a stop is provided
523
477
                    # so pop this node back into the iterator
524
 
                    rev_iter = itertools.chain(iter([node]), rev_iter)
 
478
                    rev_iter = chain(iter([node]), rev_iter)
525
479
                    break
526
480
        if stop_revision_id is None:
527
481
            # Yield everything
528
482
            for node in rev_iter:
529
 
                rev_id = node.key
 
483
                rev_id = node.key[-1]
530
484
                yield (rev_id, node.merge_depth, node.revno,
531
485
                       node.end_of_merge)
532
486
        elif stop_rule == 'exclude':
533
487
            for node in rev_iter:
534
 
                rev_id = node.key
 
488
                rev_id = node.key[-1]
535
489
                if rev_id == stop_revision_id:
536
490
                    return
537
491
                yield (rev_id, node.merge_depth, node.revno,
538
492
                       node.end_of_merge)
539
493
        elif stop_rule == 'include':
540
494
            for node in rev_iter:
541
 
                rev_id = node.key
 
495
                rev_id = node.key[-1]
542
496
                yield (rev_id, node.merge_depth, node.revno,
543
497
                       node.end_of_merge)
544
498
                if rev_id == stop_revision_id:
545
499
                    return
546
 
        elif stop_rule == 'with-merges-without-common-ancestry':
547
 
            # We want to exclude all revisions that are already part of the
548
 
            # stop_revision_id ancestry.
549
 
            graph = self.repository.get_graph()
550
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
551
 
                                                    [stop_revision_id])
552
 
            for node in rev_iter:
553
 
                rev_id = node.key
554
 
                if rev_id not in ancestors:
555
 
                    continue
556
 
                yield (rev_id, node.merge_depth, node.revno,
557
 
                       node.end_of_merge)
558
500
        elif stop_rule == 'with-merges':
559
501
            stop_rev = self.repository.get_revision(stop_revision_id)
560
502
            if stop_rev.parent_ids:
566
508
            reached_stop_revision_id = False
567
509
            revision_id_whitelist = []
568
510
            for node in rev_iter:
569
 
                rev_id = node.key
 
511
                rev_id = node.key[-1]
570
512
                if rev_id == left_parent:
571
513
                    # reached the left parent after the stop_revision
572
514
                    return
583
525
        else:
584
526
            raise ValueError('invalid stop_rule %r' % stop_rule)
585
527
 
586
 
    def _filter_start_non_ancestors(self, rev_iter):
587
 
        # If we started from a dotted revno, we want to consider it as a tip
588
 
        # and don't want to yield revisions that are not part of its
589
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
590
 
        # uninteresting descendants of the first parent of our tip before the
591
 
        # tip itself.
592
 
        first = rev_iter.next()
593
 
        (rev_id, merge_depth, revno, end_of_merge) = first
594
 
        yield first
595
 
        if not merge_depth:
596
 
            # We start at a mainline revision so by definition, all others
597
 
            # revisions in rev_iter are ancestors
598
 
            for node in rev_iter:
599
 
                yield node
600
 
 
601
 
        clean = False
602
 
        whitelist = set()
603
 
        pmap = self.repository.get_parent_map([rev_id])
604
 
        parents = pmap.get(rev_id, [])
605
 
        if parents:
606
 
            whitelist.update(parents)
607
 
        else:
608
 
            # If there is no parents, there is nothing of interest left
609
 
 
610
 
            # FIXME: It's hard to test this scenario here as this code is never
611
 
            # called in that case. -- vila 20100322
612
 
            return
613
 
 
614
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
615
 
            if not clean:
616
 
                if rev_id in whitelist:
617
 
                    pmap = self.repository.get_parent_map([rev_id])
618
 
                    parents = pmap.get(rev_id, [])
619
 
                    whitelist.remove(rev_id)
620
 
                    whitelist.update(parents)
621
 
                    if merge_depth == 0:
622
 
                        # We've reached the mainline, there is nothing left to
623
 
                        # filter
624
 
                        clean = True
625
 
                else:
626
 
                    # A revision that is not part of the ancestry of our
627
 
                    # starting revision.
628
 
                    continue
629
 
            yield (rev_id, merge_depth, revno, end_of_merge)
630
 
 
631
528
    def leave_lock_in_place(self):
632
529
        """Tell this branch object not to release the physical lock when this
633
530
        object is unlocked.
650
547
        :param other: The branch to bind to
651
548
        :type other: Branch
652
549
        """
653
 
        raise errors.UpgradeRequired(self.user_url)
654
 
 
655
 
    def get_append_revisions_only(self):
656
 
        """Whether it is only possible to append revisions to the history.
657
 
        """
658
 
        if not self._format.supports_set_append_revisions_only():
659
 
            return False
660
 
        return self.get_config(
661
 
            ).get_user_option_as_bool('append_revisions_only')
 
550
        raise errors.UpgradeRequired(self.base)
662
551
 
663
552
    def set_append_revisions_only(self, enabled):
664
553
        if not self._format.supports_set_append_revisions_only():
665
 
            raise errors.UpgradeRequired(self.user_url)
 
554
            raise errors.UpgradeRequired(self.base)
666
555
        if enabled:
667
556
            value = 'True'
668
557
        else:
679
568
        raise errors.UnsupportedOperation(self.get_reference_info, self)
680
569
 
681
570
    @needs_write_lock
682
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
571
    def fetch(self, from_branch, last_revision=None, pb=None):
683
572
        """Copy revisions from from_branch into this branch.
684
573
 
685
574
        :param from_branch: Where to copy from.
686
575
        :param last_revision: What revision to stop at (None for at the end
687
576
                              of the branch.
688
 
        :param limit: Optional rough limit of revisions to fetch
 
577
        :param pb: An optional progress bar to use.
689
578
        :return: None
690
579
        """
691
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
580
        if self.base == from_branch.base:
 
581
            return (0, [])
 
582
        if pb is not None:
 
583
            symbol_versioning.warn(
 
584
                symbol_versioning.deprecated_in((1, 14, 0))
 
585
                % "pb parameter to fetch()")
 
586
        from_branch.lock_read()
 
587
        try:
 
588
            if last_revision is None:
 
589
                last_revision = from_branch.last_revision()
 
590
                last_revision = _mod_revision.ensure_null(last_revision)
 
591
            return self.repository.fetch(from_branch.repository,
 
592
                                         revision_id=last_revision,
 
593
                                         pb=pb)
 
594
        finally:
 
595
            from_branch.unlock()
692
596
 
693
597
    def get_bound_location(self):
694
598
        """Return the URL of the branch we are bound to.
701
605
    def get_old_bound_location(self):
702
606
        """Return the URL of the branch we used to be bound to
703
607
        """
704
 
        raise errors.UpgradeRequired(self.user_url)
 
608
        raise errors.UpgradeRequired(self.base)
705
609
 
706
610
    def get_commit_builder(self, parents, config=None, timestamp=None,
707
611
                           timezone=None, committer=None, revprops=None,
708
 
                           revision_id=None, lossy=False):
 
612
                           revision_id=None):
709
613
        """Obtain a CommitBuilder for this branch.
710
614
 
711
615
        :param parents: Revision ids of the parents of the new revision.
715
619
        :param committer: Optional committer to set for commit.
716
620
        :param revprops: Optional dictionary of revision properties.
717
621
        :param revision_id: Optional revision id.
718
 
        :param lossy: Whether to discard data that can not be natively
719
 
            represented, when pushing to a foreign VCS 
720
622
        """
721
623
 
722
624
        if config is None:
723
625
            config = self.get_config()
724
626
 
725
627
        return self.repository.get_commit_builder(self, parents, config,
726
 
            timestamp, timezone, committer, revprops, revision_id,
727
 
            lossy)
 
628
            timestamp, timezone, committer, revprops, revision_id)
728
629
 
729
630
    def get_master_branch(self, possible_transports=None):
730
631
        """Return the branch we are bound to.
757
658
        """Print `file` to stdout."""
758
659
        raise NotImplementedError(self.print_file)
759
660
 
760
 
    @deprecated_method(deprecated_in((2, 4, 0)))
761
661
    def set_revision_history(self, rev_history):
762
 
        """See Branch.set_revision_history."""
763
 
        self._set_revision_history(rev_history)
764
 
 
765
 
    @needs_write_lock
766
 
    def _set_revision_history(self, rev_history):
767
 
        if len(rev_history) == 0:
768
 
            revid = _mod_revision.NULL_REVISION
769
 
        else:
770
 
            revid = rev_history[-1]
771
 
        if rev_history != self._lefthand_history(revid):
772
 
            raise errors.NotLefthandHistory(rev_history)
773
 
        self.set_last_revision_info(len(rev_history), revid)
774
 
        self._cache_revision_history(rev_history)
775
 
        for hook in Branch.hooks['set_rh']:
776
 
            hook(self, rev_history)
777
 
 
778
 
    @needs_write_lock
779
 
    def set_last_revision_info(self, revno, revision_id):
780
 
        """Set the last revision of this branch.
781
 
 
782
 
        The caller is responsible for checking that the revno is correct
783
 
        for this revision id.
784
 
 
785
 
        It may be possible to set the branch last revision to an id not
786
 
        present in the repository.  However, branches can also be
787
 
        configured to check constraints on history, in which case this may not
788
 
        be permitted.
789
 
        """
790
 
        raise NotImplementedError(self.set_last_revision_info)
791
 
 
792
 
    @needs_write_lock
793
 
    def generate_revision_history(self, revision_id, last_rev=None,
794
 
                                  other_branch=None):
795
 
        """See Branch.generate_revision_history"""
796
 
        graph = self.repository.get_graph()
797
 
        (last_revno, last_revid) = self.last_revision_info()
798
 
        known_revision_ids = [
799
 
            (last_revid, last_revno),
800
 
            (_mod_revision.NULL_REVISION, 0),
801
 
            ]
802
 
        if last_rev is not None:
803
 
            if not graph.is_ancestor(last_rev, revision_id):
804
 
                # our previous tip is not merged into stop_revision
805
 
                raise errors.DivergedBranches(self, other_branch)
806
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
807
 
        self.set_last_revision_info(revno, revision_id)
 
662
        raise NotImplementedError(self.set_revision_history)
808
663
 
809
664
    @needs_write_lock
810
665
    def set_parent(self, url):
834
689
            stacking.
835
690
        """
836
691
        if not self._format.supports_stacking():
837
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
692
            raise errors.UnstackableBranchFormat(self._format, self.base)
838
693
        # XXX: Changing from one fallback repository to another does not check
839
694
        # that all the data you need is present in the new fallback.
840
695
        # Possibly it should.
854
709
 
855
710
    def _unstack(self):
856
711
        """Change a branch to be unstacked, copying data as needed.
857
 
 
 
712
        
858
713
        Don't call this directly, use set_stacked_on_url(None).
859
714
        """
860
715
        pb = ui.ui_factory.nested_progress_bar()
861
716
        try:
862
 
            pb.update(gettext("Unstacking"))
 
717
            pb.update("Unstacking")
863
718
            # The basic approach here is to fetch the tip of the branch,
864
719
            # including all available ghosts, from the existing stacked
865
720
            # repository into a new repository object without the fallbacks. 
869
724
            old_repository = self.repository
870
725
            if len(old_repository._fallback_repositories) != 1:
871
726
                raise AssertionError("can't cope with fallback repositories "
872
 
                    "of %r (fallbacks: %r)" % (old_repository,
873
 
                        old_repository._fallback_repositories))
874
 
            # Open the new repository object.
875
 
            # Repositories don't offer an interface to remove fallback
876
 
            # repositories today; take the conceptually simpler option and just
877
 
            # reopen it.  We reopen it starting from the URL so that we
878
 
            # get a separate connection for RemoteRepositories and can
879
 
            # stream from one of them to the other.  This does mean doing
880
 
            # separate SSH connection setup, but unstacking is not a
881
 
            # common operation so it's tolerable.
882
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
883
 
            new_repository = new_bzrdir.find_repository()
884
 
            if new_repository._fallback_repositories:
885
 
                raise AssertionError("didn't expect %r to have "
886
 
                    "fallback_repositories"
887
 
                    % (self.repository,))
888
 
            # Replace self.repository with the new repository.
889
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
890
 
            # lock count) of self.repository to the new repository.
891
 
            lock_token = old_repository.lock_write().repository_token
892
 
            self.repository = new_repository
893
 
            if isinstance(self, remote.RemoteBranch):
894
 
                # Remote branches can have a second reference to the old
895
 
                # repository that need to be replaced.
896
 
                if self._real_branch is not None:
897
 
                    self._real_branch.repository = new_repository
898
 
            self.repository.lock_write(token=lock_token)
899
 
            if lock_token is not None:
900
 
                old_repository.leave_lock_in_place()
 
727
                    "of %r" % (self.repository,))
 
728
            # unlock it, including unlocking the fallback
901
729
            old_repository.unlock()
902
 
            if lock_token is not None:
903
 
                # XXX: self.repository.leave_lock_in_place() before this
904
 
                # function will not be preserved.  Fortunately that doesn't
905
 
                # affect the current default format (2a), and would be a
906
 
                # corner-case anyway.
907
 
                #  - Andrew Bennetts, 2010/06/30
908
 
                self.repository.dont_leave_lock_in_place()
909
 
            old_lock_count = 0
910
 
            while True:
911
 
                try:
912
 
                    old_repository.unlock()
913
 
                except errors.LockNotHeld:
914
 
                    break
915
 
                old_lock_count += 1
916
 
            if old_lock_count == 0:
917
 
                raise AssertionError(
918
 
                    'old_repository should have been locked at least once.')
919
 
            for i in range(old_lock_count-1):
 
730
            old_repository.lock_read()
 
731
            try:
 
732
                # Repositories don't offer an interface to remove fallback
 
733
                # repositories today; take the conceptually simpler option and just
 
734
                # reopen it.  We reopen it starting from the URL so that we
 
735
                # get a separate connection for RemoteRepositories and can
 
736
                # stream from one of them to the other.  This does mean doing
 
737
                # separate SSH connection setup, but unstacking is not a
 
738
                # common operation so it's tolerable.
 
739
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
740
                new_repository = new_bzrdir.find_repository()
 
741
                self.repository = new_repository
 
742
                if self.repository._fallback_repositories:
 
743
                    raise AssertionError("didn't expect %r to have "
 
744
                        "fallback_repositories"
 
745
                        % (self.repository,))
 
746
                # this is not paired with an unlock because it's just restoring
 
747
                # the previous state; the lock's released when set_stacked_on_url
 
748
                # returns
920
749
                self.repository.lock_write()
921
 
            # Fetch from the old repository into the new.
922
 
            old_repository.lock_read()
923
 
            try:
924
750
                # XXX: If you unstack a branch while it has a working tree
925
751
                # with a pending merge, the pending-merged revisions will no
926
752
                # longer be present.  You can (probably) revert and remerge.
927
 
                try:
928
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
929
 
                except errors.TagsNotSupported:
930
 
                    tags_to_fetch = set()
931
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
932
 
                    old_repository, required_ids=[self.last_revision()],
933
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
934
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
 
753
                #
 
754
                # XXX: This only fetches up to the tip of the repository; it
 
755
                # doesn't bring across any tags.  That's fairly consistent
 
756
                # with how branch works, but perhaps not ideal.
 
757
                self.repository.fetch(old_repository,
 
758
                    revision_id=self.last_revision(),
 
759
                    find_ghosts=True)
935
760
            finally:
936
761
                old_repository.unlock()
937
762
        finally:
942
767
 
943
768
        :seealso: Branch._get_tags_bytes.
944
769
        """
945
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
946
 
        op.add_cleanup(self.lock_write().unlock)
947
 
        return op.run_simple(bytes)
948
 
 
949
 
    def _set_tags_bytes_locked(self, bytes):
950
 
        self._tags_bytes = bytes
951
 
        return self._transport.put_bytes('tags', bytes)
 
770
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
771
            'tags', bytes)
952
772
 
953
773
    def _cache_revision_history(self, rev_history):
954
774
        """Set the cached revision history to rev_history.
981
801
        self._revision_history_cache = None
982
802
        self._revision_id_to_revno_cache = None
983
803
        self._last_revision_info_cache = None
984
 
        self._master_branch_cache = None
985
804
        self._merge_sorted_revisions_cache = None
986
805
        self._partial_revision_history_cache = []
987
806
        self._partial_revision_id_to_revno_cache = {}
988
 
        self._tags_bytes = None
989
807
 
990
808
    def _gen_revision_history(self):
991
809
        """Return sequence of revision hashes on to this branch.
1028
846
 
1029
847
    def unbind(self):
1030
848
        """Older format branches cannot bind or unbind."""
1031
 
        raise errors.UpgradeRequired(self.user_url)
 
849
        raise errors.UpgradeRequired(self.base)
1032
850
 
1033
851
    def last_revision(self):
1034
852
        """Return last revision id, or NULL_REVISION."""
1041
859
        :return: A tuple (revno, revision_id).
1042
860
        """
1043
861
        if self._last_revision_info_cache is None:
1044
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
862
            self._last_revision_info_cache = self._last_revision_info()
1045
863
        return self._last_revision_info_cache
1046
864
 
1047
 
    def _read_last_revision_info(self):
1048
 
        raise NotImplementedError(self._read_last_revision_info)
1049
 
 
1050
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
865
    def _last_revision_info(self):
 
866
        rh = self.revision_history()
 
867
        revno = len(rh)
 
868
        if revno:
 
869
            return (revno, rh[-1])
 
870
        else:
 
871
            return (0, _mod_revision.NULL_REVISION)
 
872
 
 
873
    @deprecated_method(deprecated_in((1, 6, 0)))
 
874
    def missing_revisions(self, other, stop_revision=None):
 
875
        """Return a list of new revisions that would perfectly fit.
 
876
 
 
877
        If self and other have not diverged, return a list of the revisions
 
878
        present in other, but missing from self.
 
879
        """
 
880
        self_history = self.revision_history()
 
881
        self_len = len(self_history)
 
882
        other_history = other.revision_history()
 
883
        other_len = len(other_history)
 
884
        common_index = min(self_len, other_len) -1
 
885
        if common_index >= 0 and \
 
886
            self_history[common_index] != other_history[common_index]:
 
887
            raise errors.DivergedBranches(self, other)
 
888
 
 
889
        if stop_revision is None:
 
890
            stop_revision = other_len
 
891
        else:
 
892
            if stop_revision > other_len:
 
893
                raise errors.NoSuchRevision(self, stop_revision)
 
894
        return other_history[self_len:stop_revision]
 
895
 
 
896
    @needs_write_lock
 
897
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
898
                         graph=None):
 
899
        """Pull in new perfect-fit revisions.
 
900
 
 
901
        :param other: Another Branch to pull from
 
902
        :param stop_revision: Updated until the given revision
 
903
        :param overwrite: Always set the branch pointer, rather than checking
 
904
            to see if it is a proper descendant.
 
905
        :param graph: A Graph object that can be used to query history
 
906
            information. This can be None.
 
907
        :return: None
 
908
        """
 
909
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
910
            overwrite, graph)
 
911
 
1051
912
    def import_last_revision_info(self, source_repo, revno, revid):
1052
913
        """Set the last revision info, importing from another repo if necessary.
1053
914
 
 
915
        This is used by the bound branch code to upload a revision to
 
916
        the master branch first before updating the tip of the local branch.
 
917
 
1054
918
        :param source_repo: Source repository to optionally fetch from
1055
919
        :param revno: Revision number of the new tip
1056
920
        :param revid: Revision id of the new tip
1059
923
            self.repository.fetch(source_repo, revision_id=revid)
1060
924
        self.set_last_revision_info(revno, revid)
1061
925
 
1062
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1063
 
                                           lossy=False):
1064
 
        """Set the last revision info, importing from another repo if necessary.
1065
 
 
1066
 
        This is used by the bound branch code to upload a revision to
1067
 
        the master branch first before updating the tip of the local branch.
1068
 
        Revisions referenced by source's tags are also transferred.
1069
 
 
1070
 
        :param source: Source branch to optionally fetch from
1071
 
        :param revno: Revision number of the new tip
1072
 
        :param revid: Revision id of the new tip
1073
 
        :param lossy: Whether to discard metadata that can not be
1074
 
            natively represented
1075
 
        :return: Tuple with the new revision number and revision id
1076
 
            (should only be different from the arguments when lossy=True)
1077
 
        """
1078
 
        if not self.repository.has_same_location(source.repository):
1079
 
            self.fetch(source, revid)
1080
 
        self.set_last_revision_info(revno, revid)
1081
 
        return (revno, revid)
1082
 
 
1083
926
    def revision_id_to_revno(self, revision_id):
1084
927
        """Given a revision id, return its revno"""
1085
928
        if _mod_revision.is_null(revision_id):
1105
948
            self._extend_partial_history(distance_from_last)
1106
949
        return self._partial_revision_history_cache[distance_from_last]
1107
950
 
 
951
    @needs_write_lock
1108
952
    def pull(self, source, overwrite=False, stop_revision=None,
1109
953
             possible_transports=None, *args, **kwargs):
1110
954
        """Mirror source into this branch.
1117
961
            stop_revision=stop_revision,
1118
962
            possible_transports=possible_transports, *args, **kwargs)
1119
963
 
1120
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1121
 
            *args, **kwargs):
 
964
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
965
        **kwargs):
1122
966
        """Mirror this branch into target.
1123
967
 
1124
968
        This branch is considered to be 'local', having low latency.
1125
969
        """
1126
970
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1127
 
            lossy, *args, **kwargs)
 
971
            *args, **kwargs)
 
972
 
 
973
    def lossy_push(self, target, stop_revision=None):
 
974
        """Push deltas into another branch.
 
975
 
 
976
        :note: This does not, like push, retain the revision ids from 
 
977
            the source branch and will, rather than adding bzr-specific 
 
978
            metadata, push only those semantics of the revision that can be 
 
979
            natively represented by this branch' VCS.
 
980
 
 
981
        :param target: Target branch
 
982
        :param stop_revision: Revision to push, defaults to last revision.
 
983
        :return: BranchPushResult with an extra member revidmap: 
 
984
            A dictionary mapping revision ids from the target branch 
 
985
            to new revision ids in the target branch, for each 
 
986
            revision that was pushed.
 
987
        """
 
988
        inter = InterBranch.get(self, target)
 
989
        lossy_push = getattr(inter, "lossy_push", None)
 
990
        if lossy_push is None:
 
991
            raise errors.LossyPushToSameVCS(self, target)
 
992
        return lossy_push(stop_revision)
1128
993
 
1129
994
    def basis_tree(self):
1130
995
        """Return `Tree` object for last revision."""
1147
1012
        try:
1148
1013
            return urlutils.join(self.base[:-1], parent)
1149
1014
        except errors.InvalidURLJoin, e:
1150
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1015
            raise errors.InaccessibleParent(parent, self.base)
1151
1016
 
1152
1017
    def _get_parent_location(self):
1153
1018
        raise NotImplementedError(self._get_parent_location)
1238
1103
        params = ChangeBranchTipParams(
1239
1104
            self, old_revno, new_revno, old_revid, new_revid)
1240
1105
        for hook in hooks:
1241
 
            hook(params)
 
1106
            try:
 
1107
                hook(params)
 
1108
            except errors.TipChangeRejected:
 
1109
                raise
 
1110
            except Exception:
 
1111
                exc_info = sys.exc_info()
 
1112
                hook_name = Branch.hooks.get_hook_name(hook)
 
1113
                raise errors.HookFailed(
 
1114
                    'pre_change_branch_tip', hook_name, exc_info)
1242
1115
 
1243
1116
    @needs_write_lock
1244
1117
    def update(self):
1285
1158
        return result
1286
1159
 
1287
1160
    @needs_read_lock
1288
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1289
 
            repository=None):
 
1161
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1290
1162
        """Create a new line of development from the branch, into to_bzrdir.
1291
1163
 
1292
1164
        to_bzrdir controls the branch format.
1297
1169
        if (repository_policy is not None and
1298
1170
            repository_policy.requires_stacking()):
1299
1171
            to_bzrdir._format.require_stacking(_skip_repo=True)
1300
 
        result = to_bzrdir.create_branch(repository=repository)
 
1172
        result = to_bzrdir.create_branch()
1301
1173
        result.lock_write()
1302
1174
        try:
1303
1175
            if repository_policy is not None:
1304
1176
                repository_policy.configure_branch(result)
1305
1177
            self.copy_content_into(result, revision_id=revision_id)
1306
 
            master_url = self.get_bound_location()
1307
 
            if master_url is None:
1308
 
                result.set_parent(self.bzrdir.root_transport.base)
1309
 
            else:
1310
 
                result.set_parent(master_url)
 
1178
            result.set_parent(self.bzrdir.root_transport.base)
1311
1179
        finally:
1312
1180
            result.unlock()
1313
1181
        return result
1337
1205
                revno = 1
1338
1206
        destination.set_last_revision_info(revno, revision_id)
1339
1207
 
 
1208
    @needs_read_lock
1340
1209
    def copy_content_into(self, destination, revision_id=None):
1341
1210
        """Copy the content of self into destination.
1342
1211
 
1343
1212
        revision_id: if not None, the revision history in the new branch will
1344
1213
                     be truncated to end with revision_id.
1345
1214
        """
1346
 
        return InterBranch.get(self, destination).copy_content_into(
1347
 
            revision_id=revision_id)
 
1215
        self.update_references(destination)
 
1216
        self._synchronize_history(destination, revision_id)
 
1217
        try:
 
1218
            parent = self.get_parent()
 
1219
        except errors.InaccessibleParent, e:
 
1220
            mutter('parent was not accessible to copy: %s', e)
 
1221
        else:
 
1222
            if parent:
 
1223
                destination.set_parent(parent)
 
1224
        if self._push_should_merge_tags():
 
1225
            self.tags.merge_to(destination.tags)
1348
1226
 
1349
1227
    def update_references(self, target):
1350
1228
        if not getattr(self._format, 'supports_reference_locations', False):
1391
1269
        # specific check.
1392
1270
        return result
1393
1271
 
1394
 
    def _get_checkout_format(self, lightweight=False):
 
1272
    def _get_checkout_format(self):
1395
1273
        """Return the most suitable metadir for a checkout of this branch.
1396
1274
        Weaves are used if this branch's repository uses weaves.
1397
1275
        """
1398
 
        format = self.repository.bzrdir.checkout_metadir()
1399
 
        format.set_branch_format(self._format)
 
1276
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1277
            from bzrlib.repofmt import weaverepo
 
1278
            format = bzrdir.BzrDirMetaFormat1()
 
1279
            format.repository_format = weaverepo.RepositoryFormat7()
 
1280
        else:
 
1281
            format = self.repository.bzrdir.checkout_metadir()
 
1282
            format.set_branch_format(self._format)
1400
1283
        return format
1401
1284
 
1402
1285
    def create_clone_on_transport(self, to_transport, revision_id=None,
1403
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1404
 
        no_tree=None):
 
1286
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1405
1287
        """Create a clone of this branch and its bzrdir.
1406
1288
 
1407
1289
        :param to_transport: The transport to clone onto.
1414
1296
        """
1415
1297
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1416
1298
        # clone call. Or something. 20090224 RBC/spiv.
1417
 
        # XXX: Should this perhaps clone colocated branches as well, 
1418
 
        # rather than just the default branch? 20100319 JRV
1419
1299
        if revision_id is None:
1420
1300
            revision_id = self.last_revision()
1421
1301
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1422
1302
            revision_id=revision_id, stacked_on=stacked_on,
1423
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1424
 
            no_tree=no_tree)
 
1303
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1425
1304
        return dir_to.open_branch()
1426
1305
 
1427
1306
    def create_checkout(self, to_location, revision_id=None,
1432
1311
        :param to_location: The url to produce the checkout at
1433
1312
        :param revision_id: The revision to check out
1434
1313
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1435
 
            produce a bound branch (heavyweight checkout)
 
1314
        produce a bound branch (heavyweight checkout)
1436
1315
        :param accelerator_tree: A tree which can be used for retrieving file
1437
1316
            contents more quickly than the revision tree, i.e. a workingtree.
1438
1317
            The revision tree will be used for cases where accelerator_tree's
1443
1322
        """
1444
1323
        t = transport.get_transport(to_location)
1445
1324
        t.ensure_base()
1446
 
        format = self._get_checkout_format(lightweight=lightweight)
1447
1325
        if lightweight:
 
1326
            format = self._get_checkout_format()
1448
1327
            checkout = format.initialize_on_transport(t)
1449
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1450
 
                target_branch=self)
 
1328
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1451
1329
        else:
 
1330
            format = self._get_checkout_format()
1452
1331
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1453
1332
                to_location, force_new_tree=False, format=format)
1454
1333
            checkout = checkout_branch.bzrdir
1483
1362
 
1484
1363
    def reference_parent(self, file_id, path, possible_transports=None):
1485
1364
        """Return the parent branch for a tree-reference file_id
1486
 
 
1487
1365
        :param file_id: The file_id of the tree reference
1488
1366
        :param path: The path of the file_id in the tree
1489
1367
        :return: A branch associated with the file_id
1495
1373
    def supports_tags(self):
1496
1374
        return self._format.supports_tags()
1497
1375
 
1498
 
    def automatic_tag_name(self, revision_id):
1499
 
        """Try to automatically find the tag name for a revision.
1500
 
 
1501
 
        :param revision_id: Revision id of the revision.
1502
 
        :return: A tag name or None if no tag name could be determined.
1503
 
        """
1504
 
        for hook in Branch.hooks['automatic_tag_name']:
1505
 
            ret = hook(self, revision_id)
1506
 
            if ret is not None:
1507
 
                return ret
1508
 
        return None
1509
 
 
1510
1376
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1511
1377
                                         other_branch):
1512
1378
        """Ensure that revision_b is a descendant of revision_a.
1542
1408
        else:
1543
1409
            raise AssertionError("invalid heads: %r" % (heads,))
1544
1410
 
1545
 
    def heads_to_fetch(self):
1546
 
        """Return the heads that must and that should be fetched to copy this
1547
 
        branch into another repo.
1548
 
 
1549
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1550
 
            set of heads that must be fetched.  if_present_fetch is a set of
1551
 
            heads that must be fetched if present, but no error is necessary if
1552
 
            they are not present.
1553
 
        """
1554
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1555
 
        # are the tags.
1556
 
        must_fetch = set([self.last_revision()])
1557
 
        if_present_fetch = set()
1558
 
        c = self.get_config()
1559
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1560
 
                                                 default=False)
1561
 
        if include_tags:
1562
 
            try:
1563
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1564
 
            except errors.TagsNotSupported:
1565
 
                pass
1566
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1567
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1568
 
        return must_fetch, if_present_fetch
1569
 
 
1570
 
 
1571
 
class BranchFormat(controldir.ControlComponentFormat):
 
1411
 
 
1412
class BranchFormat(object):
1572
1413
    """An encapsulation of the initialization and open routines for a format.
1573
1414
 
1574
1415
    Formats provide three things:
1577
1418
     * an open routine.
1578
1419
 
1579
1420
    Formats are placed in an dict by their format string for reference
1580
 
    during branch opening. It's not required that these be instances, they
 
1421
    during branch opening. Its not required that these be instances, they
1581
1422
    can be classes themselves with class methods - it simply depends on
1582
1423
    whether state is needed for a given format or not.
1583
1424
 
1586
1427
    object will be created every time regardless.
1587
1428
    """
1588
1429
 
 
1430
    _default_format = None
 
1431
    """The default format used for new branches."""
 
1432
 
 
1433
    _formats = {}
 
1434
    """The known formats."""
 
1435
 
 
1436
    can_set_append_revisions_only = True
 
1437
 
1589
1438
    def __eq__(self, other):
1590
1439
        return self.__class__ is other.__class__
1591
1440
 
1593
1442
        return not (self == other)
1594
1443
 
1595
1444
    @classmethod
1596
 
    def find_format(klass, a_bzrdir, name=None):
 
1445
    def find_format(klass, a_bzrdir):
1597
1446
        """Return the format for the branch object in a_bzrdir."""
1598
1447
        try:
1599
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1448
            transport = a_bzrdir.get_branch_transport(None)
1600
1449
            format_string = transport.get_bytes("format")
1601
 
            return format_registry.get(format_string)
 
1450
            return klass._formats[format_string]
1602
1451
        except errors.NoSuchFile:
1603
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1452
            raise errors.NotBranchError(path=transport.base)
1604
1453
        except KeyError:
1605
1454
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1606
1455
 
1607
1456
    @classmethod
1608
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1609
1457
    def get_default_format(klass):
1610
1458
        """Return the current default format."""
1611
 
        return format_registry.get_default()
1612
 
 
1613
 
    @classmethod
1614
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1615
 
    def get_formats(klass):
1616
 
        """Get all the known formats.
1617
 
 
1618
 
        Warning: This triggers a load of all lazy registered formats: do not
1619
 
        use except when that is desireed.
1620
 
        """
1621
 
        return format_registry._get_all()
1622
 
 
1623
 
    def get_reference(self, a_bzrdir, name=None):
 
1459
        return klass._default_format
 
1460
 
 
1461
    def get_reference(self, a_bzrdir):
1624
1462
        """Get the target reference of the branch in a_bzrdir.
1625
1463
 
1626
1464
        format probing must have been completed before calling
1628
1466
        in a_bzrdir is correct.
1629
1467
 
1630
1468
        :param a_bzrdir: The bzrdir to get the branch data from.
1631
 
        :param name: Name of the colocated branch to fetch
1632
1469
        :return: None if the branch is not a reference branch.
1633
1470
        """
1634
1471
        return None
1635
1472
 
1636
1473
    @classmethod
1637
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1474
    def set_reference(self, a_bzrdir, to_branch):
1638
1475
        """Set the target reference of the branch in a_bzrdir.
1639
1476
 
1640
1477
        format probing must have been completed before calling
1642
1479
        in a_bzrdir is correct.
1643
1480
 
1644
1481
        :param a_bzrdir: The bzrdir to set the branch reference for.
1645
 
        :param name: Name of colocated branch to set, None for default
1646
1482
        :param to_branch: branch that the checkout is to reference
1647
1483
        """
1648
1484
        raise NotImplementedError(self.set_reference)
1655
1491
        """Return the short format description for this format."""
1656
1492
        raise NotImplementedError(self.get_format_description)
1657
1493
 
1658
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1659
 
        hooks = Branch.hooks['post_branch_init']
1660
 
        if not hooks:
1661
 
            return
1662
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1663
 
        for hook in hooks:
1664
 
            hook(params)
 
1494
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1495
                           set_format=True):
 
1496
        """Initialize a branch in a bzrdir, with specified files
1665
1497
 
1666
 
    def initialize(self, a_bzrdir, name=None, repository=None,
1667
 
                   append_revisions_only=None):
1668
 
        """Create a branch of this format in a_bzrdir.
1669
 
        
1670
 
        :param name: Name of the colocated branch to create.
 
1498
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1499
        :param utf8_files: The files to create as a list of
 
1500
            (filename, content) tuples
 
1501
        :param set_format: If True, set the format with
 
1502
            self.get_format_string.  (BzrBranch4 has its format set
 
1503
            elsewhere)
 
1504
        :return: a branch in this format
1671
1505
        """
 
1506
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1507
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1508
        lock_map = {
 
1509
            'metadir': ('lock', lockdir.LockDir),
 
1510
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1511
        }
 
1512
        lock_name, lock_class = lock_map[lock_type]
 
1513
        control_files = lockable_files.LockableFiles(branch_transport,
 
1514
            lock_name, lock_class)
 
1515
        control_files.create_lock()
 
1516
        try:
 
1517
            control_files.lock_write()
 
1518
        except errors.LockContention:
 
1519
            if lock_type != 'branch4':
 
1520
                raise
 
1521
            lock_taken = False
 
1522
        else:
 
1523
            lock_taken = True
 
1524
        if set_format:
 
1525
            utf8_files += [('format', self.get_format_string())]
 
1526
        try:
 
1527
            for (filename, content) in utf8_files:
 
1528
                branch_transport.put_bytes(
 
1529
                    filename, content,
 
1530
                    mode=a_bzrdir._get_file_mode())
 
1531
        finally:
 
1532
            if lock_taken:
 
1533
                control_files.unlock()
 
1534
        return self.open(a_bzrdir, _found=True)
 
1535
 
 
1536
    def initialize(self, a_bzrdir):
 
1537
        """Create a branch of this format in a_bzrdir."""
1672
1538
        raise NotImplementedError(self.initialize)
1673
1539
 
1674
1540
    def is_supported(self):
1692
1558
        Note that it is normal for branch to be a RemoteBranch when using tags
1693
1559
        on a RemoteBranch.
1694
1560
        """
1695
 
        return _mod_tag.DisabledTags(branch)
 
1561
        return DisabledTags(branch)
1696
1562
 
1697
1563
    def network_name(self):
1698
1564
        """A simple byte string uniquely identifying this format for RPC calls.
1704
1570
        """
1705
1571
        raise NotImplementedError(self.network_name)
1706
1572
 
1707
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1708
 
            found_repository=None):
 
1573
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1709
1574
        """Return the branch object for a_bzrdir
1710
1575
 
1711
1576
        :param a_bzrdir: A BzrDir that contains a branch.
1712
 
        :param name: Name of colocated branch to open
1713
1577
        :param _found: a private parameter, do not use it. It is used to
1714
1578
            indicate if format probing has already be done.
1715
1579
        :param ignore_fallbacks: when set, no fallback branches will be opened
1718
1582
        raise NotImplementedError(self.open)
1719
1583
 
1720
1584
    @classmethod
1721
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1722
1585
    def register_format(klass, format):
1723
 
        """Register a metadir format.
1724
 
 
1725
 
        See MetaDirBranchFormatFactory for the ability to register a format
1726
 
        without loading the code the format needs until it is actually used.
1727
 
        """
1728
 
        format_registry.register(format)
 
1586
        """Register a metadir format."""
 
1587
        klass._formats[format.get_format_string()] = format
 
1588
        # Metadir formats have a network name of their format string, and get
 
1589
        # registered as class factories.
 
1590
        network_format_registry.register(format.get_format_string(), format.__class__)
1729
1591
 
1730
1592
    @classmethod
1731
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1732
1593
    def set_default_format(klass, format):
1733
 
        format_registry.set_default(format)
 
1594
        klass._default_format = format
1734
1595
 
1735
1596
    def supports_set_append_revisions_only(self):
1736
1597
        """True if this format supports set_append_revisions_only."""
1740
1601
        """True if this format records a stacked-on branch."""
1741
1602
        return False
1742
1603
 
1743
 
    def supports_leaving_lock(self):
1744
 
        """True if this format supports leaving locks in place."""
1745
 
        return False # by default
1746
 
 
1747
1604
    @classmethod
1748
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1749
1605
    def unregister_format(klass, format):
1750
 
        format_registry.remove(format)
 
1606
        del klass._formats[format.get_format_string()]
1751
1607
 
1752
1608
    def __str__(self):
1753
1609
        return self.get_format_description().rstrip()
1756
1612
        """True if this format supports tags stored in the branch"""
1757
1613
        return False  # by default
1758
1614
 
1759
 
    def tags_are_versioned(self):
1760
 
        """Whether the tag container for this branch versions tags."""
1761
 
        return False
1762
 
 
1763
 
    def supports_tags_referencing_ghosts(self):
1764
 
        """True if tags can reference ghost revisions."""
1765
 
        return True
1766
 
 
1767
 
 
1768
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1769
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1770
 
    
1771
 
    While none of the built in BranchFormats are lazy registered yet,
1772
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1773
 
    use it, and the bzr-loom plugin uses it as well (see
1774
 
    bzrlib.plugins.loom.formats).
1775
 
    """
1776
 
 
1777
 
    def __init__(self, format_string, module_name, member_name):
1778
 
        """Create a MetaDirBranchFormatFactory.
1779
 
 
1780
 
        :param format_string: The format string the format has.
1781
 
        :param module_name: Module to load the format class from.
1782
 
        :param member_name: Attribute name within the module for the format class.
1783
 
        """
1784
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1785
 
        self._format_string = format_string
1786
 
        
1787
 
    def get_format_string(self):
1788
 
        """See BranchFormat.get_format_string."""
1789
 
        return self._format_string
1790
 
 
1791
 
    def __call__(self):
1792
 
        """Used for network_format_registry support."""
1793
 
        return self.get_obj()()
1794
 
 
1795
1615
 
1796
1616
class BranchHooks(Hooks):
1797
1617
    """A dictionary mapping hook name to a list of callables for branch hooks.
1806
1626
        These are all empty initially, because by default nothing should get
1807
1627
        notified.
1808
1628
        """
1809
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1810
 
        self.add_hook('set_rh',
 
1629
        Hooks.__init__(self)
 
1630
        self.create_hook(HookPoint('set_rh',
1811
1631
            "Invoked whenever the revision history has been set via "
1812
1632
            "set_revision_history. The api signature is (branch, "
1813
1633
            "revision_history), and the branch will be write-locked. "
1814
1634
            "The set_rh hook can be expensive for bzr to trigger, a better "
1815
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1816
 
        self.add_hook('open',
 
1635
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1636
        self.create_hook(HookPoint('open',
1817
1637
            "Called with the Branch object that has been opened after a "
1818
 
            "branch is opened.", (1, 8))
1819
 
        self.add_hook('post_push',
 
1638
            "branch is opened.", (1, 8), None))
 
1639
        self.create_hook(HookPoint('post_push',
1820
1640
            "Called after a push operation completes. post_push is called "
1821
1641
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1822
 
            "bzr client.", (0, 15))
1823
 
        self.add_hook('post_pull',
 
1642
            "bzr client.", (0, 15), None))
 
1643
        self.create_hook(HookPoint('post_pull',
1824
1644
            "Called after a pull operation completes. post_pull is called "
1825
1645
            "with a bzrlib.branch.PullResult object and only runs in the "
1826
 
            "bzr client.", (0, 15))
1827
 
        self.add_hook('pre_commit',
1828
 
            "Called after a commit is calculated but before it is "
 
1646
            "bzr client.", (0, 15), None))
 
1647
        self.create_hook(HookPoint('pre_commit',
 
1648
            "Called after a commit is calculated but before it is is "
1829
1649
            "completed. pre_commit is called with (local, master, old_revno, "
1830
1650
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1831
1651
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1833
1653
            "basis revision. hooks MUST NOT modify this delta. "
1834
1654
            " future_tree is an in-memory tree obtained from "
1835
1655
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1836
 
            "tree.", (0,91))
1837
 
        self.add_hook('post_commit',
 
1656
            "tree.", (0,91), None))
 
1657
        self.create_hook(HookPoint('post_commit',
1838
1658
            "Called in the bzr client after a commit has completed. "
1839
1659
            "post_commit is called with (local, master, old_revno, old_revid, "
1840
1660
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1841
 
            "commit to a branch.", (0, 15))
1842
 
        self.add_hook('post_uncommit',
 
1661
            "commit to a branch.", (0, 15), None))
 
1662
        self.create_hook(HookPoint('post_uncommit',
1843
1663
            "Called in the bzr client after an uncommit completes. "
1844
1664
            "post_uncommit is called with (local, master, old_revno, "
1845
1665
            "old_revid, new_revno, new_revid) where local is the local branch "
1846
1666
            "or None, master is the target branch, and an empty branch "
1847
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1848
 
        self.add_hook('pre_change_branch_tip',
 
1667
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1668
        self.create_hook(HookPoint('pre_change_branch_tip',
1849
1669
            "Called in bzr client and server before a change to the tip of a "
1850
1670
            "branch is made. pre_change_branch_tip is called with a "
1851
1671
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1852
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1853
 
        self.add_hook('post_change_branch_tip',
 
1672
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1673
        self.create_hook(HookPoint('post_change_branch_tip',
1854
1674
            "Called in bzr client and server after a change to the tip of a "
1855
1675
            "branch is made. post_change_branch_tip is called with a "
1856
1676
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1857
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1858
 
        self.add_hook('transform_fallback_location',
 
1677
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1678
        self.create_hook(HookPoint('transform_fallback_location',
1859
1679
            "Called when a stacked branch is activating its fallback "
1860
1680
            "locations. transform_fallback_location is called with (branch, "
1861
1681
            "url), and should return a new url. Returning the same url "
1866
1686
            "fallback locations have not been activated. When there are "
1867
1687
            "multiple hooks installed for transform_fallback_location, "
1868
1688
            "all are called with the url returned from the previous hook."
1869
 
            "The order is however undefined.", (1, 9))
1870
 
        self.add_hook('automatic_tag_name',
1871
 
            "Called to determine an automatic tag name for a revision. "
1872
 
            "automatic_tag_name is called with (branch, revision_id) and "
1873
 
            "should return a tag name or None if no tag name could be "
1874
 
            "determined. The first non-None tag name returned will be used.",
1875
 
            (2, 2))
1876
 
        self.add_hook('post_branch_init',
1877
 
            "Called after new branch initialization completes. "
1878
 
            "post_branch_init is called with a "
1879
 
            "bzrlib.branch.BranchInitHookParams. "
1880
 
            "Note that init, branch and checkout (both heavyweight and "
1881
 
            "lightweight) will all trigger this hook.", (2, 2))
1882
 
        self.add_hook('post_switch',
1883
 
            "Called after a checkout switches branch. "
1884
 
            "post_switch is called with a "
1885
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1886
 
 
 
1689
            "The order is however undefined.", (1, 9), None))
1887
1690
 
1888
1691
 
1889
1692
# install the default hooks into the Branch class.
1891
1694
 
1892
1695
 
1893
1696
class ChangeBranchTipParams(object):
1894
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1697
    """Object holding parameters passed to *_change_branch_tip hooks.
1895
1698
 
1896
1699
    There are 5 fields that hooks may wish to access:
1897
1700
 
1928
1731
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1929
1732
 
1930
1733
 
1931
 
class BranchInitHookParams(object):
1932
 
    """Object holding parameters passed to `*_branch_init` hooks.
1933
 
 
1934
 
    There are 4 fields that hooks may wish to access:
1935
 
 
1936
 
    :ivar format: the branch format
1937
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1938
 
    :ivar name: name of colocated branch, if any (or None)
1939
 
    :ivar branch: the branch created
1940
 
 
1941
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1942
 
    the checkout, hence they are different from the corresponding fields in
1943
 
    branch, which refer to the original branch.
1944
 
    """
1945
 
 
1946
 
    def __init__(self, format, a_bzrdir, name, branch):
1947
 
        """Create a group of BranchInitHook parameters.
1948
 
 
1949
 
        :param format: the branch format
1950
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1951
 
            initialized
1952
 
        :param name: name of colocated branch, if any (or None)
1953
 
        :param branch: the branch created
1954
 
 
1955
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1956
 
        to the checkout, hence they are different from the corresponding fields
1957
 
        in branch, which refer to the original branch.
1958
 
        """
1959
 
        self.format = format
1960
 
        self.bzrdir = a_bzrdir
1961
 
        self.name = name
1962
 
        self.branch = branch
1963
 
 
1964
 
    def __eq__(self, other):
1965
 
        return self.__dict__ == other.__dict__
1966
 
 
1967
 
    def __repr__(self):
1968
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1969
 
 
1970
 
 
1971
 
class SwitchHookParams(object):
1972
 
    """Object holding parameters passed to `*_switch` hooks.
1973
 
 
1974
 
    There are 4 fields that hooks may wish to access:
1975
 
 
1976
 
    :ivar control_dir: BzrDir of the checkout to change
1977
 
    :ivar to_branch: branch that the checkout is to reference
1978
 
    :ivar force: skip the check for local commits in a heavy checkout
1979
 
    :ivar revision_id: revision ID to switch to (or None)
1980
 
    """
1981
 
 
1982
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1983
 
        """Create a group of SwitchHook parameters.
1984
 
 
1985
 
        :param control_dir: BzrDir of the checkout to change
1986
 
        :param to_branch: branch that the checkout is to reference
1987
 
        :param force: skip the check for local commits in a heavy checkout
1988
 
        :param revision_id: revision ID to switch to (or None)
1989
 
        """
1990
 
        self.control_dir = control_dir
1991
 
        self.to_branch = to_branch
1992
 
        self.force = force
1993
 
        self.revision_id = revision_id
1994
 
 
1995
 
    def __eq__(self, other):
1996
 
        return self.__dict__ == other.__dict__
1997
 
 
1998
 
    def __repr__(self):
1999
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2000
 
            self.control_dir, self.to_branch,
2001
 
            self.revision_id)
 
1734
class BzrBranchFormat4(BranchFormat):
 
1735
    """Bzr branch format 4.
 
1736
 
 
1737
    This format has:
 
1738
     - a revision-history file.
 
1739
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1740
    """
 
1741
 
 
1742
    def get_format_description(self):
 
1743
        """See BranchFormat.get_format_description()."""
 
1744
        return "Branch format 4"
 
1745
 
 
1746
    def initialize(self, a_bzrdir):
 
1747
        """Create a branch of this format in a_bzrdir."""
 
1748
        utf8_files = [('revision-history', ''),
 
1749
                      ('branch-name', ''),
 
1750
                      ]
 
1751
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1752
                                       lock_type='branch4', set_format=False)
 
1753
 
 
1754
    def __init__(self):
 
1755
        super(BzrBranchFormat4, self).__init__()
 
1756
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1757
 
 
1758
    def network_name(self):
 
1759
        """The network name for this format is the control dirs disk label."""
 
1760
        return self._matchingbzrdir.get_format_string()
 
1761
 
 
1762
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1763
        """See BranchFormat.open()."""
 
1764
        if not _found:
 
1765
            # we are being called directly and must probe.
 
1766
            raise NotImplementedError
 
1767
        return BzrBranch(_format=self,
 
1768
                         _control_files=a_bzrdir._control_files,
 
1769
                         a_bzrdir=a_bzrdir,
 
1770
                         _repository=a_bzrdir.open_repository())
 
1771
 
 
1772
    def __str__(self):
 
1773
        return "Bazaar-NG branch format 4"
2002
1774
 
2003
1775
 
2004
1776
class BranchFormatMetadir(BranchFormat):
2008
1780
        """What class to instantiate on open calls."""
2009
1781
        raise NotImplementedError(self._branch_class)
2010
1782
 
2011
 
    def _get_initial_config(self, append_revisions_only=None):
2012
 
        if append_revisions_only:
2013
 
            return "append_revisions_only = True\n"
2014
 
        else:
2015
 
            # Avoid writing anything if append_revisions_only is disabled,
2016
 
            # as that is the default.
2017
 
            return ""
2018
 
 
2019
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2020
 
                           repository=None):
2021
 
        """Initialize a branch in a bzrdir, with specified files
2022
 
 
2023
 
        :param a_bzrdir: The bzrdir to initialize the branch in
2024
 
        :param utf8_files: The files to create as a list of
2025
 
            (filename, content) tuples
2026
 
        :param name: Name of colocated branch to create, if any
2027
 
        :return: a branch in this format
2028
 
        """
2029
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2030
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2031
 
        control_files = lockable_files.LockableFiles(branch_transport,
2032
 
            'lock', lockdir.LockDir)
2033
 
        control_files.create_lock()
2034
 
        control_files.lock_write()
2035
 
        try:
2036
 
            utf8_files += [('format', self.get_format_string())]
2037
 
            for (filename, content) in utf8_files:
2038
 
                branch_transport.put_bytes(
2039
 
                    filename, content,
2040
 
                    mode=a_bzrdir._get_file_mode())
2041
 
        finally:
2042
 
            control_files.unlock()
2043
 
        branch = self.open(a_bzrdir, name, _found=True,
2044
 
                found_repository=repository)
2045
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2046
 
        return branch
2047
 
 
2048
1783
    def network_name(self):
2049
1784
        """A simple byte string uniquely identifying this format for RPC calls.
2050
1785
 
2052
1787
        """
2053
1788
        return self.get_format_string()
2054
1789
 
2055
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2056
 
            found_repository=None):
 
1790
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2057
1791
        """See BranchFormat.open()."""
2058
1792
        if not _found:
2059
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1793
            format = BranchFormat.find_format(a_bzrdir)
2060
1794
            if format.__class__ != self.__class__:
2061
1795
                raise AssertionError("wrong format %r found for %r" %
2062
1796
                    (format, self))
2063
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2064
1797
        try:
 
1798
            transport = a_bzrdir.get_branch_transport(None)
2065
1799
            control_files = lockable_files.LockableFiles(transport, 'lock',
2066
1800
                                                         lockdir.LockDir)
2067
 
            if found_repository is None:
2068
 
                found_repository = a_bzrdir.find_repository()
2069
1801
            return self._branch_class()(_format=self,
2070
1802
                              _control_files=control_files,
2071
 
                              name=name,
2072
1803
                              a_bzrdir=a_bzrdir,
2073
 
                              _repository=found_repository,
 
1804
                              _repository=a_bzrdir.find_repository(),
2074
1805
                              ignore_fallbacks=ignore_fallbacks)
2075
1806
        except errors.NoSuchFile:
2076
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1807
            raise errors.NotBranchError(path=transport.base)
2077
1808
 
2078
1809
    def __init__(self):
2079
1810
        super(BranchFormatMetadir, self).__init__()
2083
1814
    def supports_tags(self):
2084
1815
        return True
2085
1816
 
2086
 
    def supports_leaving_lock(self):
2087
 
        return True
2088
 
 
2089
1817
 
2090
1818
class BzrBranchFormat5(BranchFormatMetadir):
2091
1819
    """Bzr branch format 5.
2111
1839
        """See BranchFormat.get_format_description()."""
2112
1840
        return "Branch format 5"
2113
1841
 
2114
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2115
 
                   append_revisions_only=None):
 
1842
    def initialize(self, a_bzrdir):
2116
1843
        """Create a branch of this format in a_bzrdir."""
2117
 
        if append_revisions_only:
2118
 
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2119
1844
        utf8_files = [('revision-history', ''),
2120
1845
                      ('branch-name', ''),
2121
1846
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1847
        return self._initialize_helper(a_bzrdir, utf8_files)
2123
1848
 
2124
1849
    def supports_tags(self):
2125
1850
        return False
2147
1872
        """See BranchFormat.get_format_description()."""
2148
1873
        return "Branch format 6"
2149
1874
 
2150
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2151
 
                   append_revisions_only=None):
 
1875
    def initialize(self, a_bzrdir):
2152
1876
        """Create a branch of this format in a_bzrdir."""
2153
1877
        utf8_files = [('last-revision', '0 null:\n'),
2154
 
                      ('branch.conf',
2155
 
                          self._get_initial_config(append_revisions_only)),
 
1878
                      ('branch.conf', ''),
2156
1879
                      ('tags', ''),
2157
1880
                      ]
2158
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1881
        return self._initialize_helper(a_bzrdir, utf8_files)
2159
1882
 
2160
1883
    def make_tags(self, branch):
2161
1884
        """See bzrlib.branch.BranchFormat.make_tags()."""
2162
 
        return _mod_tag.BasicTags(branch)
 
1885
        return BasicTags(branch)
2163
1886
 
2164
1887
    def supports_set_append_revisions_only(self):
2165
1888
        return True
2179
1902
        """See BranchFormat.get_format_description()."""
2180
1903
        return "Branch format 8"
2181
1904
 
2182
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2183
 
                   append_revisions_only=None):
 
1905
    def initialize(self, a_bzrdir):
2184
1906
        """Create a branch of this format in a_bzrdir."""
2185
1907
        utf8_files = [('last-revision', '0 null:\n'),
2186
 
                      ('branch.conf',
2187
 
                          self._get_initial_config(append_revisions_only)),
 
1908
                      ('branch.conf', ''),
2188
1909
                      ('tags', ''),
2189
1910
                      ('references', '')
2190
1911
                      ]
2191
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1912
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1913
 
 
1914
    def __init__(self):
 
1915
        super(BzrBranchFormat8, self).__init__()
 
1916
        self._matchingbzrdir.repository_format = \
 
1917
            RepositoryFormatKnitPack5RichRoot()
2192
1918
 
2193
1919
    def make_tags(self, branch):
2194
1920
        """See bzrlib.branch.BranchFormat.make_tags()."""
2195
 
        return _mod_tag.BasicTags(branch)
 
1921
        return BasicTags(branch)
2196
1922
 
2197
1923
    def supports_set_append_revisions_only(self):
2198
1924
        return True
2203
1929
    supports_reference_locations = True
2204
1930
 
2205
1931
 
2206
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1932
class BzrBranchFormat7(BzrBranchFormat8):
2207
1933
    """Branch format with last-revision, tags, and a stacked location pointer.
2208
1934
 
2209
1935
    The stacked location pointer is passed down to the repository and requires
2212
1938
    This format was introduced in bzr 1.6.
2213
1939
    """
2214
1940
 
2215
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2216
 
                   append_revisions_only=None):
 
1941
    def initialize(self, a_bzrdir):
2217
1942
        """Create a branch of this format in a_bzrdir."""
2218
1943
        utf8_files = [('last-revision', '0 null:\n'),
2219
 
                      ('branch.conf',
2220
 
                          self._get_initial_config(append_revisions_only)),
 
1944
                      ('branch.conf', ''),
2221
1945
                      ('tags', ''),
2222
1946
                      ]
2223
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1947
        return self._initialize_helper(a_bzrdir, utf8_files)
2224
1948
 
2225
1949
    def _branch_class(self):
2226
1950
        return BzrBranch7
2236
1960
    def supports_set_append_revisions_only(self):
2237
1961
        return True
2238
1962
 
2239
 
    def supports_stacking(self):
2240
 
        return True
2241
 
 
2242
 
    def make_tags(self, branch):
2243
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2244
 
        return _mod_tag.BasicTags(branch)
2245
 
 
2246
1963
    supports_reference_locations = False
2247
1964
 
2248
1965
 
2265
1982
        """See BranchFormat.get_format_description()."""
2266
1983
        return "Checkout reference format 1"
2267
1984
 
2268
 
    def get_reference(self, a_bzrdir, name=None):
 
1985
    def get_reference(self, a_bzrdir):
2269
1986
        """See BranchFormat.get_reference()."""
2270
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1987
        transport = a_bzrdir.get_branch_transport(None)
2271
1988
        return transport.get_bytes('location')
2272
1989
 
2273
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1990
    def set_reference(self, a_bzrdir, to_branch):
2274
1991
        """See BranchFormat.set_reference()."""
2275
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1992
        transport = a_bzrdir.get_branch_transport(None)
2276
1993
        location = transport.put_bytes('location', to_branch.base)
2277
1994
 
2278
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2279
 
            repository=None, append_revisions_only=None):
 
1995
    def initialize(self, a_bzrdir, target_branch=None):
2280
1996
        """Create a branch of this format in a_bzrdir."""
2281
1997
        if target_branch is None:
2282
1998
            # this format does not implement branch itself, thus the implicit
2283
1999
            # creation contract must see it as uninitializable
2284
2000
            raise errors.UninitializableFormat(self)
2285
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2286
 
        if a_bzrdir._format.fixed_components:
2287
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2288
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2001
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
2002
        branch_transport = a_bzrdir.get_branch_transport(self)
2289
2003
        branch_transport.put_bytes('location',
2290
 
            target_branch.bzrdir.user_url)
 
2004
            target_branch.bzrdir.root_transport.base)
2291
2005
        branch_transport.put_bytes('format', self.get_format_string())
2292
 
        branch = self.open(
2293
 
            a_bzrdir, name, _found=True,
 
2006
        return self.open(
 
2007
            a_bzrdir, _found=True,
2294
2008
            possible_transports=[target_branch.bzrdir.root_transport])
2295
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2296
 
        return branch
2297
2009
 
2298
2010
    def __init__(self):
2299
2011
        super(BranchReferenceFormat, self).__init__()
2305
2017
        def clone(to_bzrdir, revision_id=None,
2306
2018
            repository_policy=None):
2307
2019
            """See Branch.clone()."""
2308
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2020
            return format.initialize(to_bzrdir, a_branch)
2309
2021
            # cannot obey revision_id limits when cloning a reference ...
2310
2022
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2311
2023
            # emit some sort of warning/error to the caller ?!
2312
2024
        return clone
2313
2025
 
2314
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2315
 
             possible_transports=None, ignore_fallbacks=False,
2316
 
             found_repository=None):
 
2026
    def open(self, a_bzrdir, _found=False, location=None,
 
2027
             possible_transports=None, ignore_fallbacks=False):
2317
2028
        """Return the branch that the branch reference in a_bzrdir points at.
2318
2029
 
2319
2030
        :param a_bzrdir: A BzrDir that contains a branch.
2320
 
        :param name: Name of colocated branch to open, if any
2321
2031
        :param _found: a private parameter, do not use it. It is used to
2322
2032
            indicate if format probing has already be done.
2323
2033
        :param ignore_fallbacks: when set, no fallback branches will be opened
2328
2038
        :param possible_transports: An optional reusable transports list.
2329
2039
        """
2330
2040
        if not _found:
2331
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2041
            format = BranchFormat.find_format(a_bzrdir)
2332
2042
            if format.__class__ != self.__class__:
2333
2043
                raise AssertionError("wrong format %r found for %r" %
2334
2044
                    (format, self))
2335
2045
        if location is None:
2336
 
            location = self.get_reference(a_bzrdir, name)
 
2046
            location = self.get_reference(a_bzrdir)
2337
2047
        real_bzrdir = bzrdir.BzrDir.open(
2338
2048
            location, possible_transports=possible_transports)
2339
 
        result = real_bzrdir.open_branch(name=name, 
2340
 
            ignore_fallbacks=ignore_fallbacks)
 
2049
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2341
2050
        # this changes the behaviour of result.clone to create a new reference
2342
2051
        # rather than a copy of the content of the branch.
2343
2052
        # I did not use a proxy object because that needs much more extensive
2350
2059
        return result
2351
2060
 
2352
2061
 
2353
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2354
 
    """Branch format registry."""
2355
 
 
2356
 
    def __init__(self, other_registry=None):
2357
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2358
 
        self._default_format = None
2359
 
 
2360
 
    def set_default(self, format):
2361
 
        self._default_format = format
2362
 
 
2363
 
    def get_default(self):
2364
 
        return self._default_format
2365
 
 
2366
 
 
2367
2062
network_format_registry = registry.FormatRegistry()
2368
2063
"""Registry of formats indexed by their network name.
2369
2064
 
2372
2067
BranchFormat.network_name() for more detail.
2373
2068
"""
2374
2069
 
2375
 
format_registry = BranchFormatRegistry(network_format_registry)
2376
 
 
2377
2070
 
2378
2071
# formats which have no format string are not discoverable
2379
2072
# and not independently creatable, so are not registered.
2381
2074
__format6 = BzrBranchFormat6()
2382
2075
__format7 = BzrBranchFormat7()
2383
2076
__format8 = BzrBranchFormat8()
2384
 
format_registry.register(__format5)
2385
 
format_registry.register(BranchReferenceFormat())
2386
 
format_registry.register(__format6)
2387
 
format_registry.register(__format7)
2388
 
format_registry.register(__format8)
2389
 
format_registry.set_default(__format7)
2390
 
 
2391
 
 
2392
 
class BranchWriteLockResult(LogicalLockResult):
2393
 
    """The result of write locking a branch.
2394
 
 
2395
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2396
 
        None.
2397
 
    :ivar unlock: A callable which will unlock the lock.
2398
 
    """
2399
 
 
2400
 
    def __init__(self, unlock, branch_token):
2401
 
        LogicalLockResult.__init__(self, unlock)
2402
 
        self.branch_token = branch_token
2403
 
 
2404
 
    def __repr__(self):
2405
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2406
 
            self.unlock)
 
2077
BranchFormat.register_format(__format5)
 
2078
BranchFormat.register_format(BranchReferenceFormat())
 
2079
BranchFormat.register_format(__format6)
 
2080
BranchFormat.register_format(__format7)
 
2081
BranchFormat.register_format(__format8)
 
2082
BranchFormat.set_default_format(__format7)
 
2083
_legacy_formats = [BzrBranchFormat4(),
 
2084
    ]
 
2085
network_format_registry.register(
 
2086
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2407
2087
 
2408
2088
 
2409
2089
class BzrBranch(Branch, _RelockDebugMixin):
2418
2098
    :ivar repository: Repository for this branch.
2419
2099
    :ivar base: The url of the base directory for this branch; the one
2420
2100
        containing the .bzr directory.
2421
 
    :ivar name: Optional colocated branch name as it exists in the control
2422
 
        directory.
2423
2101
    """
2424
2102
 
2425
2103
    def __init__(self, _format=None,
2426
 
                 _control_files=None, a_bzrdir=None, name=None,
2427
 
                 _repository=None, ignore_fallbacks=False):
 
2104
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2105
                 ignore_fallbacks=False):
2428
2106
        """Create new branch object at a particular location."""
2429
2107
        if a_bzrdir is None:
2430
2108
            raise ValueError('a_bzrdir must be supplied')
2431
2109
        else:
2432
2110
            self.bzrdir = a_bzrdir
2433
2111
        self._base = self.bzrdir.transport.clone('..').base
2434
 
        self.name = name
2435
2112
        # XXX: We should be able to just do
2436
2113
        #   self.base = self.bzrdir.root_transport.base
2437
2114
        # but this does not quite work yet -- mbp 20080522
2444
2121
        Branch.__init__(self)
2445
2122
 
2446
2123
    def __str__(self):
2447
 
        if self.name is None:
2448
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2449
 
        else:
2450
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2451
 
                self.name)
 
2124
        return '%s(%r)' % (self.__class__.__name__, self.base)
2452
2125
 
2453
2126
    __repr__ = __str__
2454
2127
 
2459
2132
    base = property(_get_base, doc="The URL for the root of this branch.")
2460
2133
 
2461
2134
    def _get_config(self):
2462
 
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2135
        return TransportConfig(self._transport, 'branch.conf')
2463
2136
 
2464
2137
    def is_locked(self):
2465
2138
        return self.control_files.is_locked()
2466
2139
 
2467
2140
    def lock_write(self, token=None):
2468
 
        """Lock the branch for write operations.
2469
 
 
2470
 
        :param token: A token to permit reacquiring a previously held and
2471
 
            preserved lock.
2472
 
        :return: A BranchWriteLockResult.
2473
 
        """
2474
2141
        if not self.is_locked():
2475
2142
            self._note_lock('w')
2476
2143
        # All-in-one needs to always unlock/lock.
2477
2144
        repo_control = getattr(self.repository, 'control_files', None)
2478
2145
        if self.control_files == repo_control or not self.is_locked():
2479
 
            self.repository._warn_if_deprecated(self)
2480
2146
            self.repository.lock_write()
2481
2147
            took_lock = True
2482
2148
        else:
2483
2149
            took_lock = False
2484
2150
        try:
2485
 
            return BranchWriteLockResult(self.unlock,
2486
 
                self.control_files.lock_write(token=token))
 
2151
            return self.control_files.lock_write(token=token)
2487
2152
        except:
2488
2153
            if took_lock:
2489
2154
                self.repository.unlock()
2490
2155
            raise
2491
2156
 
2492
2157
    def lock_read(self):
2493
 
        """Lock the branch for read operations.
2494
 
 
2495
 
        :return: A bzrlib.lock.LogicalLockResult.
2496
 
        """
2497
2158
        if not self.is_locked():
2498
2159
            self._note_lock('r')
2499
2160
        # All-in-one needs to always unlock/lock.
2500
2161
        repo_control = getattr(self.repository, 'control_files', None)
2501
2162
        if self.control_files == repo_control or not self.is_locked():
2502
 
            self.repository._warn_if_deprecated(self)
2503
2163
            self.repository.lock_read()
2504
2164
            took_lock = True
2505
2165
        else:
2506
2166
            took_lock = False
2507
2167
        try:
2508
2168
            self.control_files.lock_read()
2509
 
            return LogicalLockResult(self.unlock)
2510
2169
        except:
2511
2170
            if took_lock:
2512
2171
                self.repository.unlock()
2540
2199
        """See Branch.print_file."""
2541
2200
        return self.repository.print_file(file, revision_id)
2542
2201
 
 
2202
    def _write_revision_history(self, history):
 
2203
        """Factored out of set_revision_history.
 
2204
 
 
2205
        This performs the actual writing to disk.
 
2206
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2207
        self._transport.put_bytes(
 
2208
            'revision-history', '\n'.join(history),
 
2209
            mode=self.bzrdir._get_file_mode())
 
2210
 
 
2211
    @needs_write_lock
 
2212
    def set_revision_history(self, rev_history):
 
2213
        """See Branch.set_revision_history."""
 
2214
        if 'evil' in debug.debug_flags:
 
2215
            mutter_callsite(3, "set_revision_history scales with history.")
 
2216
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2217
        for rev_id in rev_history:
 
2218
            check_not_reserved_id(rev_id)
 
2219
        if Branch.hooks['post_change_branch_tip']:
 
2220
            # Don't calculate the last_revision_info() if there are no hooks
 
2221
            # that will use it.
 
2222
            old_revno, old_revid = self.last_revision_info()
 
2223
        if len(rev_history) == 0:
 
2224
            revid = _mod_revision.NULL_REVISION
 
2225
        else:
 
2226
            revid = rev_history[-1]
 
2227
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2228
        self._write_revision_history(rev_history)
 
2229
        self._clear_cached_state()
 
2230
        self._cache_revision_history(rev_history)
 
2231
        for hook in Branch.hooks['set_rh']:
 
2232
            hook(self, rev_history)
 
2233
        if Branch.hooks['post_change_branch_tip']:
 
2234
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2235
 
 
2236
    def _synchronize_history(self, destination, revision_id):
 
2237
        """Synchronize last revision and revision history between branches.
 
2238
 
 
2239
        This version is most efficient when the destination is also a
 
2240
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2241
        history is the true lefthand parent history, and all of the revisions
 
2242
        are in the destination's repository.  If not, set_revision_history
 
2243
        will fail.
 
2244
 
 
2245
        :param destination: The branch to copy the history into
 
2246
        :param revision_id: The revision-id to truncate history at.  May
 
2247
          be None to copy complete history.
 
2248
        """
 
2249
        if not isinstance(destination._format, BzrBranchFormat5):
 
2250
            super(BzrBranch, self)._synchronize_history(
 
2251
                destination, revision_id)
 
2252
            return
 
2253
        if revision_id == _mod_revision.NULL_REVISION:
 
2254
            new_history = []
 
2255
        else:
 
2256
            new_history = self.revision_history()
 
2257
        if revision_id is not None and new_history != []:
 
2258
            try:
 
2259
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2260
            except ValueError:
 
2261
                rev = self.repository.get_revision(revision_id)
 
2262
                new_history = rev.get_history(self.repository)[1:]
 
2263
        destination.set_revision_history(new_history)
 
2264
 
2543
2265
    @needs_write_lock
2544
2266
    def set_last_revision_info(self, revno, revision_id):
2545
 
        if not revision_id or not isinstance(revision_id, basestring):
2546
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2267
        """Set the last revision of this branch.
 
2268
 
 
2269
        The caller is responsible for checking that the revno is correct
 
2270
        for this revision id.
 
2271
 
 
2272
        It may be possible to set the branch last revision to an id not
 
2273
        present in the repository.  However, branches can also be
 
2274
        configured to check constraints on history, in which case this may not
 
2275
        be permitted.
 
2276
        """
2547
2277
        revision_id = _mod_revision.ensure_null(revision_id)
2548
 
        old_revno, old_revid = self.last_revision_info()
2549
 
        if self.get_append_revisions_only():
2550
 
            self._check_history_violation(revision_id)
2551
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2552
 
        self._write_last_revision_info(revno, revision_id)
2553
 
        self._clear_cached_state()
2554
 
        self._last_revision_info_cache = revno, revision_id
2555
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2278
        # this old format stores the full history, but this api doesn't
 
2279
        # provide it, so we must generate, and might as well check it's
 
2280
        # correct
 
2281
        history = self._lefthand_history(revision_id)
 
2282
        if len(history) != revno:
 
2283
            raise AssertionError('%d != %d' % (len(history), revno))
 
2284
        self.set_revision_history(history)
 
2285
 
 
2286
    def _gen_revision_history(self):
 
2287
        history = self._transport.get_bytes('revision-history').split('\n')
 
2288
        if history[-1:] == ['']:
 
2289
            # There shouldn't be a trailing newline, but just in case.
 
2290
            history.pop()
 
2291
        return history
 
2292
 
 
2293
    @needs_write_lock
 
2294
    def generate_revision_history(self, revision_id, last_rev=None,
 
2295
        other_branch=None):
 
2296
        """Create a new revision history that will finish with revision_id.
 
2297
 
 
2298
        :param revision_id: the new tip to use.
 
2299
        :param last_rev: The previous last_revision. If not None, then this
 
2300
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2301
        :param other_branch: The other branch that DivergedBranches should
 
2302
            raise with respect to.
 
2303
        """
 
2304
        self.set_revision_history(self._lefthand_history(revision_id,
 
2305
            last_rev, other_branch))
2556
2306
 
2557
2307
    def basis_tree(self):
2558
2308
        """See Branch.basis_tree."""
2567
2317
                pass
2568
2318
        return None
2569
2319
 
 
2320
    def _basic_push(self, target, overwrite, stop_revision):
 
2321
        """Basic implementation of push without bound branches or hooks.
 
2322
 
 
2323
        Must be called with source read locked and target write locked.
 
2324
        """
 
2325
        result = BranchPushResult()
 
2326
        result.source_branch = self
 
2327
        result.target_branch = target
 
2328
        result.old_revno, result.old_revid = target.last_revision_info()
 
2329
        self.update_references(target)
 
2330
        if result.old_revid != self.last_revision():
 
2331
            # We assume that during 'push' this repository is closer than
 
2332
            # the target.
 
2333
            graph = self.repository.get_graph(target.repository)
 
2334
            target.update_revisions(self, stop_revision,
 
2335
                overwrite=overwrite, graph=graph)
 
2336
        if self._push_should_merge_tags():
 
2337
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2338
                overwrite)
 
2339
        result.new_revno, result.new_revid = target.last_revision_info()
 
2340
        return result
 
2341
 
2570
2342
    def get_stacked_on_url(self):
2571
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2343
        raise errors.UnstackableBranchFormat(self._format, self.base)
2572
2344
 
2573
2345
    def set_push_location(self, location):
2574
2346
        """See Branch.set_push_location."""
2583
2355
            self._transport.put_bytes('parent', url + '\n',
2584
2356
                mode=self.bzrdir._get_file_mode())
2585
2357
 
 
2358
 
 
2359
class BzrBranch5(BzrBranch):
 
2360
    """A format 5 branch. This supports new features over plain branches.
 
2361
 
 
2362
    It has support for a master_branch which is the data for bound branches.
 
2363
    """
 
2364
 
 
2365
    def get_bound_location(self):
 
2366
        try:
 
2367
            return self._transport.get_bytes('bound')[:-1]
 
2368
        except errors.NoSuchFile:
 
2369
            return None
 
2370
 
 
2371
    @needs_read_lock
 
2372
    def get_master_branch(self, possible_transports=None):
 
2373
        """Return the branch we are bound to.
 
2374
 
 
2375
        :return: Either a Branch, or None
 
2376
 
 
2377
        This could memoise the branch, but if thats done
 
2378
        it must be revalidated on each new lock.
 
2379
        So for now we just don't memoise it.
 
2380
        # RBC 20060304 review this decision.
 
2381
        """
 
2382
        bound_loc = self.get_bound_location()
 
2383
        if not bound_loc:
 
2384
            return None
 
2385
        try:
 
2386
            return Branch.open(bound_loc,
 
2387
                               possible_transports=possible_transports)
 
2388
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2389
            raise errors.BoundBranchConnectionFailure(
 
2390
                    self, bound_loc, e)
 
2391
 
2586
2392
    @needs_write_lock
2587
 
    def unbind(self):
2588
 
        """If bound, unbind"""
2589
 
        return self.set_bound_location(None)
 
2393
    def set_bound_location(self, location):
 
2394
        """Set the target where this branch is bound to.
 
2395
 
 
2396
        :param location: URL to the target branch
 
2397
        """
 
2398
        if location:
 
2399
            self._transport.put_bytes('bound', location+'\n',
 
2400
                mode=self.bzrdir._get_file_mode())
 
2401
        else:
 
2402
            try:
 
2403
                self._transport.delete('bound')
 
2404
            except errors.NoSuchFile:
 
2405
                return False
 
2406
            return True
2590
2407
 
2591
2408
    @needs_write_lock
2592
2409
    def bind(self, other):
2614
2431
        # history around
2615
2432
        self.set_bound_location(other.base)
2616
2433
 
2617
 
    def get_bound_location(self):
2618
 
        try:
2619
 
            return self._transport.get_bytes('bound')[:-1]
2620
 
        except errors.NoSuchFile:
2621
 
            return None
2622
 
 
2623
 
    @needs_read_lock
2624
 
    def get_master_branch(self, possible_transports=None):
2625
 
        """Return the branch we are bound to.
2626
 
 
2627
 
        :return: Either a Branch, or None
2628
 
        """
2629
 
        if self._master_branch_cache is None:
2630
 
            self._master_branch_cache = self._get_master_branch(
2631
 
                possible_transports)
2632
 
        return self._master_branch_cache
2633
 
 
2634
 
    def _get_master_branch(self, possible_transports):
2635
 
        bound_loc = self.get_bound_location()
2636
 
        if not bound_loc:
2637
 
            return None
2638
 
        try:
2639
 
            return Branch.open(bound_loc,
2640
 
                               possible_transports=possible_transports)
2641
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2642
 
            raise errors.BoundBranchConnectionFailure(
2643
 
                    self, bound_loc, e)
2644
 
 
2645
2434
    @needs_write_lock
2646
 
    def set_bound_location(self, location):
2647
 
        """Set the target where this branch is bound to.
2648
 
 
2649
 
        :param location: URL to the target branch
2650
 
        """
2651
 
        self._master_branch_cache = None
2652
 
        if location:
2653
 
            self._transport.put_bytes('bound', location+'\n',
2654
 
                mode=self.bzrdir._get_file_mode())
2655
 
        else:
2656
 
            try:
2657
 
                self._transport.delete('bound')
2658
 
            except errors.NoSuchFile:
2659
 
                return False
2660
 
            return True
 
2435
    def unbind(self):
 
2436
        """If bound, unbind"""
 
2437
        return self.set_bound_location(None)
2661
2438
 
2662
2439
    @needs_write_lock
2663
2440
    def update(self, possible_transports=None):
2676
2453
            return old_tip
2677
2454
        return None
2678
2455
 
2679
 
    def _read_last_revision_info(self):
2680
 
        revision_string = self._transport.get_bytes('last-revision')
2681
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2682
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2683
 
        revno = int(revno)
2684
 
        return revno, revision_id
2685
 
 
2686
 
    def _write_last_revision_info(self, revno, revision_id):
2687
 
        """Simply write out the revision id, with no checks.
2688
 
 
2689
 
        Use set_last_revision_info to perform this safely.
2690
 
 
2691
 
        Does not update the revision_history cache.
2692
 
        """
2693
 
        revision_id = _mod_revision.ensure_null(revision_id)
2694
 
        out_string = '%d %s\n' % (revno, revision_id)
2695
 
        self._transport.put_bytes('last-revision', out_string,
2696
 
            mode=self.bzrdir._get_file_mode())
2697
 
 
2698
 
 
2699
 
class FullHistoryBzrBranch(BzrBranch):
2700
 
    """Bzr branch which contains the full revision history."""
2701
 
 
2702
 
    @needs_write_lock
2703
 
    def set_last_revision_info(self, revno, revision_id):
2704
 
        if not revision_id or not isinstance(revision_id, basestring):
2705
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2706
 
        revision_id = _mod_revision.ensure_null(revision_id)
2707
 
        # this old format stores the full history, but this api doesn't
2708
 
        # provide it, so we must generate, and might as well check it's
2709
 
        # correct
2710
 
        history = self._lefthand_history(revision_id)
2711
 
        if len(history) != revno:
2712
 
            raise AssertionError('%d != %d' % (len(history), revno))
2713
 
        self._set_revision_history(history)
2714
 
 
2715
 
    def _read_last_revision_info(self):
2716
 
        rh = self.revision_history()
2717
 
        revno = len(rh)
2718
 
        if revno:
2719
 
            return (revno, rh[-1])
2720
 
        else:
2721
 
            return (0, _mod_revision.NULL_REVISION)
2722
 
 
2723
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2724
 
    @needs_write_lock
2725
 
    def set_revision_history(self, rev_history):
2726
 
        """See Branch.set_revision_history."""
2727
 
        self._set_revision_history(rev_history)
2728
 
 
2729
 
    def _set_revision_history(self, rev_history):
2730
 
        if 'evil' in debug.debug_flags:
2731
 
            mutter_callsite(3, "set_revision_history scales with history.")
2732
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2733
 
        for rev_id in rev_history:
2734
 
            check_not_reserved_id(rev_id)
2735
 
        if Branch.hooks['post_change_branch_tip']:
2736
 
            # Don't calculate the last_revision_info() if there are no hooks
2737
 
            # that will use it.
2738
 
            old_revno, old_revid = self.last_revision_info()
2739
 
        if len(rev_history) == 0:
2740
 
            revid = _mod_revision.NULL_REVISION
2741
 
        else:
2742
 
            revid = rev_history[-1]
2743
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2744
 
        self._write_revision_history(rev_history)
2745
 
        self._clear_cached_state()
2746
 
        self._cache_revision_history(rev_history)
2747
 
        for hook in Branch.hooks['set_rh']:
2748
 
            hook(self, rev_history)
2749
 
        if Branch.hooks['post_change_branch_tip']:
2750
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2751
 
 
2752
 
    def _write_revision_history(self, history):
2753
 
        """Factored out of set_revision_history.
2754
 
 
2755
 
        This performs the actual writing to disk.
2756
 
        It is intended to be called by set_revision_history."""
2757
 
        self._transport.put_bytes(
2758
 
            'revision-history', '\n'.join(history),
2759
 
            mode=self.bzrdir._get_file_mode())
2760
 
 
2761
 
    def _gen_revision_history(self):
2762
 
        history = self._transport.get_bytes('revision-history').split('\n')
2763
 
        if history[-1:] == ['']:
2764
 
            # There shouldn't be a trailing newline, but just in case.
2765
 
            history.pop()
2766
 
        return history
2767
 
 
2768
 
    def _synchronize_history(self, destination, revision_id):
2769
 
        if not isinstance(destination, FullHistoryBzrBranch):
2770
 
            super(BzrBranch, self)._synchronize_history(
2771
 
                destination, revision_id)
2772
 
            return
2773
 
        if revision_id == _mod_revision.NULL_REVISION:
2774
 
            new_history = []
2775
 
        else:
2776
 
            new_history = self.revision_history()
2777
 
        if revision_id is not None and new_history != []:
2778
 
            try:
2779
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2780
 
            except ValueError:
2781
 
                rev = self.repository.get_revision(revision_id)
2782
 
                new_history = rev.get_history(self.repository)[1:]
2783
 
        destination._set_revision_history(new_history)
2784
 
 
2785
 
    @needs_write_lock
2786
 
    def generate_revision_history(self, revision_id, last_rev=None,
2787
 
        other_branch=None):
2788
 
        """Create a new revision history that will finish with revision_id.
2789
 
 
2790
 
        :param revision_id: the new tip to use.
2791
 
        :param last_rev: The previous last_revision. If not None, then this
2792
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2793
 
        :param other_branch: The other branch that DivergedBranches should
2794
 
            raise with respect to.
2795
 
        """
2796
 
        self._set_revision_history(self._lefthand_history(revision_id,
2797
 
            last_rev, other_branch))
2798
 
 
2799
 
 
2800
 
class BzrBranch5(FullHistoryBzrBranch):
2801
 
    """A format 5 branch. This supports new features over plain branches.
2802
 
 
2803
 
    It has support for a master_branch which is the data for bound branches.
2804
 
    """
2805
 
 
2806
 
 
2807
 
class BzrBranch8(BzrBranch):
 
2456
 
 
2457
class BzrBranch8(BzrBranch5):
2808
2458
    """A branch that stores tree-reference locations."""
2809
2459
 
2810
2460
    def _open_hook(self):
2836
2486
        self._last_revision_info_cache = None
2837
2487
        self._reference_info = None
2838
2488
 
 
2489
    def _last_revision_info(self):
 
2490
        revision_string = self._transport.get_bytes('last-revision')
 
2491
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2492
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2493
        revno = int(revno)
 
2494
        return revno, revision_id
 
2495
 
 
2496
    def _write_last_revision_info(self, revno, revision_id):
 
2497
        """Simply write out the revision id, with no checks.
 
2498
 
 
2499
        Use set_last_revision_info to perform this safely.
 
2500
 
 
2501
        Does not update the revision_history cache.
 
2502
        Intended to be called by set_last_revision_info and
 
2503
        _write_revision_history.
 
2504
        """
 
2505
        revision_id = _mod_revision.ensure_null(revision_id)
 
2506
        out_string = '%d %s\n' % (revno, revision_id)
 
2507
        self._transport.put_bytes('last-revision', out_string,
 
2508
            mode=self.bzrdir._get_file_mode())
 
2509
 
 
2510
    @needs_write_lock
 
2511
    def set_last_revision_info(self, revno, revision_id):
 
2512
        revision_id = _mod_revision.ensure_null(revision_id)
 
2513
        old_revno, old_revid = self.last_revision_info()
 
2514
        if self._get_append_revisions_only():
 
2515
            self._check_history_violation(revision_id)
 
2516
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2517
        self._write_last_revision_info(revno, revision_id)
 
2518
        self._clear_cached_state()
 
2519
        self._last_revision_info_cache = revno, revision_id
 
2520
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2521
 
 
2522
    def _synchronize_history(self, destination, revision_id):
 
2523
        """Synchronize last revision and revision history between branches.
 
2524
 
 
2525
        :see: Branch._synchronize_history
 
2526
        """
 
2527
        # XXX: The base Branch has a fast implementation of this method based
 
2528
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2529
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2530
        # but wants the fast implementation, so it calls
 
2531
        # Branch._synchronize_history directly.
 
2532
        Branch._synchronize_history(self, destination, revision_id)
 
2533
 
2839
2534
    def _check_history_violation(self, revision_id):
2840
 
        current_revid = self.last_revision()
2841
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2535
        last_revision = _mod_revision.ensure_null(self.last_revision())
2842
2536
        if _mod_revision.is_null(last_revision):
2843
2537
            return
2844
 
        graph = self.repository.get_graph()
2845
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2846
 
            if lh_ancestor == current_revid:
2847
 
                return
2848
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2538
        if last_revision not in self._lefthand_history(revision_id):
 
2539
            raise errors.AppendRevisionsOnlyViolation(self.base)
2849
2540
 
2850
2541
    def _gen_revision_history(self):
2851
2542
        """Generate the revision history from last revision
2854
2545
        self._extend_partial_history(stop_index=last_revno-1)
2855
2546
        return list(reversed(self._partial_revision_history_cache))
2856
2547
 
 
2548
    def _write_revision_history(self, history):
 
2549
        """Factored out of set_revision_history.
 
2550
 
 
2551
        This performs the actual writing to disk, with format-specific checks.
 
2552
        It is intended to be called by BzrBranch5.set_revision_history.
 
2553
        """
 
2554
        if len(history) == 0:
 
2555
            last_revision = 'null:'
 
2556
        else:
 
2557
            if history != self._lefthand_history(history[-1]):
 
2558
                raise errors.NotLefthandHistory(history)
 
2559
            last_revision = history[-1]
 
2560
        if self._get_append_revisions_only():
 
2561
            self._check_history_violation(last_revision)
 
2562
        self._write_last_revision_info(len(history), last_revision)
 
2563
 
2857
2564
    @needs_write_lock
2858
2565
    def _set_parent_location(self, url):
2859
2566
        """Set the parent branch"""
2935
2642
        if branch_location is None:
2936
2643
            return Branch.reference_parent(self, file_id, path,
2937
2644
                                           possible_transports)
2938
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2645
        branch_location = urlutils.join(self.base, branch_location)
2939
2646
        return Branch.open(branch_location,
2940
2647
                           possible_transports=possible_transports)
2941
2648
 
2945
2652
 
2946
2653
    def set_bound_location(self, location):
2947
2654
        """See Branch.set_push_location."""
2948
 
        self._master_branch_cache = None
2949
2655
        result = None
2950
2656
        config = self.get_config()
2951
2657
        if location is None:
2982
2688
        # you can always ask for the URL; but you might not be able to use it
2983
2689
        # if the repo can't support stacking.
2984
2690
        ## self._check_stackable_repo()
2985
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2986
 
        # waste effort reading the whole stack of config files.
2987
 
        config = self.get_config()._get_branch_data_config()
2988
 
        stacked_url = self._get_config_location('stacked_on_location',
2989
 
            config=config)
 
2691
        stacked_url = self._get_config_location('stacked_on_location')
2990
2692
        if stacked_url is None:
2991
2693
            raise errors.NotStacked(self)
2992
2694
        return stacked_url
2993
2695
 
 
2696
    def _get_append_revisions_only(self):
 
2697
        value = self.get_config().get_user_option('append_revisions_only')
 
2698
        return value == 'True'
 
2699
 
 
2700
    @needs_write_lock
 
2701
    def generate_revision_history(self, revision_id, last_rev=None,
 
2702
                                  other_branch=None):
 
2703
        """See BzrBranch5.generate_revision_history"""
 
2704
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2705
        revno = len(history)
 
2706
        self.set_last_revision_info(revno, revision_id)
 
2707
 
2994
2708
    @needs_read_lock
2995
2709
    def get_rev_id(self, revno, history=None):
2996
2710
        """Find the revision id of the specified revno."""
3020
2734
        try:
3021
2735
            index = self._partial_revision_history_cache.index(revision_id)
3022
2736
        except ValueError:
3023
 
            try:
3024
 
                self._extend_partial_history(stop_revision=revision_id)
3025
 
            except errors.RevisionNotPresent, e:
3026
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2737
            self._extend_partial_history(stop_revision=revision_id)
3027
2738
            index = len(self._partial_revision_history_cache) - 1
3028
2739
            if self._partial_revision_history_cache[index] != revision_id:
3029
2740
                raise errors.NoSuchRevision(self, revision_id)
3052
2763
    """
3053
2764
 
3054
2765
    def get_stacked_on_url(self):
3055
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2766
        raise errors.UnstackableBranchFormat(self._format, self.base)
3056
2767
 
3057
2768
 
3058
2769
######################################################################
3082
2793
    :ivar local_branch: target branch if there is a Master, else None
3083
2794
    :ivar target_branch: Target/destination branch object. (write locked)
3084
2795
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3085
 
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3086
2796
    """
3087
2797
 
3088
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3089
2798
    def __int__(self):
3090
 
        """Return the relative change in revno.
3091
 
 
3092
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3093
 
        """
 
2799
        # DEPRECATED: pull used to return the change in revno
3094
2800
        return self.new_revno - self.old_revno
3095
2801
 
3096
2802
    def report(self, to_file):
3097
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3098
 
        tag_updates = getattr(self, "tag_updates", None)
3099
2803
        if not is_quiet():
3100
 
            if self.old_revid != self.new_revid:
 
2804
            if self.old_revid == self.new_revid:
 
2805
                to_file.write('No revisions to pull.\n')
 
2806
            else:
3101
2807
                to_file.write('Now on revision %d.\n' % self.new_revno)
3102
 
            if tag_updates:
3103
 
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3104
 
            if self.old_revid == self.new_revid and not tag_updates:
3105
 
                if not tag_conflicts:
3106
 
                    to_file.write('No revisions or tags to pull.\n')
3107
 
                else:
3108
 
                    to_file.write('No revisions to pull.\n')
3109
2808
        self._show_tag_conficts(to_file)
3110
2809
 
3111
2810
 
3128
2827
        target, otherwise it will be None.
3129
2828
    """
3130
2829
 
3131
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3132
2830
    def __int__(self):
3133
 
        """Return the relative change in revno.
3134
 
 
3135
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3136
 
        """
 
2831
        # DEPRECATED: push used to return the change in revno
3137
2832
        return self.new_revno - self.old_revno
3138
2833
 
3139
2834
    def report(self, to_file):
3140
 
        # TODO: This function gets passed a to_file, but then
3141
 
        # ignores it and calls note() instead. This is also
3142
 
        # inconsistent with PullResult(), which writes to stdout.
3143
 
        # -- JRV20110901, bug #838853
3144
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3145
 
        tag_updates = getattr(self, "tag_updates", None)
3146
 
        if not is_quiet():
3147
 
            if self.old_revid != self.new_revid:
3148
 
                note(gettext('Pushed up to revision %d.') % self.new_revno)
3149
 
            if tag_updates:
3150
 
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3151
 
            if self.old_revid == self.new_revid and not tag_updates:
3152
 
                if not tag_conflicts:
3153
 
                    note(gettext('No new revisions or tags to push.'))
3154
 
                else:
3155
 
                    note(gettext('No new revisions to push.'))
 
2835
        """Write a human-readable description of the result."""
 
2836
        if self.old_revid == self.new_revid:
 
2837
            note('No new revisions to push.')
 
2838
        else:
 
2839
            note('Pushed up to revision %d.' % self.new_revno)
3156
2840
        self._show_tag_conficts(to_file)
3157
2841
 
3158
2842
 
3172
2856
        :param verbose: Requests more detailed display of what was checked,
3173
2857
            if any.
3174
2858
        """
3175
 
        note(gettext('checked branch {0} format {1}').format(
3176
 
                                self.branch.user_url, self.branch._format))
 
2859
        note('checked branch %s format %s', self.branch.base,
 
2860
            self.branch._format)
3177
2861
        for error in self.errors:
3178
 
            note(gettext('found error:%s'), error)
 
2862
            note('found error:%s', error)
3179
2863
 
3180
2864
 
3181
2865
class Converter5to6(object):
3220
2904
 
3221
2905
 
3222
2906
class Converter7to8(object):
3223
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
2907
    """Perform an in-place upgrade of format 6 to format 7"""
3224
2908
 
3225
2909
    def convert(self, branch):
3226
2910
        format = BzrBranchFormat8()
3229
2913
        branch._transport.put_bytes('format', format.get_format_string())
3230
2914
 
3231
2915
 
 
2916
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2917
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2918
    duration.
 
2919
 
 
2920
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2921
 
 
2922
    If an exception is raised by callable, then that exception *will* be
 
2923
    propagated, even if the unlock attempt raises its own error.  Thus
 
2924
    _run_with_write_locked_target should be preferred to simply doing::
 
2925
 
 
2926
        target.lock_write()
 
2927
        try:
 
2928
            return callable(*args, **kwargs)
 
2929
        finally:
 
2930
            target.unlock()
 
2931
 
 
2932
    """
 
2933
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2934
    # should share code?
 
2935
    target.lock_write()
 
2936
    try:
 
2937
        result = callable(*args, **kwargs)
 
2938
    except:
 
2939
        exc_info = sys.exc_info()
 
2940
        try:
 
2941
            target.unlock()
 
2942
        finally:
 
2943
            raise exc_info[0], exc_info[1], exc_info[2]
 
2944
    else:
 
2945
        target.unlock()
 
2946
        return result
 
2947
 
 
2948
 
3232
2949
class InterBranch(InterObject):
3233
2950
    """This class represents operations taking place between two branches.
3234
2951
 
3240
2957
    _optimisers = []
3241
2958
    """The available optimised InterBranch types."""
3242
2959
 
3243
 
    @classmethod
3244
 
    def _get_branch_formats_to_test(klass):
3245
 
        """Return an iterable of format tuples for testing.
3246
 
        
3247
 
        :return: An iterable of (from_format, to_format) to use when testing
3248
 
            this InterBranch class. Each InterBranch class should define this
3249
 
            method itself.
3250
 
        """
3251
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2960
    @staticmethod
 
2961
    def _get_branch_formats_to_test():
 
2962
        """Return a tuple with the Branch formats to use when testing."""
 
2963
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3252
2964
 
3253
 
    @needs_write_lock
3254
2965
    def pull(self, overwrite=False, stop_revision=None,
3255
2966
             possible_transports=None, local=False):
3256
2967
        """Mirror source into target branch.
3261
2972
        """
3262
2973
        raise NotImplementedError(self.pull)
3263
2974
 
3264
 
    @needs_write_lock
3265
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
2975
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2976
                         graph=None):
 
2977
        """Pull in new perfect-fit revisions.
 
2978
 
 
2979
        :param stop_revision: Updated until the given revision
 
2980
        :param overwrite: Always set the branch pointer, rather than checking
 
2981
            to see if it is a proper descendant.
 
2982
        :param graph: A Graph object that can be used to query history
 
2983
            information. This can be None.
 
2984
        :return: None
 
2985
        """
 
2986
        raise NotImplementedError(self.update_revisions)
 
2987
 
 
2988
    def push(self, overwrite=False, stop_revision=None,
3266
2989
             _override_hook_source_branch=None):
3267
2990
        """Mirror the source branch into the target branch.
3268
2991
 
3270
2993
        """
3271
2994
        raise NotImplementedError(self.push)
3272
2995
 
3273
 
    @needs_write_lock
3274
 
    def copy_content_into(self, revision_id=None):
3275
 
        """Copy the content of source into target
3276
 
 
3277
 
        revision_id: if not None, the revision history in the new branch will
3278
 
                     be truncated to end with revision_id.
3279
 
        """
3280
 
        raise NotImplementedError(self.copy_content_into)
3281
 
 
3282
 
    @needs_write_lock
3283
 
    def fetch(self, stop_revision=None, limit=None):
3284
 
        """Fetch revisions.
3285
 
 
3286
 
        :param stop_revision: Last revision to fetch
3287
 
        :param limit: Optional rough limit of revisions to fetch
3288
 
        """
3289
 
        raise NotImplementedError(self.fetch)
3290
 
 
3291
2996
 
3292
2997
class GenericInterBranch(InterBranch):
3293
 
    """InterBranch implementation that uses public Branch functions."""
3294
 
 
3295
 
    @classmethod
3296
 
    def is_compatible(klass, source, target):
3297
 
        # GenericBranch uses the public API, so always compatible
3298
 
        return True
3299
 
 
3300
 
    @classmethod
3301
 
    def _get_branch_formats_to_test(klass):
3302
 
        return [(format_registry.get_default(), format_registry.get_default())]
3303
 
 
3304
 
    @classmethod
3305
 
    def unwrap_format(klass, format):
3306
 
        if isinstance(format, remote.RemoteBranchFormat):
3307
 
            format._ensure_real()
3308
 
            return format._custom_format
3309
 
        return format
3310
 
 
3311
 
    @needs_write_lock
3312
 
    def copy_content_into(self, revision_id=None):
3313
 
        """Copy the content of source into target
3314
 
 
3315
 
        revision_id: if not None, the revision history in the new branch will
3316
 
                     be truncated to end with revision_id.
3317
 
        """
3318
 
        self.source.update_references(self.target)
3319
 
        self.source._synchronize_history(self.target, revision_id)
3320
 
        try:
3321
 
            parent = self.source.get_parent()
3322
 
        except errors.InaccessibleParent, e:
3323
 
            mutter('parent was not accessible to copy: %s', e)
3324
 
        else:
3325
 
            if parent:
3326
 
                self.target.set_parent(parent)
3327
 
        if self.source._push_should_merge_tags():
3328
 
            self.source.tags.merge_to(self.target.tags)
3329
 
 
3330
 
    @needs_write_lock
3331
 
    def fetch(self, stop_revision=None, limit=None):
3332
 
        if self.target.base == self.source.base:
3333
 
            return (0, [])
 
2998
    """InterBranch implementation that uses public Branch functions.
 
2999
    """
 
3000
 
 
3001
    @staticmethod
 
3002
    def _get_branch_formats_to_test():
 
3003
        return BranchFormat._default_format, BranchFormat._default_format
 
3004
 
 
3005
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3006
        graph=None):
 
3007
        """See InterBranch.update_revisions()."""
3334
3008
        self.source.lock_read()
3335
3009
        try:
3336
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3337
 
            fetch_spec_factory.source_branch = self.source
3338
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3339
 
            fetch_spec_factory.source_repo = self.source.repository
3340
 
            fetch_spec_factory.target_repo = self.target.repository
3341
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3342
 
            fetch_spec_factory.limit = limit
3343
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3344
 
            return self.target.repository.fetch(self.source.repository,
3345
 
                fetch_spec=fetch_spec)
 
3010
            other_revno, other_last_revision = self.source.last_revision_info()
 
3011
            stop_revno = None # unknown
 
3012
            if stop_revision is None:
 
3013
                stop_revision = other_last_revision
 
3014
                if _mod_revision.is_null(stop_revision):
 
3015
                    # if there are no commits, we're done.
 
3016
                    return
 
3017
                stop_revno = other_revno
 
3018
 
 
3019
            # what's the current last revision, before we fetch [and change it
 
3020
            # possibly]
 
3021
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3022
            # we fetch here so that we don't process data twice in the common
 
3023
            # case of having something to pull, and so that the check for
 
3024
            # already merged can operate on the just fetched graph, which will
 
3025
            # be cached in memory.
 
3026
            self.target.fetch(self.source, stop_revision)
 
3027
            # Check to see if one is an ancestor of the other
 
3028
            if not overwrite:
 
3029
                if graph is None:
 
3030
                    graph = self.target.repository.get_graph()
 
3031
                if self.target._check_if_descendant_or_diverged(
 
3032
                        stop_revision, last_rev, graph, self.source):
 
3033
                    # stop_revision is a descendant of last_rev, but we aren't
 
3034
                    # overwriting, so we're done.
 
3035
                    return
 
3036
            if stop_revno is None:
 
3037
                if graph is None:
 
3038
                    graph = self.target.repository.get_graph()
 
3039
                this_revno, this_last_revision = \
 
3040
                        self.target.last_revision_info()
 
3041
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3042
                                [(other_last_revision, other_revno),
 
3043
                                 (this_last_revision, this_revno)])
 
3044
            self.target.set_last_revision_info(stop_revno, stop_revision)
3346
3045
        finally:
3347
3046
            self.source.unlock()
3348
3047
 
3349
 
    @needs_write_lock
3350
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3351
 
            graph=None):
3352
 
        other_revno, other_last_revision = self.source.last_revision_info()
3353
 
        stop_revno = None # unknown
3354
 
        if stop_revision is None:
3355
 
            stop_revision = other_last_revision
3356
 
            if _mod_revision.is_null(stop_revision):
3357
 
                # if there are no commits, we're done.
3358
 
                return
3359
 
            stop_revno = other_revno
3360
 
 
3361
 
        # what's the current last revision, before we fetch [and change it
3362
 
        # possibly]
3363
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3364
 
        # we fetch here so that we don't process data twice in the common
3365
 
        # case of having something to pull, and so that the check for
3366
 
        # already merged can operate on the just fetched graph, which will
3367
 
        # be cached in memory.
3368
 
        self.fetch(stop_revision=stop_revision)
3369
 
        # Check to see if one is an ancestor of the other
3370
 
        if not overwrite:
3371
 
            if graph is None:
3372
 
                graph = self.target.repository.get_graph()
3373
 
            if self.target._check_if_descendant_or_diverged(
3374
 
                    stop_revision, last_rev, graph, self.source):
3375
 
                # stop_revision is a descendant of last_rev, but we aren't
3376
 
                # overwriting, so we're done.
3377
 
                return
3378
 
        if stop_revno is None:
3379
 
            if graph is None:
3380
 
                graph = self.target.repository.get_graph()
3381
 
            this_revno, this_last_revision = \
3382
 
                    self.target.last_revision_info()
3383
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3384
 
                            [(other_last_revision, other_revno),
3385
 
                             (this_last_revision, this_revno)])
3386
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3387
 
 
3388
 
    @needs_write_lock
3389
3048
    def pull(self, overwrite=False, stop_revision=None,
3390
 
             possible_transports=None, run_hooks=True,
3391
 
             _override_hook_target=None, local=False):
3392
 
        """Pull from source into self, updating my master if any.
3393
 
 
3394
 
        :param run_hooks: Private parameter - if false, this branch
3395
 
            is being called because it's the master of the primary branch,
3396
 
            so it should not run its hooks.
3397
 
        """
3398
 
        bound_location = self.target.get_bound_location()
3399
 
        if local and not bound_location:
3400
 
            raise errors.LocalRequiresBoundBranch()
3401
 
        master_branch = None
3402
 
        source_is_master = False
3403
 
        if bound_location:
3404
 
            # bound_location comes from a config file, some care has to be
3405
 
            # taken to relate it to source.user_url
3406
 
            normalized = urlutils.normalize_url(bound_location)
3407
 
            try:
3408
 
                relpath = self.source.user_transport.relpath(normalized)
3409
 
                source_is_master = (relpath == '')
3410
 
            except (errors.PathNotChild, errors.InvalidURL):
3411
 
                source_is_master = False
3412
 
        if not local and bound_location and not source_is_master:
3413
 
            # not pulling from master, so we need to update master.
3414
 
            master_branch = self.target.get_master_branch(possible_transports)
3415
 
            master_branch.lock_write()
3416
 
        try:
3417
 
            if master_branch:
3418
 
                # pull from source into master.
3419
 
                master_branch.pull(self.source, overwrite, stop_revision,
3420
 
                    run_hooks=False)
3421
 
            return self._pull(overwrite,
3422
 
                stop_revision, _hook_master=master_branch,
3423
 
                run_hooks=run_hooks,
3424
 
                _override_hook_target=_override_hook_target,
3425
 
                merge_tags_to_master=not source_is_master)
3426
 
        finally:
3427
 
            if master_branch:
3428
 
                master_branch.unlock()
3429
 
 
3430
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3431
 
             _override_hook_source_branch=None):
3432
 
        """See InterBranch.push.
3433
 
 
3434
 
        This is the basic concrete implementation of push()
3435
 
 
3436
 
        :param _override_hook_source_branch: If specified, run the hooks
3437
 
            passing this Branch as the source, rather than self.  This is for
3438
 
            use of RemoteBranch, where push is delegated to the underlying
3439
 
            vfs-based Branch.
3440
 
        """
3441
 
        if lossy:
3442
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3443
 
        # TODO: Public option to disable running hooks - should be trivial but
3444
 
        # needs tests.
3445
 
 
3446
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3447
 
        op.add_cleanup(self.source.lock_read().unlock)
3448
 
        op.add_cleanup(self.target.lock_write().unlock)
3449
 
        return op.run(overwrite, stop_revision,
3450
 
            _override_hook_source_branch=_override_hook_source_branch)
3451
 
 
3452
 
    def _basic_push(self, overwrite, stop_revision):
3453
 
        """Basic implementation of push without bound branches or hooks.
3454
 
 
3455
 
        Must be called with source read locked and target write locked.
3456
 
        """
3457
 
        result = BranchPushResult()
3458
 
        result.source_branch = self.source
3459
 
        result.target_branch = self.target
3460
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3461
 
        self.source.update_references(self.target)
3462
 
        if result.old_revid != stop_revision:
3463
 
            # We assume that during 'push' this repository is closer than
3464
 
            # the target.
3465
 
            graph = self.source.repository.get_graph(self.target.repository)
3466
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3467
 
                    graph=graph)
3468
 
        if self.source._push_should_merge_tags():
3469
 
            result.tag_updates, result.tag_conflicts = (
3470
 
                self.source.tags.merge_to(self.target.tags, overwrite))
3471
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3472
 
        return result
3473
 
 
3474
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3475
 
            _override_hook_source_branch=None):
3476
 
        """Push from source into target, and into target's master if any.
3477
 
        """
3478
 
        def _run_hooks():
3479
 
            if _override_hook_source_branch:
3480
 
                result.source_branch = _override_hook_source_branch
3481
 
            for hook in Branch.hooks['post_push']:
3482
 
                hook(result)
3483
 
 
3484
 
        bound_location = self.target.get_bound_location()
3485
 
        if bound_location and self.target.base != bound_location:
3486
 
            # there is a master branch.
3487
 
            #
3488
 
            # XXX: Why the second check?  Is it even supported for a branch to
3489
 
            # be bound to itself? -- mbp 20070507
3490
 
            master_branch = self.target.get_master_branch()
3491
 
            master_branch.lock_write()
3492
 
            operation.add_cleanup(master_branch.unlock)
3493
 
            # push into the master from the source branch.
3494
 
            master_inter = InterBranch.get(self.source, master_branch)
3495
 
            master_inter._basic_push(overwrite, stop_revision)
3496
 
            # and push into the target branch from the source. Note that
3497
 
            # we push from the source branch again, because it's considered
3498
 
            # the highest bandwidth repository.
3499
 
            result = self._basic_push(overwrite, stop_revision)
3500
 
            result.master_branch = master_branch
3501
 
            result.local_branch = self.target
3502
 
        else:
3503
 
            master_branch = None
3504
 
            # no master branch
3505
 
            result = self._basic_push(overwrite, stop_revision)
3506
 
            # TODO: Why set master_branch and local_branch if there's no
3507
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3508
 
            # 20070504
3509
 
            result.master_branch = self.target
3510
 
            result.local_branch = None
3511
 
        _run_hooks()
3512
 
        return result
3513
 
 
3514
 
    def _pull(self, overwrite=False, stop_revision=None,
3515
3049
             possible_transports=None, _hook_master=None, run_hooks=True,
3516
 
             _override_hook_target=None, local=False,
3517
 
             merge_tags_to_master=True):
 
3050
             _override_hook_target=None, local=False):
3518
3051
        """See Branch.pull.
3519
3052
 
3520
 
        This function is the core worker, used by GenericInterBranch.pull to
3521
 
        avoid duplication when pulling source->master and source->local.
3522
 
 
3523
3053
        :param _hook_master: Private parameter - set the branch to
3524
3054
            be supplied as the master to pull hooks.
3525
3055
        :param run_hooks: Private parameter - if false, this branch
3526
3056
            is being called because it's the master of the primary branch,
3527
3057
            so it should not run its hooks.
3528
 
            is being called because it's the master of the primary branch,
3529
 
            so it should not run its hooks.
3530
3058
        :param _override_hook_target: Private parameter - set the branch to be
3531
3059
            supplied as the target_branch to pull hooks.
3532
3060
        :param local: Only update the local branch, and not the bound branch.
3551
3079
            # -- JRV20090506
3552
3080
            result.old_revno, result.old_revid = \
3553
3081
                self.target.last_revision_info()
3554
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3555
 
                graph=graph)
 
3082
            self.target.update_revisions(self.source, stop_revision,
 
3083
                overwrite=overwrite, graph=graph)
3556
3084
            # TODO: The old revid should be specified when merging tags, 
3557
3085
            # so a tags implementation that versions tags can only 
3558
3086
            # pull in the most recent changes. -- JRV20090506
3559
 
            result.tag_updates, result.tag_conflicts = (
3560
 
                self.source.tags.merge_to(self.target.tags, overwrite,
3561
 
                    ignore_master=not merge_tags_to_master))
 
3087
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3088
                overwrite)
3562
3089
            result.new_revno, result.new_revid = self.target.last_revision_info()
3563
3090
            if _hook_master:
3564
3091
                result.master_branch = _hook_master
3573
3100
            self.source.unlock()
3574
3101
        return result
3575
3102
 
 
3103
    def push(self, overwrite=False, stop_revision=None,
 
3104
             _override_hook_source_branch=None):
 
3105
        """See InterBranch.push.
 
3106
 
 
3107
        This is the basic concrete implementation of push()
 
3108
 
 
3109
        :param _override_hook_source_branch: If specified, run
 
3110
        the hooks passing this Branch as the source, rather than self.
 
3111
        This is for use of RemoteBranch, where push is delegated to the
 
3112
        underlying vfs-based Branch.
 
3113
        """
 
3114
        # TODO: Public option to disable running hooks - should be trivial but
 
3115
        # needs tests.
 
3116
        self.source.lock_read()
 
3117
        try:
 
3118
            return _run_with_write_locked_target(
 
3119
                self.target, self._push_with_bound_branches, overwrite,
 
3120
                stop_revision,
 
3121
                _override_hook_source_branch=_override_hook_source_branch)
 
3122
        finally:
 
3123
            self.source.unlock()
 
3124
 
 
3125
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3126
            _override_hook_source_branch=None):
 
3127
        """Push from source into target, and into target's master if any.
 
3128
        """
 
3129
        def _run_hooks():
 
3130
            if _override_hook_source_branch:
 
3131
                result.source_branch = _override_hook_source_branch
 
3132
            for hook in Branch.hooks['post_push']:
 
3133
                hook(result)
 
3134
 
 
3135
        bound_location = self.target.get_bound_location()
 
3136
        if bound_location and self.target.base != bound_location:
 
3137
            # there is a master branch.
 
3138
            #
 
3139
            # XXX: Why the second check?  Is it even supported for a branch to
 
3140
            # be bound to itself? -- mbp 20070507
 
3141
            master_branch = self.target.get_master_branch()
 
3142
            master_branch.lock_write()
 
3143
            try:
 
3144
                # push into the master from the source branch.
 
3145
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3146
                # and push into the target branch from the source. Note that we
 
3147
                # push from the source branch again, because its considered the
 
3148
                # highest bandwidth repository.
 
3149
                result = self.source._basic_push(self.target, overwrite,
 
3150
                    stop_revision)
 
3151
                result.master_branch = master_branch
 
3152
                result.local_branch = self.target
 
3153
                _run_hooks()
 
3154
                return result
 
3155
            finally:
 
3156
                master_branch.unlock()
 
3157
        else:
 
3158
            # no master branch
 
3159
            result = self.source._basic_push(self.target, overwrite,
 
3160
                stop_revision)
 
3161
            # TODO: Why set master_branch and local_branch if there's no
 
3162
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3163
            # 20070504
 
3164
            result.master_branch = self.target
 
3165
            result.local_branch = None
 
3166
            _run_hooks()
 
3167
            return result
 
3168
 
 
3169
    @classmethod
 
3170
    def is_compatible(self, source, target):
 
3171
        # GenericBranch uses the public API, so always compatible
 
3172
        return True
 
3173
 
 
3174
 
 
3175
class InterToBranch5(GenericInterBranch):
 
3176
 
 
3177
    @staticmethod
 
3178
    def _get_branch_formats_to_test():
 
3179
        return BranchFormat._default_format, BzrBranchFormat5()
 
3180
 
 
3181
    def pull(self, overwrite=False, stop_revision=None,
 
3182
             possible_transports=None, run_hooks=True,
 
3183
             _override_hook_target=None, local=False):
 
3184
        """Pull from source into self, updating my master if any.
 
3185
 
 
3186
        :param run_hooks: Private parameter - if false, this branch
 
3187
            is being called because it's the master of the primary branch,
 
3188
            so it should not run its hooks.
 
3189
        """
 
3190
        bound_location = self.target.get_bound_location()
 
3191
        if local and not bound_location:
 
3192
            raise errors.LocalRequiresBoundBranch()
 
3193
        master_branch = None
 
3194
        if not local and bound_location and self.source.base != bound_location:
 
3195
            # not pulling from master, so we need to update master.
 
3196
            master_branch = self.target.get_master_branch(possible_transports)
 
3197
            master_branch.lock_write()
 
3198
        try:
 
3199
            if master_branch:
 
3200
                # pull from source into master.
 
3201
                master_branch.pull(self.source, overwrite, stop_revision,
 
3202
                    run_hooks=False)
 
3203
            return super(InterToBranch5, self).pull(overwrite,
 
3204
                stop_revision, _hook_master=master_branch,
 
3205
                run_hooks=run_hooks,
 
3206
                _override_hook_target=_override_hook_target)
 
3207
        finally:
 
3208
            if master_branch:
 
3209
                master_branch.unlock()
 
3210
 
3576
3211
 
3577
3212
InterBranch.register_optimiser(GenericInterBranch)
 
3213
InterBranch.register_optimiser(InterToBranch5)