~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2009-05-01 14:29:06 UTC
  • mto: This revision was merged to the branch mainline in revision 4321.
  • Revision ID: jelmer@samba.org-20090501142906-7zj8hcpp9igzuyi4
Add repository argument to 'repository' info hook, per Roberts review.

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,
 
37
        tsort,
40
38
        ui,
41
39
        urlutils,
42
40
        )
43
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
43
from bzrlib.tag import (
45
44
    BasicTags,
46
45
    DisabledTags,
47
46
    )
48
47
""")
49
48
 
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
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
50
from bzrlib.hooks import HookPoint, Hooks
59
51
from bzrlib.inter import InterObject
60
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
61
52
from bzrlib import registry
62
53
from bzrlib.symbol_versioning import (
63
54
    deprecated_in,
66
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
58
 
68
59
 
69
 
class Branch(controldir.ControlComponent):
 
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
63
 
 
64
 
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
70
78
    """Branch holding a history of revisions.
71
79
 
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.
 
80
    base
 
81
        Base directory/url of the branch.
 
82
 
 
83
    hooks: An instance of BranchHooks.
78
84
    """
79
85
    # this is really an instance variable - FIXME move it there
80
86
    # - RBC 20060112
81
87
    base = None
82
88
 
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
89
    def __init__(self, *ignored, **ignored_too):
92
90
        self.tags = self._format.make_tags(self)
93
91
        self._revision_history_cache = None
94
92
        self._revision_id_to_revno_cache = None
95
93
        self._partial_revision_id_to_revno_cache = {}
96
 
        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']
106
101
    def _open_hook(self):
107
102
        """Called by init to allow simpler extension of the base class."""
108
103
 
109
 
    def _activate_fallback_location(self, url):
 
104
    def _activate_fallback_location(self, url, lock_style):
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
 
        if repo.has_same_location(self.repository):
120
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
107
        if lock_style == 'write':
 
108
            repo.lock_write()
 
109
        elif lock_style == 'read':
 
110
            repo.lock_read()
121
111
        self.repository.add_fallback_repository(repo)
122
112
 
123
113
    def break_lock(self):
139
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
140
130
                self.repository.base)
141
131
 
142
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
143
 
        """Extend the partial history to include a given index
144
 
 
145
 
        If a stop_index is supplied, stop when that index has been reached.
146
 
        If a stop_revision is supplied, stop when that revision is
147
 
        encountered.  Otherwise, stop when the beginning of history is
148
 
        reached.
149
 
 
150
 
        :param stop_index: The index which should be present.  When it is
151
 
            present, history extension will stop.
152
 
        :param stop_revision: The revision id which should be present.  When
153
 
            it is encountered, history extension will stop.
154
 
        """
155
 
        if len(self._partial_revision_history_cache) == 0:
156
 
            self._partial_revision_history_cache = [self.last_revision()]
157
 
        repository._iter_for_revno(
158
 
            self.repository, self._partial_revision_history_cache,
159
 
            stop_index=stop_index, stop_revision=stop_revision)
160
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
161
 
            self._partial_revision_history_cache.pop()
162
 
 
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
132
    @staticmethod
172
133
    def open(base, _unsupported=False, possible_transports=None):
173
134
        """Open the branch rooted at base.
177
138
        """
178
139
        control = bzrdir.BzrDir.open(base, _unsupported,
179
140
                                     possible_transports=possible_transports)
180
 
        return control.open_branch(unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
181
142
 
182
143
    @staticmethod
183
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
144
    def open_from_transport(transport, _unsupported=False):
184
145
        """Open the branch rooted at transport"""
185
146
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
186
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
147
        return control.open_branch(_unsupported)
187
148
 
188
149
    @staticmethod
189
150
    def open_containing(url, possible_transports=None):
210
171
        return self.supports_tags() and self.tags.get_tag_dict()
211
172
 
212
173
    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
174
        return BranchConfig(self)
221
175
 
222
176
    def _get_config(self):
234
188
    def _get_fallback_repository(self, url):
235
189
        """Get the repository we fallback to at url."""
236
190
        url = urlutils.join(self.base, url)
237
 
        a_branch = Branch.open(url,
 
191
        a_bzrdir = bzrdir.BzrDir.open(url,
238
192
            possible_transports=[self.bzrdir.root_transport])
239
 
        return a_branch.repository
 
193
        return a_bzrdir.open_branch().repository
240
194
 
241
 
    @needs_read_lock
242
195
    def _get_tags_bytes(self):
243
196
        """Get the bytes of a serialised tags dict.
244
197
 
251
204
        :return: The bytes of the tags file.
252
205
        :seealso: Branch._set_tags_bytes.
253
206
        """
254
 
        if self._tags_bytes is None:
255
 
            self._tags_bytes = self._transport.get_bytes('tags')
256
 
        return self._tags_bytes
 
207
        return self._transport.get_bytes('tags')
257
208
 
258
209
    def _get_nick(self, local=False, possible_transports=None):
259
210
        config = self.get_config()
261
212
        if not local and not config.has_explicit_nickname():
262
213
            try:
263
214
                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
215
                if master is not None:
267
216
                    # return the master branch value
268
217
                    return master.nick
269
 
            except errors.RecursiveBind, e:
270
 
                raise e
271
218
            except errors.BzrError, e:
272
219
                # Silently fall back to local implicit nick if the master is
273
220
                # unavailable
310
257
        new_history.reverse()
311
258
        return new_history
312
259
 
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
 
        """
 
260
    def lock_write(self):
320
261
        raise NotImplementedError(self.lock_write)
321
262
 
322
263
    def lock_read(self):
323
 
        """Lock the branch for read operations.
324
 
 
325
 
        :return: A bzrlib.lock.LogicalLockResult.
326
 
        """
327
264
        raise NotImplementedError(self.lock_read)
328
265
 
329
266
    def unlock(self):
450
387
            after. If None, the rest of history is included.
451
388
        :param stop_rule: if stop_revision_id is not None, the precise rule
452
389
            to use for termination:
453
 
 
454
390
            * 'exclude' - leave the stop revision out of the result (default)
455
391
            * 'include' - the stop revision is the last item in the result
456
392
            * 'with-merges' - include the stop revision and all of its
457
393
              merged revisions in the result
458
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
459
 
              that are in both ancestries
460
394
        :param direction: either 'reverse' or 'forward':
461
 
 
462
395
            * reverse means return the start_revision_id first, i.e.
463
396
              start at the most recent revision and go backwards in history
464
397
            * forward returns tuples in the opposite order to reverse.
485
418
        # start_revision_id.
486
419
        if self._merge_sorted_revisions_cache is None:
487
420
            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)
 
421
            graph = self.repository.get_graph()
 
422
            parent_map = dict(((key, value) for key, value in
 
423
                     graph.iter_ancestry([last_revision]) if value is not None))
 
424
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
425
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
426
                generate_revno=True)
 
427
            # Drop the sequence # before caching
 
428
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
429
 
492
430
        filtered = self._filter_merge_sorted_revisions(
493
431
            self._merge_sorted_revisions_cache, start_revision_id,
494
432
            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
433
        if direction == 'reverse':
499
434
            return filtered
500
435
        if direction == 'forward':
507
442
        """Iterate over an inclusive range of sorted revisions."""
508
443
        rev_iter = iter(merge_sorted_revisions)
509
444
        if start_revision_id is not None:
510
 
            for node in rev_iter:
511
 
                rev_id = node.key
 
445
            for rev_id, depth, revno, end_of_merge in rev_iter:
512
446
                if rev_id != start_revision_id:
513
447
                    continue
514
448
                else:
515
449
                    # The decision to include the start or not
516
450
                    # 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)
 
451
                    rev_iter = chain(
 
452
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
453
                        rev_iter)
519
454
                    break
520
455
        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)
 
456
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
457
                yield rev_id, depth, revno, end_of_merge
526
458
        elif stop_rule == 'exclude':
527
 
            for node in rev_iter:
528
 
                rev_id = node.key
 
459
            for rev_id, depth, revno, end_of_merge in rev_iter:
529
460
                if rev_id == stop_revision_id:
530
461
                    return
531
 
                yield (rev_id, node.merge_depth, node.revno,
532
 
                       node.end_of_merge)
 
462
                yield rev_id, depth, revno, end_of_merge
533
463
        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)
 
464
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
465
                yield rev_id, depth, revno, end_of_merge
538
466
                if rev_id == stop_revision_id:
539
467
                    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
468
        elif stop_rule == 'with-merges':
553
469
            stop_rev = self.repository.get_revision(stop_revision_id)
554
470
            if stop_rev.parent_ids:
555
471
                left_parent = stop_rev.parent_ids[0]
556
472
            else:
557
473
                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
 
474
            for rev_id, depth, revno, end_of_merge in rev_iter:
564
475
                if rev_id == left_parent:
565
 
                    # reached the left parent after the stop_revision
566
476
                    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)
 
477
                yield rev_id, depth, revno, end_of_merge
577
478
        else:
578
479
            raise ValueError('invalid stop_rule %r' % stop_rule)
579
480
 
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
481
    def leave_lock_in_place(self):
626
482
        """Tell this branch object not to release the physical lock when this
627
483
        object is unlocked.
644
500
        :param other: The branch to bind to
645
501
        :type other: Branch
646
502
        """
647
 
        raise errors.UpgradeRequired(self.user_url)
648
 
 
649
 
    def set_append_revisions_only(self, enabled):
650
 
        if not self._format.supports_set_append_revisions_only():
651
 
            raise errors.UpgradeRequired(self.user_url)
652
 
        if enabled:
653
 
            value = 'True'
654
 
        else:
655
 
            value = 'False'
656
 
        self.get_config().set_user_option('append_revisions_only', value,
657
 
            warn_masked=True)
 
503
        raise errors.UpgradeRequired(self.base)
658
504
 
659
505
    def set_reference_info(self, file_id, tree_path, branch_location):
660
506
        """Set the branch location to use for a tree reference."""
665
511
        raise errors.UnsupportedOperation(self.get_reference_info, self)
666
512
 
667
513
    @needs_write_lock
668
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
514
    def fetch(self, from_branch, last_revision=None, pb=None):
669
515
        """Copy revisions from from_branch into this branch.
670
516
 
671
517
        :param from_branch: Where to copy from.
672
518
        :param last_revision: What revision to stop at (None for at the end
673
519
                              of the branch.
674
 
        :param limit: Optional rough limit of revisions to fetch
 
520
        :param pb: An optional progress bar to use.
675
521
        :return: None
676
522
        """
677
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
523
        if self.base == from_branch.base:
 
524
            return (0, [])
 
525
        if pb is not None:
 
526
            symbol_versioning.warn(
 
527
                symbol_versioning.deprecated_in((1, 14, 0))
 
528
                % "pb parameter to fetch()")
 
529
        from_branch.lock_read()
 
530
        try:
 
531
            if last_revision is None:
 
532
                last_revision = from_branch.last_revision()
 
533
                last_revision = _mod_revision.ensure_null(last_revision)
 
534
            return self.repository.fetch(from_branch.repository,
 
535
                                         revision_id=last_revision,
 
536
                                         pb=pb)
 
537
        finally:
 
538
            from_branch.unlock()
678
539
 
679
540
    def get_bound_location(self):
680
541
        """Return the URL of the branch we are bound to.
687
548
    def get_old_bound_location(self):
688
549
        """Return the URL of the branch we used to be bound to
689
550
        """
690
 
        raise errors.UpgradeRequired(self.user_url)
 
551
        raise errors.UpgradeRequired(self.base)
691
552
 
692
553
    def get_commit_builder(self, parents, config=None, timestamp=None,
693
554
                           timezone=None, committer=None, revprops=None,
694
 
                           revision_id=None, lossy=False):
 
555
                           revision_id=None):
695
556
        """Obtain a CommitBuilder for this branch.
696
557
 
697
558
        :param parents: Revision ids of the parents of the new revision.
701
562
        :param committer: Optional committer to set for commit.
702
563
        :param revprops: Optional dictionary of revision properties.
703
564
        :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
565
        """
707
566
 
708
567
        if config is None:
709
568
            config = self.get_config()
710
569
 
711
570
        return self.repository.get_commit_builder(self, parents, config,
712
 
            timestamp, timezone, committer, revprops, revision_id,
713
 
            lossy)
 
571
            timestamp, timezone, committer, revprops, revision_id)
714
572
 
715
573
    def get_master_branch(self, possible_transports=None):
716
574
        """Return the branch we are bound to.
743
601
        """Print `file` to stdout."""
744
602
        raise NotImplementedError(self.print_file)
745
603
 
746
 
    @deprecated_method(deprecated_in((2, 4, 0)))
747
604
    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)
 
605
        raise NotImplementedError(self.set_revision_history)
794
606
 
795
607
    @needs_write_lock
796
608
    def set_parent(self, url):
820
632
            stacking.
821
633
        """
822
634
        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.
 
635
            raise errors.UnstackableBranchFormat(self._format, self.base)
827
636
        self._check_stackable_repo()
828
637
        if not url:
829
638
            try:
831
640
            except (errors.NotStacked, errors.UnstackableBranchFormat,
832
641
                errors.UnstackableRepositoryFormat):
833
642
                return
834
 
            self._unstack()
 
643
            url = ''
 
644
            # XXX: Lock correctness - should unlock our old repo if we were
 
645
            # locked.
 
646
            # repositories don't offer an interface to remove fallback
 
647
            # repositories today; take the conceptually simpler option and just
 
648
            # reopen it.
 
649
            self.repository = self.bzrdir.find_repository()
 
650
            self.repository.lock_write()
 
651
            # for every revision reference the branch has, ensure it is pulled
 
652
            # in.
 
653
            source_repository = self._get_fallback_repository(old_url)
 
654
            for revision_id in chain([self.last_revision()],
 
655
                self.tags.get_reverse_tag_dict()):
 
656
                self.repository.fetch(source_repository, revision_id,
 
657
                    find_ghosts=True)
835
658
        else:
836
 
            self._activate_fallback_location(url)
 
659
            self._activate_fallback_location(url, 'write')
837
660
        # write this out after the repository is stacked to avoid setting a
838
661
        # stacked config that doesn't work.
839
662
        self._set_config_location('stacked_on_location', url)
840
663
 
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
664
 
926
665
    def _set_tags_bytes(self, bytes):
927
666
        """Mirror method for _get_tags_bytes.
928
667
 
929
668
        :seealso: Branch._get_tags_bytes.
930
669
        """
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)
 
670
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
671
            'tags', bytes)
938
672
 
939
673
    def _cache_revision_history(self, rev_history):
940
674
        """Set the cached revision history to rev_history.
967
701
        self._revision_history_cache = None
968
702
        self._revision_id_to_revno_cache = None
969
703
        self._last_revision_info_cache = None
970
 
        self._master_branch_cache = None
971
704
        self._merge_sorted_revisions_cache = None
972
 
        self._partial_revision_history_cache = []
973
 
        self._partial_revision_id_to_revno_cache = {}
974
 
        self._tags_bytes = None
975
705
 
976
706
    def _gen_revision_history(self):
977
707
        """Return sequence of revision hashes on to this branch.
1014
744
 
1015
745
    def unbind(self):
1016
746
        """Older format branches cannot bind or unbind."""
1017
 
        raise errors.UpgradeRequired(self.user_url)
 
747
        raise errors.UpgradeRequired(self.base)
 
748
 
 
749
    def set_append_revisions_only(self, enabled):
 
750
        """Older format branches are never restricted to append-only"""
 
751
        raise errors.UpgradeRequired(self.base)
1018
752
 
1019
753
    def last_revision(self):
1020
754
        """Return last revision id, or NULL_REVISION."""
1027
761
        :return: A tuple (revno, revision_id).
1028
762
        """
1029
763
        if self._last_revision_info_cache is None:
1030
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
764
            self._last_revision_info_cache = self._last_revision_info()
1031
765
        return self._last_revision_info_cache
1032
766
 
1033
 
    def _read_last_revision_info(self):
1034
 
        raise NotImplementedError(self._read_last_revision_info)
1035
 
 
1036
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
767
    def _last_revision_info(self):
 
768
        rh = self.revision_history()
 
769
        revno = len(rh)
 
770
        if revno:
 
771
            return (revno, rh[-1])
 
772
        else:
 
773
            return (0, _mod_revision.NULL_REVISION)
 
774
 
 
775
    @deprecated_method(deprecated_in((1, 6, 0)))
 
776
    def missing_revisions(self, other, stop_revision=None):
 
777
        """Return a list of new revisions that would perfectly fit.
 
778
 
 
779
        If self and other have not diverged, return a list of the revisions
 
780
        present in other, but missing from self.
 
781
        """
 
782
        self_history = self.revision_history()
 
783
        self_len = len(self_history)
 
784
        other_history = other.revision_history()
 
785
        other_len = len(other_history)
 
786
        common_index = min(self_len, other_len) -1
 
787
        if common_index >= 0 and \
 
788
            self_history[common_index] != other_history[common_index]:
 
789
            raise errors.DivergedBranches(self, other)
 
790
 
 
791
        if stop_revision is None:
 
792
            stop_revision = other_len
 
793
        else:
 
794
            if stop_revision > other_len:
 
795
                raise errors.NoSuchRevision(self, stop_revision)
 
796
        return other_history[self_len:stop_revision]
 
797
 
 
798
    @needs_write_lock
 
799
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
800
                         graph=None):
 
801
        """Pull in new perfect-fit revisions.
 
802
 
 
803
        :param other: Another Branch to pull from
 
804
        :param stop_revision: Updated until the given revision
 
805
        :param overwrite: Always set the branch pointer, rather than checking
 
806
            to see if it is a proper descendant.
 
807
        :param graph: A Graph object that can be used to query history
 
808
            information. This can be None.
 
809
        :return: None
 
810
        """
 
811
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
812
            overwrite, graph)
 
813
 
1037
814
    def import_last_revision_info(self, source_repo, revno, revid):
1038
815
        """Set the last revision info, importing from another repo if necessary.
1039
816
 
 
817
        This is used by the bound branch code to upload a revision to
 
818
        the master branch first before updating the tip of the local branch.
 
819
 
1040
820
        :param source_repo: Source repository to optionally fetch from
1041
821
        :param revno: Revision number of the new tip
1042
822
        :param revid: Revision id of the new tip
1045
825
            self.repository.fetch(source_repo, revision_id=revid)
1046
826
        self.set_last_revision_info(revno, revid)
1047
827
 
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
828
    def revision_id_to_revno(self, revision_id):
1070
829
        """Given a revision id, return its revno"""
1071
830
        if _mod_revision.is_null(revision_id):
1076
835
        except ValueError:
1077
836
            raise errors.NoSuchRevision(self, revision_id)
1078
837
 
1079
 
    @needs_read_lock
1080
838
    def get_rev_id(self, revno, history=None):
1081
839
        """Find the revision id of the specified revno."""
1082
840
        if revno == 0:
1083
841
            return _mod_revision.NULL_REVISION
1084
 
        last_revno, last_revid = self.last_revision_info()
1085
 
        if revno == last_revno:
1086
 
            return last_revid
1087
 
        if revno <= 0 or revno > last_revno:
 
842
        if history is None:
 
843
            history = self.revision_history()
 
844
        if revno <= 0 or revno > len(history):
1088
845
            raise errors.NoSuchRevision(self, revno)
1089
 
        distance_from_last = last_revno - revno
1090
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1091
 
            self._extend_partial_history(distance_from_last)
1092
 
        return self._partial_revision_history_cache[distance_from_last]
 
846
        return history[revno - 1]
1093
847
 
1094
848
    def pull(self, source, overwrite=False, stop_revision=None,
1095
 
             possible_transports=None, *args, **kwargs):
 
849
             possible_transports=None, _override_hook_target=None):
1096
850
        """Mirror source into this branch.
1097
851
 
1098
852
        This branch is considered to be 'local', having low latency.
1099
853
 
1100
854
        :returns: PullResult instance
1101
855
        """
1102
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1103
 
            stop_revision=stop_revision,
1104
 
            possible_transports=possible_transports, *args, **kwargs)
 
856
        raise NotImplementedError(self.pull)
1105
857
 
1106
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1107
 
            *args, **kwargs):
 
858
    def push(self, target, overwrite=False, stop_revision=None):
1108
859
        """Mirror this branch into target.
1109
860
 
1110
861
        This branch is considered to be 'local', having low latency.
1111
862
        """
1112
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1113
 
            lossy, *args, **kwargs)
 
863
        raise NotImplementedError(self.push)
1114
864
 
1115
865
    def basis_tree(self):
1116
866
        """Return `Tree` object for last revision."""
1133
883
        try:
1134
884
            return urlutils.join(self.base[:-1], parent)
1135
885
        except errors.InvalidURLJoin, e:
1136
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
886
            raise errors.InaccessibleParent(parent, self.base)
1137
887
 
1138
888
    def _get_parent_location(self):
1139
889
        raise NotImplementedError(self._get_parent_location)
1156
906
            location = None
1157
907
        return location
1158
908
 
1159
 
    def get_child_submit_format(self):
1160
 
        """Return the preferred format of submissions to this branch."""
1161
 
        return self.get_config().get_user_option("child_submit_format")
1162
 
 
1163
909
    def get_submit_branch(self):
1164
910
        """Return the submit location of the branch.
1165
911
 
1224
970
        params = ChangeBranchTipParams(
1225
971
            self, old_revno, new_revno, old_revid, new_revid)
1226
972
        for hook in hooks:
1227
 
            hook(params)
 
973
            try:
 
974
                hook(params)
 
975
            except errors.TipChangeRejected:
 
976
                raise
 
977
            except Exception:
 
978
                exc_info = sys.exc_info()
 
979
                hook_name = Branch.hooks.get_hook_name(hook)
 
980
                raise errors.HookFailed(
 
981
                    'pre_change_branch_tip', hook_name, exc_info)
1228
982
 
1229
983
    @needs_write_lock
1230
984
    def update(self):
1271
1025
        return result
1272
1026
 
1273
1027
    @needs_read_lock
1274
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1275
 
            repository=None):
 
1028
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1276
1029
        """Create a new line of development from the branch, into to_bzrdir.
1277
1030
 
1278
1031
        to_bzrdir controls the branch format.
1280
1033
        revision_id: if not None, the revision history in the new branch will
1281
1034
                     be truncated to end with revision_id.
1282
1035
        """
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)
 
1036
        result = to_bzrdir.create_branch()
1287
1037
        result.lock_write()
1288
1038
        try:
1289
1039
            if repository_policy is not None:
1290
1040
                repository_policy.configure_branch(result)
1291
1041
            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)
 
1042
            result.set_parent(self.bzrdir.root_transport.base)
1297
1043
        finally:
1298
1044
            result.unlock()
1299
1045
        return result
1313
1059
        source_revno, source_revision_id = self.last_revision_info()
1314
1060
        if revision_id is None:
1315
1061
            revno, revision_id = source_revno, source_revision_id
 
1062
        elif source_revision_id == revision_id:
 
1063
            # we know the revno without needing to walk all of history
 
1064
            revno = source_revno
1316
1065
        else:
1317
 
            graph = self.repository.get_graph()
1318
 
            try:
1319
 
                revno = graph.find_distance_to_null(revision_id, 
1320
 
                    [(source_revision_id, source_revno)])
1321
 
            except errors.GhostRevisionsHaveNoRevno:
1322
 
                # Default to 1, if we can't find anything else
1323
 
                revno = 1
 
1066
            # To figure out the revno for a random revision, we need to build
 
1067
            # the revision history, and count its length.
 
1068
            # We don't care about the order, just how long it is.
 
1069
            # Alternatively, we could start at the current location, and count
 
1070
            # backwards. But there is no guarantee that we will find it since
 
1071
            # it may be a merged revision.
 
1072
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1073
                                                                revision_id)))
1324
1074
        destination.set_last_revision_info(revno, revision_id)
1325
1075
 
 
1076
    @needs_read_lock
1326
1077
    def copy_content_into(self, destination, revision_id=None):
1327
1078
        """Copy the content of self into destination.
1328
1079
 
1329
1080
        revision_id: if not None, the revision history in the new branch will
1330
1081
                     be truncated to end with revision_id.
1331
1082
        """
1332
 
        return InterBranch.get(self, destination).copy_content_into(
1333
 
            revision_id=revision_id)
 
1083
        self.update_references(destination)
 
1084
        self._synchronize_history(destination, revision_id)
 
1085
        try:
 
1086
            parent = self.get_parent()
 
1087
        except errors.InaccessibleParent, e:
 
1088
            mutter('parent was not accessible to copy: %s', e)
 
1089
        else:
 
1090
            if parent:
 
1091
                destination.set_parent(parent)
 
1092
        if self._push_should_merge_tags():
 
1093
            self.tags.merge_to(destination.tags)
1334
1094
 
1335
1095
    def update_references(self, target):
1336
1096
        if not getattr(self._format, 'supports_reference_locations', False):
1350
1110
        target._set_all_reference_info(target_reference_dict)
1351
1111
 
1352
1112
    @needs_read_lock
1353
 
    def check(self, refs):
 
1113
    def check(self):
1354
1114
        """Check consistency of the branch.
1355
1115
 
1356
1116
        In particular this checks that revisions given in the revision-history
1359
1119
 
1360
1120
        Callers will typically also want to check the repository.
1361
1121
 
1362
 
        :param refs: Calculated refs for this branch as specified by
1363
 
            branch._get_check_refs()
1364
1122
        :return: A BranchCheckResult.
1365
1123
        """
1366
 
        result = BranchCheckResult(self)
 
1124
        mainline_parent_id = None
1367
1125
        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
 
1126
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1127
                                last_revision_id))
 
1128
        real_rev_history.reverse()
 
1129
        if len(real_rev_history) != last_revno:
 
1130
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1131
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1132
        # TODO: We should probably also check that real_rev_history actually
 
1133
        #       matches self.revision_history()
 
1134
        for revision_id in real_rev_history:
 
1135
            try:
 
1136
                revision = self.repository.get_revision(revision_id)
 
1137
            except errors.NoSuchRevision, e:
 
1138
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1139
                            % revision_id)
 
1140
            # In general the first entry on the revision history has no parents.
 
1141
            # But it's not illegal for it to have parents listed; this can happen
 
1142
            # in imports from Arch when the parents weren't reachable.
 
1143
            if mainline_parent_id is not None:
 
1144
                if mainline_parent_id not in revision.parent_ids:
 
1145
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1146
                                        "parents of {%s}"
 
1147
                                        % (mainline_parent_id, revision_id))
 
1148
            mainline_parent_id = revision_id
 
1149
        return BranchCheckResult(self)
1379
1150
 
1380
1151
    def _get_checkout_format(self):
1381
1152
        """Return the most suitable metadir for a checkout of this branch.
1382
1153
        Weaves are used if this branch's repository uses weaves.
1383
1154
        """
1384
 
        format = self.repository.bzrdir.checkout_metadir()
1385
 
        format.set_branch_format(self._format)
 
1155
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1156
            from bzrlib.repofmt import weaverepo
 
1157
            format = bzrdir.BzrDirMetaFormat1()
 
1158
            format.repository_format = weaverepo.RepositoryFormat7()
 
1159
        else:
 
1160
            format = self.repository.bzrdir.checkout_metadir()
 
1161
            format.set_branch_format(self._format)
1386
1162
        return format
1387
1163
 
1388
1164
    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):
 
1165
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1391
1166
        """Create a clone of this branch and its bzrdir.
1392
1167
 
1393
1168
        :param to_transport: The transport to clone onto.
1400
1175
        """
1401
1176
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1402
1177
        # 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
1178
        if revision_id is None:
1406
1179
            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)
 
1180
        try:
 
1181
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1182
                revision_id=revision_id, stacked_on=stacked_on,
 
1183
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1184
        except errors.FileExists:
 
1185
            if not use_existing_dir:
 
1186
                raise
 
1187
        except errors.NoSuchFile:
 
1188
            if not create_prefix:
 
1189
                raise
1411
1190
        return dir_to.open_branch()
1412
1191
 
1413
1192
    def create_checkout(self, to_location, revision_id=None,
1418
1197
        :param to_location: The url to produce the checkout at
1419
1198
        :param revision_id: The revision to check out
1420
1199
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1421
 
            produce a bound branch (heavyweight checkout)
 
1200
        produce a bound branch (heavyweight checkout)
1422
1201
        :param accelerator_tree: A tree which can be used for retrieving file
1423
1202
            contents more quickly than the revision tree, i.e. a workingtree.
1424
1203
            The revision tree will be used for cases where accelerator_tree's
1432
1211
        if lightweight:
1433
1212
            format = self._get_checkout_format()
1434
1213
            checkout = format.initialize_on_transport(t)
1435
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1436
 
                target_branch=self)
 
1214
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1437
1215
        else:
1438
1216
            format = self._get_checkout_format()
1439
1217
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1470
1248
 
1471
1249
    def reference_parent(self, file_id, path, possible_transports=None):
1472
1250
        """Return the parent branch for a tree-reference file_id
1473
 
 
1474
1251
        :param file_id: The file_id of the tree reference
1475
1252
        :param path: The path of the file_id in the tree
1476
1253
        :return: A branch associated with the file_id
1482
1259
    def supports_tags(self):
1483
1260
        return self._format.supports_tags()
1484
1261
 
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
1262
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1498
1263
                                         other_branch):
1499
1264
        """Ensure that revision_b is a descendant of revision_a.
1529
1294
        else:
1530
1295
            raise AssertionError("invalid heads: %r" % (heads,))
1531
1296
 
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):
 
1297
 
 
1298
class BranchFormat(object):
1559
1299
    """An encapsulation of the initialization and open routines for a format.
1560
1300
 
1561
1301
    Formats provide three things:
1564
1304
     * an open routine.
1565
1305
 
1566
1306
    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
 
1307
    during branch opening. Its not required that these be instances, they
1568
1308
    can be classes themselves with class methods - it simply depends on
1569
1309
    whether state is needed for a given format or not.
1570
1310
 
1573
1313
    object will be created every time regardless.
1574
1314
    """
1575
1315
 
1576
 
    can_set_append_revisions_only = True
 
1316
    _default_format = None
 
1317
    """The default format used for new branches."""
 
1318
 
 
1319
    _formats = {}
 
1320
    """The known formats."""
1577
1321
 
1578
1322
    def __eq__(self, other):
1579
1323
        return self.__class__ is other.__class__
1582
1326
        return not (self == other)
1583
1327
 
1584
1328
    @classmethod
1585
 
    def find_format(klass, a_bzrdir, name=None):
 
1329
    def find_format(klass, a_bzrdir):
1586
1330
        """Return the format for the branch object in a_bzrdir."""
1587
1331
        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)
 
1332
            transport = a_bzrdir.get_branch_transport(None)
 
1333
            format_string = transport.get("format").read()
 
1334
            return klass._formats[format_string]
1591
1335
        except errors.NoSuchFile:
1592
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1336
            raise errors.NotBranchError(path=transport.base)
1593
1337
        except KeyError:
1594
1338
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1595
1339
 
1596
1340
    @classmethod
1597
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1598
1341
    def get_default_format(klass):
1599
1342
        """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):
 
1343
        return klass._default_format
 
1344
 
 
1345
    def get_reference(self, a_bzrdir):
1613
1346
        """Get the target reference of the branch in a_bzrdir.
1614
1347
 
1615
1348
        format probing must have been completed before calling
1617
1350
        in a_bzrdir is correct.
1618
1351
 
1619
1352
        :param a_bzrdir: The bzrdir to get the branch data from.
1620
 
        :param name: Name of the colocated branch to fetch
1621
1353
        :return: None if the branch is not a reference branch.
1622
1354
        """
1623
1355
        return None
1624
1356
 
1625
1357
    @classmethod
1626
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1358
    def set_reference(self, a_bzrdir, to_branch):
1627
1359
        """Set the target reference of the branch in a_bzrdir.
1628
1360
 
1629
1361
        format probing must have been completed before calling
1631
1363
        in a_bzrdir is correct.
1632
1364
 
1633
1365
        :param a_bzrdir: The bzrdir to set the branch reference for.
1634
 
        :param name: Name of colocated branch to set, None for default
1635
1366
        :param to_branch: branch that the checkout is to reference
1636
1367
        """
1637
1368
        raise NotImplementedError(self.set_reference)
1644
1375
        """Return the short format description for this format."""
1645
1376
        raise NotImplementedError(self.get_format_description)
1646
1377
 
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)
 
1378
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1379
                           set_format=True):
 
1380
        """Initialize a branch in a bzrdir, with specified files
1654
1381
 
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.
 
1382
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1383
        :param utf8_files: The files to create as a list of
 
1384
            (filename, content) tuples
 
1385
        :param set_format: If True, set the format with
 
1386
            self.get_format_string.  (BzrBranch4 has its format set
 
1387
            elsewhere)
 
1388
        :return: a branch in this format
1659
1389
        """
 
1390
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1391
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1392
        lock_map = {
 
1393
            'metadir': ('lock', lockdir.LockDir),
 
1394
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1395
        }
 
1396
        lock_name, lock_class = lock_map[lock_type]
 
1397
        control_files = lockable_files.LockableFiles(branch_transport,
 
1398
            lock_name, lock_class)
 
1399
        control_files.create_lock()
 
1400
        control_files.lock_write()
 
1401
        if set_format:
 
1402
            utf8_files += [('format', self.get_format_string())]
 
1403
        try:
 
1404
            for (filename, content) in utf8_files:
 
1405
                branch_transport.put_bytes(
 
1406
                    filename, content,
 
1407
                    mode=a_bzrdir._get_file_mode())
 
1408
        finally:
 
1409
            control_files.unlock()
 
1410
        return self.open(a_bzrdir, _found=True)
 
1411
 
 
1412
    def initialize(self, a_bzrdir):
 
1413
        """Create a branch of this format in a_bzrdir."""
1660
1414
        raise NotImplementedError(self.initialize)
1661
1415
 
1662
1416
    def is_supported(self):
1692
1446
        """
1693
1447
        raise NotImplementedError(self.network_name)
1694
1448
 
1695
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1696
 
            found_repository=None):
 
1449
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1697
1450
        """Return the branch object for a_bzrdir
1698
1451
 
1699
1452
        :param a_bzrdir: A BzrDir that contains a branch.
1700
 
        :param name: Name of colocated branch to open
1701
1453
        :param _found: a private parameter, do not use it. It is used to
1702
1454
            indicate if format probing has already be done.
1703
1455
        :param ignore_fallbacks: when set, no fallback branches will be opened
1706
1458
        raise NotImplementedError(self.open)
1707
1459
 
1708
1460
    @classmethod
1709
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1710
1461
    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)
 
1462
        """Register a metadir format."""
 
1463
        klass._formats[format.get_format_string()] = format
 
1464
        # Metadir formats have a network name of their format string, and get
 
1465
        # registered as class factories.
 
1466
        network_format_registry.register(format.get_format_string(), format.__class__)
1717
1467
 
1718
1468
    @classmethod
1719
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1720
1469
    def set_default_format(klass, format):
1721
 
        format_registry.set_default(format)
1722
 
 
1723
 
    def supports_set_append_revisions_only(self):
1724
 
        """True if this format supports set_append_revisions_only."""
1725
 
        return False
 
1470
        klass._default_format = format
1726
1471
 
1727
1472
    def supports_stacking(self):
1728
1473
        """True if this format records a stacked-on branch."""
1729
1474
        return False
1730
1475
 
1731
 
    def supports_leaving_lock(self):
1732
 
        """True if this format supports leaving locks in place."""
1733
 
        return False # by default
1734
 
 
1735
1476
    @classmethod
1736
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1737
1477
    def unregister_format(klass, format):
1738
 
        format_registry.remove(format)
 
1478
        del klass._formats[format.get_format_string()]
1739
1479
 
1740
1480
    def __str__(self):
1741
1481
        return self.get_format_description().rstrip()
1745
1485
        return False  # by default
1746
1486
 
1747
1487
 
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
1488
class BranchHooks(Hooks):
1777
1489
    """A dictionary mapping hook name to a list of callables for branch hooks.
1778
1490
 
1786
1498
        These are all empty initially, because by default nothing should get
1787
1499
        notified.
1788
1500
        """
1789
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1790
 
        self.add_hook('set_rh',
 
1501
        Hooks.__init__(self)
 
1502
        self.create_hook(HookPoint('set_rh',
1791
1503
            "Invoked whenever the revision history has been set via "
1792
1504
            "set_revision_history. The api signature is (branch, "
1793
1505
            "revision_history), and the branch will be write-locked. "
1794
1506
            "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',
 
1507
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1508
        self.create_hook(HookPoint('open',
1797
1509
            "Called with the Branch object that has been opened after a "
1798
 
            "branch is opened.", (1, 8))
1799
 
        self.add_hook('post_push',
 
1510
            "branch is opened.", (1, 8), None))
 
1511
        self.create_hook(HookPoint('post_push',
1800
1512
            "Called after a push operation completes. post_push is called "
1801
1513
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1802
 
            "bzr client.", (0, 15))
1803
 
        self.add_hook('post_pull',
 
1514
            "bzr client.", (0, 15), None))
 
1515
        self.create_hook(HookPoint('post_pull',
1804
1516
            "Called after a pull operation completes. post_pull is called "
1805
1517
            "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 "
 
1518
            "bzr client.", (0, 15), None))
 
1519
        self.create_hook(HookPoint('pre_commit',
 
1520
            "Called after a commit is calculated but before it is is "
1809
1521
            "completed. pre_commit is called with (local, master, old_revno, "
1810
1522
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1811
1523
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1813
1525
            "basis revision. hooks MUST NOT modify this delta. "
1814
1526
            " future_tree is an in-memory tree obtained from "
1815
1527
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1816
 
            "tree.", (0,91))
1817
 
        self.add_hook('post_commit',
 
1528
            "tree.", (0,91), None))
 
1529
        self.create_hook(HookPoint('post_commit',
1818
1530
            "Called in the bzr client after a commit has completed. "
1819
1531
            "post_commit is called with (local, master, old_revno, old_revid, "
1820
1532
            "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',
 
1533
            "commit to a branch.", (0, 15), None))
 
1534
        self.create_hook(HookPoint('post_uncommit',
1823
1535
            "Called in the bzr client after an uncommit completes. "
1824
1536
            "post_uncommit is called with (local, master, old_revno, "
1825
1537
            "old_revid, new_revno, new_revid) where local is the local branch "
1826
1538
            "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',
 
1539
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1540
        self.create_hook(HookPoint('pre_change_branch_tip',
1829
1541
            "Called in bzr client and server before a change to the tip of a "
1830
1542
            "branch is made. pre_change_branch_tip is called with a "
1831
1543
            "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',
 
1544
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1545
        self.create_hook(HookPoint('post_change_branch_tip',
1834
1546
            "Called in bzr client and server after a change to the tip of a "
1835
1547
            "branch is made. post_change_branch_tip is called with a "
1836
1548
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1837
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1838
 
        self.add_hook('transform_fallback_location',
 
1549
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1550
        self.create_hook(HookPoint('transform_fallback_location',
1839
1551
            "Called when a stacked branch is activating its fallback "
1840
1552
            "locations. transform_fallback_location is called with (branch, "
1841
1553
            "url), and should return a new url. Returning the same url "
1846
1558
            "fallback locations have not been activated. When there are "
1847
1559
            "multiple hooks installed for transform_fallback_location, "
1848
1560
            "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
 
 
 
1561
            "The order is however undefined.", (1, 9), None))
1867
1562
 
1868
1563
 
1869
1564
# install the default hooks into the Branch class.
1871
1566
 
1872
1567
 
1873
1568
class ChangeBranchTipParams(object):
1874
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1569
    """Object holding parameters passed to *_change_branch_tip hooks.
1875
1570
 
1876
1571
    There are 5 fields that hooks may wish to access:
1877
1572
 
1908
1603
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1909
1604
 
1910
1605
 
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)
 
1606
class BzrBranchFormat4(BranchFormat):
 
1607
    """Bzr branch format 4.
 
1608
 
 
1609
    This format has:
 
1610
     - a revision-history file.
 
1611
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1612
    """
 
1613
 
 
1614
    def get_format_description(self):
 
1615
        """See BranchFormat.get_format_description()."""
 
1616
        return "Branch format 4"
 
1617
 
 
1618
    def initialize(self, a_bzrdir):
 
1619
        """Create a branch of this format in a_bzrdir."""
 
1620
        utf8_files = [('revision-history', ''),
 
1621
                      ('branch-name', ''),
 
1622
                      ]
 
1623
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1624
                                       lock_type='branch4', set_format=False)
 
1625
 
 
1626
    def __init__(self):
 
1627
        super(BzrBranchFormat4, self).__init__()
 
1628
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1629
 
 
1630
    def network_name(self):
 
1631
        """The network name for this format is the control dirs disk label."""
 
1632
        return self._matchingbzrdir.get_format_string()
 
1633
 
 
1634
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1635
        """See BranchFormat.open()."""
 
1636
        if not _found:
 
1637
            # we are being called directly and must probe.
 
1638
            raise NotImplementedError
 
1639
        return BzrBranch(_format=self,
 
1640
                         _control_files=a_bzrdir._control_files,
 
1641
                         a_bzrdir=a_bzrdir,
 
1642
                         _repository=a_bzrdir.open_repository())
 
1643
 
 
1644
    def __str__(self):
 
1645
        return "Bazaar-NG branch format 4"
1982
1646
 
1983
1647
 
1984
1648
class BranchFormatMetadir(BranchFormat):
1988
1652
        """What class to instantiate on open calls."""
1989
1653
        raise NotImplementedError(self._branch_class)
1990
1654
 
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
1655
    def network_name(self):
2021
1656
        """A simple byte string uniquely identifying this format for RPC calls.
2022
1657
 
2024
1659
        """
2025
1660
        return self.get_format_string()
2026
1661
 
2027
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2028
 
            found_repository=None):
 
1662
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2029
1663
        """See BranchFormat.open()."""
2030
1664
        if not _found:
2031
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1665
            format = BranchFormat.find_format(a_bzrdir)
2032
1666
            if format.__class__ != self.__class__:
2033
1667
                raise AssertionError("wrong format %r found for %r" %
2034
1668
                    (format, self))
2035
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2036
1669
        try:
 
1670
            transport = a_bzrdir.get_branch_transport(None)
2037
1671
            control_files = lockable_files.LockableFiles(transport, 'lock',
2038
1672
                                                         lockdir.LockDir)
2039
 
            if found_repository is None:
2040
 
                found_repository = a_bzrdir.find_repository()
2041
1673
            return self._branch_class()(_format=self,
2042
1674
                              _control_files=control_files,
2043
 
                              name=name,
2044
1675
                              a_bzrdir=a_bzrdir,
2045
 
                              _repository=found_repository,
 
1676
                              _repository=a_bzrdir.find_repository(),
2046
1677
                              ignore_fallbacks=ignore_fallbacks)
2047
1678
        except errors.NoSuchFile:
2048
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1679
            raise errors.NotBranchError(path=transport.base)
2049
1680
 
2050
1681
    def __init__(self):
2051
1682
        super(BranchFormatMetadir, self).__init__()
2055
1686
    def supports_tags(self):
2056
1687
        return True
2057
1688
 
2058
 
    def supports_leaving_lock(self):
2059
 
        return True
2060
 
 
2061
1689
 
2062
1690
class BzrBranchFormat5(BranchFormatMetadir):
2063
1691
    """Bzr branch format 5.
2083
1711
        """See BranchFormat.get_format_description()."""
2084
1712
        return "Branch format 5"
2085
1713
 
2086
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1714
    def initialize(self, a_bzrdir):
2087
1715
        """Create a branch of this format in a_bzrdir."""
2088
1716
        utf8_files = [('revision-history', ''),
2089
1717
                      ('branch-name', ''),
2090
1718
                      ]
2091
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1719
        return self._initialize_helper(a_bzrdir, utf8_files)
2092
1720
 
2093
1721
    def supports_tags(self):
2094
1722
        return False
2116
1744
        """See BranchFormat.get_format_description()."""
2117
1745
        return "Branch format 6"
2118
1746
 
2119
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1747
    def initialize(self, a_bzrdir):
2120
1748
        """Create a branch of this format in a_bzrdir."""
2121
1749
        utf8_files = [('last-revision', '0 null:\n'),
2122
1750
                      ('branch.conf', ''),
2123
1751
                      ('tags', ''),
2124
1752
                      ]
2125
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1753
        return self._initialize_helper(a_bzrdir, utf8_files)
2126
1754
 
2127
1755
    def make_tags(self, branch):
2128
1756
        """See bzrlib.branch.BranchFormat.make_tags()."""
2129
1757
        return BasicTags(branch)
2130
1758
 
2131
 
    def supports_set_append_revisions_only(self):
2132
 
        return True
2133
1759
 
2134
1760
 
2135
1761
class BzrBranchFormat8(BranchFormatMetadir):
2146
1772
        """See BranchFormat.get_format_description()."""
2147
1773
        return "Branch format 8"
2148
1774
 
2149
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1775
    def initialize(self, a_bzrdir):
2150
1776
        """Create a branch of this format in a_bzrdir."""
2151
1777
        utf8_files = [('last-revision', '0 null:\n'),
2152
1778
                      ('branch.conf', ''),
2153
1779
                      ('tags', ''),
2154
1780
                      ('references', '')
2155
1781
                      ]
2156
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1782
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1783
 
 
1784
    def __init__(self):
 
1785
        super(BzrBranchFormat8, self).__init__()
 
1786
        self._matchingbzrdir.repository_format = \
 
1787
            RepositoryFormatKnitPack5RichRoot()
2157
1788
 
2158
1789
    def make_tags(self, branch):
2159
1790
        """See bzrlib.branch.BranchFormat.make_tags()."""
2160
1791
        return BasicTags(branch)
2161
1792
 
2162
 
    def supports_set_append_revisions_only(self):
2163
 
        return True
2164
 
 
2165
1793
    def supports_stacking(self):
2166
1794
        return True
2167
1795
 
2168
1796
    supports_reference_locations = True
2169
1797
 
2170
1798
 
2171
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1799
class BzrBranchFormat7(BzrBranchFormat8):
2172
1800
    """Branch format with last-revision, tags, and a stacked location pointer.
2173
1801
 
2174
1802
    The stacked location pointer is passed down to the repository and requires
2177
1805
    This format was introduced in bzr 1.6.
2178
1806
    """
2179
1807
 
2180
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1808
    def initialize(self, a_bzrdir):
2181
1809
        """Create a branch of this format in a_bzrdir."""
2182
1810
        utf8_files = [('last-revision', '0 null:\n'),
2183
1811
                      ('branch.conf', ''),
2184
1812
                      ('tags', ''),
2185
1813
                      ]
2186
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1814
        return self._initialize_helper(a_bzrdir, utf8_files)
2187
1815
 
2188
1816
    def _branch_class(self):
2189
1817
        return BzrBranch7
2196
1824
        """See BranchFormat.get_format_description()."""
2197
1825
        return "Branch format 7"
2198
1826
 
2199
 
    def supports_set_append_revisions_only(self):
2200
 
        return True
2201
 
 
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
1827
    supports_reference_locations = False
2210
1828
 
2211
1829
 
2228
1846
        """See BranchFormat.get_format_description()."""
2229
1847
        return "Checkout reference format 1"
2230
1848
 
2231
 
    def get_reference(self, a_bzrdir, name=None):
 
1849
    def get_reference(self, a_bzrdir):
2232
1850
        """See BranchFormat.get_reference()."""
2233
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2234
 
        return transport.get_bytes('location')
 
1851
        transport = a_bzrdir.get_branch_transport(None)
 
1852
        return transport.get('location').read()
2235
1853
 
2236
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1854
    def set_reference(self, a_bzrdir, to_branch):
2237
1855
        """See BranchFormat.set_reference()."""
2238
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1856
        transport = a_bzrdir.get_branch_transport(None)
2239
1857
        location = transport.put_bytes('location', to_branch.base)
2240
1858
 
2241
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2242
 
            repository=None):
 
1859
    def initialize(self, a_bzrdir, target_branch=None):
2243
1860
        """Create a branch of this format in a_bzrdir."""
2244
1861
        if target_branch is None:
2245
1862
            # this format does not implement branch itself, thus the implicit
2246
1863
            # creation contract must see it as uninitializable
2247
1864
            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)
 
1865
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1866
        branch_transport = a_bzrdir.get_branch_transport(self)
2250
1867
        branch_transport.put_bytes('location',
2251
 
            target_branch.bzrdir.user_url)
 
1868
            target_branch.bzrdir.root_transport.base)
2252
1869
        branch_transport.put_bytes('format', self.get_format_string())
2253
 
        branch = self.open(
2254
 
            a_bzrdir, name, _found=True,
 
1870
        return self.open(
 
1871
            a_bzrdir, _found=True,
2255
1872
            possible_transports=[target_branch.bzrdir.root_transport])
2256
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2257
 
        return branch
2258
1873
 
2259
1874
    def __init__(self):
2260
1875
        super(BranchReferenceFormat, self).__init__()
2266
1881
        def clone(to_bzrdir, revision_id=None,
2267
1882
            repository_policy=None):
2268
1883
            """See Branch.clone()."""
2269
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1884
            return format.initialize(to_bzrdir, a_branch)
2270
1885
            # cannot obey revision_id limits when cloning a reference ...
2271
1886
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2272
1887
            # emit some sort of warning/error to the caller ?!
2273
1888
        return clone
2274
1889
 
2275
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2276
 
             possible_transports=None, ignore_fallbacks=False,
2277
 
             found_repository=None):
 
1890
    def open(self, a_bzrdir, _found=False, location=None,
 
1891
             possible_transports=None, ignore_fallbacks=False):
2278
1892
        """Return the branch that the branch reference in a_bzrdir points at.
2279
1893
 
2280
1894
        :param a_bzrdir: A BzrDir that contains a branch.
2281
 
        :param name: Name of colocated branch to open, if any
2282
1895
        :param _found: a private parameter, do not use it. It is used to
2283
1896
            indicate if format probing has already be done.
2284
1897
        :param ignore_fallbacks: when set, no fallback branches will be opened
2289
1902
        :param possible_transports: An optional reusable transports list.
2290
1903
        """
2291
1904
        if not _found:
2292
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1905
            format = BranchFormat.find_format(a_bzrdir)
2293
1906
            if format.__class__ != self.__class__:
2294
1907
                raise AssertionError("wrong format %r found for %r" %
2295
1908
                    (format, self))
2296
1909
        if location is None:
2297
 
            location = self.get_reference(a_bzrdir, name)
 
1910
            location = self.get_reference(a_bzrdir)
2298
1911
        real_bzrdir = bzrdir.BzrDir.open(
2299
1912
            location, possible_transports=possible_transports)
2300
 
        result = real_bzrdir.open_branch(name=name, 
2301
 
            ignore_fallbacks=ignore_fallbacks)
 
1913
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2302
1914
        # this changes the behaviour of result.clone to create a new reference
2303
1915
        # rather than a copy of the content of the branch.
2304
1916
        # I did not use a proxy object because that needs much more extensive
2311
1923
        return result
2312
1924
 
2313
1925
 
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
1926
network_format_registry = registry.FormatRegistry()
2329
1927
"""Registry of formats indexed by their network name.
2330
1928
 
2333
1931
BranchFormat.network_name() for more detail.
2334
1932
"""
2335
1933
 
2336
 
format_registry = BranchFormatRegistry(network_format_registry)
2337
 
 
2338
1934
 
2339
1935
# formats which have no format string are not discoverable
2340
1936
# and not independently creatable, so are not registered.
2342
1938
__format6 = BzrBranchFormat6()
2343
1939
__format7 = BzrBranchFormat7()
2344
1940
__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):
 
1941
BranchFormat.register_format(__format5)
 
1942
BranchFormat.register_format(BranchReferenceFormat())
 
1943
BranchFormat.register_format(__format6)
 
1944
BranchFormat.register_format(__format7)
 
1945
BranchFormat.register_format(__format8)
 
1946
BranchFormat.set_default_format(__format6)
 
1947
_legacy_formats = [BzrBranchFormat4(),
 
1948
    ]
 
1949
network_format_registry.register(
 
1950
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
1951
 
 
1952
 
 
1953
class BzrBranch(Branch):
2371
1954
    """A branch stored in the actual filesystem.
2372
1955
 
2373
1956
    Note that it's "local" in the context of the filesystem; it doesn't
2379
1962
    :ivar repository: Repository for this branch.
2380
1963
    :ivar base: The url of the base directory for this branch; the one
2381
1964
        containing the .bzr directory.
2382
 
    :ivar name: Optional colocated branch name as it exists in the control
2383
 
        directory.
2384
1965
    """
2385
1966
 
2386
1967
    def __init__(self, _format=None,
2387
 
                 _control_files=None, a_bzrdir=None, name=None,
2388
 
                 _repository=None, ignore_fallbacks=False):
 
1968
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1969
                 ignore_fallbacks=False):
2389
1970
        """Create new branch object at a particular location."""
2390
1971
        if a_bzrdir is None:
2391
1972
            raise ValueError('a_bzrdir must be supplied')
2392
1973
        else:
2393
1974
            self.bzrdir = a_bzrdir
2394
1975
        self._base = self.bzrdir.transport.clone('..').base
2395
 
        self.name = name
2396
1976
        # XXX: We should be able to just do
2397
1977
        #   self.base = self.bzrdir.root_transport.base
2398
1978
        # but this does not quite work yet -- mbp 20080522
2405
1985
        Branch.__init__(self)
2406
1986
 
2407
1987
    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)
 
1988
        return '%s(%r)' % (self.__class__.__name__, self.base)
2413
1989
 
2414
1990
    __repr__ = __str__
2415
1991
 
2426
2002
        return self.control_files.is_locked()
2427
2003
 
2428
2004
    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
2005
        # All-in-one needs to always unlock/lock.
2438
2006
        repo_control = getattr(self.repository, 'control_files', None)
2439
2007
        if self.control_files == repo_control or not self.is_locked():
2440
 
            self.repository._warn_if_deprecated(self)
2441
2008
            self.repository.lock_write()
2442
2009
            took_lock = True
2443
2010
        else:
2444
2011
            took_lock = False
2445
2012
        try:
2446
 
            return BranchWriteLockResult(self.unlock,
2447
 
                self.control_files.lock_write(token=token))
 
2013
            return self.control_files.lock_write(token=token)
2448
2014
        except:
2449
2015
            if took_lock:
2450
2016
                self.repository.unlock()
2451
2017
            raise
2452
2018
 
2453
2019
    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
2020
        # All-in-one needs to always unlock/lock.
2461
2021
        repo_control = getattr(self.repository, 'control_files', None)
2462
2022
        if self.control_files == repo_control or not self.is_locked():
2463
 
            self.repository._warn_if_deprecated(self)
2464
2023
            self.repository.lock_read()
2465
2024
            took_lock = True
2466
2025
        else:
2467
2026
            took_lock = False
2468
2027
        try:
2469
2028
            self.control_files.lock_read()
2470
 
            return LogicalLockResult(self.unlock)
2471
2029
        except:
2472
2030
            if took_lock:
2473
2031
                self.repository.unlock()
2474
2032
            raise
2475
2033
 
2476
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2477
2034
    def unlock(self):
2478
2035
        try:
2479
2036
            self.control_files.unlock()
2501
2058
        """See Branch.print_file."""
2502
2059
        return self.repository.print_file(file, revision_id)
2503
2060
 
 
2061
    def _write_revision_history(self, history):
 
2062
        """Factored out of set_revision_history.
 
2063
 
 
2064
        This performs the actual writing to disk.
 
2065
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2066
        self._transport.put_bytes(
 
2067
            'revision-history', '\n'.join(history),
 
2068
            mode=self.bzrdir._get_file_mode())
 
2069
 
 
2070
    @needs_write_lock
 
2071
    def set_revision_history(self, rev_history):
 
2072
        """See Branch.set_revision_history."""
 
2073
        if 'evil' in debug.debug_flags:
 
2074
            mutter_callsite(3, "set_revision_history scales with history.")
 
2075
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2076
        for rev_id in rev_history:
 
2077
            check_not_reserved_id(rev_id)
 
2078
        if Branch.hooks['post_change_branch_tip']:
 
2079
            # Don't calculate the last_revision_info() if there are no hooks
 
2080
            # that will use it.
 
2081
            old_revno, old_revid = self.last_revision_info()
 
2082
        if len(rev_history) == 0:
 
2083
            revid = _mod_revision.NULL_REVISION
 
2084
        else:
 
2085
            revid = rev_history[-1]
 
2086
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2087
        self._write_revision_history(rev_history)
 
2088
        self._clear_cached_state()
 
2089
        self._cache_revision_history(rev_history)
 
2090
        for hook in Branch.hooks['set_rh']:
 
2091
            hook(self, rev_history)
 
2092
        if Branch.hooks['post_change_branch_tip']:
 
2093
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2094
 
 
2095
    def _synchronize_history(self, destination, revision_id):
 
2096
        """Synchronize last revision and revision history between branches.
 
2097
 
 
2098
        This version is most efficient when the destination is also a
 
2099
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2100
        history is the true lefthand parent history, and all of the revisions
 
2101
        are in the destination's repository.  If not, set_revision_history
 
2102
        will fail.
 
2103
 
 
2104
        :param destination: The branch to copy the history into
 
2105
        :param revision_id: The revision-id to truncate history at.  May
 
2106
          be None to copy complete history.
 
2107
        """
 
2108
        if not isinstance(destination._format, BzrBranchFormat5):
 
2109
            super(BzrBranch, self)._synchronize_history(
 
2110
                destination, revision_id)
 
2111
            return
 
2112
        if revision_id == _mod_revision.NULL_REVISION:
 
2113
            new_history = []
 
2114
        else:
 
2115
            new_history = self.revision_history()
 
2116
        if revision_id is not None and new_history != []:
 
2117
            try:
 
2118
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2119
            except ValueError:
 
2120
                rev = self.repository.get_revision(revision_id)
 
2121
                new_history = rev.get_history(self.repository)[1:]
 
2122
        destination.set_revision_history(new_history)
 
2123
 
2504
2124
    @needs_write_lock
2505
2125
    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)
 
2126
        """Set the last revision of this branch.
 
2127
 
 
2128
        The caller is responsible for checking that the revno is correct
 
2129
        for this revision id.
 
2130
 
 
2131
        It may be possible to set the branch last revision to an id not
 
2132
        present in the repository.  However, branches can also be
 
2133
        configured to check constraints on history, in which case this may not
 
2134
        be permitted.
 
2135
        """
2508
2136
        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)
 
2137
        # this old format stores the full history, but this api doesn't
 
2138
        # provide it, so we must generate, and might as well check it's
 
2139
        # correct
 
2140
        history = self._lefthand_history(revision_id)
 
2141
        if len(history) != revno:
 
2142
            raise AssertionError('%d != %d' % (len(history), revno))
 
2143
        self.set_revision_history(history)
 
2144
 
 
2145
    def _gen_revision_history(self):
 
2146
        history = self._transport.get_bytes('revision-history').split('\n')
 
2147
        if history[-1:] == ['']:
 
2148
            # There shouldn't be a trailing newline, but just in case.
 
2149
            history.pop()
 
2150
        return history
 
2151
 
 
2152
    @needs_write_lock
 
2153
    def generate_revision_history(self, revision_id, last_rev=None,
 
2154
        other_branch=None):
 
2155
        """Create a new revision history that will finish with revision_id.
 
2156
 
 
2157
        :param revision_id: the new tip to use.
 
2158
        :param last_rev: The previous last_revision. If not None, then this
 
2159
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2160
        :param other_branch: The other branch that DivergedBranches should
 
2161
            raise with respect to.
 
2162
        """
 
2163
        self.set_revision_history(self._lefthand_history(revision_id,
 
2164
            last_rev, other_branch))
2517
2165
 
2518
2166
    def basis_tree(self):
2519
2167
        """See Branch.basis_tree."""
2520
2168
        return self.repository.revision_tree(self.last_revision())
2521
2169
 
 
2170
    @needs_write_lock
 
2171
    def pull(self, source, overwrite=False, stop_revision=None,
 
2172
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2173
             _override_hook_target=None):
 
2174
        """See Branch.pull.
 
2175
 
 
2176
        :param _hook_master: Private parameter - set the branch to
 
2177
            be supplied as the master to pull hooks.
 
2178
        :param run_hooks: Private parameter - if false, this branch
 
2179
            is being called because it's the master of the primary branch,
 
2180
            so it should not run its hooks.
 
2181
        :param _override_hook_target: Private parameter - set the branch to be
 
2182
            supplied as the target_branch to pull hooks.
 
2183
        """
 
2184
        result = PullResult()
 
2185
        result.source_branch = source
 
2186
        if _override_hook_target is None:
 
2187
            result.target_branch = self
 
2188
        else:
 
2189
            result.target_branch = _override_hook_target
 
2190
        source.lock_read()
 
2191
        try:
 
2192
            # We assume that during 'pull' the local repository is closer than
 
2193
            # the remote one.
 
2194
            source.update_references(self)
 
2195
            graph = self.repository.get_graph(source.repository)
 
2196
            result.old_revno, result.old_revid = self.last_revision_info()
 
2197
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2198
                                  graph=graph)
 
2199
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2200
            result.new_revno, result.new_revid = self.last_revision_info()
 
2201
            if _hook_master:
 
2202
                result.master_branch = _hook_master
 
2203
                result.local_branch = result.target_branch
 
2204
            else:
 
2205
                result.master_branch = result.target_branch
 
2206
                result.local_branch = None
 
2207
            if run_hooks:
 
2208
                for hook in Branch.hooks['post_pull']:
 
2209
                    hook(result)
 
2210
        finally:
 
2211
            source.unlock()
 
2212
        return result
 
2213
 
2522
2214
    def _get_parent_location(self):
2523
2215
        _locs = ['parent', 'pull', 'x-pull']
2524
2216
        for l in _locs:
2528
2220
                pass
2529
2221
        return None
2530
2222
 
 
2223
    @needs_read_lock
 
2224
    def push(self, target, overwrite=False, stop_revision=None,
 
2225
             _override_hook_source_branch=None):
 
2226
        """See Branch.push.
 
2227
 
 
2228
        This is the basic concrete implementation of push()
 
2229
 
 
2230
        :param _override_hook_source_branch: If specified, run
 
2231
        the hooks passing this Branch as the source, rather than self.
 
2232
        This is for use of RemoteBranch, where push is delegated to the
 
2233
        underlying vfs-based Branch.
 
2234
        """
 
2235
        # TODO: Public option to disable running hooks - should be trivial but
 
2236
        # needs tests.
 
2237
        return _run_with_write_locked_target(
 
2238
            target, self._push_with_bound_branches, target, overwrite,
 
2239
            stop_revision,
 
2240
            _override_hook_source_branch=_override_hook_source_branch)
 
2241
 
 
2242
    def _push_with_bound_branches(self, target, overwrite,
 
2243
            stop_revision,
 
2244
            _override_hook_source_branch=None):
 
2245
        """Push from self into target, and into target's master if any.
 
2246
 
 
2247
        This is on the base BzrBranch class even though it doesn't support
 
2248
        bound branches because the *target* might be bound.
 
2249
        """
 
2250
        def _run_hooks():
 
2251
            if _override_hook_source_branch:
 
2252
                result.source_branch = _override_hook_source_branch
 
2253
            for hook in Branch.hooks['post_push']:
 
2254
                hook(result)
 
2255
 
 
2256
        bound_location = target.get_bound_location()
 
2257
        if bound_location and target.base != bound_location:
 
2258
            # there is a master branch.
 
2259
            #
 
2260
            # XXX: Why the second check?  Is it even supported for a branch to
 
2261
            # be bound to itself? -- mbp 20070507
 
2262
            master_branch = target.get_master_branch()
 
2263
            master_branch.lock_write()
 
2264
            try:
 
2265
                # push into the master from this branch.
 
2266
                self._basic_push(master_branch, overwrite, stop_revision)
 
2267
                # and push into the target branch from this. Note that we push from
 
2268
                # this branch again, because its considered the highest bandwidth
 
2269
                # repository.
 
2270
                result = self._basic_push(target, overwrite, stop_revision)
 
2271
                result.master_branch = master_branch
 
2272
                result.local_branch = target
 
2273
                _run_hooks()
 
2274
                return result
 
2275
            finally:
 
2276
                master_branch.unlock()
 
2277
        else:
 
2278
            # no master branch
 
2279
            result = self._basic_push(target, overwrite, stop_revision)
 
2280
            # TODO: Why set master_branch and local_branch if there's no
 
2281
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2282
            # 20070504
 
2283
            result.master_branch = target
 
2284
            result.local_branch = None
 
2285
            _run_hooks()
 
2286
            return result
 
2287
 
 
2288
    def _basic_push(self, target, overwrite, stop_revision):
 
2289
        """Basic implementation of push without bound branches or hooks.
 
2290
 
 
2291
        Must be called with self read locked and target write locked.
 
2292
        """
 
2293
        result = BranchPushResult()
 
2294
        result.source_branch = self
 
2295
        result.target_branch = target
 
2296
        result.old_revno, result.old_revid = target.last_revision_info()
 
2297
        self.update_references(target)
 
2298
        if result.old_revid != self.last_revision():
 
2299
            # We assume that during 'push' this repository is closer than
 
2300
            # the target.
 
2301
            graph = self.repository.get_graph(target.repository)
 
2302
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2303
                                    graph=graph)
 
2304
        if self._push_should_merge_tags():
 
2305
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2306
        result.new_revno, result.new_revid = target.last_revision_info()
 
2307
        return result
 
2308
 
2531
2309
    def get_stacked_on_url(self):
2532
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2310
        raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2311
 
2534
2312
    def set_push_location(self, location):
2535
2313
        """See Branch.set_push_location."""
2544
2322
            self._transport.put_bytes('parent', url + '\n',
2545
2323
                mode=self.bzrdir._get_file_mode())
2546
2324
 
2547
 
    @needs_write_lock
2548
 
    def unbind(self):
2549
 
        """If bound, unbind"""
2550
 
        return self.set_bound_location(None)
 
2325
 
 
2326
class BzrBranch5(BzrBranch):
 
2327
    """A format 5 branch. This supports new features over plain branches.
 
2328
 
 
2329
    It has support for a master_branch which is the data for bound branches.
 
2330
    """
 
2331
 
 
2332
    @needs_write_lock
 
2333
    def pull(self, source, overwrite=False, stop_revision=None,
 
2334
             run_hooks=True, possible_transports=None,
 
2335
             _override_hook_target=None):
 
2336
        """Pull from source into self, updating my master if any.
 
2337
 
 
2338
        :param run_hooks: Private parameter - if false, this branch
 
2339
            is being called because it's the master of the primary branch,
 
2340
            so it should not run its hooks.
 
2341
        """
 
2342
        bound_location = self.get_bound_location()
 
2343
        master_branch = None
 
2344
        if bound_location and source.base != bound_location:
 
2345
            # not pulling from master, so we need to update master.
 
2346
            master_branch = self.get_master_branch(possible_transports)
 
2347
            master_branch.lock_write()
 
2348
        try:
 
2349
            if master_branch:
 
2350
                # pull from source into master.
 
2351
                master_branch.pull(source, overwrite, stop_revision,
 
2352
                    run_hooks=False)
 
2353
            return super(BzrBranch5, self).pull(source, overwrite,
 
2354
                stop_revision, _hook_master=master_branch,
 
2355
                run_hooks=run_hooks,
 
2356
                _override_hook_target=_override_hook_target)
 
2357
        finally:
 
2358
            if master_branch:
 
2359
                master_branch.unlock()
 
2360
 
 
2361
    def get_bound_location(self):
 
2362
        try:
 
2363
            return self._transport.get_bytes('bound')[:-1]
 
2364
        except errors.NoSuchFile:
 
2365
            return None
 
2366
 
 
2367
    @needs_read_lock
 
2368
    def get_master_branch(self, possible_transports=None):
 
2369
        """Return the branch we are bound to.
 
2370
 
 
2371
        :return: Either a Branch, or None
 
2372
 
 
2373
        This could memoise the branch, but if thats done
 
2374
        it must be revalidated on each new lock.
 
2375
        So for now we just don't memoise it.
 
2376
        # RBC 20060304 review this decision.
 
2377
        """
 
2378
        bound_loc = self.get_bound_location()
 
2379
        if not bound_loc:
 
2380
            return None
 
2381
        try:
 
2382
            return Branch.open(bound_loc,
 
2383
                               possible_transports=possible_transports)
 
2384
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2385
            raise errors.BoundBranchConnectionFailure(
 
2386
                    self, bound_loc, e)
 
2387
 
 
2388
    @needs_write_lock
 
2389
    def set_bound_location(self, location):
 
2390
        """Set the target where this branch is bound to.
 
2391
 
 
2392
        :param location: URL to the target branch
 
2393
        """
 
2394
        if location:
 
2395
            self._transport.put_bytes('bound', location+'\n',
 
2396
                mode=self.bzrdir._get_file_mode())
 
2397
        else:
 
2398
            try:
 
2399
                self._transport.delete('bound')
 
2400
            except errors.NoSuchFile:
 
2401
                return False
 
2402
            return True
2551
2403
 
2552
2404
    @needs_write_lock
2553
2405
    def bind(self, other):
2575
2427
        # history around
2576
2428
        self.set_bound_location(other.base)
2577
2429
 
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
2430
    @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
 
2431
    def unbind(self):
 
2432
        """If bound, unbind"""
 
2433
        return self.set_bound_location(None)
2622
2434
 
2623
2435
    @needs_write_lock
2624
2436
    def update(self, possible_transports=None):
2637
2449
            return old_tip
2638
2450
        return None
2639
2451
 
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):
 
2452
 
 
2453
class BzrBranch8(BzrBranch5):
2769
2454
    """A branch that stores tree-reference locations."""
2770
2455
 
2771
2456
    def _open_hook(self):
2784
2469
                    raise AssertionError(
2785
2470
                        "'transform_fallback_location' hook %s returned "
2786
2471
                        "None, not a URL." % hook_name)
2787
 
            self._activate_fallback_location(url)
 
2472
            self._activate_fallback_location(url, None)
2788
2473
 
2789
2474
    def __init__(self, *args, **kwargs):
2790
2475
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2791
2476
        super(BzrBranch8, self).__init__(*args, **kwargs)
2792
2477
        self._last_revision_info_cache = None
 
2478
        self._partial_revision_history_cache = []
2793
2479
        self._reference_info = None
2794
2480
 
2795
2481
    def _clear_cached_state(self):
2796
2482
        super(BzrBranch8, self)._clear_cached_state()
2797
2483
        self._last_revision_info_cache = None
 
2484
        self._partial_revision_history_cache = []
2798
2485
        self._reference_info = None
2799
2486
 
 
2487
    def _last_revision_info(self):
 
2488
        revision_string = self._transport.get_bytes('last-revision')
 
2489
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2490
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2491
        revno = int(revno)
 
2492
        return revno, revision_id
 
2493
 
 
2494
    def _write_last_revision_info(self, revno, revision_id):
 
2495
        """Simply write out the revision id, with no checks.
 
2496
 
 
2497
        Use set_last_revision_info to perform this safely.
 
2498
 
 
2499
        Does not update the revision_history cache.
 
2500
        Intended to be called by set_last_revision_info and
 
2501
        _write_revision_history.
 
2502
        """
 
2503
        revision_id = _mod_revision.ensure_null(revision_id)
 
2504
        out_string = '%d %s\n' % (revno, revision_id)
 
2505
        self._transport.put_bytes('last-revision', out_string,
 
2506
            mode=self.bzrdir._get_file_mode())
 
2507
 
 
2508
    @needs_write_lock
 
2509
    def set_last_revision_info(self, revno, revision_id):
 
2510
        revision_id = _mod_revision.ensure_null(revision_id)
 
2511
        old_revno, old_revid = self.last_revision_info()
 
2512
        if self._get_append_revisions_only():
 
2513
            self._check_history_violation(revision_id)
 
2514
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2515
        self._write_last_revision_info(revno, revision_id)
 
2516
        self._clear_cached_state()
 
2517
        self._last_revision_info_cache = revno, revision_id
 
2518
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2519
 
 
2520
    def _synchronize_history(self, destination, revision_id):
 
2521
        """Synchronize last revision and revision history between branches.
 
2522
 
 
2523
        :see: Branch._synchronize_history
 
2524
        """
 
2525
        # XXX: The base Branch has a fast implementation of this method based
 
2526
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2527
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2528
        # but wants the fast implementation, so it calls
 
2529
        # Branch._synchronize_history directly.
 
2530
        Branch._synchronize_history(self, destination, revision_id)
 
2531
 
2800
2532
    def _check_history_violation(self, revision_id):
2801
 
        current_revid = self.last_revision()
2802
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2533
        last_revision = _mod_revision.ensure_null(self.last_revision())
2803
2534
        if _mod_revision.is_null(last_revision):
2804
2535
            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)
 
2536
        if last_revision not in self._lefthand_history(revision_id):
 
2537
            raise errors.AppendRevisionsOnlyViolation(self.base)
2810
2538
 
2811
2539
    def _gen_revision_history(self):
2812
2540
        """Generate the revision history from last revision
2815
2543
        self._extend_partial_history(stop_index=last_revno-1)
2816
2544
        return list(reversed(self._partial_revision_history_cache))
2817
2545
 
 
2546
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2547
        """Extend the partial history to include a given index
 
2548
 
 
2549
        If a stop_index is supplied, stop when that index has been reached.
 
2550
        If a stop_revision is supplied, stop when that revision is
 
2551
        encountered.  Otherwise, stop when the beginning of history is
 
2552
        reached.
 
2553
 
 
2554
        :param stop_index: The index which should be present.  When it is
 
2555
            present, history extension will stop.
 
2556
        :param revision_id: The revision id which should be present.  When
 
2557
            it is encountered, history extension will stop.
 
2558
        """
 
2559
        repo = self.repository
 
2560
        if len(self._partial_revision_history_cache) == 0:
 
2561
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2562
        else:
 
2563
            start_revision = self._partial_revision_history_cache[-1]
 
2564
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2565
            #skip the last revision in the list
 
2566
            next_revision = iterator.next()
 
2567
        for revision_id in iterator:
 
2568
            self._partial_revision_history_cache.append(revision_id)
 
2569
            if (stop_index is not None and
 
2570
                len(self._partial_revision_history_cache) > stop_index):
 
2571
                break
 
2572
            if revision_id == stop_revision:
 
2573
                break
 
2574
 
 
2575
    def _write_revision_history(self, history):
 
2576
        """Factored out of set_revision_history.
 
2577
 
 
2578
        This performs the actual writing to disk, with format-specific checks.
 
2579
        It is intended to be called by BzrBranch5.set_revision_history.
 
2580
        """
 
2581
        if len(history) == 0:
 
2582
            last_revision = 'null:'
 
2583
        else:
 
2584
            if history != self._lefthand_history(history[-1]):
 
2585
                raise errors.NotLefthandHistory(history)
 
2586
            last_revision = history[-1]
 
2587
        if self._get_append_revisions_only():
 
2588
            self._check_history_violation(last_revision)
 
2589
        self._write_last_revision_info(len(history), last_revision)
 
2590
 
2818
2591
    @needs_write_lock
2819
2592
    def _set_parent_location(self, url):
2820
2593
        """Set the parent branch"""
2896
2669
        if branch_location is None:
2897
2670
            return Branch.reference_parent(self, file_id, path,
2898
2671
                                           possible_transports)
2899
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2672
        branch_location = urlutils.join(self.base, branch_location)
2900
2673
        return Branch.open(branch_location,
2901
2674
                           possible_transports=possible_transports)
2902
2675
 
2906
2679
 
2907
2680
    def set_bound_location(self, location):
2908
2681
        """See Branch.set_push_location."""
2909
 
        self._master_branch_cache = None
2910
2682
        result = None
2911
2683
        config = self.get_config()
2912
2684
        if location is None:
2943
2715
        # you can always ask for the URL; but you might not be able to use it
2944
2716
        # if the repo can't support stacking.
2945
2717
        ## 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)
 
2718
        stacked_url = self._get_config_location('stacked_on_location')
2951
2719
        if stacked_url is None:
2952
2720
            raise errors.NotStacked(self)
2953
2721
        return stacked_url
2954
2722
 
 
2723
    def set_append_revisions_only(self, enabled):
 
2724
        if enabled:
 
2725
            value = 'True'
 
2726
        else:
 
2727
            value = 'False'
 
2728
        self.get_config().set_user_option('append_revisions_only', value,
 
2729
            warn_masked=True)
 
2730
 
2955
2731
    def _get_append_revisions_only(self):
2956
 
        return self.get_config(
2957
 
            ).get_user_option_as_bool('append_revisions_only')
 
2732
        value = self.get_config().get_user_option('append_revisions_only')
 
2733
        return value == 'True'
 
2734
 
 
2735
    @needs_write_lock
 
2736
    def generate_revision_history(self, revision_id, last_rev=None,
 
2737
                                  other_branch=None):
 
2738
        """See BzrBranch5.generate_revision_history"""
 
2739
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2740
        revno = len(history)
 
2741
        self.set_last_revision_info(revno, revision_id)
2958
2742
 
2959
2743
    @needs_read_lock
2960
2744
    def get_rev_id(self, revno, history=None):
2985
2769
        try:
2986
2770
            index = self._partial_revision_history_cache.index(revision_id)
2987
2771
        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)
 
2772
            self._extend_partial_history(stop_revision=revision_id)
2992
2773
            index = len(self._partial_revision_history_cache) - 1
2993
2774
            if self._partial_revision_history_cache[index] != revision_id:
2994
2775
                raise errors.NoSuchRevision(self, revision_id)
3017
2798
    """
3018
2799
 
3019
2800
    def get_stacked_on_url(self):
3020
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2801
        raise errors.UnstackableBranchFormat(self._format, self.base)
3021
2802
 
3022
2803
 
3023
2804
######################################################################
3049
2830
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3050
2831
    """
3051
2832
 
3052
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3053
2833
    def __int__(self):
3054
 
        """Return the relative change in revno.
3055
 
 
3056
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3057
 
        """
 
2834
        # DEPRECATED: pull used to return the change in revno
3058
2835
        return self.new_revno - self.old_revno
3059
2836
 
3060
2837
    def report(self, to_file):
3085
2862
        target, otherwise it will be None.
3086
2863
    """
3087
2864
 
3088
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3089
2865
    def __int__(self):
3090
 
        """Return the relative change in revno.
3091
 
 
3092
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3093
 
        """
 
2866
        # DEPRECATED: push used to return the change in revno
3094
2867
        return self.new_revno - self.old_revno
3095
2868
 
3096
2869
    def report(self, to_file):
3110
2883
 
3111
2884
    def __init__(self, branch):
3112
2885
        self.branch = branch
3113
 
        self.errors = []
3114
2886
 
3115
2887
    def report_results(self, verbose):
3116
2888
        """Report the check results via trace.note.
3118
2890
        :param verbose: Requests more detailed display of what was checked,
3119
2891
            if any.
3120
2892
        """
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)
 
2893
        note('checked branch %s format %s',
 
2894
             self.branch.base,
 
2895
             self.branch._format)
3125
2896
 
3126
2897
 
3127
2898
class Converter5to6(object):
3166
2937
 
3167
2938
 
3168
2939
class Converter7to8(object):
3169
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
2940
    """Perform an in-place upgrade of format 6 to format 7"""
3170
2941
 
3171
2942
    def convert(self, branch):
3172
2943
        format = BzrBranchFormat8()
3175
2946
        branch._transport.put_bytes('format', format.get_format_string())
3176
2947
 
3177
2948
 
 
2949
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2950
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2951
    duration.
 
2952
 
 
2953
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2954
 
 
2955
    If an exception is raised by callable, then that exception *will* be
 
2956
    propagated, even if the unlock attempt raises its own error.  Thus
 
2957
    _run_with_write_locked_target should be preferred to simply doing::
 
2958
 
 
2959
        target.lock_write()
 
2960
        try:
 
2961
            return callable(*args, **kwargs)
 
2962
        finally:
 
2963
            target.unlock()
 
2964
 
 
2965
    """
 
2966
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2967
    # should share code?
 
2968
    target.lock_write()
 
2969
    try:
 
2970
        result = callable(*args, **kwargs)
 
2971
    except:
 
2972
        exc_info = sys.exc_info()
 
2973
        try:
 
2974
            target.unlock()
 
2975
        finally:
 
2976
            raise exc_info[0], exc_info[1], exc_info[2]
 
2977
    else:
 
2978
        target.unlock()
 
2979
        return result
 
2980
 
 
2981
 
3178
2982
class InterBranch(InterObject):
3179
2983
    """This class represents operations taking place between two branches.
3180
2984
 
3186
2990
    _optimisers = []
3187
2991
    """The available optimised InterBranch types."""
3188
2992
 
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)
3198
 
 
3199
 
    @needs_write_lock
3200
 
    def pull(self, overwrite=False, stop_revision=None,
3201
 
             possible_transports=None, local=False):
3202
 
        """Mirror source into target branch.
3203
 
 
3204
 
        The target branch is considered to be 'local', having low latency.
3205
 
 
3206
 
        :returns: PullResult instance
3207
 
        """
3208
 
        raise NotImplementedError(self.pull)
3209
 
 
3210
 
    @needs_write_lock
3211
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3212
 
             _override_hook_source_branch=None):
3213
 
        """Mirror the source branch into the target branch.
3214
 
 
3215
 
        The source branch is considered to be 'local', having low latency.
3216
 
        """
3217
 
        raise NotImplementedError(self.push)
3218
 
 
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)
 
2993
    @staticmethod
 
2994
    def _get_branch_formats_to_test():
 
2995
        """Return a tuple with the Branch formats to use when testing."""
 
2996
        raise NotImplementedError(self._get_branch_formats_to_test)
 
2997
 
 
2998
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2999
                         graph=None):
 
3000
        """Pull in new perfect-fit revisions.
 
3001
 
 
3002
        :param stop_revision: Updated until the given revision
 
3003
        :param overwrite: Always set the branch pointer, rather than checking
 
3004
            to see if it is a proper descendant.
 
3005
        :param graph: A Graph object that can be used to query history
 
3006
            information. This can be None.
 
3007
        :return: None
 
3008
        """
 
3009
        raise NotImplementedError(self.update_revisions)
3236
3010
 
3237
3011
 
3238
3012
class GenericInterBranch(InterBranch):
3239
 
    """InterBranch implementation that uses public Branch functions."""
 
3013
    """InterBranch implementation that uses public Branch functions.
 
3014
    """
 
3015
 
 
3016
    @staticmethod
 
3017
    def _get_branch_formats_to_test():
 
3018
        return BranchFormat._default_format, BranchFormat._default_format
 
3019
 
 
3020
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3021
        graph=None):
 
3022
        """See InterBranch.update_revisions()."""
 
3023
        self.source.lock_read()
 
3024
        try:
 
3025
            other_revno, other_last_revision = self.source.last_revision_info()
 
3026
            stop_revno = None # unknown
 
3027
            if stop_revision is None:
 
3028
                stop_revision = other_last_revision
 
3029
                if _mod_revision.is_null(stop_revision):
 
3030
                    # if there are no commits, we're done.
 
3031
                    return
 
3032
                stop_revno = other_revno
 
3033
 
 
3034
            # what's the current last revision, before we fetch [and change it
 
3035
            # possibly]
 
3036
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3037
            # we fetch here so that we don't process data twice in the common
 
3038
            # case of having something to pull, and so that the check for
 
3039
            # already merged can operate on the just fetched graph, which will
 
3040
            # be cached in memory.
 
3041
            self.target.fetch(self.source, stop_revision)
 
3042
            # Check to see if one is an ancestor of the other
 
3043
            if not overwrite:
 
3044
                if graph is None:
 
3045
                    graph = self.target.repository.get_graph()
 
3046
                if self.target._check_if_descendant_or_diverged(
 
3047
                        stop_revision, last_rev, graph, self.source):
 
3048
                    # stop_revision is a descendant of last_rev, but we aren't
 
3049
                    # overwriting, so we're done.
 
3050
                    return
 
3051
            if stop_revno is None:
 
3052
                if graph is None:
 
3053
                    graph = self.target.repository.get_graph()
 
3054
                this_revno, this_last_revision = \
 
3055
                        self.target.last_revision_info()
 
3056
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3057
                                [(other_last_revision, other_revno),
 
3058
                                 (this_last_revision, this_revno)])
 
3059
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3060
        finally:
 
3061
            self.source.unlock()
3240
3062
 
3241
3063
    @classmethod
3242
 
    def is_compatible(klass, source, target):
 
3064
    def is_compatible(self, source, target):
3243
3065
        # GenericBranch uses the public API, so always compatible
3244
3066
        return True
3245
3067
 
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, [])
3280
 
        self.source.lock_read()
3281
 
        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)
3292
 
        finally:
3293
 
            self.source.unlock()
3294
 
 
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
 
    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
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3462
 
             _override_hook_target=None, local=False,
3463
 
             merge_tags_to_master=True):
3464
 
        """See Branch.pull.
3465
 
 
3466
 
        This function is the core worker, used by GenericInterBranch.pull to
3467
 
        avoid duplication when pulling source->master and source->local.
3468
 
 
3469
 
        :param _hook_master: Private parameter - set the branch to
3470
 
            be supplied as the master to pull hooks.
3471
 
        :param run_hooks: Private parameter - if false, this branch
3472
 
            is being called because it's the master of the primary branch,
3473
 
            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
 
        :param _override_hook_target: Private parameter - set the branch to be
3477
 
            supplied as the target_branch to pull hooks.
3478
 
        :param local: Only update the local branch, and not the bound branch.
3479
 
        """
3480
 
        # This type of branch can't be bound.
3481
 
        if local:
3482
 
            raise errors.LocalRequiresBoundBranch()
3483
 
        result = PullResult()
3484
 
        result.source_branch = self.source
3485
 
        if _override_hook_target is None:
3486
 
            result.target_branch = self.target
3487
 
        else:
3488
 
            result.target_branch = _override_hook_target
3489
 
        self.source.lock_read()
3490
 
        try:
3491
 
            # We assume that during 'pull' the target repository is closer than
3492
 
            # the source one.
3493
 
            self.source.update_references(self.target)
3494
 
            graph = self.target.repository.get_graph(self.source.repository)
3495
 
            # TODO: Branch formats should have a flag that indicates 
3496
 
            # that revno's are expensive, and pull() should honor that flag.
3497
 
            # -- JRV20090506
3498
 
            result.old_revno, result.old_revid = \
3499
 
                self.target.last_revision_info()
3500
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3501
 
                graph=graph)
3502
 
            # TODO: The old revid should be specified when merging tags, 
3503
 
            # so a tags implementation that versions tags can only 
3504
 
            # pull in the most recent changes. -- JRV20090506
3505
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3506
 
                overwrite, ignore_master=not merge_tags_to_master)
3507
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3508
 
            if _hook_master:
3509
 
                result.master_branch = _hook_master
3510
 
                result.local_branch = result.target_branch
3511
 
            else:
3512
 
                result.master_branch = result.target_branch
3513
 
                result.local_branch = None
3514
 
            if run_hooks:
3515
 
                for hook in Branch.hooks['post_pull']:
3516
 
                    hook(result)
3517
 
        finally:
3518
 
            self.source.unlock()
3519
 
        return result
3520
 
 
3521
3068
 
3522
3069
InterBranch.register_optimiser(GenericInterBranch)