/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: Jelmer Vernooij
  • Date: 2009-05-05 12:54:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4331.
  • Revision ID: jelmer@samba.org-20090505125451-f09g3ly9eb3qtylw
Review from Ian.

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()
100
99
    def _open_hook(self):
101
100
        """Called by init to allow simpler extension of the base class."""
102
101
 
103
 
    def _activate_fallback_location(self, url):
104
 
        """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)
109
 
 
110
102
    def break_lock(self):
111
103
        """Break a lock if one is present from another instance.
112
104
 
121
113
        if master is not None:
122
114
            master.break_lock()
123
115
 
124
 
    def _check_stackable_repo(self):
125
 
        if not self.repository._format.supports_external_lookups:
126
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
 
                self.repository.base)
128
 
 
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
116
    @staticmethod
159
117
    def open(base, _unsupported=False, possible_transports=None):
160
118
        """Open the branch rooted at base.
164
122
        """
165
123
        control = bzrdir.BzrDir.open(base, _unsupported,
166
124
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
125
        return control.open_branch(_unsupported)
168
126
 
169
127
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
128
    def open_from_transport(transport, _unsupported=False):
171
129
        """Open the branch rooted at transport"""
172
130
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
131
        return control.open_branch(_unsupported)
174
132
 
175
133
    @staticmethod
176
134
    def open_containing(url, possible_transports=None):
199
157
    def get_config(self):
200
158
        return BranchConfig(self)
201
159
 
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
 
    def _get_fallback_repository(self, url):
215
 
        """Get the repository we fallback to at url."""
216
 
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
220
 
 
221
160
    def _get_tags_bytes(self):
222
161
        """Get the bytes of a serialised tags dict.
223
162
 
417
356
            * 'include' - the stop revision is the last item in the result
418
357
            * 'with-merges' - include the stop revision and all of its
419
358
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
359
        :param direction: either 'reverse' or 'forward':
423
360
            * reverse means return the start_revision_id first, i.e.
424
361
              start at the most recent revision and go backwards in history
446
383
        # start_revision_id.
447
384
        if self._merge_sorted_revisions_cache is None:
448
385
            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)
 
386
            graph = self.repository.get_graph()
 
387
            parent_map = dict(((key, value) for key, value in
 
388
                     graph.iter_ancestry([last_revision]) if value is not None))
 
389
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
390
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
391
                generate_revno=True)
 
392
            # Drop the sequence # before caching
 
393
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
394
 
453
395
        filtered = self._filter_merge_sorted_revisions(
454
396
            self._merge_sorted_revisions_cache, start_revision_id,
455
397
            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
398
        if direction == 'reverse':
460
399
            return filtered
461
400
        if direction == 'forward':
468
407
        """Iterate over an inclusive range of sorted revisions."""
469
408
        rev_iter = iter(merge_sorted_revisions)
470
409
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
411
                if rev_id != start_revision_id:
474
412
                    continue
475
413
                else:
476
414
                    # The decision to include the start or not
477
415
                    # 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)
 
416
                    rev_iter = chain(
 
417
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
418
                        rev_iter)
480
419
                    break
481
420
        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)
 
421
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
422
                yield rev_id, depth, revno, end_of_merge
487
423
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
424
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
425
                if rev_id == stop_revision_id:
491
426
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
427
                yield rev_id, depth, revno, end_of_merge
494
428
        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)
 
429
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
430
                yield rev_id, depth, revno, end_of_merge
499
431
                if rev_id == stop_revision_id:
500
432
                    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
433
        elif stop_rule == 'with-merges':
514
434
            stop_rev = self.repository.get_revision(stop_revision_id)
515
435
            if stop_rev.parent_ids:
516
436
                left_parent = stop_rev.parent_ids[0]
517
437
            else:
518
438
                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]
 
439
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
440
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
441
                    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)
 
442
                yield rev_id, depth, revno, end_of_merge
538
443
        else:
539
444
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
445
 
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
446
    def leave_lock_in_place(self):
587
447
        """Tell this branch object not to release the physical lock when this
588
448
        object is unlocked.
605
465
        :param other: The branch to bind to
606
466
        :type other: Branch
607
467
        """
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)
 
468
        raise errors.UpgradeRequired(self.base)
627
469
 
628
470
    @needs_write_lock
629
471
    def fetch(self, from_branch, last_revision=None, pb=None):
663
505
    def get_old_bound_location(self):
664
506
        """Return the URL of the branch we used to be bound to
665
507
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
508
        raise errors.UpgradeRequired(self.base)
667
509
 
668
510
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
511
                           timezone=None, committer=None, revprops=None,
719
561
    def set_revision_history(self, rev_history):
720
562
        raise NotImplementedError(self.set_revision_history)
721
563
 
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
564
    def set_stacked_on_url(self, url):
742
565
        """Set the URL this branch is stacked against.
743
566
 
746
569
        :raises UnstackableRepositoryFormat: If the repository does not support
747
570
            stacking.
748
571
        """
749
 
        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.
754
 
        self._check_stackable_repo()
755
 
        if not url:
756
 
            try:
757
 
                old_url = self.get_stacked_on_url()
758
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
 
                errors.UnstackableRepositoryFormat):
760
 
                return
761
 
            self._unstack()
762
 
        else:
763
 
            self._activate_fallback_location(url)
764
 
        # write this out after the repository is stacked to avoid setting a
765
 
        # stacked config that doesn't work.
766
 
        self._set_config_location('stacked_on_location', url)
767
 
 
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()
 
572
        raise NotImplementedError(self.set_stacked_on_url)
822
573
 
823
574
    def _set_tags_bytes(self, bytes):
824
575
        """Mirror method for _get_tags_bytes.
860
611
        self._revision_id_to_revno_cache = None
861
612
        self._last_revision_info_cache = None
862
613
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
614
 
866
615
    def _gen_revision_history(self):
867
616
        """Return sequence of revision hashes on to this branch.
904
653
 
905
654
    def unbind(self):
906
655
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
656
        raise errors.UpgradeRequired(self.base)
 
657
 
 
658
    def set_append_revisions_only(self, enabled):
 
659
        """Older format branches are never restricted to append-only"""
 
660
        raise errors.UpgradeRequired(self.base)
908
661
 
909
662
    def last_revision(self):
910
663
        """Return last revision id, or NULL_REVISION."""
991
744
        except ValueError:
992
745
            raise errors.NoSuchRevision(self, revision_id)
993
746
 
994
 
    @needs_read_lock
995
747
    def get_rev_id(self, revno, history=None):
996
748
        """Find the revision id of the specified revno."""
997
749
        if revno == 0:
998
750
            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:
 
751
        if history is None:
 
752
            history = self.revision_history()
 
753
        if revno <= 0 or revno > len(history):
1003
754
            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]
 
755
        return history[revno - 1]
1008
756
 
1009
 
    @needs_write_lock
1010
757
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
758
             possible_transports=None, _override_hook_target=None):
1012
759
        """Mirror source into this branch.
1013
760
 
1014
761
        This branch is considered to be 'local', having low latency.
1015
762
 
1016
763
        :returns: PullResult instance
1017
764
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
765
        raise NotImplementedError(self.pull)
1021
766
 
1022
767
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
768
        **kwargs):
1028
773
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
774
            *args, **kwargs)
1030
775
 
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)
1051
 
 
1052
776
    def basis_tree(self):
1053
777
        """Return `Tree` object for last revision."""
1054
778
        return self.repository.revision_tree(self.last_revision())
1070
794
        try:
1071
795
            return urlutils.join(self.base[:-1], parent)
1072
796
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
797
            raise errors.InaccessibleParent(parent, self.base)
1074
798
 
1075
799
    def _get_parent_location(self):
1076
800
        raise NotImplementedError(self._get_parent_location)
1093
817
            location = None
1094
818
        return location
1095
819
 
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
820
    def get_submit_branch(self):
1101
821
        """Return the submit location of the branch.
1102
822
 
1119
839
    def get_public_branch(self):
1120
840
        """Return the public location of the branch.
1121
841
 
1122
 
        This is used by merge directives.
 
842
        This is is used by merge directives.
1123
843
        """
1124
844
        return self._get_config_location('public_branch')
1125
845
 
1161
881
        params = ChangeBranchTipParams(
1162
882
            self, old_revno, new_revno, old_revid, new_revid)
1163
883
        for hook in hooks:
1164
 
            hook(params)
 
884
            try:
 
885
                hook(params)
 
886
            except errors.TipChangeRejected:
 
887
                raise
 
888
            except Exception:
 
889
                exc_info = sys.exc_info()
 
890
                hook_name = Branch.hooks.get_hook_name(hook)
 
891
                raise errors.HookFailed(
 
892
                    'pre_change_branch_tip', hook_name, exc_info)
 
893
 
 
894
    def set_parent(self, url):
 
895
        raise NotImplementedError(self.set_parent)
1165
896
 
1166
897
    @needs_write_lock
1167
898
    def update(self):
1198
929
                     be truncated to end with revision_id.
1199
930
        """
1200
931
        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
 
932
        if repository_policy is not None:
 
933
            repository_policy.configure_branch(result)
 
934
        self.copy_content_into(result, revision_id=revision_id)
 
935
        return  result
1209
936
 
1210
937
    @needs_read_lock
1211
938
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1216
943
        revision_id: if not None, the revision history in the new branch will
1217
944
                     be truncated to end with revision_id.
1218
945
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
946
        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()
 
947
        if repository_policy is not None:
 
948
            repository_policy.configure_branch(result)
 
949
        self.copy_content_into(result, revision_id=revision_id)
 
950
        result.set_parent(self.bzrdir.root_transport.base)
1231
951
        return result
1232
952
 
1233
953
    def _synchronize_history(self, destination, revision_id):
1245
965
        source_revno, source_revision_id = self.last_revision_info()
1246
966
        if revision_id is None:
1247
967
            revno, revision_id = source_revno, source_revision_id
 
968
        elif source_revision_id == revision_id:
 
969
            # we know the revno without needing to walk all of history
 
970
            revno = source_revno
1248
971
        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
 
972
            # To figure out the revno for a random revision, we need to build
 
973
            # the revision history, and count its length.
 
974
            # We don't care about the order, just how long it is.
 
975
            # Alternatively, we could start at the current location, and count
 
976
            # backwards. But there is no guarantee that we will find it since
 
977
            # it may be a merged revision.
 
978
            revno = len(list(self.repository.iter_reverse_revision_history(
 
979
                                                                revision_id)))
1256
980
        destination.set_last_revision_info(revno, revision_id)
1257
981
 
1258
982
    @needs_read_lock
1262
986
        revision_id: if not None, the revision history in the new branch will
1263
987
                     be truncated to end with revision_id.
1264
988
        """
1265
 
        self.update_references(destination)
1266
989
        self._synchronize_history(destination, revision_id)
1267
990
        try:
1268
991
            parent = self.get_parent()
1274
997
        if self._push_should_merge_tags():
1275
998
            self.tags.merge_to(destination.tags)
1276
999
 
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
1000
    @needs_read_lock
1295
 
    def check(self, refs):
 
1001
    def check(self):
1296
1002
        """Check consistency of the branch.
1297
1003
 
1298
1004
        In particular this checks that revisions given in the revision-history
1301
1007
 
1302
1008
        Callers will typically also want to check the repository.
1303
1009
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1010
        :return: A BranchCheckResult.
1307
1011
        """
1308
 
        result = BranchCheckResult(self)
 
1012
        mainline_parent_id = None
1309
1013
        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
 
1014
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1015
                                last_revision_id))
 
1016
        real_rev_history.reverse()
 
1017
        if len(real_rev_history) != last_revno:
 
1018
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1019
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1020
        # TODO: We should probably also check that real_rev_history actually
 
1021
        #       matches self.revision_history()
 
1022
        for revision_id in real_rev_history:
 
1023
            try:
 
1024
                revision = self.repository.get_revision(revision_id)
 
1025
            except errors.NoSuchRevision, e:
 
1026
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1027
                            % revision_id)
 
1028
            # In general the first entry on the revision history has no parents.
 
1029
            # But it's not illegal for it to have parents listed; this can happen
 
1030
            # in imports from Arch when the parents weren't reachable.
 
1031
            if mainline_parent_id is not None:
 
1032
                if mainline_parent_id not in revision.parent_ids:
 
1033
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1034
                                        "parents of {%s}"
 
1035
                                        % (mainline_parent_id, revision_id))
 
1036
            mainline_parent_id = revision_id
 
1037
        return BranchCheckResult(self)
1321
1038
 
1322
1039
    def _get_checkout_format(self):
1323
1040
        """Return the most suitable metadir for a checkout of this branch.
1333
1050
        return format
1334
1051
 
1335
1052
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1053
        stacked_on=None):
1337
1054
        """Create a clone of this branch and its bzrdir.
1338
1055
 
1339
1056
        :param to_transport: The transport to clone onto.
1340
1057
        :param revision_id: The revision id to use as tip in the new branch.
1341
1058
            If None the tip is obtained from this branch.
1342
1059
        :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
1060
        """
1347
1061
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1062
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1063
        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)
 
1064
            revision_id=revision_id, stacked_on=stacked_on)
1354
1065
        return dir_to.open_branch()
1355
1066
 
1356
1067
    def create_checkout(self, to_location, revision_id=None,
1375
1086
        if lightweight:
1376
1087
            format = self._get_checkout_format()
1377
1088
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1089
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1090
        else:
1381
1091
            format = self._get_checkout_format()
1382
1092
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1121
        reconciler.reconcile()
1412
1122
        return reconciler
1413
1123
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1124
    def reference_parent(self, file_id, path):
1415
1125
        """Return the parent branch for a tree-reference file_id
1416
1126
        :param file_id: The file_id of the tree reference
1417
1127
        :param path: The path of the file_id in the tree
1418
1128
        :return: A branch associated with the file_id
1419
1129
        """
1420
1130
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1131
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1132
 
1424
1133
    def supports_tags(self):
1425
1134
        return self._format.supports_tags()
1426
1135
 
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
1136
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1137
                                         other_branch):
1441
1138
        """Ensure that revision_b is a descendant of revision_a.
1496
1193
    _formats = {}
1497
1194
    """The known formats."""
1498
1195
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1196
    def __eq__(self, other):
1502
1197
        return self.__class__ is other.__class__
1503
1198
 
1505
1200
        return not (self == other)
1506
1201
 
1507
1202
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1203
    def find_format(klass, a_bzrdir):
1509
1204
        """Return the format for the branch object in a_bzrdir."""
1510
1205
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1206
            transport = a_bzrdir.get_branch_transport(None)
 
1207
            format_string = transport.get("format").read()
1513
1208
            return klass._formats[format_string]
1514
1209
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1210
            raise errors.NotBranchError(path=transport.base)
1516
1211
        except KeyError:
1517
1212
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1213
 
1554
1249
        """Return the short format description for this format."""
1555
1250
        raise NotImplementedError(self.get_format_description)
1556
1251
 
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):
 
1252
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1253
                           set_format=True):
1567
1254
        """Initialize a branch in a bzrdir, with specified files
1568
1255
 
1569
1256
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1257
        :param utf8_files: The files to create as a list of
1571
1258
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1259
        :param set_format: If True, set the format with
1574
1260
            self.get_format_string.  (BzrBranch4 has its format set
1575
1261
            elsewhere)
1576
1262
        :return: a branch in this format
1577
1263
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1264
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1265
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1266
        lock_map = {
1581
1267
            'metadir': ('lock', lockdir.LockDir),
1582
1268
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1271
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1272
            lock_name, lock_class)
1587
1273
        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
 
1274
        control_files.lock_write()
1596
1275
        if set_format:
1597
1276
            utf8_files += [('format', self.get_format_string())]
1598
1277
        try:
1601
1280
                    filename, content,
1602
1281
                    mode=a_bzrdir._get_file_mode())
1603
1282
        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
 
1283
            control_files.unlock()
 
1284
        return self.open(a_bzrdir, _found=True)
1609
1285
 
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
 
        """
 
1286
    def initialize(self, a_bzrdir):
 
1287
        """Create a branch of this format in a_bzrdir."""
1615
1288
        raise NotImplementedError(self.initialize)
1616
1289
 
1617
1290
    def is_supported(self):
1647
1320
        """
1648
1321
        raise NotImplementedError(self.network_name)
1649
1322
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1323
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1324
        """Return the branch object for a_bzrdir
1652
1325
 
1653
1326
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1327
        :param _found: a private parameter, do not use it. It is used to
1656
1328
            indicate if format probing has already be done.
1657
1329
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1343
    def set_default_format(klass, format):
1672
1344
        klass._default_format = format
1673
1345
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1346
    def supports_stacking(self):
1679
1347
        """True if this format records a stacked-on branch."""
1680
1348
        return False
1742
1410
            "post_uncommit is called with (local, master, old_revno, "
1743
1411
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1412
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1413
            "recieves new_revno of 0, new_revid of None.", (0, 15), None))
1746
1414
        self.create_hook(HookPoint('pre_change_branch_tip',
1747
1415
            "Called in bzr client and server before a change to the tip of a "
1748
1416
            "branch is made. pre_change_branch_tip is called with a "
1765
1433
            "multiple hooks installed for transform_fallback_location, "
1766
1434
            "all are called with the url returned from the previous hook."
1767
1435
            "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
1436
 
1786
1437
 
1787
1438
# install the default hooks into the Branch class.
1826
1477
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1478
 
1828
1479
 
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
1480
class BzrBranchFormat4(BranchFormat):
1908
1481
    """Bzr branch format 4.
1909
1482
 
1916
1489
        """See BranchFormat.get_format_description()."""
1917
1490
        return "Branch format 4"
1918
1491
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1492
    def initialize(self, a_bzrdir):
1920
1493
        """Create a branch of this format in a_bzrdir."""
1921
1494
        utf8_files = [('revision-history', ''),
1922
1495
                      ('branch-name', ''),
1923
1496
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1497
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1498
                                       lock_type='branch4', set_format=False)
1926
1499
 
1927
1500
    def __init__(self):
1932
1505
        """The network name for this format is the control dirs disk label."""
1933
1506
        return self._matchingbzrdir.get_format_string()
1934
1507
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1508
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1509
        """See BranchFormat.open()."""
1937
1510
        if not _found:
1938
1511
            # we are being called directly and must probe.
1940
1513
        return BzrBranch(_format=self,
1941
1514
                         _control_files=a_bzrdir._control_files,
1942
1515
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1516
                         _repository=a_bzrdir.open_repository())
1945
1517
 
1946
1518
    def __str__(self):
1961
1533
        """
1962
1534
        return self.get_format_string()
1963
1535
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1536
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1537
        """See BranchFormat.open()."""
1966
1538
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1539
            format = BranchFormat.find_format(a_bzrdir)
1968
1540
            if format.__class__ != self.__class__:
1969
1541
                raise AssertionError("wrong format %r found for %r" %
1970
1542
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1543
        try:
 
1544
            transport = a_bzrdir.get_branch_transport(None)
1973
1545
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1546
                                                         lockdir.LockDir)
1975
1547
            return self._branch_class()(_format=self,
1976
1548
                              _control_files=control_files,
1977
 
                              name=name,
1978
1549
                              a_bzrdir=a_bzrdir,
1979
1550
                              _repository=a_bzrdir.find_repository(),
1980
1551
                              ignore_fallbacks=ignore_fallbacks)
1981
1552
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1553
            raise errors.NotBranchError(path=transport.base)
1983
1554
 
1984
1555
    def __init__(self):
1985
1556
        super(BranchFormatMetadir, self).__init__()
2014
1585
        """See BranchFormat.get_format_description()."""
2015
1586
        return "Branch format 5"
2016
1587
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1588
    def initialize(self, a_bzrdir):
2018
1589
        """Create a branch of this format in a_bzrdir."""
2019
1590
        utf8_files = [('revision-history', ''),
2020
1591
                      ('branch-name', ''),
2021
1592
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1593
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1594
 
2024
1595
    def supports_tags(self):
2025
1596
        return False
2047
1618
        """See BranchFormat.get_format_description()."""
2048
1619
        return "Branch format 6"
2049
1620
 
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):
 
1621
    def initialize(self, a_bzrdir):
 
1622
        """Create a branch of this format in a_bzrdir."""
 
1623
        utf8_files = [('last-revision', '0 null:\n'),
 
1624
                      ('branch.conf', ''),
 
1625
                      ('tags', ''),
 
1626
                      ]
 
1627
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1628
 
 
1629
    def make_tags(self, branch):
 
1630
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1631
        return BasicTags(branch)
 
1632
 
 
1633
 
 
1634
 
 
1635
class BzrBranchFormat7(BranchFormatMetadir):
2108
1636
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1637
 
2110
1638
    The stacked location pointer is passed down to the repository and requires
2113
1641
    This format was introduced in bzr 1.6.
2114
1642
    """
2115
1643
 
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
1644
    def _branch_class(self):
2125
1645
        return BzrBranch7
2126
1646
 
2132
1652
        """See BranchFormat.get_format_description()."""
2133
1653
        return "Branch format 7"
2134
1654
 
2135
 
    def supports_set_append_revisions_only(self):
 
1655
    def initialize(self, a_bzrdir):
 
1656
        """Create a branch of this format in a_bzrdir."""
 
1657
        utf8_files = [('last-revision', '0 null:\n'),
 
1658
                      ('branch.conf', ''),
 
1659
                      ('tags', ''),
 
1660
                      ]
 
1661
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1662
 
 
1663
    def __init__(self):
 
1664
        super(BzrBranchFormat7, self).__init__()
 
1665
        self._matchingbzrdir.repository_format = \
 
1666
            RepositoryFormatKnitPack5RichRoot()
 
1667
 
 
1668
    def make_tags(self, branch):
 
1669
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1670
        return BasicTags(branch)
 
1671
 
 
1672
    def supports_stacking(self):
2136
1673
        return True
2137
1674
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1675
 
2141
1676
class BranchReferenceFormat(BranchFormat):
2142
1677
    """Bzr branch reference format.
2160
1695
    def get_reference(self, a_bzrdir):
2161
1696
        """See BranchFormat.get_reference()."""
2162
1697
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1698
        return transport.get('location').read()
2164
1699
 
2165
1700
    def set_reference(self, a_bzrdir, to_branch):
2166
1701
        """See BranchFormat.set_reference()."""
2167
1702
        transport = a_bzrdir.get_branch_transport(None)
2168
1703
        location = transport.put_bytes('location', to_branch.base)
2169
1704
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1705
    def initialize(self, a_bzrdir, target_branch=None):
2171
1706
        """Create a branch of this format in a_bzrdir."""
2172
1707
        if target_branch is None:
2173
1708
            # this format does not implement branch itself, thus the implicit
2174
1709
            # creation contract must see it as uninitializable
2175
1710
            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)
 
1711
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1712
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1713
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1714
            target_branch.bzrdir.root_transport.base)
2180
1715
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1716
        return self.open(
 
1717
            a_bzrdir, _found=True,
2183
1718
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1719
 
2187
1720
    def __init__(self):
2188
1721
        super(BranchReferenceFormat, self).__init__()
2194
1727
        def clone(to_bzrdir, revision_id=None,
2195
1728
            repository_policy=None):
2196
1729
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1730
            return format.initialize(to_bzrdir, a_branch)
2198
1731
            # cannot obey revision_id limits when cloning a reference ...
2199
1732
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1733
            # emit some sort of warning/error to the caller ?!
2201
1734
        return clone
2202
1735
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1736
    def open(self, a_bzrdir, _found=False, location=None,
2204
1737
             possible_transports=None, ignore_fallbacks=False):
2205
1738
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1739
 
2207
1740
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1741
        :param _found: a private parameter, do not use it. It is used to
2210
1742
            indicate if format probing has already be done.
2211
1743
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1748
        :param possible_transports: An optional reusable transports list.
2217
1749
        """
2218
1750
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1751
            format = BranchFormat.find_format(a_bzrdir)
2220
1752
            if format.__class__ != self.__class__:
2221
1753
                raise AssertionError("wrong format %r found for %r" %
2222
1754
                    (format, self))
2224
1756
            location = self.get_reference(a_bzrdir)
2225
1757
        real_bzrdir = bzrdir.BzrDir.open(
2226
1758
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1759
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1760
        # this changes the behaviour of result.clone to create a new reference
2230
1761
        # rather than a copy of the content of the branch.
2231
1762
        # I did not use a proxy object because that needs much more extensive
2252
1783
__format5 = BzrBranchFormat5()
2253
1784
__format6 = BzrBranchFormat6()
2254
1785
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1786
BranchFormat.register_format(__format5)
2257
1787
BranchFormat.register_format(BranchReferenceFormat())
2258
1788
BranchFormat.register_format(__format6)
2259
1789
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1790
BranchFormat.set_default_format(__format6)
2262
1791
_legacy_formats = [BzrBranchFormat4(),
2263
1792
    ]
2264
1793
network_format_registry.register(
2265
1794
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1795
 
2267
1796
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1797
class BzrBranch(Branch):
2269
1798
    """A branch stored in the actual filesystem.
2270
1799
 
2271
1800
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1806
    :ivar repository: Repository for this branch.
2278
1807
    :ivar base: The url of the base directory for this branch; the one
2279
1808
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1809
    """
2283
1810
 
2284
1811
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1812
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1813
                 ignore_fallbacks=False):
2287
1814
        """Create new branch object at a particular location."""
2288
1815
        if a_bzrdir is None:
2289
1816
            raise ValueError('a_bzrdir must be supplied')
2290
1817
        else:
2291
1818
            self.bzrdir = a_bzrdir
2292
1819
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1820
        # XXX: We should be able to just do
2295
1821
        #   self.base = self.bzrdir.root_transport.base
2296
1822
        # but this does not quite work yet -- mbp 20080522
2303
1829
        Branch.__init__(self)
2304
1830
 
2305
1831
    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)
 
1832
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1833
 
2312
1834
    __repr__ = __str__
2313
1835
 
2317
1839
 
2318
1840
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
1841
 
2320
 
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
2322
 
 
2323
1842
    def is_locked(self):
2324
1843
        return self.control_files.is_locked()
2325
1844
 
2326
1845
    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
 
1846
        repo_token = self.repository.lock_write()
2337
1847
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1848
            token = self.control_files.lock_write(token=token)
2339
1849
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1850
            self.repository.unlock()
2342
1851
            raise
 
1852
        return token
2343
1853
 
2344
1854
    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
 
1855
        self.repository.lock_read()
2355
1856
        try:
2356
1857
            self.control_files.lock_read()
2357
1858
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1859
            self.repository.unlock()
2360
1860
            raise
2361
1861
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1862
    def unlock(self):
 
1863
        # TODO: test for failed two phase locks. This is known broken.
2364
1864
        try:
2365
1865
            self.control_files.unlock()
2366
1866
        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()
 
1867
            self.repository.unlock()
 
1868
        if not self.control_files.is_locked():
 
1869
            # we just released the lock
 
1870
            self._clear_cached_state()
2375
1871
 
2376
1872
    def peek_lock_mode(self):
2377
1873
        if self.control_files._lock_count == 0:
2496
1992
        """See Branch.basis_tree."""
2497
1993
        return self.repository.revision_tree(self.last_revision())
2498
1994
 
 
1995
    @needs_write_lock
 
1996
    def pull(self, source, overwrite=False, stop_revision=None,
 
1997
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1998
             _override_hook_target=None):
 
1999
        """See Branch.pull.
 
2000
 
 
2001
        :param _hook_master: Private parameter - set the branch to
 
2002
            be supplied as the master to pull hooks.
 
2003
        :param run_hooks: Private parameter - if false, this branch
 
2004
            is being called because it's the master of the primary branch,
 
2005
            so it should not run its hooks.
 
2006
        :param _override_hook_target: Private parameter - set the branch to be
 
2007
            supplied as the target_branch to pull hooks.
 
2008
        """
 
2009
        result = PullResult()
 
2010
        result.source_branch = source
 
2011
        if _override_hook_target is None:
 
2012
            result.target_branch = self
 
2013
        else:
 
2014
            result.target_branch = _override_hook_target
 
2015
        source.lock_read()
 
2016
        try:
 
2017
            # We assume that during 'pull' the local repository is closer than
 
2018
            # the remote one.
 
2019
            graph = self.repository.get_graph(source.repository)
 
2020
            result.old_revno, result.old_revid = self.last_revision_info()
 
2021
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2022
                                  graph=graph)
 
2023
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2024
            result.new_revno, result.new_revid = self.last_revision_info()
 
2025
            if _hook_master:
 
2026
                result.master_branch = _hook_master
 
2027
                result.local_branch = result.target_branch
 
2028
            else:
 
2029
                result.master_branch = result.target_branch
 
2030
                result.local_branch = None
 
2031
            if run_hooks:
 
2032
                for hook in Branch.hooks['post_pull']:
 
2033
                    hook(result)
 
2034
        finally:
 
2035
            source.unlock()
 
2036
        return result
 
2037
 
2499
2038
    def _get_parent_location(self):
2500
2039
        _locs = ['parent', 'pull', 'x-pull']
2501
2040
        for l in _locs:
2514
2053
        result.source_branch = self
2515
2054
        result.target_branch = target
2516
2055
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2056
        if result.old_revid != self.last_revision():
2519
2057
            # We assume that during 'push' this repository is closer than
2520
2058
            # the target.
2528
2066
        return result
2529
2067
 
2530
2068
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2069
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2070
 
2533
2071
    def set_push_location(self, location):
2534
2072
        """See Branch.set_push_location."""
2536
2074
            'push_location', location,
2537
2075
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2076
 
 
2077
    @needs_write_lock
 
2078
    def set_parent(self, url):
 
2079
        """See Branch.set_parent."""
 
2080
        # TODO: Maybe delete old location files?
 
2081
        # URLs should never be unicode, even on the local fs,
 
2082
        # FIXUP this and get_parent in a future branch format bump:
 
2083
        # read and rewrite the file. RBC 20060125
 
2084
        if url is not None:
 
2085
            if isinstance(url, unicode):
 
2086
                try:
 
2087
                    url = url.encode('ascii')
 
2088
                except UnicodeEncodeError:
 
2089
                    raise errors.InvalidURL(url,
 
2090
                        "Urls must be 7-bit ascii, "
 
2091
                        "use bzrlib.urlutils.escape")
 
2092
            url = urlutils.relative_url(self.base, url)
 
2093
        self._set_parent_location(url)
 
2094
 
2539
2095
    def _set_parent_location(self, url):
2540
2096
        if url is None:
2541
2097
            self._transport.delete('parent')
2543
2099
            self._transport.put_bytes('parent', url + '\n',
2544
2100
                mode=self.bzrdir._get_file_mode())
2545
2101
 
 
2102
    def set_stacked_on_url(self, url):
 
2103
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2104
 
2546
2105
 
2547
2106
class BzrBranch5(BzrBranch):
2548
2107
    """A format 5 branch. This supports new features over plain branches.
2550
2109
    It has support for a master_branch which is the data for bound branches.
2551
2110
    """
2552
2111
 
 
2112
    @needs_write_lock
 
2113
    def pull(self, source, overwrite=False, stop_revision=None,
 
2114
             run_hooks=True, possible_transports=None,
 
2115
             _override_hook_target=None):
 
2116
        """Pull from source into self, updating my master if any.
 
2117
 
 
2118
        :param run_hooks: Private parameter - if false, this branch
 
2119
            is being called because it's the master of the primary branch,
 
2120
            so it should not run its hooks.
 
2121
        """
 
2122
        bound_location = self.get_bound_location()
 
2123
        master_branch = None
 
2124
        if bound_location and source.base != bound_location:
 
2125
            # not pulling from master, so we need to update master.
 
2126
            master_branch = self.get_master_branch(possible_transports)
 
2127
            master_branch.lock_write()
 
2128
        try:
 
2129
            if master_branch:
 
2130
                # pull from source into master.
 
2131
                master_branch.pull(source, overwrite, stop_revision,
 
2132
                    run_hooks=False)
 
2133
            return super(BzrBranch5, self).pull(source, overwrite,
 
2134
                stop_revision, _hook_master=master_branch,
 
2135
                run_hooks=run_hooks,
 
2136
                _override_hook_target=_override_hook_target)
 
2137
        finally:
 
2138
            if master_branch:
 
2139
                master_branch.unlock()
 
2140
 
2553
2141
    def get_bound_location(self):
2554
2142
        try:
2555
2143
            return self._transport.get_bytes('bound')[:-1]
2642
2230
        return None
2643
2231
 
2644
2232
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
2233
class BzrBranch7(BzrBranch5):
 
2234
    """A branch with support for a fallback repository."""
 
2235
 
 
2236
    def _get_fallback_repository(self, url):
 
2237
        """Get the repository we fallback to at url."""
 
2238
        url = urlutils.join(self.base, url)
 
2239
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2240
                                      possible_transports=[self._transport])
 
2241
        return a_bzrdir.open_branch().repository
 
2242
 
 
2243
    def _activate_fallback_location(self, url):
 
2244
        """Activate the branch/repository from url as a fallback repository."""
 
2245
        self.repository.add_fallback_repository(
 
2246
            self._get_fallback_repository(url))
2647
2247
 
2648
2248
    def _open_hook(self):
2649
2249
        if self._ignore_fallbacks:
2663
2263
                        "None, not a URL." % hook_name)
2664
2264
            self._activate_fallback_location(url)
2665
2265
 
 
2266
    def _check_stackable_repo(self):
 
2267
        if not self.repository._format.supports_external_lookups:
 
2268
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2269
                self.repository.base)
 
2270
 
2666
2271
    def __init__(self, *args, **kwargs):
2667
2272
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2273
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2274
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2275
        self._partial_revision_history_cache = []
2671
2276
 
2672
2277
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2278
        super(BzrBranch7, self)._clear_cached_state()
2674
2279
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2280
        self._partial_revision_history_cache = []
2676
2281
 
2677
2282
    def _last_revision_info(self):
2678
2283
        revision_string = self._transport.get_bytes('last-revision')
2724
2329
        if _mod_revision.is_null(last_revision):
2725
2330
            return
2726
2331
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2332
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2333
 
2729
2334
    def _gen_revision_history(self):
2730
2335
        """Generate the revision history from last revision
2733
2338
        self._extend_partial_history(stop_index=last_revno-1)
2734
2339
        return list(reversed(self._partial_revision_history_cache))
2735
2340
 
 
2341
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2342
        """Extend the partial history to include a given index
 
2343
 
 
2344
        If a stop_index is supplied, stop when that index has been reached.
 
2345
        If a stop_revision is supplied, stop when that revision is
 
2346
        encountered.  Otherwise, stop when the beginning of history is
 
2347
        reached.
 
2348
 
 
2349
        :param stop_index: The index which should be present.  When it is
 
2350
            present, history extension will stop.
 
2351
        :param revision_id: The revision id which should be present.  When
 
2352
            it is encountered, history extension will stop.
 
2353
        """
 
2354
        repo = self.repository
 
2355
        if len(self._partial_revision_history_cache) == 0:
 
2356
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2357
        else:
 
2358
            start_revision = self._partial_revision_history_cache[-1]
 
2359
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2360
            #skip the last revision in the list
 
2361
            next_revision = iterator.next()
 
2362
        for revision_id in iterator:
 
2363
            self._partial_revision_history_cache.append(revision_id)
 
2364
            if (stop_index is not None and
 
2365
                len(self._partial_revision_history_cache) > stop_index):
 
2366
                break
 
2367
            if revision_id == stop_revision:
 
2368
                break
 
2369
 
2736
2370
    def _write_revision_history(self, history):
2737
2371
        """Factored out of set_revision_history.
2738
2372
 
2759
2393
        """Set the parent branch"""
2760
2394
        return self._get_config_location('parent_location')
2761
2395
 
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
2396
    def set_push_location(self, location):
2838
2397
        """See Branch.set_push_location."""
2839
2398
        self._set_config_location('push_location', location)
2881
2440
            raise errors.NotStacked(self)
2882
2441
        return stacked_url
2883
2442
 
 
2443
    def set_append_revisions_only(self, enabled):
 
2444
        if enabled:
 
2445
            value = 'True'
 
2446
        else:
 
2447
            value = 'False'
 
2448
        self.get_config().set_user_option('append_revisions_only', value,
 
2449
            warn_masked=True)
 
2450
 
 
2451
    def set_stacked_on_url(self, url):
 
2452
        self._check_stackable_repo()
 
2453
        if not url:
 
2454
            try:
 
2455
                old_url = self.get_stacked_on_url()
 
2456
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2457
                errors.UnstackableRepositoryFormat):
 
2458
                return
 
2459
            url = ''
 
2460
            # repositories don't offer an interface to remove fallback
 
2461
            # repositories today; take the conceptually simpler option and just
 
2462
            # reopen it.
 
2463
            self.repository = self.bzrdir.find_repository()
 
2464
            # for every revision reference the branch has, ensure it is pulled
 
2465
            # in.
 
2466
            source_repository = self._get_fallback_repository(old_url)
 
2467
            for revision_id in chain([self.last_revision()],
 
2468
                self.tags.get_reverse_tag_dict()):
 
2469
                self.repository.fetch(source_repository, revision_id,
 
2470
                    find_ghosts=True)
 
2471
        else:
 
2472
            self._activate_fallback_location(url)
 
2473
        # write this out after the repository is stacked to avoid setting a
 
2474
        # stacked config that doesn't work.
 
2475
        self._set_config_location('stacked_on_location', url)
 
2476
 
2884
2477
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2478
        value = self.get_config().get_user_option('append_revisions_only')
 
2479
        return value == 'True'
2887
2480
 
2888
2481
    @needs_write_lock
2889
2482
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2522
        return self.revno() - index
2930
2523
 
2931
2524
 
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
2525
class BzrBranch6(BzrBranch7):
2947
2526
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2527
 
2951
2530
    """
2952
2531
 
2953
2532
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2533
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2534
 
 
2535
    def set_stacked_on_url(self, url):
 
2536
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2537
 
2956
2538
 
2957
2539
######################################################################
3036
2618
 
3037
2619
    def __init__(self, branch):
3038
2620
        self.branch = branch
3039
 
        self.errors = []
3040
2621
 
3041
2622
    def report_results(self, verbose):
3042
2623
        """Report the check results via trace.note.
3044
2625
        :param verbose: Requests more detailed display of what was checked,
3045
2626
            if any.
3046
2627
        """
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)
 
2628
        note('checked branch %s format %s',
 
2629
             self.branch.base,
 
2630
             self.branch._format)
3051
2631
 
3052
2632
 
3053
2633
class Converter5to6(object):
3091
2671
        branch._transport.put_bytes('format', format.get_format_string())
3092
2672
 
3093
2673
 
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
2674
 
3104
2675
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2676
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2719
    @staticmethod
3149
2720
    def _get_branch_formats_to_test():
3150
2721
        """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)
 
2722
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2723
 
3163
2724
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2725
                         graph=None):
3233
2794
        finally:
3234
2795
            self.source.unlock()
3235
2796
 
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
2797
    def push(self, overwrite=False, stop_revision=None,
3292
2798
             _override_hook_source_branch=None):
3293
2799
        """See InterBranch.push.
3360
2866
        return True
3361
2867
 
3362
2868
 
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
2869
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)