~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2009-07-07 04:32:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4524.
  • Revision ID: robertc@robertcollins.net-20090707043213-4hjjhgr40iq7gk2d
More informative assertions in xml serialisation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
from bzrlib import (
25
25
        bzrdir,
26
26
        cache_utf8,
27
 
        cleanup,
28
27
        config as _mod_config,
29
28
        debug,
30
29
        errors,
31
 
        fetch,
32
 
        graph as _mod_graph,
33
30
        lockdir,
34
31
        lockable_files,
35
 
        remote,
36
32
        repository,
37
33
        revision as _mod_revision,
38
34
        rio,
 
35
        symbol_versioning,
39
36
        transport,
40
 
        ui,
 
37
        tsort,
41
38
        urlutils,
42
39
        )
43
40
from bzrlib.config import BranchConfig, TransportConfig
 
41
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
42
from bzrlib.tag import (
45
43
    BasicTags,
46
44
    DisabledTags,
47
45
    )
48
46
""")
49
47
 
50
 
from bzrlib import (
51
 
    controldir,
52
 
    )
53
 
from bzrlib.decorators import (
54
 
    needs_read_lock,
55
 
    needs_write_lock,
56
 
    only_raises,
57
 
    )
58
 
from bzrlib.hooks import Hooks
 
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
49
from bzrlib.hooks import HookPoint, Hooks
59
50
from bzrlib.inter import InterObject
60
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
61
51
from bzrlib import registry
62
52
from bzrlib.symbol_versioning import (
63
53
    deprecated_in,
66
56
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
57
 
68
58
 
69
 
class Branch(controldir.ControlComponent):
 
59
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
60
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
61
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
62
 
 
63
 
 
64
# TODO: Maybe include checks for common corruption of newlines, etc?
 
65
 
 
66
# TODO: Some operations like log might retrieve the same revisions
 
67
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
68
# cache in memory to make this faster.  In general anything can be
 
69
# cached in memory between lock and unlock operations. .. nb thats
 
70
# what the transaction identity map provides
 
71
 
 
72
 
 
73
######################################################################
 
74
# branch objects
 
75
 
 
76
class Branch(object):
70
77
    """Branch holding a history of revisions.
71
78
 
72
 
    :ivar base:
73
 
        Base directory/url of the branch; using control_url and
74
 
        control_transport is more standardized.
75
 
    :ivar hooks: An instance of BranchHooks.
76
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
77
 
        _clear_cached_state.
 
79
    base
 
80
        Base directory/url of the branch.
 
81
 
 
82
    hooks: An instance of BranchHooks.
78
83
    """
79
84
    # this is really an instance variable - FIXME move it there
80
85
    # - RBC 20060112
81
86
    base = None
82
87
 
83
 
    @property
84
 
    def control_transport(self):
85
 
        return self._transport
86
 
 
87
 
    @property
88
 
    def user_transport(self):
89
 
        return self.bzrdir.user_transport
90
 
 
91
88
    def __init__(self, *ignored, **ignored_too):
92
89
        self.tags = self._format.make_tags(self)
93
90
        self._revision_history_cache = None
94
91
        self._revision_id_to_revno_cache = None
95
92
        self._partial_revision_id_to_revno_cache = {}
96
93
        self._partial_revision_history_cache = []
97
 
        self._tags_bytes = None
98
94
        self._last_revision_info_cache = None
99
 
        self._master_branch_cache = None
100
95
        self._merge_sorted_revisions_cache = None
101
96
        self._open_hook()
102
97
        hooks = Branch.hooks['open']
108
103
 
109
104
    def _activate_fallback_location(self, url):
110
105
        """Activate the branch/repository from url as a fallback repository."""
111
 
        for existing_fallback_repo in self.repository._fallback_repositories:
112
 
            if existing_fallback_repo.user_url == url:
113
 
                # This fallback is already configured.  This probably only
114
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
115
 
                # confusing _unstack we don't add this a second time.
116
 
                mutter('duplicate activation of fallback %r on %r', url, self)
117
 
                return
118
106
        repo = self._get_fallback_repository(url)
119
107
        if repo.has_same_location(self.repository):
120
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
108
            raise errors.UnstackableLocationError(self.base, url)
121
109
        self.repository.add_fallback_repository(repo)
122
110
 
123
111
    def break_lock(self):
160
148
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
161
149
            self._partial_revision_history_cache.pop()
162
150
 
163
 
    def _get_check_refs(self):
164
 
        """Get the references needed for check().
165
 
 
166
 
        See bzrlib.check.
167
 
        """
168
 
        revid = self.last_revision()
169
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
170
 
 
171
151
    @staticmethod
172
152
    def open(base, _unsupported=False, possible_transports=None):
173
153
        """Open the branch rooted at base.
177
157
        """
178
158
        control = bzrdir.BzrDir.open(base, _unsupported,
179
159
                                     possible_transports=possible_transports)
180
 
        return control.open_branch(unsupported=_unsupported)
 
160
        return control.open_branch(_unsupported)
181
161
 
182
162
    @staticmethod
183
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
163
    def open_from_transport(transport, _unsupported=False):
184
164
        """Open the branch rooted at transport"""
185
165
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
186
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
166
        return control.open_branch(_unsupported)
187
167
 
188
168
    @staticmethod
189
169
    def open_containing(url, possible_transports=None):
210
190
        return self.supports_tags() and self.tags.get_tag_dict()
211
191
 
212
192
    def get_config(self):
213
 
        """Get a bzrlib.config.BranchConfig for this Branch.
214
 
 
215
 
        This can then be used to get and set configuration options for the
216
 
        branch.
217
 
 
218
 
        :return: A bzrlib.config.BranchConfig.
219
 
        """
220
193
        return BranchConfig(self)
221
194
 
222
195
    def _get_config(self):
234
207
    def _get_fallback_repository(self, url):
235
208
        """Get the repository we fallback to at url."""
236
209
        url = urlutils.join(self.base, url)
237
 
        a_branch = Branch.open(url,
 
210
        a_bzrdir = bzrdir.BzrDir.open(url,
238
211
            possible_transports=[self.bzrdir.root_transport])
239
 
        return a_branch.repository
 
212
        return a_bzrdir.open_branch().repository
240
213
 
241
 
    @needs_read_lock
242
214
    def _get_tags_bytes(self):
243
215
        """Get the bytes of a serialised tags dict.
244
216
 
251
223
        :return: The bytes of the tags file.
252
224
        :seealso: Branch._set_tags_bytes.
253
225
        """
254
 
        if self._tags_bytes is None:
255
 
            self._tags_bytes = self._transport.get_bytes('tags')
256
 
        return self._tags_bytes
 
226
        return self._transport.get_bytes('tags')
257
227
 
258
228
    def _get_nick(self, local=False, possible_transports=None):
259
229
        config = self.get_config()
261
231
        if not local and not config.has_explicit_nickname():
262
232
            try:
263
233
                master = self.get_master_branch(possible_transports)
264
 
                if master and self.user_url == master.user_url:
265
 
                    raise errors.RecursiveBind(self.user_url)
266
234
                if master is not None:
267
235
                    # return the master branch value
268
236
                    return master.nick
269
 
            except errors.RecursiveBind, e:
270
 
                raise e
271
237
            except errors.BzrError, e:
272
238
                # Silently fall back to local implicit nick if the master is
273
239
                # unavailable
310
276
        new_history.reverse()
311
277
        return new_history
312
278
 
313
 
    def lock_write(self, token=None):
314
 
        """Lock the branch for write operations.
315
 
 
316
 
        :param token: A token to permit reacquiring a previously held and
317
 
            preserved lock.
318
 
        :return: A BranchWriteLockResult.
319
 
        """
 
279
    def lock_write(self):
320
280
        raise NotImplementedError(self.lock_write)
321
281
 
322
282
    def lock_read(self):
323
 
        """Lock the branch for read operations.
324
 
 
325
 
        :return: A bzrlib.lock.LogicalLockResult.
326
 
        """
327
283
        raise NotImplementedError(self.lock_read)
328
284
 
329
285
    def unlock(self):
450
406
            after. If None, the rest of history is included.
451
407
        :param stop_rule: if stop_revision_id is not None, the precise rule
452
408
            to use for termination:
453
 
 
454
409
            * 'exclude' - leave the stop revision out of the result (default)
455
410
            * 'include' - the stop revision is the last item in the result
456
411
            * 'with-merges' - include the stop revision and all of its
457
412
              merged revisions in the result
458
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
459
 
              that are in both ancestries
460
413
        :param direction: either 'reverse' or 'forward':
461
 
 
462
414
            * reverse means return the start_revision_id first, i.e.
463
415
              start at the most recent revision and go backwards in history
464
416
            * forward returns tuples in the opposite order to reverse.
485
437
        # start_revision_id.
486
438
        if self._merge_sorted_revisions_cache is None:
487
439
            last_revision = self.last_revision()
488
 
            known_graph = self.repository.get_known_graph_ancestry(
489
 
                [last_revision])
490
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
491
 
                last_revision)
 
440
            graph = self.repository.get_graph()
 
441
            parent_map = dict(((key, value) for key, value in
 
442
                     graph.iter_ancestry([last_revision]) if value is not None))
 
443
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
444
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
445
                generate_revno=True)
 
446
            # Drop the sequence # before caching
 
447
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
448
 
492
449
        filtered = self._filter_merge_sorted_revisions(
493
450
            self._merge_sorted_revisions_cache, start_revision_id,
494
451
            stop_revision_id, stop_rule)
495
 
        # Make sure we don't return revisions that are not part of the
496
 
        # start_revision_id ancestry.
497
 
        filtered = self._filter_start_non_ancestors(filtered)
498
452
        if direction == 'reverse':
499
453
            return filtered
500
454
        if direction == 'forward':
507
461
        """Iterate over an inclusive range of sorted revisions."""
508
462
        rev_iter = iter(merge_sorted_revisions)
509
463
        if start_revision_id is not None:
510
 
            for node in rev_iter:
511
 
                rev_id = node.key
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
512
465
                if rev_id != start_revision_id:
513
466
                    continue
514
467
                else:
515
468
                    # The decision to include the start or not
516
469
                    # depends on the stop_rule if a stop is provided
517
 
                    # so pop this node back into the iterator
518
 
                    rev_iter = chain(iter([node]), rev_iter)
 
470
                    rev_iter = chain(
 
471
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
472
                        rev_iter)
519
473
                    break
520
474
        if stop_revision_id is None:
521
 
            # Yield everything
522
 
            for node in rev_iter:
523
 
                rev_id = node.key
524
 
                yield (rev_id, node.merge_depth, node.revno,
525
 
                       node.end_of_merge)
 
475
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
476
                yield rev_id, depth, revno, end_of_merge
526
477
        elif stop_rule == 'exclude':
527
 
            for node in rev_iter:
528
 
                rev_id = node.key
 
478
            for rev_id, depth, revno, end_of_merge in rev_iter:
529
479
                if rev_id == stop_revision_id:
530
480
                    return
531
 
                yield (rev_id, node.merge_depth, node.revno,
532
 
                       node.end_of_merge)
 
481
                yield rev_id, depth, revno, end_of_merge
533
482
        elif stop_rule == 'include':
534
 
            for node in rev_iter:
535
 
                rev_id = node.key
536
 
                yield (rev_id, node.merge_depth, node.revno,
537
 
                       node.end_of_merge)
 
483
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
484
                yield rev_id, depth, revno, end_of_merge
538
485
                if rev_id == stop_revision_id:
539
486
                    return
540
 
        elif stop_rule == 'with-merges-without-common-ancestry':
541
 
            # We want to exclude all revisions that are already part of the
542
 
            # stop_revision_id ancestry.
543
 
            graph = self.repository.get_graph()
544
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
545
 
                                                    [stop_revision_id])
546
 
            for node in rev_iter:
547
 
                rev_id = node.key
548
 
                if rev_id not in ancestors:
549
 
                    continue
550
 
                yield (rev_id, node.merge_depth, node.revno,
551
 
                       node.end_of_merge)
552
487
        elif stop_rule == 'with-merges':
553
488
            stop_rev = self.repository.get_revision(stop_revision_id)
554
489
            if stop_rev.parent_ids:
555
490
                left_parent = stop_rev.parent_ids[0]
556
491
            else:
557
492
                left_parent = _mod_revision.NULL_REVISION
558
 
            # left_parent is the actual revision we want to stop logging at,
559
 
            # since we want to show the merged revisions after the stop_rev too
560
 
            reached_stop_revision_id = False
561
 
            revision_id_whitelist = []
562
 
            for node in rev_iter:
563
 
                rev_id = node.key
 
493
            for rev_id, depth, revno, end_of_merge in rev_iter:
564
494
                if rev_id == left_parent:
565
 
                    # reached the left parent after the stop_revision
566
495
                    return
567
 
                if (not reached_stop_revision_id or
568
 
                        rev_id in revision_id_whitelist):
569
 
                    yield (rev_id, node.merge_depth, node.revno,
570
 
                       node.end_of_merge)
571
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
572
 
                        # only do the merged revs of rev_id from now on
573
 
                        rev = self.repository.get_revision(rev_id)
574
 
                        if rev.parent_ids:
575
 
                            reached_stop_revision_id = True
576
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
496
                yield rev_id, depth, revno, end_of_merge
577
497
        else:
578
498
            raise ValueError('invalid stop_rule %r' % stop_rule)
579
499
 
580
 
    def _filter_start_non_ancestors(self, rev_iter):
581
 
        # If we started from a dotted revno, we want to consider it as a tip
582
 
        # and don't want to yield revisions that are not part of its
583
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
584
 
        # uninteresting descendants of the first parent of our tip before the
585
 
        # tip itself.
586
 
        first = rev_iter.next()
587
 
        (rev_id, merge_depth, revno, end_of_merge) = first
588
 
        yield first
589
 
        if not merge_depth:
590
 
            # We start at a mainline revision so by definition, all others
591
 
            # revisions in rev_iter are ancestors
592
 
            for node in rev_iter:
593
 
                yield node
594
 
 
595
 
        clean = False
596
 
        whitelist = set()
597
 
        pmap = self.repository.get_parent_map([rev_id])
598
 
        parents = pmap.get(rev_id, [])
599
 
        if parents:
600
 
            whitelist.update(parents)
601
 
        else:
602
 
            # If there is no parents, there is nothing of interest left
603
 
 
604
 
            # FIXME: It's hard to test this scenario here as this code is never
605
 
            # called in that case. -- vila 20100322
606
 
            return
607
 
 
608
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
609
 
            if not clean:
610
 
                if rev_id in whitelist:
611
 
                    pmap = self.repository.get_parent_map([rev_id])
612
 
                    parents = pmap.get(rev_id, [])
613
 
                    whitelist.remove(rev_id)
614
 
                    whitelist.update(parents)
615
 
                    if merge_depth == 0:
616
 
                        # We've reached the mainline, there is nothing left to
617
 
                        # filter
618
 
                        clean = True
619
 
                else:
620
 
                    # A revision that is not part of the ancestry of our
621
 
                    # starting revision.
622
 
                    continue
623
 
            yield (rev_id, merge_depth, revno, end_of_merge)
624
 
 
625
500
    def leave_lock_in_place(self):
626
501
        """Tell this branch object not to release the physical lock when this
627
502
        object is unlocked.
644
519
        :param other: The branch to bind to
645
520
        :type other: Branch
646
521
        """
647
 
        raise errors.UpgradeRequired(self.user_url)
 
522
        raise errors.UpgradeRequired(self.base)
648
523
 
649
524
    def set_append_revisions_only(self, enabled):
650
525
        if not self._format.supports_set_append_revisions_only():
651
 
            raise errors.UpgradeRequired(self.user_url)
 
526
            raise errors.UpgradeRequired(self.base)
652
527
        if enabled:
653
528
            value = 'True'
654
529
        else:
665
540
        raise errors.UnsupportedOperation(self.get_reference_info, self)
666
541
 
667
542
    @needs_write_lock
668
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
543
    def fetch(self, from_branch, last_revision=None, pb=None):
669
544
        """Copy revisions from from_branch into this branch.
670
545
 
671
546
        :param from_branch: Where to copy from.
672
547
        :param last_revision: What revision to stop at (None for at the end
673
548
                              of the branch.
674
 
        :param limit: Optional rough limit of revisions to fetch
 
549
        :param pb: An optional progress bar to use.
675
550
        :return: None
676
551
        """
677
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
552
        if self.base == from_branch.base:
 
553
            return (0, [])
 
554
        if pb is not None:
 
555
            symbol_versioning.warn(
 
556
                symbol_versioning.deprecated_in((1, 14, 0))
 
557
                % "pb parameter to fetch()")
 
558
        from_branch.lock_read()
 
559
        try:
 
560
            if last_revision is None:
 
561
                last_revision = from_branch.last_revision()
 
562
                last_revision = _mod_revision.ensure_null(last_revision)
 
563
            return self.repository.fetch(from_branch.repository,
 
564
                                         revision_id=last_revision,
 
565
                                         pb=pb)
 
566
        finally:
 
567
            from_branch.unlock()
678
568
 
679
569
    def get_bound_location(self):
680
570
        """Return the URL of the branch we are bound to.
687
577
    def get_old_bound_location(self):
688
578
        """Return the URL of the branch we used to be bound to
689
579
        """
690
 
        raise errors.UpgradeRequired(self.user_url)
 
580
        raise errors.UpgradeRequired(self.base)
691
581
 
692
582
    def get_commit_builder(self, parents, config=None, timestamp=None,
693
583
                           timezone=None, committer=None, revprops=None,
694
 
                           revision_id=None, lossy=False):
 
584
                           revision_id=None):
695
585
        """Obtain a CommitBuilder for this branch.
696
586
 
697
587
        :param parents: Revision ids of the parents of the new revision.
701
591
        :param committer: Optional committer to set for commit.
702
592
        :param revprops: Optional dictionary of revision properties.
703
593
        :param revision_id: Optional revision id.
704
 
        :param lossy: Whether to discard data that can not be natively
705
 
            represented, when pushing to a foreign VCS 
706
594
        """
707
595
 
708
596
        if config is None:
709
597
            config = self.get_config()
710
598
 
711
599
        return self.repository.get_commit_builder(self, parents, config,
712
 
            timestamp, timezone, committer, revprops, revision_id,
713
 
            lossy)
 
600
            timestamp, timezone, committer, revprops, revision_id)
714
601
 
715
602
    def get_master_branch(self, possible_transports=None):
716
603
        """Return the branch we are bound to.
743
630
        """Print `file` to stdout."""
744
631
        raise NotImplementedError(self.print_file)
745
632
 
746
 
    @deprecated_method(deprecated_in((2, 4, 0)))
747
633
    def set_revision_history(self, rev_history):
748
 
        """See Branch.set_revision_history."""
749
 
        self._set_revision_history(rev_history)
750
 
 
751
 
    @needs_write_lock
752
 
    def _set_revision_history(self, rev_history):
753
 
        if len(rev_history) == 0:
754
 
            revid = _mod_revision.NULL_REVISION
755
 
        else:
756
 
            revid = rev_history[-1]
757
 
        if rev_history != self._lefthand_history(revid):
758
 
            raise errors.NotLefthandHistory(rev_history)
759
 
        self.set_last_revision_info(len(rev_history), revid)
760
 
        self._cache_revision_history(rev_history)
761
 
        for hook in Branch.hooks['set_rh']:
762
 
            hook(self, rev_history)
763
 
 
764
 
    @needs_write_lock
765
 
    def set_last_revision_info(self, revno, revision_id):
766
 
        """Set the last revision of this branch.
767
 
 
768
 
        The caller is responsible for checking that the revno is correct
769
 
        for this revision id.
770
 
 
771
 
        It may be possible to set the branch last revision to an id not
772
 
        present in the repository.  However, branches can also be
773
 
        configured to check constraints on history, in which case this may not
774
 
        be permitted.
775
 
        """
776
 
        raise NotImplementedError(self.set_last_revision_info)
777
 
 
778
 
    @needs_write_lock
779
 
    def generate_revision_history(self, revision_id, last_rev=None,
780
 
                                  other_branch=None):
781
 
        """See Branch.generate_revision_history"""
782
 
        graph = self.repository.get_graph()
783
 
        (last_revno, last_revid) = self.last_revision_info()
784
 
        known_revision_ids = [
785
 
            (last_revid, last_revno),
786
 
            (_mod_revision.NULL_REVISION, 0),
787
 
            ]
788
 
        if last_rev is not None:
789
 
            if not graph.is_ancestor(last_rev, revision_id):
790
 
                # our previous tip is not merged into stop_revision
791
 
                raise errors.DivergedBranches(self, other_branch)
792
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
793
 
        self.set_last_revision_info(revno, revision_id)
 
634
        raise NotImplementedError(self.set_revision_history)
794
635
 
795
636
    @needs_write_lock
796
637
    def set_parent(self, url):
820
661
            stacking.
821
662
        """
822
663
        if not self._format.supports_stacking():
823
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
824
 
        # XXX: Changing from one fallback repository to another does not check
825
 
        # that all the data you need is present in the new fallback.
826
 
        # Possibly it should.
 
664
            raise errors.UnstackableBranchFormat(self._format, self.base)
827
665
        self._check_stackable_repo()
828
666
        if not url:
829
667
            try:
831
669
            except (errors.NotStacked, errors.UnstackableBranchFormat,
832
670
                errors.UnstackableRepositoryFormat):
833
671
                return
834
 
            self._unstack()
 
672
            url = ''
 
673
            # XXX: Lock correctness - should unlock our old repo if we were
 
674
            # locked.
 
675
            # repositories don't offer an interface to remove fallback
 
676
            # repositories today; take the conceptually simpler option and just
 
677
            # reopen it.
 
678
            self.repository = self.bzrdir.find_repository()
 
679
            self.repository.lock_write()
 
680
            # for every revision reference the branch has, ensure it is pulled
 
681
            # in.
 
682
            source_repository = self._get_fallback_repository(old_url)
 
683
            for revision_id in chain([self.last_revision()],
 
684
                self.tags.get_reverse_tag_dict()):
 
685
                self.repository.fetch(source_repository, revision_id,
 
686
                    find_ghosts=True)
835
687
        else:
836
688
            self._activate_fallback_location(url)
837
689
        # write this out after the repository is stacked to avoid setting a
838
690
        # stacked config that doesn't work.
839
691
        self._set_config_location('stacked_on_location', url)
840
692
 
841
 
    def _unstack(self):
842
 
        """Change a branch to be unstacked, copying data as needed.
843
 
 
844
 
        Don't call this directly, use set_stacked_on_url(None).
845
 
        """
846
 
        pb = ui.ui_factory.nested_progress_bar()
847
 
        try:
848
 
            pb.update("Unstacking")
849
 
            # The basic approach here is to fetch the tip of the branch,
850
 
            # including all available ghosts, from the existing stacked
851
 
            # repository into a new repository object without the fallbacks. 
852
 
            #
853
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
854
 
            # correct for CHKMap repostiories
855
 
            old_repository = self.repository
856
 
            if len(old_repository._fallback_repositories) != 1:
857
 
                raise AssertionError("can't cope with fallback repositories "
858
 
                    "of %r (fallbacks: %r)" % (old_repository,
859
 
                        old_repository._fallback_repositories))
860
 
            # Open the new repository object.
861
 
            # Repositories don't offer an interface to remove fallback
862
 
            # repositories today; take the conceptually simpler option and just
863
 
            # reopen it.  We reopen it starting from the URL so that we
864
 
            # get a separate connection for RemoteRepositories and can
865
 
            # stream from one of them to the other.  This does mean doing
866
 
            # separate SSH connection setup, but unstacking is not a
867
 
            # common operation so it's tolerable.
868
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
869
 
            new_repository = new_bzrdir.find_repository()
870
 
            if new_repository._fallback_repositories:
871
 
                raise AssertionError("didn't expect %r to have "
872
 
                    "fallback_repositories"
873
 
                    % (self.repository,))
874
 
            # Replace self.repository with the new repository.
875
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
876
 
            # lock count) of self.repository to the new repository.
877
 
            lock_token = old_repository.lock_write().repository_token
878
 
            self.repository = new_repository
879
 
            if isinstance(self, remote.RemoteBranch):
880
 
                # Remote branches can have a second reference to the old
881
 
                # repository that need to be replaced.
882
 
                if self._real_branch is not None:
883
 
                    self._real_branch.repository = new_repository
884
 
            self.repository.lock_write(token=lock_token)
885
 
            if lock_token is not None:
886
 
                old_repository.leave_lock_in_place()
887
 
            old_repository.unlock()
888
 
            if lock_token is not None:
889
 
                # XXX: self.repository.leave_lock_in_place() before this
890
 
                # function will not be preserved.  Fortunately that doesn't
891
 
                # affect the current default format (2a), and would be a
892
 
                # corner-case anyway.
893
 
                #  - Andrew Bennetts, 2010/06/30
894
 
                self.repository.dont_leave_lock_in_place()
895
 
            old_lock_count = 0
896
 
            while True:
897
 
                try:
898
 
                    old_repository.unlock()
899
 
                except errors.LockNotHeld:
900
 
                    break
901
 
                old_lock_count += 1
902
 
            if old_lock_count == 0:
903
 
                raise AssertionError(
904
 
                    'old_repository should have been locked at least once.')
905
 
            for i in range(old_lock_count-1):
906
 
                self.repository.lock_write()
907
 
            # Fetch from the old repository into the new.
908
 
            old_repository.lock_read()
909
 
            try:
910
 
                # XXX: If you unstack a branch while it has a working tree
911
 
                # with a pending merge, the pending-merged revisions will no
912
 
                # longer be present.  You can (probably) revert and remerge.
913
 
                try:
914
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
915
 
                except errors.TagsNotSupported:
916
 
                    tags_to_fetch = set()
917
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
918
 
                    old_repository, required_ids=[self.last_revision()],
919
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
920
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
921
 
            finally:
922
 
                old_repository.unlock()
923
 
        finally:
924
 
            pb.finished()
925
693
 
926
694
    def _set_tags_bytes(self, bytes):
927
695
        """Mirror method for _get_tags_bytes.
928
696
 
929
697
        :seealso: Branch._get_tags_bytes.
930
698
        """
931
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
932
 
        op.add_cleanup(self.lock_write().unlock)
933
 
        return op.run_simple(bytes)
934
 
 
935
 
    def _set_tags_bytes_locked(self, bytes):
936
 
        self._tags_bytes = bytes
937
 
        return self._transport.put_bytes('tags', bytes)
 
699
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
700
            'tags', bytes)
938
701
 
939
702
    def _cache_revision_history(self, rev_history):
940
703
        """Set the cached revision history to rev_history.
967
730
        self._revision_history_cache = None
968
731
        self._revision_id_to_revno_cache = None
969
732
        self._last_revision_info_cache = None
970
 
        self._master_branch_cache = None
971
733
        self._merge_sorted_revisions_cache = None
972
734
        self._partial_revision_history_cache = []
973
735
        self._partial_revision_id_to_revno_cache = {}
974
 
        self._tags_bytes = None
975
736
 
976
737
    def _gen_revision_history(self):
977
738
        """Return sequence of revision hashes on to this branch.
1014
775
 
1015
776
    def unbind(self):
1016
777
        """Older format branches cannot bind or unbind."""
1017
 
        raise errors.UpgradeRequired(self.user_url)
 
778
        raise errors.UpgradeRequired(self.base)
1018
779
 
1019
780
    def last_revision(self):
1020
781
        """Return last revision id, or NULL_REVISION."""
1027
788
        :return: A tuple (revno, revision_id).
1028
789
        """
1029
790
        if self._last_revision_info_cache is None:
1030
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
791
            self._last_revision_info_cache = self._last_revision_info()
1031
792
        return self._last_revision_info_cache
1032
793
 
1033
 
    def _read_last_revision_info(self):
1034
 
        raise NotImplementedError(self._read_last_revision_info)
1035
 
 
1036
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
794
    def _last_revision_info(self):
 
795
        rh = self.revision_history()
 
796
        revno = len(rh)
 
797
        if revno:
 
798
            return (revno, rh[-1])
 
799
        else:
 
800
            return (0, _mod_revision.NULL_REVISION)
 
801
 
 
802
    @deprecated_method(deprecated_in((1, 6, 0)))
 
803
    def missing_revisions(self, other, stop_revision=None):
 
804
        """Return a list of new revisions that would perfectly fit.
 
805
 
 
806
        If self and other have not diverged, return a list of the revisions
 
807
        present in other, but missing from self.
 
808
        """
 
809
        self_history = self.revision_history()
 
810
        self_len = len(self_history)
 
811
        other_history = other.revision_history()
 
812
        other_len = len(other_history)
 
813
        common_index = min(self_len, other_len) -1
 
814
        if common_index >= 0 and \
 
815
            self_history[common_index] != other_history[common_index]:
 
816
            raise errors.DivergedBranches(self, other)
 
817
 
 
818
        if stop_revision is None:
 
819
            stop_revision = other_len
 
820
        else:
 
821
            if stop_revision > other_len:
 
822
                raise errors.NoSuchRevision(self, stop_revision)
 
823
        return other_history[self_len:stop_revision]
 
824
 
 
825
    @needs_write_lock
 
826
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
827
                         graph=None):
 
828
        """Pull in new perfect-fit revisions.
 
829
 
 
830
        :param other: Another Branch to pull from
 
831
        :param stop_revision: Updated until the given revision
 
832
        :param overwrite: Always set the branch pointer, rather than checking
 
833
            to see if it is a proper descendant.
 
834
        :param graph: A Graph object that can be used to query history
 
835
            information. This can be None.
 
836
        :return: None
 
837
        """
 
838
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
839
            overwrite, graph)
 
840
 
1037
841
    def import_last_revision_info(self, source_repo, revno, revid):
1038
842
        """Set the last revision info, importing from another repo if necessary.
1039
843
 
 
844
        This is used by the bound branch code to upload a revision to
 
845
        the master branch first before updating the tip of the local branch.
 
846
 
1040
847
        :param source_repo: Source repository to optionally fetch from
1041
848
        :param revno: Revision number of the new tip
1042
849
        :param revid: Revision id of the new tip
1045
852
            self.repository.fetch(source_repo, revision_id=revid)
1046
853
        self.set_last_revision_info(revno, revid)
1047
854
 
1048
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1049
 
                                           lossy=False):
1050
 
        """Set the last revision info, importing from another repo if necessary.
1051
 
 
1052
 
        This is used by the bound branch code to upload a revision to
1053
 
        the master branch first before updating the tip of the local branch.
1054
 
        Revisions referenced by source's tags are also transferred.
1055
 
 
1056
 
        :param source: Source branch to optionally fetch from
1057
 
        :param revno: Revision number of the new tip
1058
 
        :param revid: Revision id of the new tip
1059
 
        :param lossy: Whether to discard metadata that can not be
1060
 
            natively represented
1061
 
        :return: Tuple with the new revision number and revision id
1062
 
            (should only be different from the arguments when lossy=True)
1063
 
        """
1064
 
        if not self.repository.has_same_location(source.repository):
1065
 
            self.fetch(source, revid)
1066
 
        self.set_last_revision_info(revno, revid)
1067
 
        return (revno, revid)
1068
 
 
1069
855
    def revision_id_to_revno(self, revision_id):
1070
856
        """Given a revision id, return its revno"""
1071
857
        if _mod_revision.is_null(revision_id):
1091
877
            self._extend_partial_history(distance_from_last)
1092
878
        return self._partial_revision_history_cache[distance_from_last]
1093
879
 
 
880
    @needs_write_lock
1094
881
    def pull(self, source, overwrite=False, stop_revision=None,
1095
882
             possible_transports=None, *args, **kwargs):
1096
883
        """Mirror source into this branch.
1103
890
            stop_revision=stop_revision,
1104
891
            possible_transports=possible_transports, *args, **kwargs)
1105
892
 
1106
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1107
 
            *args, **kwargs):
 
893
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
894
        **kwargs):
1108
895
        """Mirror this branch into target.
1109
896
 
1110
897
        This branch is considered to be 'local', having low latency.
1111
898
        """
1112
899
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1113
 
            lossy, *args, **kwargs)
 
900
            *args, **kwargs)
 
901
 
 
902
    def lossy_push(self, target, stop_revision=None):
 
903
        """Push deltas into another branch.
 
904
 
 
905
        :note: This does not, like push, retain the revision ids from 
 
906
            the source branch and will, rather than adding bzr-specific 
 
907
            metadata, push only those semantics of the revision that can be 
 
908
            natively represented by this branch' VCS.
 
909
 
 
910
        :param target: Target branch
 
911
        :param stop_revision: Revision to push, defaults to last revision.
 
912
        :return: BranchPushResult with an extra member revidmap: 
 
913
            A dictionary mapping revision ids from the target branch 
 
914
            to new revision ids in the target branch, for each 
 
915
            revision that was pushed.
 
916
        """
 
917
        inter = InterBranch.get(self, target)
 
918
        lossy_push = getattr(inter, "lossy_push", None)
 
919
        if lossy_push is None:
 
920
            raise errors.LossyPushToSameVCS(self, target)
 
921
        return lossy_push(stop_revision)
1114
922
 
1115
923
    def basis_tree(self):
1116
924
        """Return `Tree` object for last revision."""
1133
941
        try:
1134
942
            return urlutils.join(self.base[:-1], parent)
1135
943
        except errors.InvalidURLJoin, e:
1136
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
944
            raise errors.InaccessibleParent(parent, self.base)
1137
945
 
1138
946
    def _get_parent_location(self):
1139
947
        raise NotImplementedError(self._get_parent_location)
1224
1032
        params = ChangeBranchTipParams(
1225
1033
            self, old_revno, new_revno, old_revid, new_revid)
1226
1034
        for hook in hooks:
1227
 
            hook(params)
 
1035
            try:
 
1036
                hook(params)
 
1037
            except errors.TipChangeRejected:
 
1038
                raise
 
1039
            except Exception:
 
1040
                exc_info = sys.exc_info()
 
1041
                hook_name = Branch.hooks.get_hook_name(hook)
 
1042
                raise errors.HookFailed(
 
1043
                    'pre_change_branch_tip', hook_name, exc_info)
1228
1044
 
1229
1045
    @needs_write_lock
1230
1046
    def update(self):
1271
1087
        return result
1272
1088
 
1273
1089
    @needs_read_lock
1274
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1275
 
            repository=None):
 
1090
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1276
1091
        """Create a new line of development from the branch, into to_bzrdir.
1277
1092
 
1278
1093
        to_bzrdir controls the branch format.
1280
1095
        revision_id: if not None, the revision history in the new branch will
1281
1096
                     be truncated to end with revision_id.
1282
1097
        """
1283
 
        if (repository_policy is not None and
1284
 
            repository_policy.requires_stacking()):
1285
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1286
 
        result = to_bzrdir.create_branch(repository=repository)
 
1098
        result = to_bzrdir.create_branch()
1287
1099
        result.lock_write()
1288
1100
        try:
1289
1101
            if repository_policy is not None:
1290
1102
                repository_policy.configure_branch(result)
1291
1103
            self.copy_content_into(result, revision_id=revision_id)
1292
 
            master_url = self.get_bound_location()
1293
 
            if master_url is None:
1294
 
                result.set_parent(self.bzrdir.root_transport.base)
1295
 
            else:
1296
 
                result.set_parent(master_url)
 
1104
            result.set_parent(self.bzrdir.root_transport.base)
1297
1105
        finally:
1298
1106
            result.unlock()
1299
1107
        return result
1323
1131
                revno = 1
1324
1132
        destination.set_last_revision_info(revno, revision_id)
1325
1133
 
 
1134
    @needs_read_lock
1326
1135
    def copy_content_into(self, destination, revision_id=None):
1327
1136
        """Copy the content of self into destination.
1328
1137
 
1329
1138
        revision_id: if not None, the revision history in the new branch will
1330
1139
                     be truncated to end with revision_id.
1331
1140
        """
1332
 
        return InterBranch.get(self, destination).copy_content_into(
1333
 
            revision_id=revision_id)
 
1141
        self.update_references(destination)
 
1142
        self._synchronize_history(destination, revision_id)
 
1143
        try:
 
1144
            parent = self.get_parent()
 
1145
        except errors.InaccessibleParent, e:
 
1146
            mutter('parent was not accessible to copy: %s', e)
 
1147
        else:
 
1148
            if parent:
 
1149
                destination.set_parent(parent)
 
1150
        if self._push_should_merge_tags():
 
1151
            self.tags.merge_to(destination.tags)
1334
1152
 
1335
1153
    def update_references(self, target):
1336
1154
        if not getattr(self._format, 'supports_reference_locations', False):
1350
1168
        target._set_all_reference_info(target_reference_dict)
1351
1169
 
1352
1170
    @needs_read_lock
1353
 
    def check(self, refs):
 
1171
    def check(self):
1354
1172
        """Check consistency of the branch.
1355
1173
 
1356
1174
        In particular this checks that revisions given in the revision-history
1359
1177
 
1360
1178
        Callers will typically also want to check the repository.
1361
1179
 
1362
 
        :param refs: Calculated refs for this branch as specified by
1363
 
            branch._get_check_refs()
1364
1180
        :return: A BranchCheckResult.
1365
1181
        """
1366
 
        result = BranchCheckResult(self)
 
1182
        ret = BranchCheckResult(self)
 
1183
        mainline_parent_id = None
1367
1184
        last_revno, last_revision_id = self.last_revision_info()
1368
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1369
 
        if actual_revno != last_revno:
1370
 
            result.errors.append(errors.BzrCheckError(
1371
 
                'revno does not match len(mainline) %s != %s' % (
1372
 
                last_revno, actual_revno)))
1373
 
        # TODO: We should probably also check that self.revision_history
1374
 
        # matches the repository for older branch formats.
1375
 
        # If looking for the code that cross-checks repository parents against
1376
 
        # the iter_reverse_revision_history output, that is now a repository
1377
 
        # specific check.
1378
 
        return result
 
1185
        real_rev_history = []
 
1186
        try:
 
1187
            for revid in self.repository.iter_reverse_revision_history(
 
1188
                last_revision_id):
 
1189
                real_rev_history.append(revid)
 
1190
        except errors.RevisionNotPresent:
 
1191
            ret.ghosts_in_mainline = True
 
1192
        else:
 
1193
            ret.ghosts_in_mainline = False
 
1194
        real_rev_history.reverse()
 
1195
        if len(real_rev_history) != last_revno:
 
1196
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1197
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1198
        # TODO: We should probably also check that real_rev_history actually
 
1199
        #       matches self.revision_history()
 
1200
        for revision_id in real_rev_history:
 
1201
            try:
 
1202
                revision = self.repository.get_revision(revision_id)
 
1203
            except errors.NoSuchRevision, e:
 
1204
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1205
                            % revision_id)
 
1206
            # In general the first entry on the revision history has no parents.
 
1207
            # But it's not illegal for it to have parents listed; this can happen
 
1208
            # in imports from Arch when the parents weren't reachable.
 
1209
            if mainline_parent_id is not None:
 
1210
                if mainline_parent_id not in revision.parent_ids:
 
1211
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1212
                                        "parents of {%s}"
 
1213
                                        % (mainline_parent_id, revision_id))
 
1214
            mainline_parent_id = revision_id
 
1215
        return ret
1379
1216
 
1380
1217
    def _get_checkout_format(self):
1381
1218
        """Return the most suitable metadir for a checkout of this branch.
1382
1219
        Weaves are used if this branch's repository uses weaves.
1383
1220
        """
1384
 
        format = self.repository.bzrdir.checkout_metadir()
1385
 
        format.set_branch_format(self._format)
 
1221
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1222
            from bzrlib.repofmt import weaverepo
 
1223
            format = bzrdir.BzrDirMetaFormat1()
 
1224
            format.repository_format = weaverepo.RepositoryFormat7()
 
1225
        else:
 
1226
            format = self.repository.bzrdir.checkout_metadir()
 
1227
            format.set_branch_format(self._format)
1386
1228
        return format
1387
1229
 
1388
1230
    def create_clone_on_transport(self, to_transport, revision_id=None,
1389
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1390
 
        no_tree=None):
 
1231
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1391
1232
        """Create a clone of this branch and its bzrdir.
1392
1233
 
1393
1234
        :param to_transport: The transport to clone onto.
1400
1241
        """
1401
1242
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1402
1243
        # clone call. Or something. 20090224 RBC/spiv.
1403
 
        # XXX: Should this perhaps clone colocated branches as well, 
1404
 
        # rather than just the default branch? 20100319 JRV
1405
1244
        if revision_id is None:
1406
1245
            revision_id = self.last_revision()
1407
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1408
 
            revision_id=revision_id, stacked_on=stacked_on,
1409
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1410
 
            no_tree=no_tree)
 
1246
        try:
 
1247
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1248
                revision_id=revision_id, stacked_on=stacked_on,
 
1249
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1250
        except errors.FileExists:
 
1251
            if not use_existing_dir:
 
1252
                raise
 
1253
        except errors.NoSuchFile:
 
1254
            if not create_prefix:
 
1255
                raise
1411
1256
        return dir_to.open_branch()
1412
1257
 
1413
1258
    def create_checkout(self, to_location, revision_id=None,
1418
1263
        :param to_location: The url to produce the checkout at
1419
1264
        :param revision_id: The revision to check out
1420
1265
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1421
 
            produce a bound branch (heavyweight checkout)
 
1266
        produce a bound branch (heavyweight checkout)
1422
1267
        :param accelerator_tree: A tree which can be used for retrieving file
1423
1268
            contents more quickly than the revision tree, i.e. a workingtree.
1424
1269
            The revision tree will be used for cases where accelerator_tree's
1432
1277
        if lightweight:
1433
1278
            format = self._get_checkout_format()
1434
1279
            checkout = format.initialize_on_transport(t)
1435
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1436
 
                target_branch=self)
 
1280
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1437
1281
        else:
1438
1282
            format = self._get_checkout_format()
1439
1283
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1470
1314
 
1471
1315
    def reference_parent(self, file_id, path, possible_transports=None):
1472
1316
        """Return the parent branch for a tree-reference file_id
1473
 
 
1474
1317
        :param file_id: The file_id of the tree reference
1475
1318
        :param path: The path of the file_id in the tree
1476
1319
        :return: A branch associated with the file_id
1482
1325
    def supports_tags(self):
1483
1326
        return self._format.supports_tags()
1484
1327
 
1485
 
    def automatic_tag_name(self, revision_id):
1486
 
        """Try to automatically find the tag name for a revision.
1487
 
 
1488
 
        :param revision_id: Revision id of the revision.
1489
 
        :return: A tag name or None if no tag name could be determined.
1490
 
        """
1491
 
        for hook in Branch.hooks['automatic_tag_name']:
1492
 
            ret = hook(self, revision_id)
1493
 
            if ret is not None:
1494
 
                return ret
1495
 
        return None
1496
 
 
1497
1328
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1498
1329
                                         other_branch):
1499
1330
        """Ensure that revision_b is a descendant of revision_a.
1529
1360
        else:
1530
1361
            raise AssertionError("invalid heads: %r" % (heads,))
1531
1362
 
1532
 
    def heads_to_fetch(self):
1533
 
        """Return the heads that must and that should be fetched to copy this
1534
 
        branch into another repo.
1535
 
 
1536
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1537
 
            set of heads that must be fetched.  if_present_fetch is a set of
1538
 
            heads that must be fetched if present, but no error is necessary if
1539
 
            they are not present.
1540
 
        """
1541
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1542
 
        # are the tags.
1543
 
        must_fetch = set([self.last_revision()])
1544
 
        if_present_fetch = set()
1545
 
        c = self.get_config()
1546
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1547
 
                                                 default=False)
1548
 
        if include_tags:
1549
 
            try:
1550
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1551
 
            except errors.TagsNotSupported:
1552
 
                pass
1553
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1554
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1555
 
        return must_fetch, if_present_fetch
1556
 
 
1557
 
 
1558
 
class BranchFormat(controldir.ControlComponentFormat):
 
1363
 
 
1364
class BranchFormat(object):
1559
1365
    """An encapsulation of the initialization and open routines for a format.
1560
1366
 
1561
1367
    Formats provide three things:
1564
1370
     * an open routine.
1565
1371
 
1566
1372
    Formats are placed in an dict by their format string for reference
1567
 
    during branch opening. It's not required that these be instances, they
 
1373
    during branch opening. Its not required that these be instances, they
1568
1374
    can be classes themselves with class methods - it simply depends on
1569
1375
    whether state is needed for a given format or not.
1570
1376
 
1573
1379
    object will be created every time regardless.
1574
1380
    """
1575
1381
 
 
1382
    _default_format = None
 
1383
    """The default format used for new branches."""
 
1384
 
 
1385
    _formats = {}
 
1386
    """The known formats."""
 
1387
 
1576
1388
    can_set_append_revisions_only = True
1577
1389
 
1578
1390
    def __eq__(self, other):
1582
1394
        return not (self == other)
1583
1395
 
1584
1396
    @classmethod
1585
 
    def find_format(klass, a_bzrdir, name=None):
 
1397
    def find_format(klass, a_bzrdir):
1586
1398
        """Return the format for the branch object in a_bzrdir."""
1587
1399
        try:
1588
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1589
 
            format_string = transport.get_bytes("format")
1590
 
            return format_registry.get(format_string)
 
1400
            transport = a_bzrdir.get_branch_transport(None)
 
1401
            format_string = transport.get("format").read()
 
1402
            return klass._formats[format_string]
1591
1403
        except errors.NoSuchFile:
1592
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1404
            raise errors.NotBranchError(path=transport.base)
1593
1405
        except KeyError:
1594
1406
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1595
1407
 
1596
1408
    @classmethod
1597
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1598
1409
    def get_default_format(klass):
1599
1410
        """Return the current default format."""
1600
 
        return format_registry.get_default()
1601
 
 
1602
 
    @classmethod
1603
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1604
 
    def get_formats(klass):
1605
 
        """Get all the known formats.
1606
 
 
1607
 
        Warning: This triggers a load of all lazy registered formats: do not
1608
 
        use except when that is desireed.
1609
 
        """
1610
 
        return format_registry._get_all()
1611
 
 
1612
 
    def get_reference(self, a_bzrdir, name=None):
 
1411
        return klass._default_format
 
1412
 
 
1413
    def get_reference(self, a_bzrdir):
1613
1414
        """Get the target reference of the branch in a_bzrdir.
1614
1415
 
1615
1416
        format probing must have been completed before calling
1617
1418
        in a_bzrdir is correct.
1618
1419
 
1619
1420
        :param a_bzrdir: The bzrdir to get the branch data from.
1620
 
        :param name: Name of the colocated branch to fetch
1621
1421
        :return: None if the branch is not a reference branch.
1622
1422
        """
1623
1423
        return None
1624
1424
 
1625
1425
    @classmethod
1626
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1426
    def set_reference(self, a_bzrdir, to_branch):
1627
1427
        """Set the target reference of the branch in a_bzrdir.
1628
1428
 
1629
1429
        format probing must have been completed before calling
1631
1431
        in a_bzrdir is correct.
1632
1432
 
1633
1433
        :param a_bzrdir: The bzrdir to set the branch reference for.
1634
 
        :param name: Name of colocated branch to set, None for default
1635
1434
        :param to_branch: branch that the checkout is to reference
1636
1435
        """
1637
1436
        raise NotImplementedError(self.set_reference)
1644
1443
        """Return the short format description for this format."""
1645
1444
        raise NotImplementedError(self.get_format_description)
1646
1445
 
1647
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1648
 
        hooks = Branch.hooks['post_branch_init']
1649
 
        if not hooks:
1650
 
            return
1651
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1652
 
        for hook in hooks:
1653
 
            hook(params)
 
1446
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1447
                           set_format=True):
 
1448
        """Initialize a branch in a bzrdir, with specified files
1654
1449
 
1655
 
    def initialize(self, a_bzrdir, name=None, repository=None):
1656
 
        """Create a branch of this format in a_bzrdir.
1657
 
        
1658
 
        :param name: Name of the colocated branch to create.
 
1450
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1451
        :param utf8_files: The files to create as a list of
 
1452
            (filename, content) tuples
 
1453
        :param set_format: If True, set the format with
 
1454
            self.get_format_string.  (BzrBranch4 has its format set
 
1455
            elsewhere)
 
1456
        :return: a branch in this format
1659
1457
        """
 
1458
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1459
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1460
        lock_map = {
 
1461
            'metadir': ('lock', lockdir.LockDir),
 
1462
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1463
        }
 
1464
        lock_name, lock_class = lock_map[lock_type]
 
1465
        control_files = lockable_files.LockableFiles(branch_transport,
 
1466
            lock_name, lock_class)
 
1467
        control_files.create_lock()
 
1468
        try:
 
1469
            control_files.lock_write()
 
1470
        except errors.LockContention:
 
1471
            if lock_type != 'branch4':
 
1472
                raise
 
1473
            lock_taken = False
 
1474
        else:
 
1475
            lock_taken = True
 
1476
        if set_format:
 
1477
            utf8_files += [('format', self.get_format_string())]
 
1478
        try:
 
1479
            for (filename, content) in utf8_files:
 
1480
                branch_transport.put_bytes(
 
1481
                    filename, content,
 
1482
                    mode=a_bzrdir._get_file_mode())
 
1483
        finally:
 
1484
            if lock_taken:
 
1485
                control_files.unlock()
 
1486
        return self.open(a_bzrdir, _found=True)
 
1487
 
 
1488
    def initialize(self, a_bzrdir):
 
1489
        """Create a branch of this format in a_bzrdir."""
1660
1490
        raise NotImplementedError(self.initialize)
1661
1491
 
1662
1492
    def is_supported(self):
1692
1522
        """
1693
1523
        raise NotImplementedError(self.network_name)
1694
1524
 
1695
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1696
 
            found_repository=None):
 
1525
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1697
1526
        """Return the branch object for a_bzrdir
1698
1527
 
1699
1528
        :param a_bzrdir: A BzrDir that contains a branch.
1700
 
        :param name: Name of colocated branch to open
1701
1529
        :param _found: a private parameter, do not use it. It is used to
1702
1530
            indicate if format probing has already be done.
1703
1531
        :param ignore_fallbacks: when set, no fallback branches will be opened
1706
1534
        raise NotImplementedError(self.open)
1707
1535
 
1708
1536
    @classmethod
1709
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1710
1537
    def register_format(klass, format):
1711
 
        """Register a metadir format.
1712
 
 
1713
 
        See MetaDirBranchFormatFactory for the ability to register a format
1714
 
        without loading the code the format needs until it is actually used.
1715
 
        """
1716
 
        format_registry.register(format)
 
1538
        """Register a metadir format."""
 
1539
        klass._formats[format.get_format_string()] = format
 
1540
        # Metadir formats have a network name of their format string, and get
 
1541
        # registered as class factories.
 
1542
        network_format_registry.register(format.get_format_string(), format.__class__)
1717
1543
 
1718
1544
    @classmethod
1719
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1720
1545
    def set_default_format(klass, format):
1721
 
        format_registry.set_default(format)
 
1546
        klass._default_format = format
1722
1547
 
1723
1548
    def supports_set_append_revisions_only(self):
1724
1549
        """True if this format supports set_append_revisions_only."""
1728
1553
        """True if this format records a stacked-on branch."""
1729
1554
        return False
1730
1555
 
1731
 
    def supports_leaving_lock(self):
1732
 
        """True if this format supports leaving locks in place."""
1733
 
        return False # by default
1734
 
 
1735
1556
    @classmethod
1736
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1737
1557
    def unregister_format(klass, format):
1738
 
        format_registry.remove(format)
 
1558
        del klass._formats[format.get_format_string()]
1739
1559
 
1740
1560
    def __str__(self):
1741
1561
        return self.get_format_description().rstrip()
1745
1565
        return False  # by default
1746
1566
 
1747
1567
 
1748
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1749
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1750
 
    
1751
 
    While none of the built in BranchFormats are lazy registered yet,
1752
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1753
 
    use it, and the bzr-loom plugin uses it as well (see
1754
 
    bzrlib.plugins.loom.formats).
1755
 
    """
1756
 
 
1757
 
    def __init__(self, format_string, module_name, member_name):
1758
 
        """Create a MetaDirBranchFormatFactory.
1759
 
 
1760
 
        :param format_string: The format string the format has.
1761
 
        :param module_name: Module to load the format class from.
1762
 
        :param member_name: Attribute name within the module for the format class.
1763
 
        """
1764
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1765
 
        self._format_string = format_string
1766
 
        
1767
 
    def get_format_string(self):
1768
 
        """See BranchFormat.get_format_string."""
1769
 
        return self._format_string
1770
 
 
1771
 
    def __call__(self):
1772
 
        """Used for network_format_registry support."""
1773
 
        return self.get_obj()()
1774
 
 
1775
 
 
1776
1568
class BranchHooks(Hooks):
1777
1569
    """A dictionary mapping hook name to a list of callables for branch hooks.
1778
1570
 
1786
1578
        These are all empty initially, because by default nothing should get
1787
1579
        notified.
1788
1580
        """
1789
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1790
 
        self.add_hook('set_rh',
 
1581
        Hooks.__init__(self)
 
1582
        self.create_hook(HookPoint('set_rh',
1791
1583
            "Invoked whenever the revision history has been set via "
1792
1584
            "set_revision_history. The api signature is (branch, "
1793
1585
            "revision_history), and the branch will be write-locked. "
1794
1586
            "The set_rh hook can be expensive for bzr to trigger, a better "
1795
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1796
 
        self.add_hook('open',
 
1587
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1588
        self.create_hook(HookPoint('open',
1797
1589
            "Called with the Branch object that has been opened after a "
1798
 
            "branch is opened.", (1, 8))
1799
 
        self.add_hook('post_push',
 
1590
            "branch is opened.", (1, 8), None))
 
1591
        self.create_hook(HookPoint('post_push',
1800
1592
            "Called after a push operation completes. post_push is called "
1801
1593
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1802
 
            "bzr client.", (0, 15))
1803
 
        self.add_hook('post_pull',
 
1594
            "bzr client.", (0, 15), None))
 
1595
        self.create_hook(HookPoint('post_pull',
1804
1596
            "Called after a pull operation completes. post_pull is called "
1805
1597
            "with a bzrlib.branch.PullResult object and only runs in the "
1806
 
            "bzr client.", (0, 15))
1807
 
        self.add_hook('pre_commit',
1808
 
            "Called after a commit is calculated but before it is "
 
1598
            "bzr client.", (0, 15), None))
 
1599
        self.create_hook(HookPoint('pre_commit',
 
1600
            "Called after a commit is calculated but before it is is "
1809
1601
            "completed. pre_commit is called with (local, master, old_revno, "
1810
1602
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1811
1603
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1813
1605
            "basis revision. hooks MUST NOT modify this delta. "
1814
1606
            " future_tree is an in-memory tree obtained from "
1815
1607
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1816
 
            "tree.", (0,91))
1817
 
        self.add_hook('post_commit',
 
1608
            "tree.", (0,91), None))
 
1609
        self.create_hook(HookPoint('post_commit',
1818
1610
            "Called in the bzr client after a commit has completed. "
1819
1611
            "post_commit is called with (local, master, old_revno, old_revid, "
1820
1612
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1821
 
            "commit to a branch.", (0, 15))
1822
 
        self.add_hook('post_uncommit',
 
1613
            "commit to a branch.", (0, 15), None))
 
1614
        self.create_hook(HookPoint('post_uncommit',
1823
1615
            "Called in the bzr client after an uncommit completes. "
1824
1616
            "post_uncommit is called with (local, master, old_revno, "
1825
1617
            "old_revid, new_revno, new_revid) where local is the local branch "
1826
1618
            "or None, master is the target branch, and an empty branch "
1827
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1828
 
        self.add_hook('pre_change_branch_tip',
 
1619
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1620
        self.create_hook(HookPoint('pre_change_branch_tip',
1829
1621
            "Called in bzr client and server before a change to the tip of a "
1830
1622
            "branch is made. pre_change_branch_tip is called with a "
1831
1623
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1832
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1833
 
        self.add_hook('post_change_branch_tip',
 
1624
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1625
        self.create_hook(HookPoint('post_change_branch_tip',
1834
1626
            "Called in bzr client and server after a change to the tip of a "
1835
1627
            "branch is made. post_change_branch_tip is called with a "
1836
1628
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1837
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1838
 
        self.add_hook('transform_fallback_location',
 
1629
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1630
        self.create_hook(HookPoint('transform_fallback_location',
1839
1631
            "Called when a stacked branch is activating its fallback "
1840
1632
            "locations. transform_fallback_location is called with (branch, "
1841
1633
            "url), and should return a new url. Returning the same url "
1846
1638
            "fallback locations have not been activated. When there are "
1847
1639
            "multiple hooks installed for transform_fallback_location, "
1848
1640
            "all are called with the url returned from the previous hook."
1849
 
            "The order is however undefined.", (1, 9))
1850
 
        self.add_hook('automatic_tag_name',
1851
 
            "Called to determine an automatic tag name for a revision. "
1852
 
            "automatic_tag_name is called with (branch, revision_id) and "
1853
 
            "should return a tag name or None if no tag name could be "
1854
 
            "determined. The first non-None tag name returned will be used.",
1855
 
            (2, 2))
1856
 
        self.add_hook('post_branch_init',
1857
 
            "Called after new branch initialization completes. "
1858
 
            "post_branch_init is called with a "
1859
 
            "bzrlib.branch.BranchInitHookParams. "
1860
 
            "Note that init, branch and checkout (both heavyweight and "
1861
 
            "lightweight) will all trigger this hook.", (2, 2))
1862
 
        self.add_hook('post_switch',
1863
 
            "Called after a checkout switches branch. "
1864
 
            "post_switch is called with a "
1865
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1866
 
 
 
1641
            "The order is however undefined.", (1, 9), None))
1867
1642
 
1868
1643
 
1869
1644
# install the default hooks into the Branch class.
1871
1646
 
1872
1647
 
1873
1648
class ChangeBranchTipParams(object):
1874
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1649
    """Object holding parameters passed to *_change_branch_tip hooks.
1875
1650
 
1876
1651
    There are 5 fields that hooks may wish to access:
1877
1652
 
1908
1683
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1909
1684
 
1910
1685
 
1911
 
class BranchInitHookParams(object):
1912
 
    """Object holding parameters passed to `*_branch_init` hooks.
1913
 
 
1914
 
    There are 4 fields that hooks may wish to access:
1915
 
 
1916
 
    :ivar format: the branch format
1917
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1918
 
    :ivar name: name of colocated branch, if any (or None)
1919
 
    :ivar branch: the branch created
1920
 
 
1921
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1922
 
    the checkout, hence they are different from the corresponding fields in
1923
 
    branch, which refer to the original branch.
1924
 
    """
1925
 
 
1926
 
    def __init__(self, format, a_bzrdir, name, branch):
1927
 
        """Create a group of BranchInitHook parameters.
1928
 
 
1929
 
        :param format: the branch format
1930
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1931
 
            initialized
1932
 
        :param name: name of colocated branch, if any (or None)
1933
 
        :param branch: the branch created
1934
 
 
1935
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1936
 
        to the checkout, hence they are different from the corresponding fields
1937
 
        in branch, which refer to the original branch.
1938
 
        """
1939
 
        self.format = format
1940
 
        self.bzrdir = a_bzrdir
1941
 
        self.name = name
1942
 
        self.branch = branch
1943
 
 
1944
 
    def __eq__(self, other):
1945
 
        return self.__dict__ == other.__dict__
1946
 
 
1947
 
    def __repr__(self):
1948
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1949
 
 
1950
 
 
1951
 
class SwitchHookParams(object):
1952
 
    """Object holding parameters passed to `*_switch` hooks.
1953
 
 
1954
 
    There are 4 fields that hooks may wish to access:
1955
 
 
1956
 
    :ivar control_dir: BzrDir of the checkout to change
1957
 
    :ivar to_branch: branch that the checkout is to reference
1958
 
    :ivar force: skip the check for local commits in a heavy checkout
1959
 
    :ivar revision_id: revision ID to switch to (or None)
1960
 
    """
1961
 
 
1962
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1963
 
        """Create a group of SwitchHook parameters.
1964
 
 
1965
 
        :param control_dir: BzrDir of the checkout to change
1966
 
        :param to_branch: branch that the checkout is to reference
1967
 
        :param force: skip the check for local commits in a heavy checkout
1968
 
        :param revision_id: revision ID to switch to (or None)
1969
 
        """
1970
 
        self.control_dir = control_dir
1971
 
        self.to_branch = to_branch
1972
 
        self.force = force
1973
 
        self.revision_id = revision_id
1974
 
 
1975
 
    def __eq__(self, other):
1976
 
        return self.__dict__ == other.__dict__
1977
 
 
1978
 
    def __repr__(self):
1979
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1980
 
            self.control_dir, self.to_branch,
1981
 
            self.revision_id)
 
1686
class BzrBranchFormat4(BranchFormat):
 
1687
    """Bzr branch format 4.
 
1688
 
 
1689
    This format has:
 
1690
     - a revision-history file.
 
1691
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1692
    """
 
1693
 
 
1694
    def get_format_description(self):
 
1695
        """See BranchFormat.get_format_description()."""
 
1696
        return "Branch format 4"
 
1697
 
 
1698
    def initialize(self, a_bzrdir):
 
1699
        """Create a branch of this format in a_bzrdir."""
 
1700
        utf8_files = [('revision-history', ''),
 
1701
                      ('branch-name', ''),
 
1702
                      ]
 
1703
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1704
                                       lock_type='branch4', set_format=False)
 
1705
 
 
1706
    def __init__(self):
 
1707
        super(BzrBranchFormat4, self).__init__()
 
1708
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1709
 
 
1710
    def network_name(self):
 
1711
        """The network name for this format is the control dirs disk label."""
 
1712
        return self._matchingbzrdir.get_format_string()
 
1713
 
 
1714
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1715
        """See BranchFormat.open()."""
 
1716
        if not _found:
 
1717
            # we are being called directly and must probe.
 
1718
            raise NotImplementedError
 
1719
        return BzrBranch(_format=self,
 
1720
                         _control_files=a_bzrdir._control_files,
 
1721
                         a_bzrdir=a_bzrdir,
 
1722
                         _repository=a_bzrdir.open_repository())
 
1723
 
 
1724
    def __str__(self):
 
1725
        return "Bazaar-NG branch format 4"
1982
1726
 
1983
1727
 
1984
1728
class BranchFormatMetadir(BranchFormat):
1988
1732
        """What class to instantiate on open calls."""
1989
1733
        raise NotImplementedError(self._branch_class)
1990
1734
 
1991
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1992
 
                           repository=None):
1993
 
        """Initialize a branch in a bzrdir, with specified files
1994
 
 
1995
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1996
 
        :param utf8_files: The files to create as a list of
1997
 
            (filename, content) tuples
1998
 
        :param name: Name of colocated branch to create, if any
1999
 
        :return: a branch in this format
2000
 
        """
2001
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2002
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2003
 
        control_files = lockable_files.LockableFiles(branch_transport,
2004
 
            'lock', lockdir.LockDir)
2005
 
        control_files.create_lock()
2006
 
        control_files.lock_write()
2007
 
        try:
2008
 
            utf8_files += [('format', self.get_format_string())]
2009
 
            for (filename, content) in utf8_files:
2010
 
                branch_transport.put_bytes(
2011
 
                    filename, content,
2012
 
                    mode=a_bzrdir._get_file_mode())
2013
 
        finally:
2014
 
            control_files.unlock()
2015
 
        branch = self.open(a_bzrdir, name, _found=True,
2016
 
                found_repository=repository)
2017
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2018
 
        return branch
2019
 
 
2020
1735
    def network_name(self):
2021
1736
        """A simple byte string uniquely identifying this format for RPC calls.
2022
1737
 
2024
1739
        """
2025
1740
        return self.get_format_string()
2026
1741
 
2027
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2028
 
            found_repository=None):
 
1742
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2029
1743
        """See BranchFormat.open()."""
2030
1744
        if not _found:
2031
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1745
            format = BranchFormat.find_format(a_bzrdir)
2032
1746
            if format.__class__ != self.__class__:
2033
1747
                raise AssertionError("wrong format %r found for %r" %
2034
1748
                    (format, self))
2035
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2036
1749
        try:
 
1750
            transport = a_bzrdir.get_branch_transport(None)
2037
1751
            control_files = lockable_files.LockableFiles(transport, 'lock',
2038
1752
                                                         lockdir.LockDir)
2039
 
            if found_repository is None:
2040
 
                found_repository = a_bzrdir.find_repository()
2041
1753
            return self._branch_class()(_format=self,
2042
1754
                              _control_files=control_files,
2043
 
                              name=name,
2044
1755
                              a_bzrdir=a_bzrdir,
2045
 
                              _repository=found_repository,
 
1756
                              _repository=a_bzrdir.find_repository(),
2046
1757
                              ignore_fallbacks=ignore_fallbacks)
2047
1758
        except errors.NoSuchFile:
2048
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1759
            raise errors.NotBranchError(path=transport.base)
2049
1760
 
2050
1761
    def __init__(self):
2051
1762
        super(BranchFormatMetadir, self).__init__()
2055
1766
    def supports_tags(self):
2056
1767
        return True
2057
1768
 
2058
 
    def supports_leaving_lock(self):
2059
 
        return True
2060
 
 
2061
1769
 
2062
1770
class BzrBranchFormat5(BranchFormatMetadir):
2063
1771
    """Bzr branch format 5.
2083
1791
        """See BranchFormat.get_format_description()."""
2084
1792
        return "Branch format 5"
2085
1793
 
2086
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1794
    def initialize(self, a_bzrdir):
2087
1795
        """Create a branch of this format in a_bzrdir."""
2088
1796
        utf8_files = [('revision-history', ''),
2089
1797
                      ('branch-name', ''),
2090
1798
                      ]
2091
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1799
        return self._initialize_helper(a_bzrdir, utf8_files)
2092
1800
 
2093
1801
    def supports_tags(self):
2094
1802
        return False
2116
1824
        """See BranchFormat.get_format_description()."""
2117
1825
        return "Branch format 6"
2118
1826
 
2119
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1827
    def initialize(self, a_bzrdir):
2120
1828
        """Create a branch of this format in a_bzrdir."""
2121
1829
        utf8_files = [('last-revision', '0 null:\n'),
2122
1830
                      ('branch.conf', ''),
2123
1831
                      ('tags', ''),
2124
1832
                      ]
2125
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1833
        return self._initialize_helper(a_bzrdir, utf8_files)
2126
1834
 
2127
1835
    def make_tags(self, branch):
2128
1836
        """See bzrlib.branch.BranchFormat.make_tags()."""
2146
1854
        """See BranchFormat.get_format_description()."""
2147
1855
        return "Branch format 8"
2148
1856
 
2149
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1857
    def initialize(self, a_bzrdir):
2150
1858
        """Create a branch of this format in a_bzrdir."""
2151
1859
        utf8_files = [('last-revision', '0 null:\n'),
2152
1860
                      ('branch.conf', ''),
2153
1861
                      ('tags', ''),
2154
1862
                      ('references', '')
2155
1863
                      ]
2156
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1864
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1865
 
 
1866
    def __init__(self):
 
1867
        super(BzrBranchFormat8, self).__init__()
 
1868
        self._matchingbzrdir.repository_format = \
 
1869
            RepositoryFormatKnitPack5RichRoot()
2157
1870
 
2158
1871
    def make_tags(self, branch):
2159
1872
        """See bzrlib.branch.BranchFormat.make_tags()."""
2168
1881
    supports_reference_locations = True
2169
1882
 
2170
1883
 
2171
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1884
class BzrBranchFormat7(BzrBranchFormat8):
2172
1885
    """Branch format with last-revision, tags, and a stacked location pointer.
2173
1886
 
2174
1887
    The stacked location pointer is passed down to the repository and requires
2177
1890
    This format was introduced in bzr 1.6.
2178
1891
    """
2179
1892
 
2180
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1893
    def initialize(self, a_bzrdir):
2181
1894
        """Create a branch of this format in a_bzrdir."""
2182
1895
        utf8_files = [('last-revision', '0 null:\n'),
2183
1896
                      ('branch.conf', ''),
2184
1897
                      ('tags', ''),
2185
1898
                      ]
2186
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1899
        return self._initialize_helper(a_bzrdir, utf8_files)
2187
1900
 
2188
1901
    def _branch_class(self):
2189
1902
        return BzrBranch7
2199
1912
    def supports_set_append_revisions_only(self):
2200
1913
        return True
2201
1914
 
2202
 
    def supports_stacking(self):
2203
 
        return True
2204
 
 
2205
 
    def make_tags(self, branch):
2206
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2207
 
        return BasicTags(branch)
2208
 
 
2209
1915
    supports_reference_locations = False
2210
1916
 
2211
1917
 
2228
1934
        """See BranchFormat.get_format_description()."""
2229
1935
        return "Checkout reference format 1"
2230
1936
 
2231
 
    def get_reference(self, a_bzrdir, name=None):
 
1937
    def get_reference(self, a_bzrdir):
2232
1938
        """See BranchFormat.get_reference()."""
2233
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2234
 
        return transport.get_bytes('location')
 
1939
        transport = a_bzrdir.get_branch_transport(None)
 
1940
        return transport.get('location').read()
2235
1941
 
2236
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1942
    def set_reference(self, a_bzrdir, to_branch):
2237
1943
        """See BranchFormat.set_reference()."""
2238
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1944
        transport = a_bzrdir.get_branch_transport(None)
2239
1945
        location = transport.put_bytes('location', to_branch.base)
2240
1946
 
2241
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2242
 
            repository=None):
 
1947
    def initialize(self, a_bzrdir, target_branch=None):
2243
1948
        """Create a branch of this format in a_bzrdir."""
2244
1949
        if target_branch is None:
2245
1950
            # this format does not implement branch itself, thus the implicit
2246
1951
            # creation contract must see it as uninitializable
2247
1952
            raise errors.UninitializableFormat(self)
2248
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2249
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1953
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1954
        branch_transport = a_bzrdir.get_branch_transport(self)
2250
1955
        branch_transport.put_bytes('location',
2251
 
            target_branch.bzrdir.user_url)
 
1956
            target_branch.bzrdir.root_transport.base)
2252
1957
        branch_transport.put_bytes('format', self.get_format_string())
2253
 
        branch = self.open(
2254
 
            a_bzrdir, name, _found=True,
 
1958
        return self.open(
 
1959
            a_bzrdir, _found=True,
2255
1960
            possible_transports=[target_branch.bzrdir.root_transport])
2256
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2257
 
        return branch
2258
1961
 
2259
1962
    def __init__(self):
2260
1963
        super(BranchReferenceFormat, self).__init__()
2266
1969
        def clone(to_bzrdir, revision_id=None,
2267
1970
            repository_policy=None):
2268
1971
            """See Branch.clone()."""
2269
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1972
            return format.initialize(to_bzrdir, a_branch)
2270
1973
            # cannot obey revision_id limits when cloning a reference ...
2271
1974
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2272
1975
            # emit some sort of warning/error to the caller ?!
2273
1976
        return clone
2274
1977
 
2275
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2276
 
             possible_transports=None, ignore_fallbacks=False,
2277
 
             found_repository=None):
 
1978
    def open(self, a_bzrdir, _found=False, location=None,
 
1979
             possible_transports=None, ignore_fallbacks=False):
2278
1980
        """Return the branch that the branch reference in a_bzrdir points at.
2279
1981
 
2280
1982
        :param a_bzrdir: A BzrDir that contains a branch.
2281
 
        :param name: Name of colocated branch to open, if any
2282
1983
        :param _found: a private parameter, do not use it. It is used to
2283
1984
            indicate if format probing has already be done.
2284
1985
        :param ignore_fallbacks: when set, no fallback branches will be opened
2289
1990
        :param possible_transports: An optional reusable transports list.
2290
1991
        """
2291
1992
        if not _found:
2292
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1993
            format = BranchFormat.find_format(a_bzrdir)
2293
1994
            if format.__class__ != self.__class__:
2294
1995
                raise AssertionError("wrong format %r found for %r" %
2295
1996
                    (format, self))
2296
1997
        if location is None:
2297
 
            location = self.get_reference(a_bzrdir, name)
 
1998
            location = self.get_reference(a_bzrdir)
2298
1999
        real_bzrdir = bzrdir.BzrDir.open(
2299
2000
            location, possible_transports=possible_transports)
2300
 
        result = real_bzrdir.open_branch(name=name, 
2301
 
            ignore_fallbacks=ignore_fallbacks)
 
2001
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2302
2002
        # this changes the behaviour of result.clone to create a new reference
2303
2003
        # rather than a copy of the content of the branch.
2304
2004
        # I did not use a proxy object because that needs much more extensive
2311
2011
        return result
2312
2012
 
2313
2013
 
2314
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2315
 
    """Branch format registry."""
2316
 
 
2317
 
    def __init__(self, other_registry=None):
2318
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2319
 
        self._default_format = None
2320
 
 
2321
 
    def set_default(self, format):
2322
 
        self._default_format = format
2323
 
 
2324
 
    def get_default(self):
2325
 
        return self._default_format
2326
 
 
2327
 
 
2328
2014
network_format_registry = registry.FormatRegistry()
2329
2015
"""Registry of formats indexed by their network name.
2330
2016
 
2333
2019
BranchFormat.network_name() for more detail.
2334
2020
"""
2335
2021
 
2336
 
format_registry = BranchFormatRegistry(network_format_registry)
2337
 
 
2338
2022
 
2339
2023
# formats which have no format string are not discoverable
2340
2024
# and not independently creatable, so are not registered.
2342
2026
__format6 = BzrBranchFormat6()
2343
2027
__format7 = BzrBranchFormat7()
2344
2028
__format8 = BzrBranchFormat8()
2345
 
format_registry.register(__format5)
2346
 
format_registry.register(BranchReferenceFormat())
2347
 
format_registry.register(__format6)
2348
 
format_registry.register(__format7)
2349
 
format_registry.register(__format8)
2350
 
format_registry.set_default(__format7)
2351
 
 
2352
 
 
2353
 
class BranchWriteLockResult(LogicalLockResult):
2354
 
    """The result of write locking a branch.
2355
 
 
2356
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2357
 
        None.
2358
 
    :ivar unlock: A callable which will unlock the lock.
2359
 
    """
2360
 
 
2361
 
    def __init__(self, unlock, branch_token):
2362
 
        LogicalLockResult.__init__(self, unlock)
2363
 
        self.branch_token = branch_token
2364
 
 
2365
 
    def __repr__(self):
2366
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2367
 
            self.unlock)
2368
 
 
2369
 
 
2370
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2029
BranchFormat.register_format(__format5)
 
2030
BranchFormat.register_format(BranchReferenceFormat())
 
2031
BranchFormat.register_format(__format6)
 
2032
BranchFormat.register_format(__format7)
 
2033
BranchFormat.register_format(__format8)
 
2034
BranchFormat.set_default_format(__format6)
 
2035
_legacy_formats = [BzrBranchFormat4(),
 
2036
    ]
 
2037
network_format_registry.register(
 
2038
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2039
 
 
2040
 
 
2041
class BzrBranch(Branch):
2371
2042
    """A branch stored in the actual filesystem.
2372
2043
 
2373
2044
    Note that it's "local" in the context of the filesystem; it doesn't
2379
2050
    :ivar repository: Repository for this branch.
2380
2051
    :ivar base: The url of the base directory for this branch; the one
2381
2052
        containing the .bzr directory.
2382
 
    :ivar name: Optional colocated branch name as it exists in the control
2383
 
        directory.
2384
2053
    """
2385
2054
 
2386
2055
    def __init__(self, _format=None,
2387
 
                 _control_files=None, a_bzrdir=None, name=None,
2388
 
                 _repository=None, ignore_fallbacks=False):
 
2056
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2057
                 ignore_fallbacks=False):
2389
2058
        """Create new branch object at a particular location."""
2390
2059
        if a_bzrdir is None:
2391
2060
            raise ValueError('a_bzrdir must be supplied')
2392
2061
        else:
2393
2062
            self.bzrdir = a_bzrdir
2394
2063
        self._base = self.bzrdir.transport.clone('..').base
2395
 
        self.name = name
2396
2064
        # XXX: We should be able to just do
2397
2065
        #   self.base = self.bzrdir.root_transport.base
2398
2066
        # but this does not quite work yet -- mbp 20080522
2405
2073
        Branch.__init__(self)
2406
2074
 
2407
2075
    def __str__(self):
2408
 
        if self.name is None:
2409
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2410
 
        else:
2411
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2412
 
                self.name)
 
2076
        return '%s(%r)' % (self.__class__.__name__, self.base)
2413
2077
 
2414
2078
    __repr__ = __str__
2415
2079
 
2426
2090
        return self.control_files.is_locked()
2427
2091
 
2428
2092
    def lock_write(self, token=None):
2429
 
        """Lock the branch for write operations.
2430
 
 
2431
 
        :param token: A token to permit reacquiring a previously held and
2432
 
            preserved lock.
2433
 
        :return: A BranchWriteLockResult.
2434
 
        """
2435
 
        if not self.is_locked():
2436
 
            self._note_lock('w')
2437
2093
        # All-in-one needs to always unlock/lock.
2438
2094
        repo_control = getattr(self.repository, 'control_files', None)
2439
2095
        if self.control_files == repo_control or not self.is_locked():
2440
 
            self.repository._warn_if_deprecated(self)
2441
2096
            self.repository.lock_write()
2442
2097
            took_lock = True
2443
2098
        else:
2444
2099
            took_lock = False
2445
2100
        try:
2446
 
            return BranchWriteLockResult(self.unlock,
2447
 
                self.control_files.lock_write(token=token))
 
2101
            return self.control_files.lock_write(token=token)
2448
2102
        except:
2449
2103
            if took_lock:
2450
2104
                self.repository.unlock()
2451
2105
            raise
2452
2106
 
2453
2107
    def lock_read(self):
2454
 
        """Lock the branch for read operations.
2455
 
 
2456
 
        :return: A bzrlib.lock.LogicalLockResult.
2457
 
        """
2458
 
        if not self.is_locked():
2459
 
            self._note_lock('r')
2460
2108
        # All-in-one needs to always unlock/lock.
2461
2109
        repo_control = getattr(self.repository, 'control_files', None)
2462
2110
        if self.control_files == repo_control or not self.is_locked():
2463
 
            self.repository._warn_if_deprecated(self)
2464
2111
            self.repository.lock_read()
2465
2112
            took_lock = True
2466
2113
        else:
2467
2114
            took_lock = False
2468
2115
        try:
2469
2116
            self.control_files.lock_read()
2470
 
            return LogicalLockResult(self.unlock)
2471
2117
        except:
2472
2118
            if took_lock:
2473
2119
                self.repository.unlock()
2474
2120
            raise
2475
2121
 
2476
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2477
2122
    def unlock(self):
2478
2123
        try:
2479
2124
            self.control_files.unlock()
2501
2146
        """See Branch.print_file."""
2502
2147
        return self.repository.print_file(file, revision_id)
2503
2148
 
 
2149
    def _write_revision_history(self, history):
 
2150
        """Factored out of set_revision_history.
 
2151
 
 
2152
        This performs the actual writing to disk.
 
2153
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2154
        self._transport.put_bytes(
 
2155
            'revision-history', '\n'.join(history),
 
2156
            mode=self.bzrdir._get_file_mode())
 
2157
 
 
2158
    @needs_write_lock
 
2159
    def set_revision_history(self, rev_history):
 
2160
        """See Branch.set_revision_history."""
 
2161
        if 'evil' in debug.debug_flags:
 
2162
            mutter_callsite(3, "set_revision_history scales with history.")
 
2163
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2164
        for rev_id in rev_history:
 
2165
            check_not_reserved_id(rev_id)
 
2166
        if Branch.hooks['post_change_branch_tip']:
 
2167
            # Don't calculate the last_revision_info() if there are no hooks
 
2168
            # that will use it.
 
2169
            old_revno, old_revid = self.last_revision_info()
 
2170
        if len(rev_history) == 0:
 
2171
            revid = _mod_revision.NULL_REVISION
 
2172
        else:
 
2173
            revid = rev_history[-1]
 
2174
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2175
        self._write_revision_history(rev_history)
 
2176
        self._clear_cached_state()
 
2177
        self._cache_revision_history(rev_history)
 
2178
        for hook in Branch.hooks['set_rh']:
 
2179
            hook(self, rev_history)
 
2180
        if Branch.hooks['post_change_branch_tip']:
 
2181
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2182
 
 
2183
    def _synchronize_history(self, destination, revision_id):
 
2184
        """Synchronize last revision and revision history between branches.
 
2185
 
 
2186
        This version is most efficient when the destination is also a
 
2187
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2188
        history is the true lefthand parent history, and all of the revisions
 
2189
        are in the destination's repository.  If not, set_revision_history
 
2190
        will fail.
 
2191
 
 
2192
        :param destination: The branch to copy the history into
 
2193
        :param revision_id: The revision-id to truncate history at.  May
 
2194
          be None to copy complete history.
 
2195
        """
 
2196
        if not isinstance(destination._format, BzrBranchFormat5):
 
2197
            super(BzrBranch, self)._synchronize_history(
 
2198
                destination, revision_id)
 
2199
            return
 
2200
        if revision_id == _mod_revision.NULL_REVISION:
 
2201
            new_history = []
 
2202
        else:
 
2203
            new_history = self.revision_history()
 
2204
        if revision_id is not None and new_history != []:
 
2205
            try:
 
2206
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2207
            except ValueError:
 
2208
                rev = self.repository.get_revision(revision_id)
 
2209
                new_history = rev.get_history(self.repository)[1:]
 
2210
        destination.set_revision_history(new_history)
 
2211
 
2504
2212
    @needs_write_lock
2505
2213
    def set_last_revision_info(self, revno, revision_id):
2506
 
        if not revision_id or not isinstance(revision_id, basestring):
2507
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2214
        """Set the last revision of this branch.
 
2215
 
 
2216
        The caller is responsible for checking that the revno is correct
 
2217
        for this revision id.
 
2218
 
 
2219
        It may be possible to set the branch last revision to an id not
 
2220
        present in the repository.  However, branches can also be
 
2221
        configured to check constraints on history, in which case this may not
 
2222
        be permitted.
 
2223
        """
2508
2224
        revision_id = _mod_revision.ensure_null(revision_id)
2509
 
        old_revno, old_revid = self.last_revision_info()
2510
 
        if self._get_append_revisions_only():
2511
 
            self._check_history_violation(revision_id)
2512
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2513
 
        self._write_last_revision_info(revno, revision_id)
2514
 
        self._clear_cached_state()
2515
 
        self._last_revision_info_cache = revno, revision_id
2516
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2225
        # this old format stores the full history, but this api doesn't
 
2226
        # provide it, so we must generate, and might as well check it's
 
2227
        # correct
 
2228
        history = self._lefthand_history(revision_id)
 
2229
        if len(history) != revno:
 
2230
            raise AssertionError('%d != %d' % (len(history), revno))
 
2231
        self.set_revision_history(history)
 
2232
 
 
2233
    def _gen_revision_history(self):
 
2234
        history = self._transport.get_bytes('revision-history').split('\n')
 
2235
        if history[-1:] == ['']:
 
2236
            # There shouldn't be a trailing newline, but just in case.
 
2237
            history.pop()
 
2238
        return history
 
2239
 
 
2240
    @needs_write_lock
 
2241
    def generate_revision_history(self, revision_id, last_rev=None,
 
2242
        other_branch=None):
 
2243
        """Create a new revision history that will finish with revision_id.
 
2244
 
 
2245
        :param revision_id: the new tip to use.
 
2246
        :param last_rev: The previous last_revision. If not None, then this
 
2247
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2248
        :param other_branch: The other branch that DivergedBranches should
 
2249
            raise with respect to.
 
2250
        """
 
2251
        self.set_revision_history(self._lefthand_history(revision_id,
 
2252
            last_rev, other_branch))
2517
2253
 
2518
2254
    def basis_tree(self):
2519
2255
        """See Branch.basis_tree."""
2528
2264
                pass
2529
2265
        return None
2530
2266
 
 
2267
    def _basic_push(self, target, overwrite, stop_revision):
 
2268
        """Basic implementation of push without bound branches or hooks.
 
2269
 
 
2270
        Must be called with source read locked and target write locked.
 
2271
        """
 
2272
        result = BranchPushResult()
 
2273
        result.source_branch = self
 
2274
        result.target_branch = target
 
2275
        result.old_revno, result.old_revid = target.last_revision_info()
 
2276
        self.update_references(target)
 
2277
        if result.old_revid != self.last_revision():
 
2278
            # We assume that during 'push' this repository is closer than
 
2279
            # the target.
 
2280
            graph = self.repository.get_graph(target.repository)
 
2281
            target.update_revisions(self, stop_revision,
 
2282
                overwrite=overwrite, graph=graph)
 
2283
        if self._push_should_merge_tags():
 
2284
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2285
                overwrite)
 
2286
        result.new_revno, result.new_revid = target.last_revision_info()
 
2287
        return result
 
2288
 
2531
2289
    def get_stacked_on_url(self):
2532
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2290
        raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2291
 
2534
2292
    def set_push_location(self, location):
2535
2293
        """See Branch.set_push_location."""
2544
2302
            self._transport.put_bytes('parent', url + '\n',
2545
2303
                mode=self.bzrdir._get_file_mode())
2546
2304
 
 
2305
 
 
2306
class BzrBranch5(BzrBranch):
 
2307
    """A format 5 branch. This supports new features over plain branches.
 
2308
 
 
2309
    It has support for a master_branch which is the data for bound branches.
 
2310
    """
 
2311
 
 
2312
    def get_bound_location(self):
 
2313
        try:
 
2314
            return self._transport.get_bytes('bound')[:-1]
 
2315
        except errors.NoSuchFile:
 
2316
            return None
 
2317
 
 
2318
    @needs_read_lock
 
2319
    def get_master_branch(self, possible_transports=None):
 
2320
        """Return the branch we are bound to.
 
2321
 
 
2322
        :return: Either a Branch, or None
 
2323
 
 
2324
        This could memoise the branch, but if thats done
 
2325
        it must be revalidated on each new lock.
 
2326
        So for now we just don't memoise it.
 
2327
        # RBC 20060304 review this decision.
 
2328
        """
 
2329
        bound_loc = self.get_bound_location()
 
2330
        if not bound_loc:
 
2331
            return None
 
2332
        try:
 
2333
            return Branch.open(bound_loc,
 
2334
                               possible_transports=possible_transports)
 
2335
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2336
            raise errors.BoundBranchConnectionFailure(
 
2337
                    self, bound_loc, e)
 
2338
 
2547
2339
    @needs_write_lock
2548
 
    def unbind(self):
2549
 
        """If bound, unbind"""
2550
 
        return self.set_bound_location(None)
 
2340
    def set_bound_location(self, location):
 
2341
        """Set the target where this branch is bound to.
 
2342
 
 
2343
        :param location: URL to the target branch
 
2344
        """
 
2345
        if location:
 
2346
            self._transport.put_bytes('bound', location+'\n',
 
2347
                mode=self.bzrdir._get_file_mode())
 
2348
        else:
 
2349
            try:
 
2350
                self._transport.delete('bound')
 
2351
            except errors.NoSuchFile:
 
2352
                return False
 
2353
            return True
2551
2354
 
2552
2355
    @needs_write_lock
2553
2356
    def bind(self, other):
2575
2378
        # history around
2576
2379
        self.set_bound_location(other.base)
2577
2380
 
2578
 
    def get_bound_location(self):
2579
 
        try:
2580
 
            return self._transport.get_bytes('bound')[:-1]
2581
 
        except errors.NoSuchFile:
2582
 
            return None
2583
 
 
2584
 
    @needs_read_lock
2585
 
    def get_master_branch(self, possible_transports=None):
2586
 
        """Return the branch we are bound to.
2587
 
 
2588
 
        :return: Either a Branch, or None
2589
 
        """
2590
 
        if self._master_branch_cache is None:
2591
 
            self._master_branch_cache = self._get_master_branch(
2592
 
                possible_transports)
2593
 
        return self._master_branch_cache
2594
 
 
2595
 
    def _get_master_branch(self, possible_transports):
2596
 
        bound_loc = self.get_bound_location()
2597
 
        if not bound_loc:
2598
 
            return None
2599
 
        try:
2600
 
            return Branch.open(bound_loc,
2601
 
                               possible_transports=possible_transports)
2602
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2603
 
            raise errors.BoundBranchConnectionFailure(
2604
 
                    self, bound_loc, e)
2605
 
 
2606
2381
    @needs_write_lock
2607
 
    def set_bound_location(self, location):
2608
 
        """Set the target where this branch is bound to.
2609
 
 
2610
 
        :param location: URL to the target branch
2611
 
        """
2612
 
        self._master_branch_cache = None
2613
 
        if location:
2614
 
            self._transport.put_bytes('bound', location+'\n',
2615
 
                mode=self.bzrdir._get_file_mode())
2616
 
        else:
2617
 
            try:
2618
 
                self._transport.delete('bound')
2619
 
            except errors.NoSuchFile:
2620
 
                return False
2621
 
            return True
 
2382
    def unbind(self):
 
2383
        """If bound, unbind"""
 
2384
        return self.set_bound_location(None)
2622
2385
 
2623
2386
    @needs_write_lock
2624
2387
    def update(self, possible_transports=None):
2637
2400
            return old_tip
2638
2401
        return None
2639
2402
 
2640
 
    def _read_last_revision_info(self):
2641
 
        revision_string = self._transport.get_bytes('last-revision')
2642
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2643
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2644
 
        revno = int(revno)
2645
 
        return revno, revision_id
2646
 
 
2647
 
    def _write_last_revision_info(self, revno, revision_id):
2648
 
        """Simply write out the revision id, with no checks.
2649
 
 
2650
 
        Use set_last_revision_info to perform this safely.
2651
 
 
2652
 
        Does not update the revision_history cache.
2653
 
        """
2654
 
        revision_id = _mod_revision.ensure_null(revision_id)
2655
 
        out_string = '%d %s\n' % (revno, revision_id)
2656
 
        self._transport.put_bytes('last-revision', out_string,
2657
 
            mode=self.bzrdir._get_file_mode())
2658
 
 
2659
 
 
2660
 
class FullHistoryBzrBranch(BzrBranch):
2661
 
    """Bzr branch which contains the full revision history."""
2662
 
 
2663
 
    @needs_write_lock
2664
 
    def set_last_revision_info(self, revno, revision_id):
2665
 
        if not revision_id or not isinstance(revision_id, basestring):
2666
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2667
 
        revision_id = _mod_revision.ensure_null(revision_id)
2668
 
        # this old format stores the full history, but this api doesn't
2669
 
        # provide it, so we must generate, and might as well check it's
2670
 
        # correct
2671
 
        history = self._lefthand_history(revision_id)
2672
 
        if len(history) != revno:
2673
 
            raise AssertionError('%d != %d' % (len(history), revno))
2674
 
        self._set_revision_history(history)
2675
 
 
2676
 
    def _read_last_revision_info(self):
2677
 
        rh = self.revision_history()
2678
 
        revno = len(rh)
2679
 
        if revno:
2680
 
            return (revno, rh[-1])
2681
 
        else:
2682
 
            return (0, _mod_revision.NULL_REVISION)
2683
 
 
2684
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2685
 
    @needs_write_lock
2686
 
    def set_revision_history(self, rev_history):
2687
 
        """See Branch.set_revision_history."""
2688
 
        self._set_revision_history(rev_history)
2689
 
 
2690
 
    def _set_revision_history(self, rev_history):
2691
 
        if 'evil' in debug.debug_flags:
2692
 
            mutter_callsite(3, "set_revision_history scales with history.")
2693
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2694
 
        for rev_id in rev_history:
2695
 
            check_not_reserved_id(rev_id)
2696
 
        if Branch.hooks['post_change_branch_tip']:
2697
 
            # Don't calculate the last_revision_info() if there are no hooks
2698
 
            # that will use it.
2699
 
            old_revno, old_revid = self.last_revision_info()
2700
 
        if len(rev_history) == 0:
2701
 
            revid = _mod_revision.NULL_REVISION
2702
 
        else:
2703
 
            revid = rev_history[-1]
2704
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2705
 
        self._write_revision_history(rev_history)
2706
 
        self._clear_cached_state()
2707
 
        self._cache_revision_history(rev_history)
2708
 
        for hook in Branch.hooks['set_rh']:
2709
 
            hook(self, rev_history)
2710
 
        if Branch.hooks['post_change_branch_tip']:
2711
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2712
 
 
2713
 
    def _write_revision_history(self, history):
2714
 
        """Factored out of set_revision_history.
2715
 
 
2716
 
        This performs the actual writing to disk.
2717
 
        It is intended to be called by set_revision_history."""
2718
 
        self._transport.put_bytes(
2719
 
            'revision-history', '\n'.join(history),
2720
 
            mode=self.bzrdir._get_file_mode())
2721
 
 
2722
 
    def _gen_revision_history(self):
2723
 
        history = self._transport.get_bytes('revision-history').split('\n')
2724
 
        if history[-1:] == ['']:
2725
 
            # There shouldn't be a trailing newline, but just in case.
2726
 
            history.pop()
2727
 
        return history
2728
 
 
2729
 
    def _synchronize_history(self, destination, revision_id):
2730
 
        if not isinstance(destination, FullHistoryBzrBranch):
2731
 
            super(BzrBranch, self)._synchronize_history(
2732
 
                destination, revision_id)
2733
 
            return
2734
 
        if revision_id == _mod_revision.NULL_REVISION:
2735
 
            new_history = []
2736
 
        else:
2737
 
            new_history = self.revision_history()
2738
 
        if revision_id is not None and new_history != []:
2739
 
            try:
2740
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2741
 
            except ValueError:
2742
 
                rev = self.repository.get_revision(revision_id)
2743
 
                new_history = rev.get_history(self.repository)[1:]
2744
 
        destination._set_revision_history(new_history)
2745
 
 
2746
 
    @needs_write_lock
2747
 
    def generate_revision_history(self, revision_id, last_rev=None,
2748
 
        other_branch=None):
2749
 
        """Create a new revision history that will finish with revision_id.
2750
 
 
2751
 
        :param revision_id: the new tip to use.
2752
 
        :param last_rev: The previous last_revision. If not None, then this
2753
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2754
 
        :param other_branch: The other branch that DivergedBranches should
2755
 
            raise with respect to.
2756
 
        """
2757
 
        self._set_revision_history(self._lefthand_history(revision_id,
2758
 
            last_rev, other_branch))
2759
 
 
2760
 
 
2761
 
class BzrBranch5(FullHistoryBzrBranch):
2762
 
    """A format 5 branch. This supports new features over plain branches.
2763
 
 
2764
 
    It has support for a master_branch which is the data for bound branches.
2765
 
    """
2766
 
 
2767
 
 
2768
 
class BzrBranch8(BzrBranch):
 
2403
 
 
2404
class BzrBranch8(BzrBranch5):
2769
2405
    """A branch that stores tree-reference locations."""
2770
2406
 
2771
2407
    def _open_hook(self):
2797
2433
        self._last_revision_info_cache = None
2798
2434
        self._reference_info = None
2799
2435
 
 
2436
    def _last_revision_info(self):
 
2437
        revision_string = self._transport.get_bytes('last-revision')
 
2438
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2439
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2440
        revno = int(revno)
 
2441
        return revno, revision_id
 
2442
 
 
2443
    def _write_last_revision_info(self, revno, revision_id):
 
2444
        """Simply write out the revision id, with no checks.
 
2445
 
 
2446
        Use set_last_revision_info to perform this safely.
 
2447
 
 
2448
        Does not update the revision_history cache.
 
2449
        Intended to be called by set_last_revision_info and
 
2450
        _write_revision_history.
 
2451
        """
 
2452
        revision_id = _mod_revision.ensure_null(revision_id)
 
2453
        out_string = '%d %s\n' % (revno, revision_id)
 
2454
        self._transport.put_bytes('last-revision', out_string,
 
2455
            mode=self.bzrdir._get_file_mode())
 
2456
 
 
2457
    @needs_write_lock
 
2458
    def set_last_revision_info(self, revno, revision_id):
 
2459
        revision_id = _mod_revision.ensure_null(revision_id)
 
2460
        old_revno, old_revid = self.last_revision_info()
 
2461
        if self._get_append_revisions_only():
 
2462
            self._check_history_violation(revision_id)
 
2463
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2464
        self._write_last_revision_info(revno, revision_id)
 
2465
        self._clear_cached_state()
 
2466
        self._last_revision_info_cache = revno, revision_id
 
2467
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2468
 
 
2469
    def _synchronize_history(self, destination, revision_id):
 
2470
        """Synchronize last revision and revision history between branches.
 
2471
 
 
2472
        :see: Branch._synchronize_history
 
2473
        """
 
2474
        # XXX: The base Branch has a fast implementation of this method based
 
2475
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2476
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2477
        # but wants the fast implementation, so it calls
 
2478
        # Branch._synchronize_history directly.
 
2479
        Branch._synchronize_history(self, destination, revision_id)
 
2480
 
2800
2481
    def _check_history_violation(self, revision_id):
2801
 
        current_revid = self.last_revision()
2802
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2482
        last_revision = _mod_revision.ensure_null(self.last_revision())
2803
2483
        if _mod_revision.is_null(last_revision):
2804
2484
            return
2805
 
        graph = self.repository.get_graph()
2806
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2807
 
            if lh_ancestor == current_revid:
2808
 
                return
2809
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2485
        if last_revision not in self._lefthand_history(revision_id):
 
2486
            raise errors.AppendRevisionsOnlyViolation(self.base)
2810
2487
 
2811
2488
    def _gen_revision_history(self):
2812
2489
        """Generate the revision history from last revision
2815
2492
        self._extend_partial_history(stop_index=last_revno-1)
2816
2493
        return list(reversed(self._partial_revision_history_cache))
2817
2494
 
 
2495
    def _write_revision_history(self, history):
 
2496
        """Factored out of set_revision_history.
 
2497
 
 
2498
        This performs the actual writing to disk, with format-specific checks.
 
2499
        It is intended to be called by BzrBranch5.set_revision_history.
 
2500
        """
 
2501
        if len(history) == 0:
 
2502
            last_revision = 'null:'
 
2503
        else:
 
2504
            if history != self._lefthand_history(history[-1]):
 
2505
                raise errors.NotLefthandHistory(history)
 
2506
            last_revision = history[-1]
 
2507
        if self._get_append_revisions_only():
 
2508
            self._check_history_violation(last_revision)
 
2509
        self._write_last_revision_info(len(history), last_revision)
 
2510
 
2818
2511
    @needs_write_lock
2819
2512
    def _set_parent_location(self, url):
2820
2513
        """Set the parent branch"""
2896
2589
        if branch_location is None:
2897
2590
            return Branch.reference_parent(self, file_id, path,
2898
2591
                                           possible_transports)
2899
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2592
        branch_location = urlutils.join(self.base, branch_location)
2900
2593
        return Branch.open(branch_location,
2901
2594
                           possible_transports=possible_transports)
2902
2595
 
2906
2599
 
2907
2600
    def set_bound_location(self, location):
2908
2601
        """See Branch.set_push_location."""
2909
 
        self._master_branch_cache = None
2910
2602
        result = None
2911
2603
        config = self.get_config()
2912
2604
        if location is None:
2943
2635
        # you can always ask for the URL; but you might not be able to use it
2944
2636
        # if the repo can't support stacking.
2945
2637
        ## self._check_stackable_repo()
2946
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2947
 
        # waste effort reading the whole stack of config files.
2948
 
        config = self.get_config()._get_branch_data_config()
2949
 
        stacked_url = self._get_config_location('stacked_on_location',
2950
 
            config=config)
 
2638
        stacked_url = self._get_config_location('stacked_on_location')
2951
2639
        if stacked_url is None:
2952
2640
            raise errors.NotStacked(self)
2953
2641
        return stacked_url
2954
2642
 
2955
2643
    def _get_append_revisions_only(self):
2956
 
        return self.get_config(
2957
 
            ).get_user_option_as_bool('append_revisions_only')
 
2644
        value = self.get_config().get_user_option('append_revisions_only')
 
2645
        return value == 'True'
 
2646
 
 
2647
    @needs_write_lock
 
2648
    def generate_revision_history(self, revision_id, last_rev=None,
 
2649
                                  other_branch=None):
 
2650
        """See BzrBranch5.generate_revision_history"""
 
2651
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2652
        revno = len(history)
 
2653
        self.set_last_revision_info(revno, revision_id)
2958
2654
 
2959
2655
    @needs_read_lock
2960
2656
    def get_rev_id(self, revno, history=None):
2985
2681
        try:
2986
2682
            index = self._partial_revision_history_cache.index(revision_id)
2987
2683
        except ValueError:
2988
 
            try:
2989
 
                self._extend_partial_history(stop_revision=revision_id)
2990
 
            except errors.RevisionNotPresent, e:
2991
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2684
            self._extend_partial_history(stop_revision=revision_id)
2992
2685
            index = len(self._partial_revision_history_cache) - 1
2993
2686
            if self._partial_revision_history_cache[index] != revision_id:
2994
2687
                raise errors.NoSuchRevision(self, revision_id)
3017
2710
    """
3018
2711
 
3019
2712
    def get_stacked_on_url(self):
3020
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2713
        raise errors.UnstackableBranchFormat(self._format, self.base)
3021
2714
 
3022
2715
 
3023
2716
######################################################################
3049
2742
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3050
2743
    """
3051
2744
 
3052
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3053
2745
    def __int__(self):
3054
 
        """Return the relative change in revno.
3055
 
 
3056
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3057
 
        """
 
2746
        # DEPRECATED: pull used to return the change in revno
3058
2747
        return self.new_revno - self.old_revno
3059
2748
 
3060
2749
    def report(self, to_file):
3085
2774
        target, otherwise it will be None.
3086
2775
    """
3087
2776
 
3088
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3089
2777
    def __int__(self):
3090
 
        """Return the relative change in revno.
3091
 
 
3092
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3093
 
        """
 
2778
        # DEPRECATED: push used to return the change in revno
3094
2779
        return self.new_revno - self.old_revno
3095
2780
 
3096
2781
    def report(self, to_file):
3110
2795
 
3111
2796
    def __init__(self, branch):
3112
2797
        self.branch = branch
3113
 
        self.errors = []
 
2798
        self.ghosts_in_mainline = False
3114
2799
 
3115
2800
    def report_results(self, verbose):
3116
2801
        """Report the check results via trace.note.
3118
2803
        :param verbose: Requests more detailed display of what was checked,
3119
2804
            if any.
3120
2805
        """
3121
 
        note('checked branch %s format %s', self.branch.user_url,
3122
 
            self.branch._format)
3123
 
        for error in self.errors:
3124
 
            note('found error:%s', error)
 
2806
        note('checked branch %s format %s',
 
2807
             self.branch.base,
 
2808
             self.branch._format)
 
2809
        if self.ghosts_in_mainline:
 
2810
            note('branch contains ghosts in mainline')
3125
2811
 
3126
2812
 
3127
2813
class Converter5to6(object):
3166
2852
 
3167
2853
 
3168
2854
class Converter7to8(object):
3169
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
2855
    """Perform an in-place upgrade of format 6 to format 7"""
3170
2856
 
3171
2857
    def convert(self, branch):
3172
2858
        format = BzrBranchFormat8()
3175
2861
        branch._transport.put_bytes('format', format.get_format_string())
3176
2862
 
3177
2863
 
 
2864
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2865
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2866
    duration.
 
2867
 
 
2868
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2869
 
 
2870
    If an exception is raised by callable, then that exception *will* be
 
2871
    propagated, even if the unlock attempt raises its own error.  Thus
 
2872
    _run_with_write_locked_target should be preferred to simply doing::
 
2873
 
 
2874
        target.lock_write()
 
2875
        try:
 
2876
            return callable(*args, **kwargs)
 
2877
        finally:
 
2878
            target.unlock()
 
2879
 
 
2880
    """
 
2881
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2882
    # should share code?
 
2883
    target.lock_write()
 
2884
    try:
 
2885
        result = callable(*args, **kwargs)
 
2886
    except:
 
2887
        exc_info = sys.exc_info()
 
2888
        try:
 
2889
            target.unlock()
 
2890
        finally:
 
2891
            raise exc_info[0], exc_info[1], exc_info[2]
 
2892
    else:
 
2893
        target.unlock()
 
2894
        return result
 
2895
 
 
2896
 
3178
2897
class InterBranch(InterObject):
3179
2898
    """This class represents operations taking place between two branches.
3180
2899
 
3186
2905
    _optimisers = []
3187
2906
    """The available optimised InterBranch types."""
3188
2907
 
3189
 
    @classmethod
3190
 
    def _get_branch_formats_to_test(klass):
3191
 
        """Return an iterable of format tuples for testing.
3192
 
        
3193
 
        :return: An iterable of (from_format, to_format) to use when testing
3194
 
            this InterBranch class. Each InterBranch class should define this
3195
 
            method itself.
3196
 
        """
3197
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2908
    @staticmethod
 
2909
    def _get_branch_formats_to_test():
 
2910
        """Return a tuple with the Branch formats to use when testing."""
 
2911
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3198
2912
 
3199
 
    @needs_write_lock
3200
2913
    def pull(self, overwrite=False, stop_revision=None,
3201
2914
             possible_transports=None, local=False):
3202
2915
        """Mirror source into target branch.
3207
2920
        """
3208
2921
        raise NotImplementedError(self.pull)
3209
2922
 
3210
 
    @needs_write_lock
3211
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
2923
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2924
                         graph=None):
 
2925
        """Pull in new perfect-fit revisions.
 
2926
 
 
2927
        :param stop_revision: Updated until the given revision
 
2928
        :param overwrite: Always set the branch pointer, rather than checking
 
2929
            to see if it is a proper descendant.
 
2930
        :param graph: A Graph object that can be used to query history
 
2931
            information. This can be None.
 
2932
        :return: None
 
2933
        """
 
2934
        raise NotImplementedError(self.update_revisions)
 
2935
 
 
2936
    def push(self, overwrite=False, stop_revision=None,
3212
2937
             _override_hook_source_branch=None):
3213
2938
        """Mirror the source branch into the target branch.
3214
2939
 
3216
2941
        """
3217
2942
        raise NotImplementedError(self.push)
3218
2943
 
3219
 
    @needs_write_lock
3220
 
    def copy_content_into(self, revision_id=None):
3221
 
        """Copy the content of source into target
3222
 
 
3223
 
        revision_id: if not None, the revision history in the new branch will
3224
 
                     be truncated to end with revision_id.
3225
 
        """
3226
 
        raise NotImplementedError(self.copy_content_into)
3227
 
 
3228
 
    @needs_write_lock
3229
 
    def fetch(self, stop_revision=None, limit=None):
3230
 
        """Fetch revisions.
3231
 
 
3232
 
        :param stop_revision: Last revision to fetch
3233
 
        :param limit: Optional rough limit of revisions to fetch
3234
 
        """
3235
 
        raise NotImplementedError(self.fetch)
3236
 
 
3237
2944
 
3238
2945
class GenericInterBranch(InterBranch):
3239
 
    """InterBranch implementation that uses public Branch functions."""
3240
 
 
3241
 
    @classmethod
3242
 
    def is_compatible(klass, source, target):
3243
 
        # GenericBranch uses the public API, so always compatible
3244
 
        return True
3245
 
 
3246
 
    @classmethod
3247
 
    def _get_branch_formats_to_test(klass):
3248
 
        return [(format_registry.get_default(), format_registry.get_default())]
3249
 
 
3250
 
    @classmethod
3251
 
    def unwrap_format(klass, format):
3252
 
        if isinstance(format, remote.RemoteBranchFormat):
3253
 
            format._ensure_real()
3254
 
            return format._custom_format
3255
 
        return format
3256
 
 
3257
 
    @needs_write_lock
3258
 
    def copy_content_into(self, revision_id=None):
3259
 
        """Copy the content of source into target
3260
 
 
3261
 
        revision_id: if not None, the revision history in the new branch will
3262
 
                     be truncated to end with revision_id.
3263
 
        """
3264
 
        self.source.update_references(self.target)
3265
 
        self.source._synchronize_history(self.target, revision_id)
3266
 
        try:
3267
 
            parent = self.source.get_parent()
3268
 
        except errors.InaccessibleParent, e:
3269
 
            mutter('parent was not accessible to copy: %s', e)
3270
 
        else:
3271
 
            if parent:
3272
 
                self.target.set_parent(parent)
3273
 
        if self.source._push_should_merge_tags():
3274
 
            self.source.tags.merge_to(self.target.tags)
3275
 
 
3276
 
    @needs_write_lock
3277
 
    def fetch(self, stop_revision=None, limit=None):
3278
 
        if self.target.base == self.source.base:
3279
 
            return (0, [])
 
2946
    """InterBranch implementation that uses public Branch functions.
 
2947
    """
 
2948
 
 
2949
    @staticmethod
 
2950
    def _get_branch_formats_to_test():
 
2951
        return BranchFormat._default_format, BranchFormat._default_format
 
2952
 
 
2953
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2954
        graph=None):
 
2955
        """See InterBranch.update_revisions()."""
3280
2956
        self.source.lock_read()
3281
2957
        try:
3282
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3283
 
            fetch_spec_factory.source_branch = self.source
3284
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3285
 
            fetch_spec_factory.source_repo = self.source.repository
3286
 
            fetch_spec_factory.target_repo = self.target.repository
3287
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3288
 
            fetch_spec_factory.limit = limit
3289
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3290
 
            return self.target.repository.fetch(self.source.repository,
3291
 
                fetch_spec=fetch_spec)
 
2958
            other_revno, other_last_revision = self.source.last_revision_info()
 
2959
            stop_revno = None # unknown
 
2960
            if stop_revision is None:
 
2961
                stop_revision = other_last_revision
 
2962
                if _mod_revision.is_null(stop_revision):
 
2963
                    # if there are no commits, we're done.
 
2964
                    return
 
2965
                stop_revno = other_revno
 
2966
 
 
2967
            # what's the current last revision, before we fetch [and change it
 
2968
            # possibly]
 
2969
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2970
            # we fetch here so that we don't process data twice in the common
 
2971
            # case of having something to pull, and so that the check for
 
2972
            # already merged can operate on the just fetched graph, which will
 
2973
            # be cached in memory.
 
2974
            self.target.fetch(self.source, stop_revision)
 
2975
            # Check to see if one is an ancestor of the other
 
2976
            if not overwrite:
 
2977
                if graph is None:
 
2978
                    graph = self.target.repository.get_graph()
 
2979
                if self.target._check_if_descendant_or_diverged(
 
2980
                        stop_revision, last_rev, graph, self.source):
 
2981
                    # stop_revision is a descendant of last_rev, but we aren't
 
2982
                    # overwriting, so we're done.
 
2983
                    return
 
2984
            if stop_revno is None:
 
2985
                if graph is None:
 
2986
                    graph = self.target.repository.get_graph()
 
2987
                this_revno, this_last_revision = \
 
2988
                        self.target.last_revision_info()
 
2989
                stop_revno = graph.find_distance_to_null(stop_revision,
 
2990
                                [(other_last_revision, other_revno),
 
2991
                                 (this_last_revision, this_revno)])
 
2992
            self.target.set_last_revision_info(stop_revno, stop_revision)
3292
2993
        finally:
3293
2994
            self.source.unlock()
3294
2995
 
3295
 
    @needs_write_lock
3296
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3297
 
            graph=None):
3298
 
        other_revno, other_last_revision = self.source.last_revision_info()
3299
 
        stop_revno = None # unknown
3300
 
        if stop_revision is None:
3301
 
            stop_revision = other_last_revision
3302
 
            if _mod_revision.is_null(stop_revision):
3303
 
                # if there are no commits, we're done.
3304
 
                return
3305
 
            stop_revno = other_revno
3306
 
 
3307
 
        # what's the current last revision, before we fetch [and change it
3308
 
        # possibly]
3309
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3310
 
        # we fetch here so that we don't process data twice in the common
3311
 
        # case of having something to pull, and so that the check for
3312
 
        # already merged can operate on the just fetched graph, which will
3313
 
        # be cached in memory.
3314
 
        self.fetch(stop_revision=stop_revision)
3315
 
        # Check to see if one is an ancestor of the other
3316
 
        if not overwrite:
3317
 
            if graph is None:
3318
 
                graph = self.target.repository.get_graph()
3319
 
            if self.target._check_if_descendant_or_diverged(
3320
 
                    stop_revision, last_rev, graph, self.source):
3321
 
                # stop_revision is a descendant of last_rev, but we aren't
3322
 
                # overwriting, so we're done.
3323
 
                return
3324
 
        if stop_revno is None:
3325
 
            if graph is None:
3326
 
                graph = self.target.repository.get_graph()
3327
 
            this_revno, this_last_revision = \
3328
 
                    self.target.last_revision_info()
3329
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3330
 
                            [(other_last_revision, other_revno),
3331
 
                             (this_last_revision, this_revno)])
3332
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3333
 
 
3334
 
    @needs_write_lock
3335
2996
    def pull(self, overwrite=False, stop_revision=None,
3336
 
             possible_transports=None, run_hooks=True,
3337
 
             _override_hook_target=None, local=False):
3338
 
        """Pull from source into self, updating my master if any.
3339
 
 
3340
 
        :param run_hooks: Private parameter - if false, this branch
3341
 
            is being called because it's the master of the primary branch,
3342
 
            so it should not run its hooks.
3343
 
        """
3344
 
        bound_location = self.target.get_bound_location()
3345
 
        if local and not bound_location:
3346
 
            raise errors.LocalRequiresBoundBranch()
3347
 
        master_branch = None
3348
 
        source_is_master = False
3349
 
        if bound_location:
3350
 
            # bound_location comes from a config file, some care has to be
3351
 
            # taken to relate it to source.user_url
3352
 
            normalized = urlutils.normalize_url(bound_location)
3353
 
            try:
3354
 
                relpath = self.source.user_transport.relpath(normalized)
3355
 
                source_is_master = (relpath == '')
3356
 
            except (errors.PathNotChild, errors.InvalidURL):
3357
 
                source_is_master = False
3358
 
        if not local and bound_location and not source_is_master:
3359
 
            # not pulling from master, so we need to update master.
3360
 
            master_branch = self.target.get_master_branch(possible_transports)
3361
 
            master_branch.lock_write()
3362
 
        try:
3363
 
            if master_branch:
3364
 
                # pull from source into master.
3365
 
                master_branch.pull(self.source, overwrite, stop_revision,
3366
 
                    run_hooks=False)
3367
 
            return self._pull(overwrite,
3368
 
                stop_revision, _hook_master=master_branch,
3369
 
                run_hooks=run_hooks,
3370
 
                _override_hook_target=_override_hook_target,
3371
 
                merge_tags_to_master=not source_is_master)
3372
 
        finally:
3373
 
            if master_branch:
3374
 
                master_branch.unlock()
3375
 
 
3376
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3377
 
             _override_hook_source_branch=None):
3378
 
        """See InterBranch.push.
3379
 
 
3380
 
        This is the basic concrete implementation of push()
3381
 
 
3382
 
        :param _override_hook_source_branch: If specified, run the hooks
3383
 
            passing this Branch as the source, rather than self.  This is for
3384
 
            use of RemoteBranch, where push is delegated to the underlying
3385
 
            vfs-based Branch.
3386
 
        """
3387
 
        if lossy:
3388
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3389
 
        # TODO: Public option to disable running hooks - should be trivial but
3390
 
        # needs tests.
3391
 
 
3392
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3393
 
        op.add_cleanup(self.source.lock_read().unlock)
3394
 
        op.add_cleanup(self.target.lock_write().unlock)
3395
 
        return op.run(overwrite, stop_revision,
3396
 
            _override_hook_source_branch=_override_hook_source_branch)
3397
 
 
3398
 
    def _basic_push(self, overwrite, stop_revision):
3399
 
        """Basic implementation of push without bound branches or hooks.
3400
 
 
3401
 
        Must be called with source read locked and target write locked.
3402
 
        """
3403
 
        result = BranchPushResult()
3404
 
        result.source_branch = self.source
3405
 
        result.target_branch = self.target
3406
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3407
 
        self.source.update_references(self.target)
3408
 
        if result.old_revid != stop_revision:
3409
 
            # We assume that during 'push' this repository is closer than
3410
 
            # the target.
3411
 
            graph = self.source.repository.get_graph(self.target.repository)
3412
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3413
 
                    graph=graph)
3414
 
        if self.source._push_should_merge_tags():
3415
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3416
 
                overwrite)
3417
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3418
 
        return result
3419
 
 
3420
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3421
 
            _override_hook_source_branch=None):
3422
 
        """Push from source into target, and into target's master if any.
3423
 
        """
3424
 
        def _run_hooks():
3425
 
            if _override_hook_source_branch:
3426
 
                result.source_branch = _override_hook_source_branch
3427
 
            for hook in Branch.hooks['post_push']:
3428
 
                hook(result)
3429
 
 
3430
 
        bound_location = self.target.get_bound_location()
3431
 
        if bound_location and self.target.base != bound_location:
3432
 
            # there is a master branch.
3433
 
            #
3434
 
            # XXX: Why the second check?  Is it even supported for a branch to
3435
 
            # be bound to itself? -- mbp 20070507
3436
 
            master_branch = self.target.get_master_branch()
3437
 
            master_branch.lock_write()
3438
 
            operation.add_cleanup(master_branch.unlock)
3439
 
            # push into the master from the source branch.
3440
 
            master_inter = InterBranch.get(self.source, master_branch)
3441
 
            master_inter._basic_push(overwrite, stop_revision)
3442
 
            # and push into the target branch from the source. Note that
3443
 
            # we push from the source branch again, because it's considered
3444
 
            # the highest bandwidth repository.
3445
 
            result = self._basic_push(overwrite, stop_revision)
3446
 
            result.master_branch = master_branch
3447
 
            result.local_branch = self.target
3448
 
        else:
3449
 
            master_branch = None
3450
 
            # no master branch
3451
 
            result = self._basic_push(overwrite, stop_revision)
3452
 
            # TODO: Why set master_branch and local_branch if there's no
3453
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3454
 
            # 20070504
3455
 
            result.master_branch = self.target
3456
 
            result.local_branch = None
3457
 
        _run_hooks()
3458
 
        return result
3459
 
 
3460
 
    def _pull(self, overwrite=False, stop_revision=None,
3461
2997
             possible_transports=None, _hook_master=None, run_hooks=True,
3462
 
             _override_hook_target=None, local=False,
3463
 
             merge_tags_to_master=True):
 
2998
             _override_hook_target=None, local=False):
3464
2999
        """See Branch.pull.
3465
3000
 
3466
 
        This function is the core worker, used by GenericInterBranch.pull to
3467
 
        avoid duplication when pulling source->master and source->local.
3468
 
 
3469
3001
        :param _hook_master: Private parameter - set the branch to
3470
3002
            be supplied as the master to pull hooks.
3471
3003
        :param run_hooks: Private parameter - if false, this branch
3472
3004
            is being called because it's the master of the primary branch,
3473
3005
            so it should not run its hooks.
3474
 
            is being called because it's the master of the primary branch,
3475
 
            so it should not run its hooks.
3476
3006
        :param _override_hook_target: Private parameter - set the branch to be
3477
3007
            supplied as the target_branch to pull hooks.
3478
3008
        :param local: Only update the local branch, and not the bound branch.
3497
3027
            # -- JRV20090506
3498
3028
            result.old_revno, result.old_revid = \
3499
3029
                self.target.last_revision_info()
3500
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3501
 
                graph=graph)
 
3030
            self.target.update_revisions(self.source, stop_revision,
 
3031
                overwrite=overwrite, graph=graph)
3502
3032
            # TODO: The old revid should be specified when merging tags, 
3503
3033
            # so a tags implementation that versions tags can only 
3504
3034
            # pull in the most recent changes. -- JRV20090506
3505
3035
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3506
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3036
                overwrite)
3507
3037
            result.new_revno, result.new_revid = self.target.last_revision_info()
3508
3038
            if _hook_master:
3509
3039
                result.master_branch = _hook_master
3518
3048
            self.source.unlock()
3519
3049
        return result
3520
3050
 
 
3051
    def push(self, overwrite=False, stop_revision=None,
 
3052
             _override_hook_source_branch=None):
 
3053
        """See InterBranch.push.
 
3054
 
 
3055
        This is the basic concrete implementation of push()
 
3056
 
 
3057
        :param _override_hook_source_branch: If specified, run
 
3058
        the hooks passing this Branch as the source, rather than self.
 
3059
        This is for use of RemoteBranch, where push is delegated to the
 
3060
        underlying vfs-based Branch.
 
3061
        """
 
3062
        # TODO: Public option to disable running hooks - should be trivial but
 
3063
        # needs tests.
 
3064
        self.source.lock_read()
 
3065
        try:
 
3066
            return _run_with_write_locked_target(
 
3067
                self.target, self._push_with_bound_branches, overwrite,
 
3068
                stop_revision,
 
3069
                _override_hook_source_branch=_override_hook_source_branch)
 
3070
        finally:
 
3071
            self.source.unlock()
 
3072
 
 
3073
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3074
            _override_hook_source_branch=None):
 
3075
        """Push from source into target, and into target's master if any.
 
3076
        """
 
3077
        def _run_hooks():
 
3078
            if _override_hook_source_branch:
 
3079
                result.source_branch = _override_hook_source_branch
 
3080
            for hook in Branch.hooks['post_push']:
 
3081
                hook(result)
 
3082
 
 
3083
        bound_location = self.target.get_bound_location()
 
3084
        if bound_location and self.target.base != bound_location:
 
3085
            # there is a master branch.
 
3086
            #
 
3087
            # XXX: Why the second check?  Is it even supported for a branch to
 
3088
            # be bound to itself? -- mbp 20070507
 
3089
            master_branch = self.target.get_master_branch()
 
3090
            master_branch.lock_write()
 
3091
            try:
 
3092
                # push into the master from the source branch.
 
3093
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3094
                # and push into the target branch from the source. Note that we
 
3095
                # push from the source branch again, because its considered the
 
3096
                # highest bandwidth repository.
 
3097
                result = self.source._basic_push(self.target, overwrite,
 
3098
                    stop_revision)
 
3099
                result.master_branch = master_branch
 
3100
                result.local_branch = self.target
 
3101
                _run_hooks()
 
3102
                return result
 
3103
            finally:
 
3104
                master_branch.unlock()
 
3105
        else:
 
3106
            # no master branch
 
3107
            result = self.source._basic_push(self.target, overwrite,
 
3108
                stop_revision)
 
3109
            # TODO: Why set master_branch and local_branch if there's no
 
3110
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3111
            # 20070504
 
3112
            result.master_branch = self.target
 
3113
            result.local_branch = None
 
3114
            _run_hooks()
 
3115
            return result
 
3116
 
 
3117
    @classmethod
 
3118
    def is_compatible(self, source, target):
 
3119
        # GenericBranch uses the public API, so always compatible
 
3120
        return True
 
3121
 
 
3122
 
 
3123
class InterToBranch5(GenericInterBranch):
 
3124
 
 
3125
    @staticmethod
 
3126
    def _get_branch_formats_to_test():
 
3127
        return BranchFormat._default_format, BzrBranchFormat5()
 
3128
 
 
3129
    def pull(self, overwrite=False, stop_revision=None,
 
3130
             possible_transports=None, run_hooks=True,
 
3131
             _override_hook_target=None, local=False):
 
3132
        """Pull from source into self, updating my master if any.
 
3133
 
 
3134
        :param run_hooks: Private parameter - if false, this branch
 
3135
            is being called because it's the master of the primary branch,
 
3136
            so it should not run its hooks.
 
3137
        """
 
3138
        bound_location = self.target.get_bound_location()
 
3139
        if local and not bound_location:
 
3140
            raise errors.LocalRequiresBoundBranch()
 
3141
        master_branch = None
 
3142
        if not local and bound_location and self.source.base != bound_location:
 
3143
            # not pulling from master, so we need to update master.
 
3144
            master_branch = self.target.get_master_branch(possible_transports)
 
3145
            master_branch.lock_write()
 
3146
        try:
 
3147
            if master_branch:
 
3148
                # pull from source into master.
 
3149
                master_branch.pull(self.source, overwrite, stop_revision,
 
3150
                    run_hooks=False)
 
3151
            return super(InterToBranch5, self).pull(overwrite,
 
3152
                stop_revision, _hook_master=master_branch,
 
3153
                run_hooks=run_hooks,
 
3154
                _override_hook_target=_override_hook_target)
 
3155
        finally:
 
3156
            if master_branch:
 
3157
                master_branch.unlock()
 
3158
 
3521
3159
 
3522
3160
InterBranch.register_optimiser(GenericInterBranch)
 
3161
InterBranch.register_optimiser(InterToBranch5)