/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Ian Clatworthy
  • Date: 2009-04-02 04:12:11 UTC
  • mfrom: (4208.4.8 bzr.eol)
  • mto: This revision was merged to the branch mainline in revision 4233.
  • Revision ID: ian.clatworthy@canonical.com-20090402041211-jl6u7r4r5inw9p2h
Integrated EOL conversion support (Ian Clatworthy)

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
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
 
from cStringIO import StringIO
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
33
        symbol_versioning,
36
34
        transport,
37
35
        tsort,
38
36
        ui,
39
37
        urlutils,
40
38
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
39
from bzrlib.config import BranchConfig
42
40
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
41
from bzrlib.tag import (
44
42
    BasicTags,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
48
from bzrlib.hooks import HookPoint, Hooks
51
49
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
50
from bzrlib import registry
54
51
from bzrlib.symbol_versioning import (
55
52
    deprecated_in,
63
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
61
 
65
62
 
66
 
class Branch(bzrdir.ControlComponent):
 
63
# TODO: Maybe include checks for common corruption of newlines, etc?
 
64
 
 
65
# TODO: Some operations like log might retrieve the same revisions
 
66
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
67
# cache in memory to make this faster.  In general anything can be
 
68
# cached in memory between lock and unlock operations. .. nb thats
 
69
# what the transaction identity map provides
 
70
 
 
71
 
 
72
######################################################################
 
73
# branch objects
 
74
 
 
75
class Branch(object):
67
76
    """Branch holding a history of revisions.
68
77
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
78
    base
 
79
        Base directory/url of the branch.
72
80
 
73
81
    hooks: An instance of BranchHooks.
74
82
    """
76
84
    # - RBC 20060112
77
85
    base = None
78
86
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
87
    def __init__(self, *ignored, **ignored_too):
88
88
        self.tags = self._format.make_tags(self)
89
89
        self._revision_history_cache = None
90
90
        self._revision_id_to_revno_cache = None
91
91
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
92
        self._last_revision_info_cache = None
94
93
        self._merge_sorted_revisions_cache = None
95
94
        self._open_hook()
102
101
 
103
102
    def _activate_fallback_location(self, url):
104
103
        """Activate the branch/repository from url as a fallback repository."""
105
 
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
 
        self.repository.add_fallback_repository(repo)
 
104
        self.repository.add_fallback_repository(
 
105
            self._get_fallback_repository(url))
109
106
 
110
107
    def break_lock(self):
111
108
        """Break a lock if one is present from another instance.
126
123
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
124
                self.repository.base)
128
125
 
129
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
 
        """Extend the partial history to include a given index
131
 
 
132
 
        If a stop_index is supplied, stop when that index has been reached.
133
 
        If a stop_revision is supplied, stop when that revision is
134
 
        encountered.  Otherwise, stop when the beginning of history is
135
 
        reached.
136
 
 
137
 
        :param stop_index: The index which should be present.  When it is
138
 
            present, history extension will stop.
139
 
        :param stop_revision: The revision id which should be present.  When
140
 
            it is encountered, history extension will stop.
141
 
        """
142
 
        if len(self._partial_revision_history_cache) == 0:
143
 
            self._partial_revision_history_cache = [self.last_revision()]
144
 
        repository._iter_for_revno(
145
 
            self.repository, self._partial_revision_history_cache,
146
 
            stop_index=stop_index, stop_revision=stop_revision)
147
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
 
            self._partial_revision_history_cache.pop()
149
 
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
126
    @staticmethod
159
127
    def open(base, _unsupported=False, possible_transports=None):
160
128
        """Open the branch rooted at base.
164
132
        """
165
133
        control = bzrdir.BzrDir.open(base, _unsupported,
166
134
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
135
        return control.open_branch(_unsupported)
168
136
 
169
137
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
138
    def open_from_transport(transport, _unsupported=False):
171
139
        """Open the branch rooted at transport"""
172
140
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
174
142
 
175
143
    @staticmethod
176
144
    def open_containing(url, possible_transports=None):
199
167
    def get_config(self):
200
168
        return BranchConfig(self)
201
169
 
202
 
    def _get_config(self):
203
 
        """Get the concrete config for just the config in this branch.
204
 
 
205
 
        This is not intended for client use; see Branch.get_config for the
206
 
        public API.
207
 
 
208
 
        Added in 1.14.
209
 
 
210
 
        :return: An object supporting get_option and set_option.
211
 
        """
212
 
        raise NotImplementedError(self._get_config)
213
 
 
214
170
    def _get_fallback_repository(self, url):
215
171
        """Get the repository we fallback to at url."""
216
172
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
173
        a_bzrdir = bzrdir.BzrDir.open(url,
218
174
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
175
        return a_bzrdir.open_branch().repository
220
176
 
221
177
    def _get_tags_bytes(self):
222
178
        """Get the bytes of a serialised tags dict.
417
373
            * 'include' - the stop revision is the last item in the result
418
374
            * 'with-merges' - include the stop revision and all of its
419
375
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
376
        :param direction: either 'reverse' or 'forward':
423
377
            * reverse means return the start_revision_id first, i.e.
424
378
              start at the most recent revision and go backwards in history
446
400
        # start_revision_id.
447
401
        if self._merge_sorted_revisions_cache is None:
448
402
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
403
            graph = self.repository.get_graph()
 
404
            parent_map = dict(((key, value) for key, value in
 
405
                     graph.iter_ancestry([last_revision]) if value is not None))
 
406
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
407
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
408
                generate_revno=True)
 
409
            # Drop the sequence # before caching
 
410
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
411
 
453
412
        filtered = self._filter_merge_sorted_revisions(
454
413
            self._merge_sorted_revisions_cache, start_revision_id,
455
414
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
415
        if direction == 'reverse':
460
416
            return filtered
461
417
        if direction == 'forward':
468
424
        """Iterate over an inclusive range of sorted revisions."""
469
425
        rev_iter = iter(merge_sorted_revisions)
470
426
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
427
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
428
                if rev_id != start_revision_id:
474
429
                    continue
475
430
                else:
476
431
                    # The decision to include the start or not
477
432
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
433
                    rev_iter = chain(
 
434
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
435
                        rev_iter)
480
436
                    break
481
437
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
438
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
439
                yield rev_id, depth, revno, end_of_merge
487
440
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
442
                if rev_id == stop_revision_id:
491
443
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
444
                yield rev_id, depth, revno, end_of_merge
494
445
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
446
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
447
                yield rev_id, depth, revno, end_of_merge
499
448
                if rev_id == stop_revision_id:
500
449
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
450
        elif stop_rule == 'with-merges':
514
451
            stop_rev = self.repository.get_revision(stop_revision_id)
515
452
            if stop_rev.parent_ids:
516
453
                left_parent = stop_rev.parent_ids[0]
517
454
            else:
518
455
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
456
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
457
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
458
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
459
                yield rev_id, depth, revno, end_of_merge
538
460
        else:
539
461
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
462
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
463
    def leave_lock_in_place(self):
587
464
        """Tell this branch object not to release the physical lock when this
588
465
        object is unlocked.
605
482
        :param other: The branch to bind to
606
483
        :type other: Branch
607
484
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
609
 
 
610
 
    def set_append_revisions_only(self, enabled):
611
 
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
613
 
        if enabled:
614
 
            value = 'True'
615
 
        else:
616
 
            value = 'False'
617
 
        self.get_config().set_user_option('append_revisions_only', value,
618
 
            warn_masked=True)
619
 
 
620
 
    def set_reference_info(self, file_id, tree_path, branch_location):
621
 
        """Set the branch location to use for a tree reference."""
622
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
623
 
 
624
 
    def get_reference_info(self, file_id):
625
 
        """Get the tree_path and branch_location for a tree reference."""
626
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
485
        raise errors.UpgradeRequired(self.base)
627
486
 
628
487
    @needs_write_lock
629
488
    def fetch(self, from_branch, last_revision=None, pb=None):
663
522
    def get_old_bound_location(self):
664
523
        """Return the URL of the branch we used to be bound to
665
524
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
525
        raise errors.UpgradeRequired(self.base)
667
526
 
668
527
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
528
                           timezone=None, committer=None, revprops=None,
719
578
    def set_revision_history(self, rev_history):
720
579
        raise NotImplementedError(self.set_revision_history)
721
580
 
722
 
    @needs_write_lock
723
 
    def set_parent(self, url):
724
 
        """See Branch.set_parent."""
725
 
        # TODO: Maybe delete old location files?
726
 
        # URLs should never be unicode, even on the local fs,
727
 
        # FIXUP this and get_parent in a future branch format bump:
728
 
        # read and rewrite the file. RBC 20060125
729
 
        if url is not None:
730
 
            if isinstance(url, unicode):
731
 
                try:
732
 
                    url = url.encode('ascii')
733
 
                except UnicodeEncodeError:
734
 
                    raise errors.InvalidURL(url,
735
 
                        "Urls must be 7-bit ascii, "
736
 
                        "use bzrlib.urlutils.escape")
737
 
            url = urlutils.relative_url(self.base, url)
738
 
        self._set_parent_location(url)
739
 
 
740
 
    @needs_write_lock
741
581
    def set_stacked_on_url(self, url):
742
582
        """Set the URL this branch is stacked against.
743
583
 
747
587
            stacking.
748
588
        """
749
589
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
 
        # XXX: Changing from one fallback repository to another does not check
752
 
        # that all the data you need is present in the new fallback.
753
 
        # Possibly it should.
 
590
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
591
        self._check_stackable_repo()
755
592
        if not url:
756
593
            try:
758
595
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
596
                errors.UnstackableRepositoryFormat):
760
597
                return
761
 
            self._unstack()
 
598
            url = ''
 
599
            # repositories don't offer an interface to remove fallback
 
600
            # repositories today; take the conceptually simpler option and just
 
601
            # reopen it.
 
602
            self.repository = self.bzrdir.find_repository()
 
603
            # for every revision reference the branch has, ensure it is pulled
 
604
            # in.
 
605
            source_repository = self._get_fallback_repository(old_url)
 
606
            for revision_id in chain([self.last_revision()],
 
607
                self.tags.get_reverse_tag_dict()):
 
608
                self.repository.fetch(source_repository, revision_id,
 
609
                    find_ghosts=True)
762
610
        else:
763
611
            self._activate_fallback_location(url)
764
612
        # write this out after the repository is stacked to avoid setting a
765
613
        # stacked config that doesn't work.
766
614
        self._set_config_location('stacked_on_location', url)
767
615
 
768
 
    def _unstack(self):
769
 
        """Change a branch to be unstacked, copying data as needed.
770
 
        
771
 
        Don't call this directly, use set_stacked_on_url(None).
772
 
        """
773
 
        pb = ui.ui_factory.nested_progress_bar()
774
 
        try:
775
 
            pb.update("Unstacking")
776
 
            # The basic approach here is to fetch the tip of the branch,
777
 
            # including all available ghosts, from the existing stacked
778
 
            # repository into a new repository object without the fallbacks. 
779
 
            #
780
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
 
            # correct for CHKMap repostiories
782
 
            old_repository = self.repository
783
 
            if len(old_repository._fallback_repositories) != 1:
784
 
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
787
 
            old_repository.unlock()
788
 
            old_repository.lock_read()
789
 
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
 
                # XXX: If you unstack a branch while it has a working tree
809
 
                # with a pending merge, the pending-merged revisions will no
810
 
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
818
 
            finally:
819
 
                old_repository.unlock()
820
 
        finally:
821
 
            pb.finished()
822
616
 
823
617
    def _set_tags_bytes(self, bytes):
824
618
        """Mirror method for _get_tags_bytes.
860
654
        self._revision_id_to_revno_cache = None
861
655
        self._last_revision_info_cache = None
862
656
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
657
 
866
658
    def _gen_revision_history(self):
867
659
        """Return sequence of revision hashes on to this branch.
904
696
 
905
697
    def unbind(self):
906
698
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
699
        raise errors.UpgradeRequired(self.base)
 
700
 
 
701
    def set_append_revisions_only(self, enabled):
 
702
        """Older format branches are never restricted to append-only"""
 
703
        raise errors.UpgradeRequired(self.base)
908
704
 
909
705
    def last_revision(self):
910
706
        """Return last revision id, or NULL_REVISION."""
991
787
        except ValueError:
992
788
            raise errors.NoSuchRevision(self, revision_id)
993
789
 
994
 
    @needs_read_lock
995
790
    def get_rev_id(self, revno, history=None):
996
791
        """Find the revision id of the specified revno."""
997
792
        if revno == 0:
998
793
            return _mod_revision.NULL_REVISION
999
 
        last_revno, last_revid = self.last_revision_info()
1000
 
        if revno == last_revno:
1001
 
            return last_revid
1002
 
        if revno <= 0 or revno > last_revno:
 
794
        if history is None:
 
795
            history = self.revision_history()
 
796
        if revno <= 0 or revno > len(history):
1003
797
            raise errors.NoSuchRevision(self, revno)
1004
 
        distance_from_last = last_revno - revno
1005
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1006
 
            self._extend_partial_history(distance_from_last)
1007
 
        return self._partial_revision_history_cache[distance_from_last]
 
798
        return history[revno - 1]
1008
799
 
1009
 
    @needs_write_lock
1010
800
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
801
             possible_transports=None, _override_hook_target=None):
1012
802
        """Mirror source into this branch.
1013
803
 
1014
804
        This branch is considered to be 'local', having low latency.
1015
805
 
1016
806
        :returns: PullResult instance
1017
807
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
808
        raise NotImplementedError(self.pull)
1021
809
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
810
    def push(self, target, overwrite=False, stop_revision=None):
1024
811
        """Mirror this branch into target.
1025
812
 
1026
813
        This branch is considered to be 'local', having low latency.
1027
814
        """
1028
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
815
        raise NotImplementedError(self.push)
1051
816
 
1052
817
    def basis_tree(self):
1053
818
        """Return `Tree` object for last revision."""
1070
835
        try:
1071
836
            return urlutils.join(self.base[:-1], parent)
1072
837
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
838
            raise errors.InaccessibleParent(parent, self.base)
1074
839
 
1075
840
    def _get_parent_location(self):
1076
841
        raise NotImplementedError(self._get_parent_location)
1093
858
            location = None
1094
859
        return location
1095
860
 
1096
 
    def get_child_submit_format(self):
1097
 
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
1099
 
 
1100
861
    def get_submit_branch(self):
1101
862
        """Return the submit location of the branch.
1102
863
 
1119
880
    def get_public_branch(self):
1120
881
        """Return the public location of the branch.
1121
882
 
1122
 
        This is used by merge directives.
 
883
        This is is used by merge directives.
1123
884
        """
1124
885
        return self._get_config_location('public_branch')
1125
886
 
1161
922
        params = ChangeBranchTipParams(
1162
923
            self, old_revno, new_revno, old_revid, new_revid)
1163
924
        for hook in hooks:
1164
 
            hook(params)
 
925
            try:
 
926
                hook(params)
 
927
            except errors.TipChangeRejected:
 
928
                raise
 
929
            except Exception:
 
930
                exc_info = sys.exc_info()
 
931
                hook_name = Branch.hooks.get_hook_name(hook)
 
932
                raise errors.HookFailed(
 
933
                    'pre_change_branch_tip', hook_name, exc_info)
 
934
 
 
935
    def set_parent(self, url):
 
936
        raise NotImplementedError(self.set_parent)
1165
937
 
1166
938
    @needs_write_lock
1167
939
    def update(self):
1198
970
                     be truncated to end with revision_id.
1199
971
        """
1200
972
        result = to_bzrdir.create_branch()
1201
 
        result.lock_write()
1202
 
        try:
1203
 
            if repository_policy is not None:
1204
 
                repository_policy.configure_branch(result)
1205
 
            self.copy_content_into(result, revision_id=revision_id)
1206
 
        finally:
1207
 
            result.unlock()
1208
 
        return result
 
973
        if repository_policy is not None:
 
974
            repository_policy.configure_branch(result)
 
975
        self.copy_content_into(result, revision_id=revision_id)
 
976
        return  result
1209
977
 
1210
978
    @needs_read_lock
1211
979
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1216
984
        revision_id: if not None, the revision history in the new branch will
1217
985
                     be truncated to end with revision_id.
1218
986
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
987
        result = to_bzrdir.create_branch()
1223
 
        result.lock_write()
1224
 
        try:
1225
 
            if repository_policy is not None:
1226
 
                repository_policy.configure_branch(result)
1227
 
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
1229
 
        finally:
1230
 
            result.unlock()
 
988
        if repository_policy is not None:
 
989
            repository_policy.configure_branch(result)
 
990
        self.copy_content_into(result, revision_id=revision_id)
 
991
        result.set_parent(self.bzrdir.root_transport.base)
1231
992
        return result
1232
993
 
1233
994
    def _synchronize_history(self, destination, revision_id):
1245
1006
        source_revno, source_revision_id = self.last_revision_info()
1246
1007
        if revision_id is None:
1247
1008
            revno, revision_id = source_revno, source_revision_id
 
1009
        elif source_revision_id == revision_id:
 
1010
            # we know the revno without needing to walk all of history
 
1011
            revno = source_revno
1248
1012
        else:
1249
 
            graph = self.repository.get_graph()
1250
 
            try:
1251
 
                revno = graph.find_distance_to_null(revision_id, 
1252
 
                    [(source_revision_id, source_revno)])
1253
 
            except errors.GhostRevisionsHaveNoRevno:
1254
 
                # Default to 1, if we can't find anything else
1255
 
                revno = 1
 
1013
            # To figure out the revno for a random revision, we need to build
 
1014
            # the revision history, and count its length.
 
1015
            # We don't care about the order, just how long it is.
 
1016
            # Alternatively, we could start at the current location, and count
 
1017
            # backwards. But there is no guarantee that we will find it since
 
1018
            # it may be a merged revision.
 
1019
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1020
                                                                revision_id)))
1256
1021
        destination.set_last_revision_info(revno, revision_id)
1257
1022
 
1258
1023
    @needs_read_lock
1262
1027
        revision_id: if not None, the revision history in the new branch will
1263
1028
                     be truncated to end with revision_id.
1264
1029
        """
1265
 
        self.update_references(destination)
1266
1030
        self._synchronize_history(destination, revision_id)
1267
1031
        try:
1268
1032
            parent = self.get_parent()
1274
1038
        if self._push_should_merge_tags():
1275
1039
            self.tags.merge_to(destination.tags)
1276
1040
 
1277
 
    def update_references(self, target):
1278
 
        if not getattr(self._format, 'supports_reference_locations', False):
1279
 
            return
1280
 
        reference_dict = self._get_all_reference_info()
1281
 
        if len(reference_dict) == 0:
1282
 
            return
1283
 
        old_base = self.base
1284
 
        new_base = target.base
1285
 
        target_reference_dict = target._get_all_reference_info()
1286
 
        for file_id, (tree_path, branch_location) in (
1287
 
            reference_dict.items()):
1288
 
            branch_location = urlutils.rebase_url(branch_location,
1289
 
                                                  old_base, new_base)
1290
 
            target_reference_dict.setdefault(
1291
 
                file_id, (tree_path, branch_location))
1292
 
        target._set_all_reference_info(target_reference_dict)
1293
 
 
1294
1041
    @needs_read_lock
1295
 
    def check(self, refs):
 
1042
    def check(self):
1296
1043
        """Check consistency of the branch.
1297
1044
 
1298
1045
        In particular this checks that revisions given in the revision-history
1301
1048
 
1302
1049
        Callers will typically also want to check the repository.
1303
1050
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1051
        :return: A BranchCheckResult.
1307
1052
        """
1308
 
        result = BranchCheckResult(self)
 
1053
        mainline_parent_id = None
1309
1054
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
1055
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1056
                                last_revision_id))
 
1057
        real_rev_history.reverse()
 
1058
        if len(real_rev_history) != last_revno:
 
1059
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1060
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1061
        # TODO: We should probably also check that real_rev_history actually
 
1062
        #       matches self.revision_history()
 
1063
        for revision_id in real_rev_history:
 
1064
            try:
 
1065
                revision = self.repository.get_revision(revision_id)
 
1066
            except errors.NoSuchRevision, e:
 
1067
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1068
                            % revision_id)
 
1069
            # In general the first entry on the revision history has no parents.
 
1070
            # But it's not illegal for it to have parents listed; this can happen
 
1071
            # in imports from Arch when the parents weren't reachable.
 
1072
            if mainline_parent_id is not None:
 
1073
                if mainline_parent_id not in revision.parent_ids:
 
1074
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1075
                                        "parents of {%s}"
 
1076
                                        % (mainline_parent_id, revision_id))
 
1077
            mainline_parent_id = revision_id
 
1078
        return BranchCheckResult(self)
1321
1079
 
1322
1080
    def _get_checkout_format(self):
1323
1081
        """Return the most suitable metadir for a checkout of this branch.
1333
1091
        return format
1334
1092
 
1335
1093
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1094
        stacked_on=None):
1337
1095
        """Create a clone of this branch and its bzrdir.
1338
1096
 
1339
1097
        :param to_transport: The transport to clone onto.
1340
1098
        :param revision_id: The revision id to use as tip in the new branch.
1341
1099
            If None the tip is obtained from this branch.
1342
1100
        :param stacked_on: An optional URL to stack the clone on.
1343
 
        :param create_prefix: Create any missing directories leading up to
1344
 
            to_transport.
1345
 
        :param use_existing_dir: Use an existing directory if one exists.
1346
1101
        """
1347
1102
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1103
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1104
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1105
            revision_id=revision_id, stacked_on=stacked_on)
1354
1106
        return dir_to.open_branch()
1355
1107
 
1356
1108
    def create_checkout(self, to_location, revision_id=None,
1375
1127
        if lightweight:
1376
1128
            format = self._get_checkout_format()
1377
1129
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1130
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1131
        else:
1381
1132
            format = self._get_checkout_format()
1382
1133
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1162
        reconciler.reconcile()
1412
1163
        return reconciler
1413
1164
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1165
    def reference_parent(self, file_id, path):
1415
1166
        """Return the parent branch for a tree-reference file_id
1416
1167
        :param file_id: The file_id of the tree reference
1417
1168
        :param path: The path of the file_id in the tree
1418
1169
        :return: A branch associated with the file_id
1419
1170
        """
1420
1171
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1172
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1173
 
1424
1174
    def supports_tags(self):
1425
1175
        return self._format.supports_tags()
1426
1176
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1177
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1178
                                         other_branch):
1441
1179
        """Ensure that revision_b is a descendant of revision_a.
1496
1234
    _formats = {}
1497
1235
    """The known formats."""
1498
1236
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1237
    def __eq__(self, other):
1502
1238
        return self.__class__ is other.__class__
1503
1239
 
1505
1241
        return not (self == other)
1506
1242
 
1507
1243
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1244
    def find_format(klass, a_bzrdir):
1509
1245
        """Return the format for the branch object in a_bzrdir."""
1510
1246
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1247
            transport = a_bzrdir.get_branch_transport(None)
 
1248
            format_string = transport.get("format").read()
1513
1249
            return klass._formats[format_string]
1514
1250
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1251
            raise errors.NotBranchError(path=transport.base)
1516
1252
        except KeyError:
1517
1253
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1254
 
1554
1290
        """Return the short format description for this format."""
1555
1291
        raise NotImplementedError(self.get_format_description)
1556
1292
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1293
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1294
                           set_format=True):
1567
1295
        """Initialize a branch in a bzrdir, with specified files
1568
1296
 
1569
1297
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1298
        :param utf8_files: The files to create as a list of
1571
1299
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1300
        :param set_format: If True, set the format with
1574
1301
            self.get_format_string.  (BzrBranch4 has its format set
1575
1302
            elsewhere)
1576
1303
        :return: a branch in this format
1577
1304
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1305
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1306
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1307
        lock_map = {
1581
1308
            'metadir': ('lock', lockdir.LockDir),
1582
1309
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1312
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1313
            lock_name, lock_class)
1587
1314
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
 
1315
        control_files.lock_write()
1596
1316
        if set_format:
1597
1317
            utf8_files += [('format', self.get_format_string())]
1598
1318
        try:
1601
1321
                    filename, content,
1602
1322
                    mode=a_bzrdir._get_file_mode())
1603
1323
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1324
            control_files.unlock()
 
1325
        return self.open(a_bzrdir, _found=True)
1609
1326
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1327
    def initialize(self, a_bzrdir):
 
1328
        """Create a branch of this format in a_bzrdir."""
1615
1329
        raise NotImplementedError(self.initialize)
1616
1330
 
1617
1331
    def is_supported(self):
1647
1361
        """
1648
1362
        raise NotImplementedError(self.network_name)
1649
1363
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1364
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1365
        """Return the branch object for a_bzrdir
1652
1366
 
1653
1367
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1368
        :param _found: a private parameter, do not use it. It is used to
1656
1369
            indicate if format probing has already be done.
1657
1370
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1384
    def set_default_format(klass, format):
1672
1385
        klass._default_format = format
1673
1386
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1387
    def supports_stacking(self):
1679
1388
        """True if this format records a stacked-on branch."""
1680
1389
        return False
1742
1451
            "post_uncommit is called with (local, master, old_revno, "
1743
1452
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1453
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1454
            "recieves new_revno of 0, new_revid of None.", (0, 15), None))
1746
1455
        self.create_hook(HookPoint('pre_change_branch_tip',
1747
1456
            "Called in bzr client and server before a change to the tip of a "
1748
1457
            "branch is made. pre_change_branch_tip is called with a "
1765
1474
            "multiple hooks installed for transform_fallback_location, "
1766
1475
            "all are called with the url returned from the previous hook."
1767
1476
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
1785
1477
 
1786
1478
 
1787
1479
# install the default hooks into the Branch class.
1826
1518
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1519
 
1828
1520
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1521
class BzrBranchFormat4(BranchFormat):
1908
1522
    """Bzr branch format 4.
1909
1523
 
1916
1530
        """See BranchFormat.get_format_description()."""
1917
1531
        return "Branch format 4"
1918
1532
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1533
    def initialize(self, a_bzrdir):
1920
1534
        """Create a branch of this format in a_bzrdir."""
1921
1535
        utf8_files = [('revision-history', ''),
1922
1536
                      ('branch-name', ''),
1923
1537
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1538
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1539
                                       lock_type='branch4', set_format=False)
1926
1540
 
1927
1541
    def __init__(self):
1932
1546
        """The network name for this format is the control dirs disk label."""
1933
1547
        return self._matchingbzrdir.get_format_string()
1934
1548
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1549
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1550
        """See BranchFormat.open()."""
1937
1551
        if not _found:
1938
1552
            # we are being called directly and must probe.
1940
1554
        return BzrBranch(_format=self,
1941
1555
                         _control_files=a_bzrdir._control_files,
1942
1556
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1557
                         _repository=a_bzrdir.open_repository())
1945
1558
 
1946
1559
    def __str__(self):
1961
1574
        """
1962
1575
        return self.get_format_string()
1963
1576
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1577
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1578
        """See BranchFormat.open()."""
1966
1579
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1580
            format = BranchFormat.find_format(a_bzrdir)
1968
1581
            if format.__class__ != self.__class__:
1969
1582
                raise AssertionError("wrong format %r found for %r" %
1970
1583
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1584
        try:
 
1585
            transport = a_bzrdir.get_branch_transport(None)
1973
1586
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1587
                                                         lockdir.LockDir)
1975
1588
            return self._branch_class()(_format=self,
1976
1589
                              _control_files=control_files,
1977
 
                              name=name,
1978
1590
                              a_bzrdir=a_bzrdir,
1979
1591
                              _repository=a_bzrdir.find_repository(),
1980
1592
                              ignore_fallbacks=ignore_fallbacks)
1981
1593
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1594
            raise errors.NotBranchError(path=transport.base)
1983
1595
 
1984
1596
    def __init__(self):
1985
1597
        super(BranchFormatMetadir, self).__init__()
2014
1626
        """See BranchFormat.get_format_description()."""
2015
1627
        return "Branch format 5"
2016
1628
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1629
    def initialize(self, a_bzrdir):
2018
1630
        """Create a branch of this format in a_bzrdir."""
2019
1631
        utf8_files = [('revision-history', ''),
2020
1632
                      ('branch-name', ''),
2021
1633
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1634
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1635
 
2024
1636
    def supports_tags(self):
2025
1637
        return False
2047
1659
        """See BranchFormat.get_format_description()."""
2048
1660
        return "Branch format 6"
2049
1661
 
2050
 
    def initialize(self, a_bzrdir, name=None):
2051
 
        """Create a branch of this format in a_bzrdir."""
2052
 
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
2054
 
                      ('tags', ''),
2055
 
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2057
 
 
2058
 
    def make_tags(self, branch):
2059
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
2061
 
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
 
 
2065
 
 
2066
 
class BzrBranchFormat8(BranchFormatMetadir):
2067
 
    """Metadir format supporting storing locations of subtree branches."""
2068
 
 
2069
 
    def _branch_class(self):
2070
 
        return BzrBranch8
2071
 
 
2072
 
    def get_format_string(self):
2073
 
        """See BranchFormat.get_format_string()."""
2074
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
 
 
2076
 
    def get_format_description(self):
2077
 
        """See BranchFormat.get_format_description()."""
2078
 
        return "Branch format 8"
2079
 
 
2080
 
    def initialize(self, a_bzrdir, name=None):
2081
 
        """Create a branch of this format in a_bzrdir."""
2082
 
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
2084
 
                      ('tags', ''),
2085
 
                      ('references', '')
2086
 
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
2093
 
 
2094
 
    def make_tags(self, branch):
2095
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
2097
 
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
 
    def supports_stacking(self):
2102
 
        return True
2103
 
 
2104
 
    supports_reference_locations = True
2105
 
 
2106
 
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1662
    def initialize(self, a_bzrdir):
 
1663
        """Create a branch of this format in a_bzrdir."""
 
1664
        utf8_files = [('last-revision', '0 null:\n'),
 
1665
                      ('branch.conf', ''),
 
1666
                      ('tags', ''),
 
1667
                      ]
 
1668
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1669
 
 
1670
    def make_tags(self, branch):
 
1671
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1672
        return BasicTags(branch)
 
1673
 
 
1674
 
 
1675
 
 
1676
class BzrBranchFormat7(BranchFormatMetadir):
2108
1677
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1678
 
2110
1679
    The stacked location pointer is passed down to the repository and requires
2113
1682
    This format was introduced in bzr 1.6.
2114
1683
    """
2115
1684
 
2116
 
    def initialize(self, a_bzrdir, name=None):
2117
 
        """Create a branch of this format in a_bzrdir."""
2118
 
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
2120
 
                      ('tags', ''),
2121
 
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2123
 
 
2124
1685
    def _branch_class(self):
2125
1686
        return BzrBranch7
2126
1687
 
2132
1693
        """See BranchFormat.get_format_description()."""
2133
1694
        return "Branch format 7"
2134
1695
 
2135
 
    def supports_set_append_revisions_only(self):
 
1696
    def initialize(self, a_bzrdir):
 
1697
        """Create a branch of this format in a_bzrdir."""
 
1698
        utf8_files = [('last-revision', '0 null:\n'),
 
1699
                      ('branch.conf', ''),
 
1700
                      ('tags', ''),
 
1701
                      ]
 
1702
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1703
 
 
1704
    def __init__(self):
 
1705
        super(BzrBranchFormat7, self).__init__()
 
1706
        self._matchingbzrdir.repository_format = \
 
1707
            RepositoryFormatKnitPack5RichRoot()
 
1708
 
 
1709
    def make_tags(self, branch):
 
1710
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1711
        return BasicTags(branch)
 
1712
 
 
1713
    def supports_stacking(self):
2136
1714
        return True
2137
1715
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1716
 
2141
1717
class BranchReferenceFormat(BranchFormat):
2142
1718
    """Bzr branch reference format.
2160
1736
    def get_reference(self, a_bzrdir):
2161
1737
        """See BranchFormat.get_reference()."""
2162
1738
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1739
        return transport.get('location').read()
2164
1740
 
2165
1741
    def set_reference(self, a_bzrdir, to_branch):
2166
1742
        """See BranchFormat.set_reference()."""
2167
1743
        transport = a_bzrdir.get_branch_transport(None)
2168
1744
        location = transport.put_bytes('location', to_branch.base)
2169
1745
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1746
    def initialize(self, a_bzrdir, target_branch=None):
2171
1747
        """Create a branch of this format in a_bzrdir."""
2172
1748
        if target_branch is None:
2173
1749
            # this format does not implement branch itself, thus the implicit
2174
1750
            # creation contract must see it as uninitializable
2175
1751
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1752
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1753
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1754
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1755
            target_branch.bzrdir.root_transport.base)
2180
1756
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1757
        return self.open(
 
1758
            a_bzrdir, _found=True,
2183
1759
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1760
 
2187
1761
    def __init__(self):
2188
1762
        super(BranchReferenceFormat, self).__init__()
2194
1768
        def clone(to_bzrdir, revision_id=None,
2195
1769
            repository_policy=None):
2196
1770
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1771
            return format.initialize(to_bzrdir, a_branch)
2198
1772
            # cannot obey revision_id limits when cloning a reference ...
2199
1773
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1774
            # emit some sort of warning/error to the caller ?!
2201
1775
        return clone
2202
1776
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1777
    def open(self, a_bzrdir, _found=False, location=None,
2204
1778
             possible_transports=None, ignore_fallbacks=False):
2205
1779
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1780
 
2207
1781
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1782
        :param _found: a private parameter, do not use it. It is used to
2210
1783
            indicate if format probing has already be done.
2211
1784
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1789
        :param possible_transports: An optional reusable transports list.
2217
1790
        """
2218
1791
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1792
            format = BranchFormat.find_format(a_bzrdir)
2220
1793
            if format.__class__ != self.__class__:
2221
1794
                raise AssertionError("wrong format %r found for %r" %
2222
1795
                    (format, self))
2224
1797
            location = self.get_reference(a_bzrdir)
2225
1798
        real_bzrdir = bzrdir.BzrDir.open(
2226
1799
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1800
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1801
        # this changes the behaviour of result.clone to create a new reference
2230
1802
        # rather than a copy of the content of the branch.
2231
1803
        # I did not use a proxy object because that needs much more extensive
2252
1824
__format5 = BzrBranchFormat5()
2253
1825
__format6 = BzrBranchFormat6()
2254
1826
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1827
BranchFormat.register_format(__format5)
2257
1828
BranchFormat.register_format(BranchReferenceFormat())
2258
1829
BranchFormat.register_format(__format6)
2259
1830
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1831
BranchFormat.set_default_format(__format6)
2262
1832
_legacy_formats = [BzrBranchFormat4(),
2263
1833
    ]
2264
1834
network_format_registry.register(
2265
1835
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1836
 
2267
1837
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1838
class BzrBranch(Branch):
2269
1839
    """A branch stored in the actual filesystem.
2270
1840
 
2271
1841
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1847
    :ivar repository: Repository for this branch.
2278
1848
    :ivar base: The url of the base directory for this branch; the one
2279
1849
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1850
    """
2283
1851
 
2284
1852
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1853
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1854
                 ignore_fallbacks=False):
2287
1855
        """Create new branch object at a particular location."""
2288
1856
        if a_bzrdir is None:
2289
1857
            raise ValueError('a_bzrdir must be supplied')
2290
1858
        else:
2291
1859
            self.bzrdir = a_bzrdir
2292
1860
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1861
        # XXX: We should be able to just do
2295
1862
        #   self.base = self.bzrdir.root_transport.base
2296
1863
        # but this does not quite work yet -- mbp 20080522
2303
1870
        Branch.__init__(self)
2304
1871
 
2305
1872
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
1873
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1874
 
2312
1875
    __repr__ = __str__
2313
1876
 
2317
1880
 
2318
1881
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
1882
 
2320
 
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
2322
 
 
2323
1883
    def is_locked(self):
2324
1884
        return self.control_files.is_locked()
2325
1885
 
2326
1886
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
 
        # All-in-one needs to always unlock/lock.
2330
 
        repo_control = getattr(self.repository, 'control_files', None)
2331
 
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
 
            self.repository.lock_write()
2334
 
            took_lock = True
2335
 
        else:
2336
 
            took_lock = False
 
1887
        repo_token = self.repository.lock_write()
2337
1888
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1889
            token = self.control_files.lock_write(token=token)
2339
1890
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1891
            self.repository.unlock()
2342
1892
            raise
 
1893
        return token
2343
1894
 
2344
1895
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
 
        # All-in-one needs to always unlock/lock.
2348
 
        repo_control = getattr(self.repository, 'control_files', None)
2349
 
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
 
            self.repository.lock_read()
2352
 
            took_lock = True
2353
 
        else:
2354
 
            took_lock = False
 
1896
        self.repository.lock_read()
2355
1897
        try:
2356
1898
            self.control_files.lock_read()
2357
1899
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1900
            self.repository.unlock()
2360
1901
            raise
2361
1902
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1903
    def unlock(self):
 
1904
        # TODO: test for failed two phase locks. This is known broken.
2364
1905
        try:
2365
1906
            self.control_files.unlock()
2366
1907
        finally:
2367
 
            # All-in-one needs to always unlock/lock.
2368
 
            repo_control = getattr(self.repository, 'control_files', None)
2369
 
            if (self.control_files == repo_control or
2370
 
                not self.control_files.is_locked()):
2371
 
                self.repository.unlock()
2372
 
            if not self.control_files.is_locked():
2373
 
                # we just released the lock
2374
 
                self._clear_cached_state()
 
1908
            self.repository.unlock()
 
1909
        if not self.control_files.is_locked():
 
1910
            # we just released the lock
 
1911
            self._clear_cached_state()
2375
1912
 
2376
1913
    def peek_lock_mode(self):
2377
1914
        if self.control_files._lock_count == 0:
2496
2033
        """See Branch.basis_tree."""
2497
2034
        return self.repository.revision_tree(self.last_revision())
2498
2035
 
 
2036
    @needs_write_lock
 
2037
    def pull(self, source, overwrite=False, stop_revision=None,
 
2038
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2039
             _override_hook_target=None):
 
2040
        """See Branch.pull.
 
2041
 
 
2042
        :param _hook_master: Private parameter - set the branch to
 
2043
            be supplied as the master to pull hooks.
 
2044
        :param run_hooks: Private parameter - if false, this branch
 
2045
            is being called because it's the master of the primary branch,
 
2046
            so it should not run its hooks.
 
2047
        :param _override_hook_target: Private parameter - set the branch to be
 
2048
            supplied as the target_branch to pull hooks.
 
2049
        """
 
2050
        result = PullResult()
 
2051
        result.source_branch = source
 
2052
        if _override_hook_target is None:
 
2053
            result.target_branch = self
 
2054
        else:
 
2055
            result.target_branch = _override_hook_target
 
2056
        source.lock_read()
 
2057
        try:
 
2058
            # We assume that during 'pull' the local repository is closer than
 
2059
            # the remote one.
 
2060
            graph = self.repository.get_graph(source.repository)
 
2061
            result.old_revno, result.old_revid = self.last_revision_info()
 
2062
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2063
                                  graph=graph)
 
2064
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2065
            result.new_revno, result.new_revid = self.last_revision_info()
 
2066
            if _hook_master:
 
2067
                result.master_branch = _hook_master
 
2068
                result.local_branch = result.target_branch
 
2069
            else:
 
2070
                result.master_branch = result.target_branch
 
2071
                result.local_branch = None
 
2072
            if run_hooks:
 
2073
                for hook in Branch.hooks['post_pull']:
 
2074
                    hook(result)
 
2075
        finally:
 
2076
            source.unlock()
 
2077
        return result
 
2078
 
2499
2079
    def _get_parent_location(self):
2500
2080
        _locs = ['parent', 'pull', 'x-pull']
2501
2081
        for l in _locs:
2505
2085
                pass
2506
2086
        return None
2507
2087
 
 
2088
    @needs_read_lock
 
2089
    def push(self, target, overwrite=False, stop_revision=None,
 
2090
             _override_hook_source_branch=None):
 
2091
        """See Branch.push.
 
2092
 
 
2093
        This is the basic concrete implementation of push()
 
2094
 
 
2095
        :param _override_hook_source_branch: If specified, run
 
2096
        the hooks passing this Branch as the source, rather than self.
 
2097
        This is for use of RemoteBranch, where push is delegated to the
 
2098
        underlying vfs-based Branch.
 
2099
        """
 
2100
        # TODO: Public option to disable running hooks - should be trivial but
 
2101
        # needs tests.
 
2102
        return _run_with_write_locked_target(
 
2103
            target, self._push_with_bound_branches, target, overwrite,
 
2104
            stop_revision,
 
2105
            _override_hook_source_branch=_override_hook_source_branch)
 
2106
 
 
2107
    def _push_with_bound_branches(self, target, overwrite,
 
2108
            stop_revision,
 
2109
            _override_hook_source_branch=None):
 
2110
        """Push from self into target, and into target's master if any.
 
2111
 
 
2112
        This is on the base BzrBranch class even though it doesn't support
 
2113
        bound branches because the *target* might be bound.
 
2114
        """
 
2115
        def _run_hooks():
 
2116
            if _override_hook_source_branch:
 
2117
                result.source_branch = _override_hook_source_branch
 
2118
            for hook in Branch.hooks['post_push']:
 
2119
                hook(result)
 
2120
 
 
2121
        bound_location = target.get_bound_location()
 
2122
        if bound_location and target.base != bound_location:
 
2123
            # there is a master branch.
 
2124
            #
 
2125
            # XXX: Why the second check?  Is it even supported for a branch to
 
2126
            # be bound to itself? -- mbp 20070507
 
2127
            master_branch = target.get_master_branch()
 
2128
            master_branch.lock_write()
 
2129
            try:
 
2130
                # push into the master from this branch.
 
2131
                self._basic_push(master_branch, overwrite, stop_revision)
 
2132
                # and push into the target branch from this. Note that we push from
 
2133
                # this branch again, because its considered the highest bandwidth
 
2134
                # repository.
 
2135
                result = self._basic_push(target, overwrite, stop_revision)
 
2136
                result.master_branch = master_branch
 
2137
                result.local_branch = target
 
2138
                _run_hooks()
 
2139
                return result
 
2140
            finally:
 
2141
                master_branch.unlock()
 
2142
        else:
 
2143
            # no master branch
 
2144
            result = self._basic_push(target, overwrite, stop_revision)
 
2145
            # TODO: Why set master_branch and local_branch if there's no
 
2146
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2147
            # 20070504
 
2148
            result.master_branch = target
 
2149
            result.local_branch = None
 
2150
            _run_hooks()
 
2151
            return result
 
2152
 
2508
2153
    def _basic_push(self, target, overwrite, stop_revision):
2509
2154
        """Basic implementation of push without bound branches or hooks.
2510
2155
 
2511
 
        Must be called with source read locked and target write locked.
 
2156
        Must be called with self read locked and target write locked.
2512
2157
        """
2513
2158
        result = BranchPushResult()
2514
2159
        result.source_branch = self
2515
2160
        result.target_branch = target
2516
2161
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2162
        if result.old_revid != self.last_revision():
2519
2163
            # We assume that during 'push' this repository is closer than
2520
2164
            # the target.
2521
2165
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2166
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2167
                                    graph=graph)
2524
2168
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2169
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2170
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2171
        return result
2529
2172
 
2530
2173
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2174
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2175
 
2533
2176
    def set_push_location(self, location):
2534
2177
        """See Branch.set_push_location."""
2536
2179
            'push_location', location,
2537
2180
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2181
 
 
2182
    @needs_write_lock
 
2183
    def set_parent(self, url):
 
2184
        """See Branch.set_parent."""
 
2185
        # TODO: Maybe delete old location files?
 
2186
        # URLs should never be unicode, even on the local fs,
 
2187
        # FIXUP this and get_parent in a future branch format bump:
 
2188
        # read and rewrite the file. RBC 20060125
 
2189
        if url is not None:
 
2190
            if isinstance(url, unicode):
 
2191
                try:
 
2192
                    url = url.encode('ascii')
 
2193
                except UnicodeEncodeError:
 
2194
                    raise errors.InvalidURL(url,
 
2195
                        "Urls must be 7-bit ascii, "
 
2196
                        "use bzrlib.urlutils.escape")
 
2197
            url = urlutils.relative_url(self.base, url)
 
2198
        self._set_parent_location(url)
 
2199
 
2539
2200
    def _set_parent_location(self, url):
2540
2201
        if url is None:
2541
2202
            self._transport.delete('parent')
2550
2211
    It has support for a master_branch which is the data for bound branches.
2551
2212
    """
2552
2213
 
 
2214
    @needs_write_lock
 
2215
    def pull(self, source, overwrite=False, stop_revision=None,
 
2216
             run_hooks=True, possible_transports=None,
 
2217
             _override_hook_target=None):
 
2218
        """Pull from source into self, updating my master if any.
 
2219
 
 
2220
        :param run_hooks: Private parameter - if false, this branch
 
2221
            is being called because it's the master of the primary branch,
 
2222
            so it should not run its hooks.
 
2223
        """
 
2224
        bound_location = self.get_bound_location()
 
2225
        master_branch = None
 
2226
        if bound_location and source.base != bound_location:
 
2227
            # not pulling from master, so we need to update master.
 
2228
            master_branch = self.get_master_branch(possible_transports)
 
2229
            master_branch.lock_write()
 
2230
        try:
 
2231
            if master_branch:
 
2232
                # pull from source into master.
 
2233
                master_branch.pull(source, overwrite, stop_revision,
 
2234
                    run_hooks=False)
 
2235
            return super(BzrBranch5, self).pull(source, overwrite,
 
2236
                stop_revision, _hook_master=master_branch,
 
2237
                run_hooks=run_hooks,
 
2238
                _override_hook_target=_override_hook_target)
 
2239
        finally:
 
2240
            if master_branch:
 
2241
                master_branch.unlock()
 
2242
 
2553
2243
    def get_bound_location(self):
2554
2244
        try:
2555
2245
            return self._transport.get_bytes('bound')[:-1]
2642
2332
        return None
2643
2333
 
2644
2334
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
2335
class BzrBranch7(BzrBranch5):
 
2336
    """A branch with support for a fallback repository."""
2647
2337
 
2648
2338
    def _open_hook(self):
2649
2339
        if self._ignore_fallbacks:
2665
2355
 
2666
2356
    def __init__(self, *args, **kwargs):
2667
2357
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2358
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2359
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2360
        self._partial_revision_history_cache = []
2671
2361
 
2672
2362
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2363
        super(BzrBranch7, self)._clear_cached_state()
2674
2364
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2365
        self._partial_revision_history_cache = []
2676
2366
 
2677
2367
    def _last_revision_info(self):
2678
2368
        revision_string = self._transport.get_bytes('last-revision')
2724
2414
        if _mod_revision.is_null(last_revision):
2725
2415
            return
2726
2416
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2417
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2418
 
2729
2419
    def _gen_revision_history(self):
2730
2420
        """Generate the revision history from last revision
2733
2423
        self._extend_partial_history(stop_index=last_revno-1)
2734
2424
        return list(reversed(self._partial_revision_history_cache))
2735
2425
 
 
2426
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2427
        """Extend the partial history to include a given index
 
2428
 
 
2429
        If a stop_index is supplied, stop when that index has been reached.
 
2430
        If a stop_revision is supplied, stop when that revision is
 
2431
        encountered.  Otherwise, stop when the beginning of history is
 
2432
        reached.
 
2433
 
 
2434
        :param stop_index: The index which should be present.  When it is
 
2435
            present, history extension will stop.
 
2436
        :param revision_id: The revision id which should be present.  When
 
2437
            it is encountered, history extension will stop.
 
2438
        """
 
2439
        repo = self.repository
 
2440
        if len(self._partial_revision_history_cache) == 0:
 
2441
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2442
        else:
 
2443
            start_revision = self._partial_revision_history_cache[-1]
 
2444
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2445
            #skip the last revision in the list
 
2446
            next_revision = iterator.next()
 
2447
        for revision_id in iterator:
 
2448
            self._partial_revision_history_cache.append(revision_id)
 
2449
            if (stop_index is not None and
 
2450
                len(self._partial_revision_history_cache) > stop_index):
 
2451
                break
 
2452
            if revision_id == stop_revision:
 
2453
                break
 
2454
 
2736
2455
    def _write_revision_history(self, history):
2737
2456
        """Factored out of set_revision_history.
2738
2457
 
2759
2478
        """Set the parent branch"""
2760
2479
        return self._get_config_location('parent_location')
2761
2480
 
2762
 
    @needs_write_lock
2763
 
    def _set_all_reference_info(self, info_dict):
2764
 
        """Replace all reference info stored in a branch.
2765
 
 
2766
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2767
 
        """
2768
 
        s = StringIO()
2769
 
        writer = rio.RioWriter(s)
2770
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2771
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
 
                                branch_location=branch_location)
2773
 
            writer.write_stanza(stanza)
2774
 
        self._transport.put_bytes('references', s.getvalue())
2775
 
        self._reference_info = info_dict
2776
 
 
2777
 
    @needs_read_lock
2778
 
    def _get_all_reference_info(self):
2779
 
        """Return all the reference info stored in a branch.
2780
 
 
2781
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2782
 
        """
2783
 
        if self._reference_info is not None:
2784
 
            return self._reference_info
2785
 
        rio_file = self._transport.get('references')
2786
 
        try:
2787
 
            stanzas = rio.read_stanzas(rio_file)
2788
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2789
 
                             s['branch_location'])) for s in stanzas)
2790
 
        finally:
2791
 
            rio_file.close()
2792
 
        self._reference_info = info_dict
2793
 
        return info_dict
2794
 
 
2795
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2796
 
        """Set the branch location to use for a tree reference.
2797
 
 
2798
 
        :param file_id: The file-id of the tree reference.
2799
 
        :param tree_path: The path of the tree reference in the tree.
2800
 
        :param branch_location: The location of the branch to retrieve tree
2801
 
            references from.
2802
 
        """
2803
 
        info_dict = self._get_all_reference_info()
2804
 
        info_dict[file_id] = (tree_path, branch_location)
2805
 
        if None in (tree_path, branch_location):
2806
 
            if tree_path is not None:
2807
 
                raise ValueError('tree_path must be None when branch_location'
2808
 
                                 ' is None.')
2809
 
            if branch_location is not None:
2810
 
                raise ValueError('branch_location must be None when tree_path'
2811
 
                                 ' is None.')
2812
 
            del info_dict[file_id]
2813
 
        self._set_all_reference_info(info_dict)
2814
 
 
2815
 
    def get_reference_info(self, file_id):
2816
 
        """Get the tree_path and branch_location for a tree reference.
2817
 
 
2818
 
        :return: a tuple of (tree_path, branch_location)
2819
 
        """
2820
 
        return self._get_all_reference_info().get(file_id, (None, None))
2821
 
 
2822
 
    def reference_parent(self, file_id, path, possible_transports=None):
2823
 
        """Return the parent branch for a tree-reference file_id.
2824
 
 
2825
 
        :param file_id: The file_id of the tree reference
2826
 
        :param path: The path of the file_id in the tree
2827
 
        :return: A branch associated with the file_id
2828
 
        """
2829
 
        branch_location = self.get_reference_info(file_id)[1]
2830
 
        if branch_location is None:
2831
 
            return Branch.reference_parent(self, file_id, path,
2832
 
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
2834
 
        return Branch.open(branch_location,
2835
 
                           possible_transports=possible_transports)
2836
 
 
2837
2481
    def set_push_location(self, location):
2838
2482
        """See Branch.set_push_location."""
2839
2483
        self._set_config_location('push_location', location)
2881
2525
            raise errors.NotStacked(self)
2882
2526
        return stacked_url
2883
2527
 
 
2528
    def set_append_revisions_only(self, enabled):
 
2529
        if enabled:
 
2530
            value = 'True'
 
2531
        else:
 
2532
            value = 'False'
 
2533
        self.get_config().set_user_option('append_revisions_only', value,
 
2534
            warn_masked=True)
 
2535
 
2884
2536
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2537
        value = self.get_config().get_user_option('append_revisions_only')
 
2538
        return value == 'True'
2887
2539
 
2888
2540
    @needs_write_lock
2889
2541
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2581
        return self.revno() - index
2930
2582
 
2931
2583
 
2932
 
class BzrBranch7(BzrBranch8):
2933
 
    """A branch with support for a fallback repository."""
2934
 
 
2935
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2936
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2937
 
 
2938
 
    def get_reference_info(self, file_id):
2939
 
        Branch.get_reference_info(self, file_id)
2940
 
 
2941
 
    def reference_parent(self, file_id, path, possible_transports=None):
2942
 
        return Branch.reference_parent(self, file_id, path,
2943
 
                                       possible_transports)
2944
 
 
2945
 
 
2946
2584
class BzrBranch6(BzrBranch7):
2947
2585
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2586
 
2951
2589
    """
2952
2590
 
2953
2591
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2592
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2593
 
2956
2594
 
2957
2595
######################################################################
3036
2674
 
3037
2675
    def __init__(self, branch):
3038
2676
        self.branch = branch
3039
 
        self.errors = []
3040
2677
 
3041
2678
    def report_results(self, verbose):
3042
2679
        """Report the check results via trace.note.
3044
2681
        :param verbose: Requests more detailed display of what was checked,
3045
2682
            if any.
3046
2683
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
3049
 
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
2684
        note('checked branch %s format %s',
 
2685
             self.branch.base,
 
2686
             self.branch._format)
3051
2687
 
3052
2688
 
3053
2689
class Converter5to6(object):
3091
2727
        branch._transport.put_bytes('format', format.get_format_string())
3092
2728
 
3093
2729
 
3094
 
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
3096
 
 
3097
 
    def convert(self, branch):
3098
 
        format = BzrBranchFormat8()
3099
 
        branch._transport.put_bytes('references', '')
3100
 
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
2730
 
3104
2731
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2732
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2775
    @staticmethod
3149
2776
    def _get_branch_formats_to_test():
3150
2777
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3152
 
 
3153
 
    def pull(self, overwrite=False, stop_revision=None,
3154
 
             possible_transports=None, local=False):
3155
 
        """Mirror source into target branch.
3156
 
 
3157
 
        The target branch is considered to be 'local', having low latency.
3158
 
 
3159
 
        :returns: PullResult instance
3160
 
        """
3161
 
        raise NotImplementedError(self.pull)
 
2778
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2779
 
3163
2780
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2781
                         graph=None):
3173
2790
        """
3174
2791
        raise NotImplementedError(self.update_revisions)
3175
2792
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
3177
 
             _override_hook_source_branch=None):
3178
 
        """Mirror the source branch into the target branch.
3179
 
 
3180
 
        The source branch is considered to be 'local', having low latency.
3181
 
        """
3182
 
        raise NotImplementedError(self.push)
3183
 
 
3184
2793
 
3185
2794
class GenericInterBranch(InterBranch):
3186
2795
    """InterBranch implementation that uses public Branch functions.
3233
2842
        finally:
3234
2843
            self.source.unlock()
3235
2844
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
2845
    @classmethod
3358
2846
    def is_compatible(self, source, target):
3359
2847
        # GenericBranch uses the public API, so always compatible
3360
2848
        return True
3361
2849
 
3362
2850
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
 
 
3400
2851
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)