~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Sidnei da Silva
  • Date: 2009-07-04 02:16:06 UTC
  • mto: (4531.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4532.
  • Revision ID: sidnei.da.silva@canonical.com-20090704021606-os06th007b2bfu5u
- Define targets as 'release' and 'dev', allow passing them through make

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 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
25
25
        bzrdir,
26
26
        cache_utf8,
27
27
        config as _mod_config,
28
 
        controldir,
29
28
        debug,
30
29
        errors,
31
30
        lockdir,
32
31
        lockable_files,
33
 
        remote,
34
32
        repository,
35
33
        revision as _mod_revision,
36
34
        rio,
48
46
    )
49
47
""")
50
48
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
52
50
from bzrlib.hooks import HookPoint, Hooks
53
51
from bzrlib.inter import InterObject
54
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
52
from bzrlib import registry
56
53
from bzrlib.symbol_versioning import (
57
54
    deprecated_in,
65
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
63
 
67
64
 
68
 
class Branch(controldir.ControlComponent):
 
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):
69
78
    """Branch holding a history of revisions.
70
79
 
71
 
    :ivar base:
72
 
        Base directory/url of the branch; using control_url and
73
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
74
82
 
75
83
    hooks: An instance of BranchHooks.
76
84
    """
78
86
    # - RBC 20060112
79
87
    base = None
80
88
 
81
 
    @property
82
 
    def control_transport(self):
83
 
        return self._transport
84
 
 
85
 
    @property
86
 
    def user_transport(self):
87
 
        return self.bzrdir.user_transport
88
 
 
89
89
    def __init__(self, *ignored, **ignored_too):
90
90
        self.tags = self._format.make_tags(self)
91
91
        self._revision_history_cache = None
92
92
        self._revision_id_to_revno_cache = None
93
93
        self._partial_revision_id_to_revno_cache = {}
94
 
        self._partial_revision_history_cache = []
95
94
        self._last_revision_info_cache = None
96
95
        self._merge_sorted_revisions_cache = None
97
96
        self._open_hook()
105
104
    def _activate_fallback_location(self, url):
106
105
        """Activate the branch/repository from url as a fallback repository."""
107
106
        repo = self._get_fallback_repository(url)
108
 
        if repo.has_same_location(self.repository):
109
 
            raise errors.UnstackableLocationError(self.user_url, url)
110
107
        self.repository.add_fallback_repository(repo)
111
108
 
112
109
    def break_lock(self):
128
125
            raise errors.UnstackableRepositoryFormat(self.repository._format,
129
126
                self.repository.base)
130
127
 
131
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
 
        """Extend the partial history to include a given index
133
 
 
134
 
        If a stop_index is supplied, stop when that index has been reached.
135
 
        If a stop_revision is supplied, stop when that revision is
136
 
        encountered.  Otherwise, stop when the beginning of history is
137
 
        reached.
138
 
 
139
 
        :param stop_index: The index which should be present.  When it is
140
 
            present, history extension will stop.
141
 
        :param stop_revision: The revision id which should be present.  When
142
 
            it is encountered, history extension will stop.
143
 
        """
144
 
        if len(self._partial_revision_history_cache) == 0:
145
 
            self._partial_revision_history_cache = [self.last_revision()]
146
 
        repository._iter_for_revno(
147
 
            self.repository, self._partial_revision_history_cache,
148
 
            stop_index=stop_index, stop_revision=stop_revision)
149
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
 
            self._partial_revision_history_cache.pop()
151
 
 
152
 
    def _get_check_refs(self):
153
 
        """Get the references needed for check().
154
 
 
155
 
        See bzrlib.check.
156
 
        """
157
 
        revid = self.last_revision()
158
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
159
 
 
160
128
    @staticmethod
161
129
    def open(base, _unsupported=False, possible_transports=None):
162
130
        """Open the branch rooted at base.
166
134
        """
167
135
        control = bzrdir.BzrDir.open(base, _unsupported,
168
136
                                     possible_transports=possible_transports)
169
 
        return control.open_branch(unsupported=_unsupported)
 
137
        return control.open_branch(_unsupported)
170
138
 
171
139
    @staticmethod
172
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
140
    def open_from_transport(transport, _unsupported=False):
173
141
        """Open the branch rooted at transport"""
174
142
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
143
        return control.open_branch(_unsupported)
176
144
 
177
145
    @staticmethod
178
146
    def open_containing(url, possible_transports=None):
199
167
        return self.supports_tags() and self.tags.get_tag_dict()
200
168
 
201
169
    def get_config(self):
202
 
        """Get a bzrlib.config.BranchConfig for this Branch.
203
 
 
204
 
        This can then be used to get and set configuration options for the
205
 
        branch.
206
 
 
207
 
        :return: A bzrlib.config.BranchConfig.
208
 
        """
209
170
        return BranchConfig(self)
210
171
 
211
172
    def _get_config(self):
223
184
    def _get_fallback_repository(self, url):
224
185
        """Get the repository we fallback to at url."""
225
186
        url = urlutils.join(self.base, url)
226
 
        a_branch = Branch.open(url,
 
187
        a_bzrdir = bzrdir.BzrDir.open(url,
227
188
            possible_transports=[self.bzrdir.root_transport])
228
 
        return a_branch.repository
 
189
        return a_bzrdir.open_branch().repository
229
190
 
230
191
    def _get_tags_bytes(self):
231
192
        """Get the bytes of a serialised tags dict.
247
208
        if not local and not config.has_explicit_nickname():
248
209
            try:
249
210
                master = self.get_master_branch(possible_transports)
250
 
                if master and self.user_url == master.user_url:
251
 
                    raise errors.RecursiveBind(self.user_url)
252
211
                if master is not None:
253
212
                    # return the master branch value
254
213
                    return master.nick
255
 
            except errors.RecursiveBind, e:
256
 
                raise e
257
214
            except errors.BzrError, e:
258
215
                # Silently fall back to local implicit nick if the master is
259
216
                # unavailable
296
253
        new_history.reverse()
297
254
        return new_history
298
255
 
299
 
    def lock_write(self, token=None):
300
 
        """Lock the branch for write operations.
301
 
 
302
 
        :param token: A token to permit reacquiring a previously held and
303
 
            preserved lock.
304
 
        :return: A BranchWriteLockResult.
305
 
        """
 
256
    def lock_write(self):
306
257
        raise NotImplementedError(self.lock_write)
307
258
 
308
259
    def lock_read(self):
309
 
        """Lock the branch for read operations.
310
 
 
311
 
        :return: A bzrlib.lock.LogicalLockResult.
312
 
        """
313
260
        raise NotImplementedError(self.lock_read)
314
261
 
315
262
    def unlock(self):
440
387
            * 'include' - the stop revision is the last item in the result
441
388
            * 'with-merges' - include the stop revision and all of its
442
389
              merged revisions in the result
443
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
444
 
              that are in both ancestries
445
390
        :param direction: either 'reverse' or 'forward':
446
391
            * reverse means return the start_revision_id first, i.e.
447
392
              start at the most recent revision and go backwards in history
469
414
        # start_revision_id.
470
415
        if self._merge_sorted_revisions_cache is None:
471
416
            last_revision = self.last_revision()
472
 
            known_graph = self.repository.get_known_graph_ancestry(
473
 
                [last_revision])
474
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
475
 
                last_revision)
 
417
            graph = self.repository.get_graph()
 
418
            parent_map = dict(((key, value) for key, value in
 
419
                     graph.iter_ancestry([last_revision]) if value is not None))
 
420
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
421
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
422
                generate_revno=True)
 
423
            # Drop the sequence # before caching
 
424
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
425
 
476
426
        filtered = self._filter_merge_sorted_revisions(
477
427
            self._merge_sorted_revisions_cache, start_revision_id,
478
428
            stop_revision_id, stop_rule)
479
 
        # Make sure we don't return revisions that are not part of the
480
 
        # start_revision_id ancestry.
481
 
        filtered = self._filter_start_non_ancestors(filtered)
482
429
        if direction == 'reverse':
483
430
            return filtered
484
431
        if direction == 'forward':
491
438
        """Iterate over an inclusive range of sorted revisions."""
492
439
        rev_iter = iter(merge_sorted_revisions)
493
440
        if start_revision_id is not None:
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
496
442
                if rev_id != start_revision_id:
497
443
                    continue
498
444
                else:
499
445
                    # The decision to include the start or not
500
446
                    # depends on the stop_rule if a stop is provided
501
 
                    # so pop this node back into the iterator
502
 
                    rev_iter = chain(iter([node]), rev_iter)
 
447
                    rev_iter = chain(
 
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
449
                        rev_iter)
503
450
                    break
504
451
        if stop_revision_id is None:
505
 
            # Yield everything
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
452
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
453
                yield rev_id, depth, revno, end_of_merge
510
454
        elif stop_rule == 'exclude':
511
 
            for node in rev_iter:
512
 
                rev_id = node.key[-1]
 
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
513
456
                if rev_id == stop_revision_id:
514
457
                    return
515
 
                yield (rev_id, node.merge_depth, node.revno,
516
 
                       node.end_of_merge)
 
458
                yield rev_id, depth, revno, end_of_merge
517
459
        elif stop_rule == 'include':
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                yield (rev_id, node.merge_depth, node.revno,
521
 
                       node.end_of_merge)
 
460
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
461
                yield rev_id, depth, revno, end_of_merge
522
462
                if rev_id == stop_revision_id:
523
463
                    return
524
 
        elif stop_rule == 'with-merges-without-common-ancestry':
525
 
            # We want to exclude all revisions that are already part of the
526
 
            # stop_revision_id ancestry.
527
 
            graph = self.repository.get_graph()
528
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
529
 
                                                    [stop_revision_id])
530
 
            for node in rev_iter:
531
 
                rev_id = node.key[-1]
532
 
                if rev_id not in ancestors:
533
 
                    continue
534
 
                yield (rev_id, node.merge_depth, node.revno,
535
 
                       node.end_of_merge)
536
464
        elif stop_rule == 'with-merges':
537
465
            stop_rev = self.repository.get_revision(stop_revision_id)
538
466
            if stop_rev.parent_ids:
539
467
                left_parent = stop_rev.parent_ids[0]
540
468
            else:
541
469
                left_parent = _mod_revision.NULL_REVISION
542
 
            # left_parent is the actual revision we want to stop logging at,
543
 
            # since we want to show the merged revisions after the stop_rev too
544
 
            reached_stop_revision_id = False
545
 
            revision_id_whitelist = []
546
 
            for node in rev_iter:
547
 
                rev_id = node.key[-1]
 
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
548
471
                if rev_id == left_parent:
549
 
                    # reached the left parent after the stop_revision
550
472
                    return
551
 
                if (not reached_stop_revision_id or
552
 
                        rev_id in revision_id_whitelist):
553
 
                    yield (rev_id, node.merge_depth, node.revno,
554
 
                       node.end_of_merge)
555
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
556
 
                        # only do the merged revs of rev_id from now on
557
 
                        rev = self.repository.get_revision(rev_id)
558
 
                        if rev.parent_ids:
559
 
                            reached_stop_revision_id = True
560
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
473
                yield rev_id, depth, revno, end_of_merge
561
474
        else:
562
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
563
476
 
564
 
    def _filter_start_non_ancestors(self, rev_iter):
565
 
        # If we started from a dotted revno, we want to consider it as a tip
566
 
        # and don't want to yield revisions that are not part of its
567
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
568
 
        # uninteresting descendants of the first parent of our tip before the
569
 
        # tip itself.
570
 
        first = rev_iter.next()
571
 
        (rev_id, merge_depth, revno, end_of_merge) = first
572
 
        yield first
573
 
        if not merge_depth:
574
 
            # We start at a mainline revision so by definition, all others
575
 
            # revisions in rev_iter are ancestors
576
 
            for node in rev_iter:
577
 
                yield node
578
 
 
579
 
        clean = False
580
 
        whitelist = set()
581
 
        pmap = self.repository.get_parent_map([rev_id])
582
 
        parents = pmap.get(rev_id, [])
583
 
        if parents:
584
 
            whitelist.update(parents)
585
 
        else:
586
 
            # If there is no parents, there is nothing of interest left
587
 
 
588
 
            # FIXME: It's hard to test this scenario here as this code is never
589
 
            # called in that case. -- vila 20100322
590
 
            return
591
 
 
592
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
593
 
            if not clean:
594
 
                if rev_id in whitelist:
595
 
                    pmap = self.repository.get_parent_map([rev_id])
596
 
                    parents = pmap.get(rev_id, [])
597
 
                    whitelist.remove(rev_id)
598
 
                    whitelist.update(parents)
599
 
                    if merge_depth == 0:
600
 
                        # We've reached the mainline, there is nothing left to
601
 
                        # filter
602
 
                        clean = True
603
 
                else:
604
 
                    # A revision that is not part of the ancestry of our
605
 
                    # starting revision.
606
 
                    continue
607
 
            yield (rev_id, merge_depth, revno, end_of_merge)
608
 
 
609
477
    def leave_lock_in_place(self):
610
478
        """Tell this branch object not to release the physical lock when this
611
479
        object is unlocked.
628
496
        :param other: The branch to bind to
629
497
        :type other: Branch
630
498
        """
631
 
        raise errors.UpgradeRequired(self.user_url)
632
 
 
633
 
    def set_append_revisions_only(self, enabled):
634
 
        if not self._format.supports_set_append_revisions_only():
635
 
            raise errors.UpgradeRequired(self.user_url)
636
 
        if enabled:
637
 
            value = 'True'
638
 
        else:
639
 
            value = 'False'
640
 
        self.get_config().set_user_option('append_revisions_only', value,
641
 
            warn_masked=True)
 
499
        raise errors.UpgradeRequired(self.base)
642
500
 
643
501
    def set_reference_info(self, file_id, tree_path, branch_location):
644
502
        """Set the branch location to use for a tree reference."""
686
544
    def get_old_bound_location(self):
687
545
        """Return the URL of the branch we used to be bound to
688
546
        """
689
 
        raise errors.UpgradeRequired(self.user_url)
 
547
        raise errors.UpgradeRequired(self.base)
690
548
 
691
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
692
550
                           timezone=None, committer=None, revprops=None,
770
628
            stacking.
771
629
        """
772
630
        if not self._format.supports_stacking():
773
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
774
 
        # XXX: Changing from one fallback repository to another does not check
775
 
        # that all the data you need is present in the new fallback.
776
 
        # Possibly it should.
 
631
            raise errors.UnstackableBranchFormat(self._format, self.base)
777
632
        self._check_stackable_repo()
778
633
        if not url:
779
634
            try:
781
636
            except (errors.NotStacked, errors.UnstackableBranchFormat,
782
637
                errors.UnstackableRepositoryFormat):
783
638
                return
784
 
            self._unstack()
 
639
            url = ''
 
640
            # XXX: Lock correctness - should unlock our old repo if we were
 
641
            # locked.
 
642
            # repositories don't offer an interface to remove fallback
 
643
            # repositories today; take the conceptually simpler option and just
 
644
            # reopen it.
 
645
            self.repository = self.bzrdir.find_repository()
 
646
            self.repository.lock_write()
 
647
            # for every revision reference the branch has, ensure it is pulled
 
648
            # in.
 
649
            source_repository = self._get_fallback_repository(old_url)
 
650
            for revision_id in chain([self.last_revision()],
 
651
                self.tags.get_reverse_tag_dict()):
 
652
                self.repository.fetch(source_repository, revision_id,
 
653
                    find_ghosts=True)
785
654
        else:
786
655
            self._activate_fallback_location(url)
787
656
        # write this out after the repository is stacked to avoid setting a
788
657
        # stacked config that doesn't work.
789
658
        self._set_config_location('stacked_on_location', url)
790
659
 
791
 
    def _unstack(self):
792
 
        """Change a branch to be unstacked, copying data as needed.
793
 
        
794
 
        Don't call this directly, use set_stacked_on_url(None).
795
 
        """
796
 
        pb = ui.ui_factory.nested_progress_bar()
797
 
        try:
798
 
            pb.update("Unstacking")
799
 
            # The basic approach here is to fetch the tip of the branch,
800
 
            # including all available ghosts, from the existing stacked
801
 
            # repository into a new repository object without the fallbacks. 
802
 
            #
803
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
804
 
            # correct for CHKMap repostiories
805
 
            old_repository = self.repository
806
 
            if len(old_repository._fallback_repositories) != 1:
807
 
                raise AssertionError("can't cope with fallback repositories "
808
 
                    "of %r" % (self.repository,))
809
 
            # Open the new repository object.
810
 
            # Repositories don't offer an interface to remove fallback
811
 
            # repositories today; take the conceptually simpler option and just
812
 
            # reopen it.  We reopen it starting from the URL so that we
813
 
            # get a separate connection for RemoteRepositories and can
814
 
            # stream from one of them to the other.  This does mean doing
815
 
            # separate SSH connection setup, but unstacking is not a
816
 
            # common operation so it's tolerable.
817
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
818
 
            new_repository = new_bzrdir.find_repository()
819
 
            if new_repository._fallback_repositories:
820
 
                raise AssertionError("didn't expect %r to have "
821
 
                    "fallback_repositories"
822
 
                    % (self.repository,))
823
 
            # Replace self.repository with the new repository.
824
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
825
 
            # lock count) of self.repository to the new repository.
826
 
            lock_token = old_repository.lock_write().repository_token
827
 
            self.repository = new_repository
828
 
            if isinstance(self, remote.RemoteBranch):
829
 
                # Remote branches can have a second reference to the old
830
 
                # repository that need to be replaced.
831
 
                if self._real_branch is not None:
832
 
                    self._real_branch.repository = new_repository
833
 
            self.repository.lock_write(token=lock_token)
834
 
            if lock_token is not None:
835
 
                old_repository.leave_lock_in_place()
836
 
            old_repository.unlock()
837
 
            if lock_token is not None:
838
 
                # XXX: self.repository.leave_lock_in_place() before this
839
 
                # function will not be preserved.  Fortunately that doesn't
840
 
                # affect the current default format (2a), and would be a
841
 
                # corner-case anyway.
842
 
                #  - Andrew Bennetts, 2010/06/30
843
 
                self.repository.dont_leave_lock_in_place()
844
 
            old_lock_count = 0
845
 
            while True:
846
 
                try:
847
 
                    old_repository.unlock()
848
 
                except errors.LockNotHeld:
849
 
                    break
850
 
                old_lock_count += 1
851
 
            if old_lock_count == 0:
852
 
                raise AssertionError(
853
 
                    'old_repository should have been locked at least once.')
854
 
            for i in range(old_lock_count-1):
855
 
                self.repository.lock_write()
856
 
            # Fetch from the old repository into the new.
857
 
            old_repository.lock_read()
858
 
            try:
859
 
                # XXX: If you unstack a branch while it has a working tree
860
 
                # with a pending merge, the pending-merged revisions will no
861
 
                # longer be present.  You can (probably) revert and remerge.
862
 
                #
863
 
                # XXX: This only fetches up to the tip of the repository; it
864
 
                # doesn't bring across any tags.  That's fairly consistent
865
 
                # with how branch works, but perhaps not ideal.
866
 
                self.repository.fetch(old_repository,
867
 
                    revision_id=self.last_revision(),
868
 
                    find_ghosts=True)
869
 
            finally:
870
 
                old_repository.unlock()
871
 
        finally:
872
 
            pb.finished()
873
660
 
874
661
    def _set_tags_bytes(self, bytes):
875
662
        """Mirror method for _get_tags_bytes.
911
698
        self._revision_id_to_revno_cache = None
912
699
        self._last_revision_info_cache = None
913
700
        self._merge_sorted_revisions_cache = None
914
 
        self._partial_revision_history_cache = []
915
 
        self._partial_revision_id_to_revno_cache = {}
916
701
 
917
702
    def _gen_revision_history(self):
918
703
        """Return sequence of revision hashes on to this branch.
955
740
 
956
741
    def unbind(self):
957
742
        """Older format branches cannot bind or unbind."""
958
 
        raise errors.UpgradeRequired(self.user_url)
 
743
        raise errors.UpgradeRequired(self.base)
 
744
 
 
745
    def set_append_revisions_only(self, enabled):
 
746
        """Older format branches are never restricted to append-only"""
 
747
        raise errors.UpgradeRequired(self.base)
959
748
 
960
749
    def last_revision(self):
961
750
        """Return last revision id, or NULL_REVISION."""
1002
791
                raise errors.NoSuchRevision(self, stop_revision)
1003
792
        return other_history[self_len:stop_revision]
1004
793
 
 
794
    @needs_write_lock
1005
795
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1006
796
                         graph=None):
1007
797
        """Pull in new perfect-fit revisions.
1041
831
        except ValueError:
1042
832
            raise errors.NoSuchRevision(self, revision_id)
1043
833
 
1044
 
    @needs_read_lock
1045
834
    def get_rev_id(self, revno, history=None):
1046
835
        """Find the revision id of the specified revno."""
1047
836
        if revno == 0:
1048
837
            return _mod_revision.NULL_REVISION
1049
 
        last_revno, last_revid = self.last_revision_info()
1050
 
        if revno == last_revno:
1051
 
            return last_revid
1052
 
        if revno <= 0 or revno > last_revno:
 
838
        if history is None:
 
839
            history = self.revision_history()
 
840
        if revno <= 0 or revno > len(history):
1053
841
            raise errors.NoSuchRevision(self, revno)
1054
 
        distance_from_last = last_revno - revno
1055
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1056
 
            self._extend_partial_history(distance_from_last)
1057
 
        return self._partial_revision_history_cache[distance_from_last]
 
842
        return history[revno - 1]
1058
843
 
 
844
    @needs_write_lock
1059
845
    def pull(self, source, overwrite=False, stop_revision=None,
1060
846
             possible_transports=None, *args, **kwargs):
1061
847
        """Mirror source into this branch.
1119
905
        try:
1120
906
            return urlutils.join(self.base[:-1], parent)
1121
907
        except errors.InvalidURLJoin, e:
1122
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
908
            raise errors.InaccessibleParent(parent, self.base)
1123
909
 
1124
910
    def _get_parent_location(self):
1125
911
        raise NotImplementedError(self._get_parent_location)
1210
996
        params = ChangeBranchTipParams(
1211
997
            self, old_revno, new_revno, old_revid, new_revid)
1212
998
        for hook in hooks:
1213
 
            hook(params)
 
999
            try:
 
1000
                hook(params)
 
1001
            except errors.TipChangeRejected:
 
1002
                raise
 
1003
            except Exception:
 
1004
                exc_info = sys.exc_info()
 
1005
                hook_name = Branch.hooks.get_hook_name(hook)
 
1006
                raise errors.HookFailed(
 
1007
                    'pre_change_branch_tip', hook_name, exc_info)
1214
1008
 
1215
1009
    @needs_write_lock
1216
1010
    def update(self):
1265
1059
        revision_id: if not None, the revision history in the new branch will
1266
1060
                     be truncated to end with revision_id.
1267
1061
        """
1268
 
        if (repository_policy is not None and
1269
 
            repository_policy.requires_stacking()):
1270
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1271
1062
        result = to_bzrdir.create_branch()
1272
1063
        result.lock_write()
1273
1064
        try:
1294
1085
        source_revno, source_revision_id = self.last_revision_info()
1295
1086
        if revision_id is None:
1296
1087
            revno, revision_id = source_revno, source_revision_id
 
1088
        elif source_revision_id == revision_id:
 
1089
            # we know the revno without needing to walk all of history
 
1090
            revno = source_revno
1297
1091
        else:
1298
 
            graph = self.repository.get_graph()
1299
 
            try:
1300
 
                revno = graph.find_distance_to_null(revision_id, 
1301
 
                    [(source_revision_id, source_revno)])
1302
 
            except errors.GhostRevisionsHaveNoRevno:
1303
 
                # Default to 1, if we can't find anything else
1304
 
                revno = 1
 
1092
            # To figure out the revno for a random revision, we need to build
 
1093
            # the revision history, and count its length.
 
1094
            # We don't care about the order, just how long it is.
 
1095
            # Alternatively, we could start at the current location, and count
 
1096
            # backwards. But there is no guarantee that we will find it since
 
1097
            # it may be a merged revision.
 
1098
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1099
                                                                revision_id)))
1305
1100
        destination.set_last_revision_info(revno, revision_id)
1306
1101
 
 
1102
    @needs_read_lock
1307
1103
    def copy_content_into(self, destination, revision_id=None):
1308
1104
        """Copy the content of self into destination.
1309
1105
 
1310
1106
        revision_id: if not None, the revision history in the new branch will
1311
1107
                     be truncated to end with revision_id.
1312
1108
        """
1313
 
        return InterBranch.get(self, destination).copy_content_into(
1314
 
            revision_id=revision_id)
 
1109
        self.update_references(destination)
 
1110
        self._synchronize_history(destination, revision_id)
 
1111
        try:
 
1112
            parent = self.get_parent()
 
1113
        except errors.InaccessibleParent, e:
 
1114
            mutter('parent was not accessible to copy: %s', e)
 
1115
        else:
 
1116
            if parent:
 
1117
                destination.set_parent(parent)
 
1118
        if self._push_should_merge_tags():
 
1119
            self.tags.merge_to(destination.tags)
1315
1120
 
1316
1121
    def update_references(self, target):
1317
1122
        if not getattr(self._format, 'supports_reference_locations', False):
1331
1136
        target._set_all_reference_info(target_reference_dict)
1332
1137
 
1333
1138
    @needs_read_lock
1334
 
    def check(self, refs):
 
1139
    def check(self):
1335
1140
        """Check consistency of the branch.
1336
1141
 
1337
1142
        In particular this checks that revisions given in the revision-history
1340
1145
 
1341
1146
        Callers will typically also want to check the repository.
1342
1147
 
1343
 
        :param refs: Calculated refs for this branch as specified by
1344
 
            branch._get_check_refs()
1345
1148
        :return: A BranchCheckResult.
1346
1149
        """
1347
 
        result = BranchCheckResult(self)
 
1150
        mainline_parent_id = None
1348
1151
        last_revno, last_revision_id = self.last_revision_info()
1349
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1350
 
        if actual_revno != last_revno:
1351
 
            result.errors.append(errors.BzrCheckError(
1352
 
                'revno does not match len(mainline) %s != %s' % (
1353
 
                last_revno, actual_revno)))
1354
 
        # TODO: We should probably also check that self.revision_history
1355
 
        # matches the repository for older branch formats.
1356
 
        # If looking for the code that cross-checks repository parents against
1357
 
        # the iter_reverse_revision_history output, that is now a repository
1358
 
        # specific check.
1359
 
        return result
 
1152
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1153
                                last_revision_id))
 
1154
        real_rev_history.reverse()
 
1155
        if len(real_rev_history) != last_revno:
 
1156
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1157
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1158
        # TODO: We should probably also check that real_rev_history actually
 
1159
        #       matches self.revision_history()
 
1160
        for revision_id in real_rev_history:
 
1161
            try:
 
1162
                revision = self.repository.get_revision(revision_id)
 
1163
            except errors.NoSuchRevision, e:
 
1164
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1165
                            % revision_id)
 
1166
            # In general the first entry on the revision history has no parents.
 
1167
            # But it's not illegal for it to have parents listed; this can happen
 
1168
            # in imports from Arch when the parents weren't reachable.
 
1169
            if mainline_parent_id is not None:
 
1170
                if mainline_parent_id not in revision.parent_ids:
 
1171
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1172
                                        "parents of {%s}"
 
1173
                                        % (mainline_parent_id, revision_id))
 
1174
            mainline_parent_id = revision_id
 
1175
        return BranchCheckResult(self)
1360
1176
 
1361
1177
    def _get_checkout_format(self):
1362
1178
        """Return the most suitable metadir for a checkout of this branch.
1385
1201
        """
1386
1202
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1387
1203
        # clone call. Or something. 20090224 RBC/spiv.
1388
 
        # XXX: Should this perhaps clone colocated branches as well, 
1389
 
        # rather than just the default branch? 20100319 JRV
1390
1204
        if revision_id is None:
1391
1205
            revision_id = self.last_revision()
1392
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1393
 
            revision_id=revision_id, stacked_on=stacked_on,
1394
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1206
        try:
 
1207
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1208
                revision_id=revision_id, stacked_on=stacked_on,
 
1209
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1210
        except errors.FileExists:
 
1211
            if not use_existing_dir:
 
1212
                raise
 
1213
        except errors.NoSuchFile:
 
1214
            if not create_prefix:
 
1215
                raise
1395
1216
        return dir_to.open_branch()
1396
1217
 
1397
1218
    def create_checkout(self, to_location, revision_id=None,
1416
1237
        if lightweight:
1417
1238
            format = self._get_checkout_format()
1418
1239
            checkout = format.initialize_on_transport(t)
1419
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1420
 
                target_branch=self)
 
1240
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1421
1241
        else:
1422
1242
            format = self._get_checkout_format()
1423
1243
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1465
1285
    def supports_tags(self):
1466
1286
        return self._format.supports_tags()
1467
1287
 
1468
 
    def automatic_tag_name(self, revision_id):
1469
 
        """Try to automatically find the tag name for a revision.
1470
 
 
1471
 
        :param revision_id: Revision id of the revision.
1472
 
        :return: A tag name or None if no tag name could be determined.
1473
 
        """
1474
 
        for hook in Branch.hooks['automatic_tag_name']:
1475
 
            ret = hook(self, revision_id)
1476
 
            if ret is not None:
1477
 
                return ret
1478
 
        return None
1479
 
 
1480
1288
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1481
1289
                                         other_branch):
1482
1290
        """Ensure that revision_b is a descendant of revision_a.
1537
1345
    _formats = {}
1538
1346
    """The known formats."""
1539
1347
 
1540
 
    can_set_append_revisions_only = True
1541
 
 
1542
1348
    def __eq__(self, other):
1543
1349
        return self.__class__ is other.__class__
1544
1350
 
1546
1352
        return not (self == other)
1547
1353
 
1548
1354
    @classmethod
1549
 
    def find_format(klass, a_bzrdir, name=None):
 
1355
    def find_format(klass, a_bzrdir):
1550
1356
        """Return the format for the branch object in a_bzrdir."""
1551
1357
        try:
1552
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1553
 
            format_string = transport.get_bytes("format")
1554
 
            format = klass._formats[format_string]
1555
 
            if isinstance(format, MetaDirBranchFormatFactory):
1556
 
                return format()
1557
 
            return format
 
1358
            transport = a_bzrdir.get_branch_transport(None)
 
1359
            format_string = transport.get("format").read()
 
1360
            return klass._formats[format_string]
1558
1361
        except errors.NoSuchFile:
1559
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1362
            raise errors.NotBranchError(path=transport.base)
1560
1363
        except KeyError:
1561
1364
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1562
1365
 
1565
1368
        """Return the current default format."""
1566
1369
        return klass._default_format
1567
1370
 
1568
 
    @classmethod
1569
 
    def get_formats(klass):
1570
 
        """Get all the known formats.
1571
 
 
1572
 
        Warning: This triggers a load of all lazy registered formats: do not
1573
 
        use except when that is desireed.
1574
 
        """
1575
 
        result = []
1576
 
        for fmt in klass._formats.values():
1577
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1578
 
                fmt = fmt()
1579
 
            result.append(fmt)
1580
 
        return result
1581
 
 
1582
 
    def get_reference(self, a_bzrdir, name=None):
 
1371
    def get_reference(self, a_bzrdir):
1583
1372
        """Get the target reference of the branch in a_bzrdir.
1584
1373
 
1585
1374
        format probing must have been completed before calling
1587
1376
        in a_bzrdir is correct.
1588
1377
 
1589
1378
        :param a_bzrdir: The bzrdir to get the branch data from.
1590
 
        :param name: Name of the colocated branch to fetch
1591
1379
        :return: None if the branch is not a reference branch.
1592
1380
        """
1593
1381
        return None
1594
1382
 
1595
1383
    @classmethod
1596
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1384
    def set_reference(self, a_bzrdir, to_branch):
1597
1385
        """Set the target reference of the branch in a_bzrdir.
1598
1386
 
1599
1387
        format probing must have been completed before calling
1601
1389
        in a_bzrdir is correct.
1602
1390
 
1603
1391
        :param a_bzrdir: The bzrdir to set the branch reference for.
1604
 
        :param name: Name of colocated branch to set, None for default
1605
1392
        :param to_branch: branch that the checkout is to reference
1606
1393
        """
1607
1394
        raise NotImplementedError(self.set_reference)
1614
1401
        """Return the short format description for this format."""
1615
1402
        raise NotImplementedError(self.get_format_description)
1616
1403
 
1617
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1618
 
        hooks = Branch.hooks['post_branch_init']
1619
 
        if not hooks:
1620
 
            return
1621
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1622
 
        for hook in hooks:
1623
 
            hook(params)
1624
 
 
1625
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
 
                           lock_type='metadir', set_format=True):
 
1404
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1405
                           set_format=True):
1627
1406
        """Initialize a branch in a bzrdir, with specified files
1628
1407
 
1629
1408
        :param a_bzrdir: The bzrdir to initialize the branch in
1630
1409
        :param utf8_files: The files to create as a list of
1631
1410
            (filename, content) tuples
1632
 
        :param name: Name of colocated branch to create, if any
1633
1411
        :param set_format: If True, set the format with
1634
1412
            self.get_format_string.  (BzrBranch4 has its format set
1635
1413
            elsewhere)
1636
1414
        :return: a branch in this format
1637
1415
        """
1638
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1416
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1417
        branch_transport = a_bzrdir.get_branch_transport(self)
1640
1418
        lock_map = {
1641
1419
            'metadir': ('lock', lockdir.LockDir),
1642
1420
            'branch4': ('branch-lock', lockable_files.TransportLock),
1663
1441
        finally:
1664
1442
            if lock_taken:
1665
1443
                control_files.unlock()
1666
 
        branch = self.open(a_bzrdir, name, _found=True)
1667
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1668
 
        return branch
 
1444
        return self.open(a_bzrdir, _found=True)
1669
1445
 
1670
 
    def initialize(self, a_bzrdir, name=None):
1671
 
        """Create a branch of this format in a_bzrdir.
1672
 
        
1673
 
        :param name: Name of the colocated branch to create.
1674
 
        """
 
1446
    def initialize(self, a_bzrdir):
 
1447
        """Create a branch of this format in a_bzrdir."""
1675
1448
        raise NotImplementedError(self.initialize)
1676
1449
 
1677
1450
    def is_supported(self):
1707
1480
        """
1708
1481
        raise NotImplementedError(self.network_name)
1709
1482
 
1710
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1483
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1711
1484
        """Return the branch object for a_bzrdir
1712
1485
 
1713
1486
        :param a_bzrdir: A BzrDir that contains a branch.
1714
 
        :param name: Name of colocated branch to open
1715
1487
        :param _found: a private parameter, do not use it. It is used to
1716
1488
            indicate if format probing has already be done.
1717
1489
        :param ignore_fallbacks: when set, no fallback branches will be opened
1721
1493
 
1722
1494
    @classmethod
1723
1495
    def register_format(klass, format):
1724
 
        """Register a metadir format.
1725
 
        
1726
 
        See MetaDirBranchFormatFactory for the ability to register a format
1727
 
        without loading the code the format needs until it is actually used.
1728
 
        """
 
1496
        """Register a metadir format."""
1729
1497
        klass._formats[format.get_format_string()] = format
1730
1498
        # Metadir formats have a network name of their format string, and get
1731
 
        # registered as factories.
1732
 
        if isinstance(format, MetaDirBranchFormatFactory):
1733
 
            network_format_registry.register(format.get_format_string(), format)
1734
 
        else:
1735
 
            network_format_registry.register(format.get_format_string(),
1736
 
                format.__class__)
 
1499
        # registered as class factories.
 
1500
        network_format_registry.register(format.get_format_string(), format.__class__)
1737
1501
 
1738
1502
    @classmethod
1739
1503
    def set_default_format(klass, format):
1740
1504
        klass._default_format = format
1741
1505
 
1742
 
    def supports_set_append_revisions_only(self):
1743
 
        """True if this format supports set_append_revisions_only."""
1744
 
        return False
1745
 
 
1746
1506
    def supports_stacking(self):
1747
1507
        """True if this format records a stacked-on branch."""
1748
1508
        return False
1759
1519
        return False  # by default
1760
1520
 
1761
1521
 
1762
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1764
 
    
1765
 
    While none of the built in BranchFormats are lazy registered yet,
1766
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
 
    use it, and the bzr-loom plugin uses it as well (see
1768
 
    bzrlib.plugins.loom.formats).
1769
 
    """
1770
 
 
1771
 
    def __init__(self, format_string, module_name, member_name):
1772
 
        """Create a MetaDirBranchFormatFactory.
1773
 
 
1774
 
        :param format_string: The format string the format has.
1775
 
        :param module_name: Module to load the format class from.
1776
 
        :param member_name: Attribute name within the module for the format class.
1777
 
        """
1778
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
 
        self._format_string = format_string
1780
 
        
1781
 
    def get_format_string(self):
1782
 
        """See BranchFormat.get_format_string."""
1783
 
        return self._format_string
1784
 
 
1785
 
    def __call__(self):
1786
 
        """Used for network_format_registry support."""
1787
 
        return self.get_obj()()
1788
 
 
1789
 
 
1790
1522
class BranchHooks(Hooks):
1791
1523
    """A dictionary mapping hook name to a list of callables for branch hooks.
1792
1524
 
1861
1593
            "multiple hooks installed for transform_fallback_location, "
1862
1594
            "all are called with the url returned from the previous hook."
1863
1595
            "The order is however undefined.", (1, 9), None))
1864
 
        self.create_hook(HookPoint('automatic_tag_name',
1865
 
            "Called to determine an automatic tag name for a revision. "
1866
 
            "automatic_tag_name is called with (branch, revision_id) and "
1867
 
            "should return a tag name or None if no tag name could be "
1868
 
            "determined. The first non-None tag name returned will be used.",
1869
 
            (2, 2), None))
1870
 
        self.create_hook(HookPoint('post_branch_init',
1871
 
            "Called after new branch initialization completes. "
1872
 
            "post_branch_init is called with a "
1873
 
            "bzrlib.branch.BranchInitHookParams. "
1874
 
            "Note that init, branch and checkout (both heavyweight and "
1875
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1876
 
        self.create_hook(HookPoint('post_switch',
1877
 
            "Called after a checkout switches branch. "
1878
 
            "post_switch is called with a "
1879
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1880
 
 
1881
1596
 
1882
1597
 
1883
1598
# install the default hooks into the Branch class.
1922
1637
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1923
1638
 
1924
1639
 
1925
 
class BranchInitHookParams(object):
1926
 
    """Object holding parameters passed to *_branch_init hooks.
1927
 
 
1928
 
    There are 4 fields that hooks may wish to access:
1929
 
 
1930
 
    :ivar format: the branch format
1931
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1932
 
    :ivar name: name of colocated branch, if any (or None)
1933
 
    :ivar branch: the branch created
1934
 
 
1935
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
 
    the checkout, hence they are different from the corresponding fields in
1937
 
    branch, which refer to the original branch.
1938
 
    """
1939
 
 
1940
 
    def __init__(self, format, a_bzrdir, name, branch):
1941
 
        """Create a group of BranchInitHook parameters.
1942
 
 
1943
 
        :param format: the branch format
1944
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1945
 
            initialized
1946
 
        :param name: name of colocated branch, if any (or None)
1947
 
        :param branch: the branch created
1948
 
 
1949
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1950
 
        to the checkout, hence they are different from the corresponding fields
1951
 
        in branch, which refer to the original branch.
1952
 
        """
1953
 
        self.format = format
1954
 
        self.bzrdir = a_bzrdir
1955
 
        self.name = name
1956
 
        self.branch = branch
1957
 
 
1958
 
    def __eq__(self, other):
1959
 
        return self.__dict__ == other.__dict__
1960
 
 
1961
 
    def __repr__(self):
1962
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
 
1964
 
 
1965
 
class SwitchHookParams(object):
1966
 
    """Object holding parameters passed to *_switch hooks.
1967
 
 
1968
 
    There are 4 fields that hooks may wish to access:
1969
 
 
1970
 
    :ivar control_dir: BzrDir of the checkout to change
1971
 
    :ivar to_branch: branch that the checkout is to reference
1972
 
    :ivar force: skip the check for local commits in a heavy checkout
1973
 
    :ivar revision_id: revision ID to switch to (or None)
1974
 
    """
1975
 
 
1976
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1977
 
        """Create a group of SwitchHook parameters.
1978
 
 
1979
 
        :param control_dir: BzrDir of the checkout to change
1980
 
        :param to_branch: branch that the checkout is to reference
1981
 
        :param force: skip the check for local commits in a heavy checkout
1982
 
        :param revision_id: revision ID to switch to (or None)
1983
 
        """
1984
 
        self.control_dir = control_dir
1985
 
        self.to_branch = to_branch
1986
 
        self.force = force
1987
 
        self.revision_id = revision_id
1988
 
 
1989
 
    def __eq__(self, other):
1990
 
        return self.__dict__ == other.__dict__
1991
 
 
1992
 
    def __repr__(self):
1993
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
 
            self.control_dir, self.to_branch,
1995
 
            self.revision_id)
1996
 
 
1997
 
 
1998
1640
class BzrBranchFormat4(BranchFormat):
1999
1641
    """Bzr branch format 4.
2000
1642
 
2007
1649
        """See BranchFormat.get_format_description()."""
2008
1650
        return "Branch format 4"
2009
1651
 
2010
 
    def initialize(self, a_bzrdir, name=None):
 
1652
    def initialize(self, a_bzrdir):
2011
1653
        """Create a branch of this format in a_bzrdir."""
2012
1654
        utf8_files = [('revision-history', ''),
2013
1655
                      ('branch-name', ''),
2014
1656
                      ]
2015
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1657
        return self._initialize_helper(a_bzrdir, utf8_files,
2016
1658
                                       lock_type='branch4', set_format=False)
2017
1659
 
2018
1660
    def __init__(self):
2023
1665
        """The network name for this format is the control dirs disk label."""
2024
1666
        return self._matchingbzrdir.get_format_string()
2025
1667
 
2026
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1668
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2027
1669
        """See BranchFormat.open()."""
2028
1670
        if not _found:
2029
1671
            # we are being called directly and must probe.
2031
1673
        return BzrBranch(_format=self,
2032
1674
                         _control_files=a_bzrdir._control_files,
2033
1675
                         a_bzrdir=a_bzrdir,
2034
 
                         name=name,
2035
1676
                         _repository=a_bzrdir.open_repository())
2036
1677
 
2037
1678
    def __str__(self):
2052
1693
        """
2053
1694
        return self.get_format_string()
2054
1695
 
2055
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1696
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2056
1697
        """See BranchFormat.open()."""
2057
1698
        if not _found:
2058
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1699
            format = BranchFormat.find_format(a_bzrdir)
2059
1700
            if format.__class__ != self.__class__:
2060
1701
                raise AssertionError("wrong format %r found for %r" %
2061
1702
                    (format, self))
2062
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2063
1703
        try:
 
1704
            transport = a_bzrdir.get_branch_transport(None)
2064
1705
            control_files = lockable_files.LockableFiles(transport, 'lock',
2065
1706
                                                         lockdir.LockDir)
2066
1707
            return self._branch_class()(_format=self,
2067
1708
                              _control_files=control_files,
2068
 
                              name=name,
2069
1709
                              a_bzrdir=a_bzrdir,
2070
1710
                              _repository=a_bzrdir.find_repository(),
2071
1711
                              ignore_fallbacks=ignore_fallbacks)
2072
1712
        except errors.NoSuchFile:
2073
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1713
            raise errors.NotBranchError(path=transport.base)
2074
1714
 
2075
1715
    def __init__(self):
2076
1716
        super(BranchFormatMetadir, self).__init__()
2105
1745
        """See BranchFormat.get_format_description()."""
2106
1746
        return "Branch format 5"
2107
1747
 
2108
 
    def initialize(self, a_bzrdir, name=None):
 
1748
    def initialize(self, a_bzrdir):
2109
1749
        """Create a branch of this format in a_bzrdir."""
2110
1750
        utf8_files = [('revision-history', ''),
2111
1751
                      ('branch-name', ''),
2112
1752
                      ]
2113
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1753
        return self._initialize_helper(a_bzrdir, utf8_files)
2114
1754
 
2115
1755
    def supports_tags(self):
2116
1756
        return False
2138
1778
        """See BranchFormat.get_format_description()."""
2139
1779
        return "Branch format 6"
2140
1780
 
2141
 
    def initialize(self, a_bzrdir, name=None):
 
1781
    def initialize(self, a_bzrdir):
2142
1782
        """Create a branch of this format in a_bzrdir."""
2143
1783
        utf8_files = [('last-revision', '0 null:\n'),
2144
1784
                      ('branch.conf', ''),
2145
1785
                      ('tags', ''),
2146
1786
                      ]
2147
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1787
        return self._initialize_helper(a_bzrdir, utf8_files)
2148
1788
 
2149
1789
    def make_tags(self, branch):
2150
1790
        """See bzrlib.branch.BranchFormat.make_tags()."""
2151
1791
        return BasicTags(branch)
2152
1792
 
2153
 
    def supports_set_append_revisions_only(self):
2154
 
        return True
2155
1793
 
2156
1794
 
2157
1795
class BzrBranchFormat8(BranchFormatMetadir):
2168
1806
        """See BranchFormat.get_format_description()."""
2169
1807
        return "Branch format 8"
2170
1808
 
2171
 
    def initialize(self, a_bzrdir, name=None):
 
1809
    def initialize(self, a_bzrdir):
2172
1810
        """Create a branch of this format in a_bzrdir."""
2173
1811
        utf8_files = [('last-revision', '0 null:\n'),
2174
1812
                      ('branch.conf', ''),
2175
1813
                      ('tags', ''),
2176
1814
                      ('references', '')
2177
1815
                      ]
2178
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1816
        return self._initialize_helper(a_bzrdir, utf8_files)
2179
1817
 
2180
1818
    def __init__(self):
2181
1819
        super(BzrBranchFormat8, self).__init__()
2186
1824
        """See bzrlib.branch.BranchFormat.make_tags()."""
2187
1825
        return BasicTags(branch)
2188
1826
 
2189
 
    def supports_set_append_revisions_only(self):
2190
 
        return True
2191
 
 
2192
1827
    def supports_stacking(self):
2193
1828
        return True
2194
1829
 
2204
1839
    This format was introduced in bzr 1.6.
2205
1840
    """
2206
1841
 
2207
 
    def initialize(self, a_bzrdir, name=None):
 
1842
    def initialize(self, a_bzrdir):
2208
1843
        """Create a branch of this format in a_bzrdir."""
2209
1844
        utf8_files = [('last-revision', '0 null:\n'),
2210
1845
                      ('branch.conf', ''),
2211
1846
                      ('tags', ''),
2212
1847
                      ]
2213
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1848
        return self._initialize_helper(a_bzrdir, utf8_files)
2214
1849
 
2215
1850
    def _branch_class(self):
2216
1851
        return BzrBranch7
2223
1858
        """See BranchFormat.get_format_description()."""
2224
1859
        return "Branch format 7"
2225
1860
 
2226
 
    def supports_set_append_revisions_only(self):
2227
 
        return True
2228
 
 
2229
1861
    supports_reference_locations = False
2230
1862
 
2231
1863
 
2248
1880
        """See BranchFormat.get_format_description()."""
2249
1881
        return "Checkout reference format 1"
2250
1882
 
2251
 
    def get_reference(self, a_bzrdir, name=None):
 
1883
    def get_reference(self, a_bzrdir):
2252
1884
        """See BranchFormat.get_reference()."""
2253
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2254
 
        return transport.get_bytes('location')
 
1885
        transport = a_bzrdir.get_branch_transport(None)
 
1886
        return transport.get('location').read()
2255
1887
 
2256
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1888
    def set_reference(self, a_bzrdir, to_branch):
2257
1889
        """See BranchFormat.set_reference()."""
2258
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1890
        transport = a_bzrdir.get_branch_transport(None)
2259
1891
        location = transport.put_bytes('location', to_branch.base)
2260
1892
 
2261
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1893
    def initialize(self, a_bzrdir, target_branch=None):
2262
1894
        """Create a branch of this format in a_bzrdir."""
2263
1895
        if target_branch is None:
2264
1896
            # this format does not implement branch itself, thus the implicit
2265
1897
            # creation contract must see it as uninitializable
2266
1898
            raise errors.UninitializableFormat(self)
2267
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1899
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1900
        branch_transport = a_bzrdir.get_branch_transport(self)
2269
1901
        branch_transport.put_bytes('location',
2270
 
            target_branch.bzrdir.user_url)
 
1902
            target_branch.bzrdir.root_transport.base)
2271
1903
        branch_transport.put_bytes('format', self.get_format_string())
2272
 
        branch = self.open(
2273
 
            a_bzrdir, name, _found=True,
 
1904
        return self.open(
 
1905
            a_bzrdir, _found=True,
2274
1906
            possible_transports=[target_branch.bzrdir.root_transport])
2275
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2276
 
        return branch
2277
1907
 
2278
1908
    def __init__(self):
2279
1909
        super(BranchReferenceFormat, self).__init__()
2285
1915
        def clone(to_bzrdir, revision_id=None,
2286
1916
            repository_policy=None):
2287
1917
            """See Branch.clone()."""
2288
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1918
            return format.initialize(to_bzrdir, a_branch)
2289
1919
            # cannot obey revision_id limits when cloning a reference ...
2290
1920
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2291
1921
            # emit some sort of warning/error to the caller ?!
2292
1922
        return clone
2293
1923
 
2294
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1924
    def open(self, a_bzrdir, _found=False, location=None,
2295
1925
             possible_transports=None, ignore_fallbacks=False):
2296
1926
        """Return the branch that the branch reference in a_bzrdir points at.
2297
1927
 
2298
1928
        :param a_bzrdir: A BzrDir that contains a branch.
2299
 
        :param name: Name of colocated branch to open, if any
2300
1929
        :param _found: a private parameter, do not use it. It is used to
2301
1930
            indicate if format probing has already be done.
2302
1931
        :param ignore_fallbacks: when set, no fallback branches will be opened
2307
1936
        :param possible_transports: An optional reusable transports list.
2308
1937
        """
2309
1938
        if not _found:
2310
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1939
            format = BranchFormat.find_format(a_bzrdir)
2311
1940
            if format.__class__ != self.__class__:
2312
1941
                raise AssertionError("wrong format %r found for %r" %
2313
1942
                    (format, self))
2314
1943
        if location is None:
2315
 
            location = self.get_reference(a_bzrdir, name)
 
1944
            location = self.get_reference(a_bzrdir)
2316
1945
        real_bzrdir = bzrdir.BzrDir.open(
2317
1946
            location, possible_transports=possible_transports)
2318
 
        result = real_bzrdir.open_branch(name=name, 
2319
 
            ignore_fallbacks=ignore_fallbacks)
 
1947
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2320
1948
        # this changes the behaviour of result.clone to create a new reference
2321
1949
        # rather than a copy of the content of the branch.
2322
1950
        # I did not use a proxy object because that needs much more extensive
2349
1977
BranchFormat.register_format(__format6)
2350
1978
BranchFormat.register_format(__format7)
2351
1979
BranchFormat.register_format(__format8)
2352
 
BranchFormat.set_default_format(__format7)
 
1980
BranchFormat.set_default_format(__format6)
2353
1981
_legacy_formats = [BzrBranchFormat4(),
2354
1982
    ]
2355
1983
network_format_registry.register(
2356
1984
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2357
1985
 
2358
1986
 
2359
 
class BranchWriteLockResult(LogicalLockResult):
2360
 
    """The result of write locking a branch.
2361
 
 
2362
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2363
 
        None.
2364
 
    :ivar unlock: A callable which will unlock the lock.
2365
 
    """
2366
 
 
2367
 
    def __init__(self, unlock, branch_token):
2368
 
        LogicalLockResult.__init__(self, unlock)
2369
 
        self.branch_token = branch_token
2370
 
 
2371
 
    def __repr__(self):
2372
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2373
 
            self.unlock)
2374
 
 
2375
 
 
2376
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1987
class BzrBranch(Branch):
2377
1988
    """A branch stored in the actual filesystem.
2378
1989
 
2379
1990
    Note that it's "local" in the context of the filesystem; it doesn't
2385
1996
    :ivar repository: Repository for this branch.
2386
1997
    :ivar base: The url of the base directory for this branch; the one
2387
1998
        containing the .bzr directory.
2388
 
    :ivar name: Optional colocated branch name as it exists in the control
2389
 
        directory.
2390
1999
    """
2391
2000
 
2392
2001
    def __init__(self, _format=None,
2393
 
                 _control_files=None, a_bzrdir=None, name=None,
2394
 
                 _repository=None, ignore_fallbacks=False):
 
2002
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2003
                 ignore_fallbacks=False):
2395
2004
        """Create new branch object at a particular location."""
2396
2005
        if a_bzrdir is None:
2397
2006
            raise ValueError('a_bzrdir must be supplied')
2398
2007
        else:
2399
2008
            self.bzrdir = a_bzrdir
2400
2009
        self._base = self.bzrdir.transport.clone('..').base
2401
 
        self.name = name
2402
2010
        # XXX: We should be able to just do
2403
2011
        #   self.base = self.bzrdir.root_transport.base
2404
2012
        # but this does not quite work yet -- mbp 20080522
2411
2019
        Branch.__init__(self)
2412
2020
 
2413
2021
    def __str__(self):
2414
 
        if self.name is None:
2415
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2416
 
        else:
2417
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2418
 
                self.name)
 
2022
        return '%s(%r)' % (self.__class__.__name__, self.base)
2419
2023
 
2420
2024
    __repr__ = __str__
2421
2025
 
2432
2036
        return self.control_files.is_locked()
2433
2037
 
2434
2038
    def lock_write(self, token=None):
2435
 
        """Lock the branch for write operations.
2436
 
 
2437
 
        :param token: A token to permit reacquiring a previously held and
2438
 
            preserved lock.
2439
 
        :return: A BranchWriteLockResult.
2440
 
        """
2441
 
        if not self.is_locked():
2442
 
            self._note_lock('w')
2443
2039
        # All-in-one needs to always unlock/lock.
2444
2040
        repo_control = getattr(self.repository, 'control_files', None)
2445
2041
        if self.control_files == repo_control or not self.is_locked():
2446
 
            self.repository._warn_if_deprecated(self)
2447
2042
            self.repository.lock_write()
2448
2043
            took_lock = True
2449
2044
        else:
2450
2045
            took_lock = False
2451
2046
        try:
2452
 
            return BranchWriteLockResult(self.unlock,
2453
 
                self.control_files.lock_write(token=token))
 
2047
            return self.control_files.lock_write(token=token)
2454
2048
        except:
2455
2049
            if took_lock:
2456
2050
                self.repository.unlock()
2457
2051
            raise
2458
2052
 
2459
2053
    def lock_read(self):
2460
 
        """Lock the branch for read operations.
2461
 
 
2462
 
        :return: A bzrlib.lock.LogicalLockResult.
2463
 
        """
2464
 
        if not self.is_locked():
2465
 
            self._note_lock('r')
2466
2054
        # All-in-one needs to always unlock/lock.
2467
2055
        repo_control = getattr(self.repository, 'control_files', None)
2468
2056
        if self.control_files == repo_control or not self.is_locked():
2469
 
            self.repository._warn_if_deprecated(self)
2470
2057
            self.repository.lock_read()
2471
2058
            took_lock = True
2472
2059
        else:
2473
2060
            took_lock = False
2474
2061
        try:
2475
2062
            self.control_files.lock_read()
2476
 
            return LogicalLockResult(self.unlock)
2477
2063
        except:
2478
2064
            if took_lock:
2479
2065
                self.repository.unlock()
2480
2066
            raise
2481
2067
 
2482
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2483
2068
    def unlock(self):
2484
2069
        try:
2485
2070
            self.control_files.unlock()
2648
2233
        return result
2649
2234
 
2650
2235
    def get_stacked_on_url(self):
2651
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2236
        raise errors.UnstackableBranchFormat(self._format, self.base)
2652
2237
 
2653
2238
    def set_push_location(self, location):
2654
2239
        """See Branch.set_push_location."""
2787
2372
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
2373
        super(BzrBranch8, self).__init__(*args, **kwargs)
2789
2374
        self._last_revision_info_cache = None
 
2375
        self._partial_revision_history_cache = []
2790
2376
        self._reference_info = None
2791
2377
 
2792
2378
    def _clear_cached_state(self):
2793
2379
        super(BzrBranch8, self)._clear_cached_state()
2794
2380
        self._last_revision_info_cache = None
 
2381
        self._partial_revision_history_cache = []
2795
2382
        self._reference_info = None
2796
2383
 
2797
2384
    def _last_revision_info(self):
2844
2431
        if _mod_revision.is_null(last_revision):
2845
2432
            return
2846
2433
        if last_revision not in self._lefthand_history(revision_id):
2847
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2434
            raise errors.AppendRevisionsOnlyViolation(self.base)
2848
2435
 
2849
2436
    def _gen_revision_history(self):
2850
2437
        """Generate the revision history from last revision
2853
2440
        self._extend_partial_history(stop_index=last_revno-1)
2854
2441
        return list(reversed(self._partial_revision_history_cache))
2855
2442
 
 
2443
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2444
        """Extend the partial history to include a given index
 
2445
 
 
2446
        If a stop_index is supplied, stop when that index has been reached.
 
2447
        If a stop_revision is supplied, stop when that revision is
 
2448
        encountered.  Otherwise, stop when the beginning of history is
 
2449
        reached.
 
2450
 
 
2451
        :param stop_index: The index which should be present.  When it is
 
2452
            present, history extension will stop.
 
2453
        :param revision_id: The revision id which should be present.  When
 
2454
            it is encountered, history extension will stop.
 
2455
        """
 
2456
        repo = self.repository
 
2457
        if len(self._partial_revision_history_cache) == 0:
 
2458
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2459
        else:
 
2460
            start_revision = self._partial_revision_history_cache[-1]
 
2461
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2462
            #skip the last revision in the list
 
2463
            next_revision = iterator.next()
 
2464
        for revision_id in iterator:
 
2465
            self._partial_revision_history_cache.append(revision_id)
 
2466
            if (stop_index is not None and
 
2467
                len(self._partial_revision_history_cache) > stop_index):
 
2468
                break
 
2469
            if revision_id == stop_revision:
 
2470
                break
 
2471
 
2856
2472
    def _write_revision_history(self, history):
2857
2473
        """Factored out of set_revision_history.
2858
2474
 
2950
2566
        if branch_location is None:
2951
2567
            return Branch.reference_parent(self, file_id, path,
2952
2568
                                           possible_transports)
2953
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2569
        branch_location = urlutils.join(self.base, branch_location)
2954
2570
        return Branch.open(branch_location,
2955
2571
                           possible_transports=possible_transports)
2956
2572
 
3001
2617
            raise errors.NotStacked(self)
3002
2618
        return stacked_url
3003
2619
 
 
2620
    def set_append_revisions_only(self, enabled):
 
2621
        if enabled:
 
2622
            value = 'True'
 
2623
        else:
 
2624
            value = 'False'
 
2625
        self.get_config().set_user_option('append_revisions_only', value,
 
2626
            warn_masked=True)
 
2627
 
3004
2628
    def _get_append_revisions_only(self):
3005
 
        return self.get_config(
3006
 
            ).get_user_option_as_bool('append_revisions_only')
 
2629
        value = self.get_config().get_user_option('append_revisions_only')
 
2630
        return value == 'True'
3007
2631
 
3008
2632
    @needs_write_lock
3009
2633
    def generate_revision_history(self, revision_id, last_rev=None,
3071
2695
    """
3072
2696
 
3073
2697
    def get_stacked_on_url(self):
3074
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2698
        raise errors.UnstackableBranchFormat(self._format, self.base)
3075
2699
 
3076
2700
 
3077
2701
######################################################################
3156
2780
 
3157
2781
    def __init__(self, branch):
3158
2782
        self.branch = branch
3159
 
        self.errors = []
3160
2783
 
3161
2784
    def report_results(self, verbose):
3162
2785
        """Report the check results via trace.note.
3164
2787
        :param verbose: Requests more detailed display of what was checked,
3165
2788
            if any.
3166
2789
        """
3167
 
        note('checked branch %s format %s', self.branch.user_url,
3168
 
            self.branch._format)
3169
 
        for error in self.errors:
3170
 
            note('found error:%s', error)
 
2790
        note('checked branch %s format %s',
 
2791
             self.branch.base,
 
2792
             self.branch._format)
3171
2793
 
3172
2794
 
3173
2795
class Converter5to6(object):
3265
2887
    _optimisers = []
3266
2888
    """The available optimised InterBranch types."""
3267
2889
 
3268
 
    @classmethod
3269
 
    def _get_branch_formats_to_test(klass):
3270
 
        """Return an iterable of format tuples for testing.
3271
 
        
3272
 
        :return: An iterable of (from_format, to_format) to use when testing
3273
 
            this InterBranch class. Each InterBranch class should define this
3274
 
            method itself.
3275
 
        """
3276
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2890
    @staticmethod
 
2891
    def _get_branch_formats_to_test():
 
2892
        """Return a tuple with the Branch formats to use when testing."""
 
2893
        raise NotImplementedError(self._get_branch_formats_to_test)
3277
2894
 
3278
 
    @needs_write_lock
3279
2895
    def pull(self, overwrite=False, stop_revision=None,
3280
2896
             possible_transports=None, local=False):
3281
2897
        """Mirror source into target branch.
3286
2902
        """
3287
2903
        raise NotImplementedError(self.pull)
3288
2904
 
3289
 
    @needs_write_lock
3290
2905
    def update_revisions(self, stop_revision=None, overwrite=False,
3291
2906
                         graph=None):
3292
2907
        """Pull in new perfect-fit revisions.
3300
2915
        """
3301
2916
        raise NotImplementedError(self.update_revisions)
3302
2917
 
3303
 
    @needs_write_lock
3304
2918
    def push(self, overwrite=False, stop_revision=None,
3305
2919
             _override_hook_source_branch=None):
3306
2920
        """Mirror the source branch into the target branch.
3309
2923
        """
3310
2924
        raise NotImplementedError(self.push)
3311
2925
 
3312
 
    @needs_write_lock
3313
 
    def copy_content_into(self, revision_id=None):
3314
 
        """Copy the content of source into target
3315
 
 
3316
 
        revision_id: if not None, the revision history in the new branch will
3317
 
                     be truncated to end with revision_id.
3318
 
        """
3319
 
        raise NotImplementedError(self.copy_content_into)
3320
 
 
3321
2926
 
3322
2927
class GenericInterBranch(InterBranch):
3323
 
    """InterBranch implementation that uses public Branch functions."""
3324
 
 
3325
 
    @classmethod
3326
 
    def is_compatible(klass, source, target):
3327
 
        # GenericBranch uses the public API, so always compatible
3328
 
        return True
3329
 
 
3330
 
    @classmethod
3331
 
    def _get_branch_formats_to_test(klass):
3332
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3333
 
 
3334
 
    @classmethod
3335
 
    def unwrap_format(klass, format):
3336
 
        if isinstance(format, remote.RemoteBranchFormat):
3337
 
            format._ensure_real()
3338
 
            return format._custom_format
3339
 
        return format                                                                                                  
3340
 
 
3341
 
    @needs_write_lock
3342
 
    def copy_content_into(self, revision_id=None):
3343
 
        """Copy the content of source into target
3344
 
 
3345
 
        revision_id: if not None, the revision history in the new branch will
3346
 
                     be truncated to end with revision_id.
3347
 
        """
3348
 
        self.source.update_references(self.target)
3349
 
        self.source._synchronize_history(self.target, revision_id)
3350
 
        try:
3351
 
            parent = self.source.get_parent()
3352
 
        except errors.InaccessibleParent, e:
3353
 
            mutter('parent was not accessible to copy: %s', e)
3354
 
        else:
3355
 
            if parent:
3356
 
                self.target.set_parent(parent)
3357
 
        if self.source._push_should_merge_tags():
3358
 
            self.source.tags.merge_to(self.target.tags)
3359
 
 
3360
 
    @needs_write_lock
 
2928
    """InterBranch implementation that uses public Branch functions.
 
2929
    """
 
2930
 
 
2931
    @staticmethod
 
2932
    def _get_branch_formats_to_test():
 
2933
        return BranchFormat._default_format, BranchFormat._default_format
 
2934
 
3361
2935
    def update_revisions(self, stop_revision=None, overwrite=False,
3362
2936
        graph=None):
3363
2937
        """See InterBranch.update_revisions()."""
3364
 
        other_revno, other_last_revision = self.source.last_revision_info()
3365
 
        stop_revno = None # unknown
3366
 
        if stop_revision is None:
3367
 
            stop_revision = other_last_revision
3368
 
            if _mod_revision.is_null(stop_revision):
3369
 
                # if there are no commits, we're done.
3370
 
                return
3371
 
            stop_revno = other_revno
3372
 
 
3373
 
        # what's the current last revision, before we fetch [and change it
3374
 
        # possibly]
3375
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3376
 
        # we fetch here so that we don't process data twice in the common
3377
 
        # case of having something to pull, and so that the check for
3378
 
        # already merged can operate on the just fetched graph, which will
3379
 
        # be cached in memory.
3380
 
        self.target.fetch(self.source, stop_revision)
3381
 
        # Check to see if one is an ancestor of the other
3382
 
        if not overwrite:
3383
 
            if graph is None:
3384
 
                graph = self.target.repository.get_graph()
3385
 
            if self.target._check_if_descendant_or_diverged(
3386
 
                    stop_revision, last_rev, graph, self.source):
3387
 
                # stop_revision is a descendant of last_rev, but we aren't
3388
 
                # overwriting, so we're done.
3389
 
                return
3390
 
        if stop_revno is None:
3391
 
            if graph is None:
3392
 
                graph = self.target.repository.get_graph()
3393
 
            this_revno, this_last_revision = \
3394
 
                    self.target.last_revision_info()
3395
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3396
 
                            [(other_last_revision, other_revno),
3397
 
                             (this_last_revision, this_revno)])
3398
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3399
 
 
3400
 
    @needs_write_lock
 
2938
        self.source.lock_read()
 
2939
        try:
 
2940
            other_revno, other_last_revision = self.source.last_revision_info()
 
2941
            stop_revno = None # unknown
 
2942
            if stop_revision is None:
 
2943
                stop_revision = other_last_revision
 
2944
                if _mod_revision.is_null(stop_revision):
 
2945
                    # if there are no commits, we're done.
 
2946
                    return
 
2947
                stop_revno = other_revno
 
2948
 
 
2949
            # what's the current last revision, before we fetch [and change it
 
2950
            # possibly]
 
2951
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2952
            # we fetch here so that we don't process data twice in the common
 
2953
            # case of having something to pull, and so that the check for
 
2954
            # already merged can operate on the just fetched graph, which will
 
2955
            # be cached in memory.
 
2956
            self.target.fetch(self.source, stop_revision)
 
2957
            # Check to see if one is an ancestor of the other
 
2958
            if not overwrite:
 
2959
                if graph is None:
 
2960
                    graph = self.target.repository.get_graph()
 
2961
                if self.target._check_if_descendant_or_diverged(
 
2962
                        stop_revision, last_rev, graph, self.source):
 
2963
                    # stop_revision is a descendant of last_rev, but we aren't
 
2964
                    # overwriting, so we're done.
 
2965
                    return
 
2966
            if stop_revno is None:
 
2967
                if graph is None:
 
2968
                    graph = self.target.repository.get_graph()
 
2969
                this_revno, this_last_revision = \
 
2970
                        self.target.last_revision_info()
 
2971
                stop_revno = graph.find_distance_to_null(stop_revision,
 
2972
                                [(other_last_revision, other_revno),
 
2973
                                 (this_last_revision, this_revno)])
 
2974
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
2975
        finally:
 
2976
            self.source.unlock()
 
2977
 
3401
2978
    def pull(self, overwrite=False, stop_revision=None,
3402
 
             possible_transports=None, run_hooks=True,
 
2979
             possible_transports=None, _hook_master=None, run_hooks=True,
3403
2980
             _override_hook_target=None, local=False):
3404
 
        """Pull from source into self, updating my master if any.
 
2981
        """See Branch.pull.
3405
2982
 
 
2983
        :param _hook_master: Private parameter - set the branch to
 
2984
            be supplied as the master to pull hooks.
3406
2985
        :param run_hooks: Private parameter - if false, this branch
3407
2986
            is being called because it's the master of the primary branch,
3408
2987
            so it should not run its hooks.
 
2988
        :param _override_hook_target: Private parameter - set the branch to be
 
2989
            supplied as the target_branch to pull hooks.
 
2990
        :param local: Only update the local branch, and not the bound branch.
3409
2991
        """
3410
 
        bound_location = self.target.get_bound_location()
3411
 
        if local and not bound_location:
 
2992
        # This type of branch can't be bound.
 
2993
        if local:
3412
2994
            raise errors.LocalRequiresBoundBranch()
3413
 
        master_branch = None
3414
 
        if not local and bound_location and self.source.user_url != bound_location:
3415
 
            # not pulling from master, so we need to update master.
3416
 
            master_branch = self.target.get_master_branch(possible_transports)
3417
 
            master_branch.lock_write()
 
2995
        result = PullResult()
 
2996
        result.source_branch = self.source
 
2997
        if _override_hook_target is None:
 
2998
            result.target_branch = self.target
 
2999
        else:
 
3000
            result.target_branch = _override_hook_target
 
3001
        self.source.lock_read()
3418
3002
        try:
3419
 
            if master_branch:
3420
 
                # pull from source into master.
3421
 
                master_branch.pull(self.source, overwrite, stop_revision,
3422
 
                    run_hooks=False)
3423
 
            return self._pull(overwrite,
3424
 
                stop_revision, _hook_master=master_branch,
3425
 
                run_hooks=run_hooks,
3426
 
                _override_hook_target=_override_hook_target)
 
3003
            # We assume that during 'pull' the target repository is closer than
 
3004
            # the source one.
 
3005
            self.source.update_references(self.target)
 
3006
            graph = self.target.repository.get_graph(self.source.repository)
 
3007
            # TODO: Branch formats should have a flag that indicates 
 
3008
            # that revno's are expensive, and pull() should honor that flag.
 
3009
            # -- JRV20090506
 
3010
            result.old_revno, result.old_revid = \
 
3011
                self.target.last_revision_info()
 
3012
            self.target.update_revisions(self.source, stop_revision,
 
3013
                overwrite=overwrite, graph=graph)
 
3014
            # TODO: The old revid should be specified when merging tags, 
 
3015
            # so a tags implementation that versions tags can only 
 
3016
            # pull in the most recent changes. -- JRV20090506
 
3017
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3018
                overwrite)
 
3019
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3020
            if _hook_master:
 
3021
                result.master_branch = _hook_master
 
3022
                result.local_branch = result.target_branch
 
3023
            else:
 
3024
                result.master_branch = result.target_branch
 
3025
                result.local_branch = None
 
3026
            if run_hooks:
 
3027
                for hook in Branch.hooks['post_pull']:
 
3028
                    hook(result)
3427
3029
        finally:
3428
 
            if master_branch:
3429
 
                master_branch.unlock()
 
3030
            self.source.unlock()
 
3031
        return result
3430
3032
 
3431
3033
    def push(self, overwrite=False, stop_revision=None,
3432
3034
             _override_hook_source_branch=None):
3449
3051
                _override_hook_source_branch=_override_hook_source_branch)
3450
3052
        finally:
3451
3053
            self.source.unlock()
 
3054
        return result
3452
3055
 
3453
3056
    def _push_with_bound_branches(self, overwrite, stop_revision,
3454
3057
            _override_hook_source_branch=None):
3494
3097
            _run_hooks()
3495
3098
            return result
3496
3099
 
3497
 
    def _pull(self, overwrite=False, stop_revision=None,
3498
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3100
    @classmethod
 
3101
    def is_compatible(self, source, target):
 
3102
        # GenericBranch uses the public API, so always compatible
 
3103
        return True
 
3104
 
 
3105
 
 
3106
class InterToBranch5(GenericInterBranch):
 
3107
 
 
3108
    @staticmethod
 
3109
    def _get_branch_formats_to_test():
 
3110
        return BranchFormat._default_format, BzrBranchFormat5()
 
3111
 
 
3112
    def pull(self, overwrite=False, stop_revision=None,
 
3113
             possible_transports=None, run_hooks=True,
3499
3114
             _override_hook_target=None, local=False):
3500
 
        """See Branch.pull.
3501
 
 
3502
 
        This function is the core worker, used by GenericInterBranch.pull to
3503
 
        avoid duplication when pulling source->master and source->local.
3504
 
 
3505
 
        :param _hook_master: Private parameter - set the branch to
3506
 
            be supplied as the master to pull hooks.
 
3115
        """Pull from source into self, updating my master if any.
 
3116
 
3507
3117
        :param run_hooks: Private parameter - if false, this branch
3508
3118
            is being called because it's the master of the primary branch,
3509
3119
            so it should not run its hooks.
3510
 
        :param _override_hook_target: Private parameter - set the branch to be
3511
 
            supplied as the target_branch to pull hooks.
3512
 
        :param local: Only update the local branch, and not the bound branch.
3513
3120
        """
3514
 
        # This type of branch can't be bound.
3515
 
        if local:
 
3121
        bound_location = self.target.get_bound_location()
 
3122
        if local and not bound_location:
3516
3123
            raise errors.LocalRequiresBoundBranch()
3517
 
        result = PullResult()
3518
 
        result.source_branch = self.source
3519
 
        if _override_hook_target is None:
3520
 
            result.target_branch = self.target
3521
 
        else:
3522
 
            result.target_branch = _override_hook_target
3523
 
        self.source.lock_read()
 
3124
        master_branch = None
 
3125
        if not local and bound_location and self.source.base != bound_location:
 
3126
            # not pulling from master, so we need to update master.
 
3127
            master_branch = self.target.get_master_branch(possible_transports)
 
3128
            master_branch.lock_write()
3524
3129
        try:
3525
 
            # We assume that during 'pull' the target repository is closer than
3526
 
            # the source one.
3527
 
            self.source.update_references(self.target)
3528
 
            graph = self.target.repository.get_graph(self.source.repository)
3529
 
            # TODO: Branch formats should have a flag that indicates 
3530
 
            # that revno's are expensive, and pull() should honor that flag.
3531
 
            # -- JRV20090506
3532
 
            result.old_revno, result.old_revid = \
3533
 
                self.target.last_revision_info()
3534
 
            self.target.update_revisions(self.source, stop_revision,
3535
 
                overwrite=overwrite, graph=graph)
3536
 
            # TODO: The old revid should be specified when merging tags, 
3537
 
            # so a tags implementation that versions tags can only 
3538
 
            # pull in the most recent changes. -- JRV20090506
3539
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3540
 
                overwrite)
3541
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3542
 
            if _hook_master:
3543
 
                result.master_branch = _hook_master
3544
 
                result.local_branch = result.target_branch
3545
 
            else:
3546
 
                result.master_branch = result.target_branch
3547
 
                result.local_branch = None
3548
 
            if run_hooks:
3549
 
                for hook in Branch.hooks['post_pull']:
3550
 
                    hook(result)
 
3130
            if master_branch:
 
3131
                # pull from source into master.
 
3132
                master_branch.pull(self.source, overwrite, stop_revision,
 
3133
                    run_hooks=False)
 
3134
            return super(InterToBranch5, self).pull(overwrite,
 
3135
                stop_revision, _hook_master=master_branch,
 
3136
                run_hooks=run_hooks,
 
3137
                _override_hook_target=_override_hook_target)
3551
3138
        finally:
3552
 
            self.source.unlock()
3553
 
        return result
 
3139
            if master_branch:
 
3140
                master_branch.unlock()
3554
3141
 
3555
3142
 
3556
3143
InterBranch.register_optimiser(GenericInterBranch)
 
3144
InterBranch.register_optimiser(InterToBranch5)