~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2011-09-26 15:21:01 UTC
  • mfrom: (6165.2.3 avoid-revision-history)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20110926152101-afcxw1hikybyivfd
merge avoid-revision-history.

Show diffs side-by-side

added added

removed removed

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