~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2009-02-20 08:26:50 UTC
  • mto: This revision was merged to the branch mainline in revision 4028.
  • Revision ID: robertc@robertcollins.net-20090220082650-wmzch4en338bymkm
Cherrypick and polish the RemoteSink for streaming push.

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 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
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
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
42
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
40
from bzrlib.tag import (
44
41
    BasicTags,
46
43
    )
47
44
""")
48
45
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
51
 
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
 
from bzrlib import registry
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
54
48
from bzrlib.symbol_versioning import (
55
49
    deprecated_in,
56
50
    deprecated_method,
63
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
58
 
65
59
 
66
 
class Branch(bzrdir.ControlComponent):
 
60
# TODO: Maybe include checks for common corruption of newlines, etc?
 
61
 
 
62
# TODO: Some operations like log might retrieve the same revisions
 
63
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
64
# cache in memory to make this faster.  In general anything can be
 
65
# cached in memory between lock and unlock operations. .. nb thats
 
66
# what the transaction identity map provides
 
67
 
 
68
 
 
69
######################################################################
 
70
# branch objects
 
71
 
 
72
class Branch(object):
67
73
    """Branch holding a history of revisions.
68
74
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
75
    base
 
76
        Base directory/url of the branch.
72
77
 
73
78
    hooks: An instance of BranchHooks.
74
79
    """
76
81
    # - RBC 20060112
77
82
    base = None
78
83
 
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
 
84
    # override this to set the strategy for storing tags
 
85
    def _make_tags(self):
 
86
        return DisabledTags(self)
86
87
 
87
88
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
89
        self.tags = self._make_tags()
89
90
        self._revision_history_cache = None
90
91
        self._revision_id_to_revno_cache = None
91
92
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
93
        self._last_revision_info_cache = None
94
94
        self._merge_sorted_revisions_cache = None
95
95
        self._open_hook()
100
100
    def _open_hook(self):
101
101
        """Called by init to allow simpler extension of the base class."""
102
102
 
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
103
    def break_lock(self):
111
104
        """Break a lock if one is present from another instance.
112
105
 
121
114
        if master is not None:
122
115
            master.break_lock()
123
116
 
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
117
    @staticmethod
159
118
    def open(base, _unsupported=False, possible_transports=None):
160
119
        """Open the branch rooted at base.
164
123
        """
165
124
        control = bzrdir.BzrDir.open(base, _unsupported,
166
125
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
126
        return control.open_branch(_unsupported)
168
127
 
169
128
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
129
    def open_from_transport(transport, _unsupported=False):
171
130
        """Open the branch rooted at transport"""
172
131
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
132
        return control.open_branch(_unsupported)
174
133
 
175
134
    @staticmethod
176
135
    def open_containing(url, possible_transports=None):
177
136
        """Open an existing branch which contains url.
178
 
 
 
137
        
179
138
        This probes for a branch at url, and searches upwards from there.
180
139
 
181
140
        Basically we keep looking up until we find the control directory or
182
141
        run into the root.  If there isn't one, raises NotBranchError.
183
 
        If there is one and it is either an unrecognised format or an unsupported
 
142
        If there is one and it is either an unrecognised format or an unsupported 
184
143
        format, UnknownFormatError or UnsupportedFormatError are raised.
185
144
        If there is one, it is returned, along with the unused portion of url.
186
145
        """
188
147
                                                         possible_transports)
189
148
        return control.open_branch(), relpath
190
149
 
191
 
    def _push_should_merge_tags(self):
192
 
        """Should _basic_push merge this branch's tags into the target?
193
 
 
194
 
        The default implementation returns False if this branch has no tags,
195
 
        and True the rest of the time.  Subclasses may override this.
196
 
        """
197
 
        return self.supports_tags() and self.tags.get_tag_dict()
198
 
 
199
150
    def get_config(self):
200
151
        return BranchConfig(self)
201
152
 
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
 
    def _get_tags_bytes(self):
222
 
        """Get the bytes of a serialised tags dict.
223
 
 
224
 
        Note that not all branches support tags, nor do all use the same tags
225
 
        logic: this method is specific to BasicTags. Other tag implementations
226
 
        may use the same method name and behave differently, safely, because
227
 
        of the double-dispatch via
228
 
        format.make_tags->tags_instance->get_tags_dict.
229
 
 
230
 
        :return: The bytes of the tags file.
231
 
        :seealso: Branch._set_tags_bytes.
232
 
        """
233
 
        return self._transport.get_bytes('tags')
234
 
 
235
153
    def _get_nick(self, local=False, possible_transports=None):
236
154
        config = self.get_config()
237
155
        # explicit overrides master, but don't look for master if local is True
337
255
    @needs_read_lock
338
256
    def revision_id_to_dotted_revno(self, revision_id):
339
257
        """Given a revision id, return its dotted revno.
340
 
 
 
258
        
341
259
        :return: a tuple like (1,) or (400,1,3).
342
260
        """
343
261
        return self._do_revision_id_to_dotted_revno(revision_id)
417
335
            * 'include' - the stop revision is the last item in the result
418
336
            * 'with-merges' - include the stop revision and all of its
419
337
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
338
        :param direction: either 'reverse' or 'forward':
423
339
            * reverse means return the start_revision_id first, i.e.
424
340
              start at the most recent revision and go backwards in history
446
362
        # start_revision_id.
447
363
        if self._merge_sorted_revisions_cache is None:
448
364
            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)
 
365
            graph = self.repository.get_graph()
 
366
            parent_map = dict(((key, value) for key, value in
 
367
                     graph.iter_ancestry([last_revision]) if value is not None))
 
368
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
369
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
370
                generate_revno=True)
 
371
            # Drop the sequence # before caching
 
372
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
373
 
453
374
        filtered = self._filter_merge_sorted_revisions(
454
375
            self._merge_sorted_revisions_cache, start_revision_id,
455
376
            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
377
        if direction == 'reverse':
460
378
            return filtered
461
379
        if direction == 'forward':
468
386
        """Iterate over an inclusive range of sorted revisions."""
469
387
        rev_iter = iter(merge_sorted_revisions)
470
388
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
389
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
390
                if rev_id != start_revision_id:
474
391
                    continue
475
392
                else:
476
393
                    # The decision to include the start or not
477
394
                    # 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)
 
395
                    rev_iter = chain(
 
396
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
397
                        rev_iter)
480
398
                    break
481
399
        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)
 
400
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
401
                yield rev_id, depth, revno, end_of_merge
487
402
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
403
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
404
                if rev_id == stop_revision_id:
491
405
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
406
                yield rev_id, depth, revno, end_of_merge
494
407
        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)
 
408
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
409
                yield rev_id, depth, revno, end_of_merge
499
410
                if rev_id == stop_revision_id:
500
411
                    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
412
        elif stop_rule == 'with-merges':
514
413
            stop_rev = self.repository.get_revision(stop_revision_id)
515
414
            if stop_rev.parent_ids:
516
415
                left_parent = stop_rev.parent_ids[0]
517
416
            else:
518
417
                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]
 
418
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
419
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
420
                    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)
 
421
                yield rev_id, depth, revno, end_of_merge
538
422
        else:
539
423
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
424
 
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
425
    def leave_lock_in_place(self):
587
426
        """Tell this branch object not to release the physical lock when this
588
427
        object is unlocked.
589
 
 
 
428
        
590
429
        If lock_write doesn't return a token, then this method is not supported.
591
430
        """
592
431
        self.control_files.leave_in_place()
605
444
        :param other: The branch to bind to
606
445
        :type other: Branch
607
446
        """
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)
 
447
        raise errors.UpgradeRequired(self.base)
627
448
 
628
449
    @needs_write_lock
629
450
    def fetch(self, from_branch, last_revision=None, pb=None):
633
454
        :param last_revision: What revision to stop at (None for at the end
634
455
                              of the branch.
635
456
        :param pb: An optional progress bar to use.
636
 
        :return: None
 
457
 
 
458
        Returns the copied revision count and the failed revisions in a tuple:
 
459
        (copied, failures).
637
460
        """
638
461
        if self.base == from_branch.base:
639
462
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "pb parameter to fetch()")
 
463
        if pb is None:
 
464
            nested_pb = ui.ui_factory.nested_progress_bar()
 
465
            pb = nested_pb
 
466
        else:
 
467
            nested_pb = None
 
468
 
644
469
        from_branch.lock_read()
645
470
        try:
646
471
            if last_revision is None:
 
472
                pb.update('get source history')
647
473
                last_revision = from_branch.last_revision()
648
474
                last_revision = _mod_revision.ensure_null(last_revision)
649
475
            return self.repository.fetch(from_branch.repository,
650
476
                                         revision_id=last_revision,
651
 
                                         pb=pb)
 
477
                                         pb=nested_pb)
652
478
        finally:
 
479
            if nested_pb is not None:
 
480
                nested_pb.finished()
653
481
            from_branch.unlock()
654
482
 
655
483
    def get_bound_location(self):
659
487
        branch.
660
488
        """
661
489
        return None
662
 
 
 
490
    
663
491
    def get_old_bound_location(self):
664
492
        """Return the URL of the branch we used to be bound to
665
493
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
494
        raise errors.UpgradeRequired(self.base)
667
495
 
668
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
 
                           timezone=None, committer=None, revprops=None,
 
496
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
497
                           timezone=None, committer=None, revprops=None, 
670
498
                           revision_id=None):
671
499
        """Obtain a CommitBuilder for this branch.
672
 
 
 
500
        
673
501
        :param parents: Revision ids of the parents of the new revision.
674
502
        :param config: Optional configuration to use.
675
503
        :param timestamp: Optional timestamp recorded for commit.
681
509
 
682
510
        if config is None:
683
511
            config = self.get_config()
684
 
 
 
512
        
685
513
        return self.repository.get_commit_builder(self, parents, config,
686
514
            timestamp, timezone, committer, revprops, revision_id)
687
515
 
688
516
    def get_master_branch(self, possible_transports=None):
689
517
        """Return the branch we are bound to.
690
 
 
 
518
        
691
519
        :return: Either a Branch, or None
692
520
        """
693
521
        return None
719
547
    def set_revision_history(self, rev_history):
720
548
        raise NotImplementedError(self.set_revision_history)
721
549
 
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
550
    def set_stacked_on_url(self, url):
742
551
        """Set the URL this branch is stacked against.
743
552
 
746
555
        :raises UnstackableRepositoryFormat: If the repository does not support
747
556
            stacking.
748
557
        """
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()
822
 
 
823
 
    def _set_tags_bytes(self, bytes):
824
 
        """Mirror method for _get_tags_bytes.
825
 
 
826
 
        :seealso: Branch._get_tags_bytes.
827
 
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
558
        raise NotImplementedError(self.set_stacked_on_url)
830
559
 
831
560
    def _cache_revision_history(self, rev_history):
832
561
        """Set the cached revision history to rev_history.
860
589
        self._revision_id_to_revno_cache = None
861
590
        self._last_revision_info_cache = None
862
591
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
592
 
866
593
    def _gen_revision_history(self):
867
594
        """Return sequence of revision hashes on to this branch.
868
 
 
 
595
        
869
596
        Unlike revision_history, this method always regenerates or rereads the
870
597
        revision history, i.e. it does not cache the result, so repeated calls
871
598
        may be expensive.
872
599
 
873
600
        Concrete subclasses should override this instead of revision_history so
874
601
        that subclasses do not need to deal with caching logic.
875
 
 
 
602
        
876
603
        This API is semi-public; it only for use by subclasses, all other code
877
604
        should consider it to be private.
878
605
        """
881
608
    @needs_read_lock
882
609
    def revision_history(self):
883
610
        """Return sequence of revision ids on this branch.
884
 
 
 
611
        
885
612
        This method will cache the revision history for as long as it is safe to
886
613
        do so.
887
614
        """
904
631
 
905
632
    def unbind(self):
906
633
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
634
        raise errors.UpgradeRequired(self.base)
 
635
 
 
636
    def set_append_revisions_only(self, enabled):
 
637
        """Older format branches are never restricted to append-only"""
 
638
        raise errors.UpgradeRequired(self.base)
908
639
 
909
640
    def last_revision(self):
910
641
        """Return last revision id, or NULL_REVISION."""
931
662
    @deprecated_method(deprecated_in((1, 6, 0)))
932
663
    def missing_revisions(self, other, stop_revision=None):
933
664
        """Return a list of new revisions that would perfectly fit.
934
 
 
 
665
        
935
666
        If self and other have not diverged, return a list of the revisions
936
667
        present in other, but missing from self.
937
668
        """
964
695
            information. This can be None.
965
696
        :return: None
966
697
        """
967
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
969
 
 
970
 
    def import_last_revision_info(self, source_repo, revno, revid):
971
 
        """Set the last revision info, importing from another repo if necessary.
972
 
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
 
        :param source_repo: Source repository to optionally fetch from
977
 
        :param revno: Revision number of the new tip
978
 
        :param revid: Revision id of the new tip
979
 
        """
980
 
        if not self.repository.has_same_location(source_repo):
981
 
            self.repository.fetch(source_repo, revision_id=revid)
982
 
        self.set_last_revision_info(revno, revid)
 
698
        other.lock_read()
 
699
        try:
 
700
            other_revno, other_last_revision = other.last_revision_info()
 
701
            stop_revno = None # unknown
 
702
            if stop_revision is None:
 
703
                stop_revision = other_last_revision
 
704
                if _mod_revision.is_null(stop_revision):
 
705
                    # if there are no commits, we're done.
 
706
                    return
 
707
                stop_revno = other_revno
 
708
 
 
709
            # what's the current last revision, before we fetch [and change it
 
710
            # possibly]
 
711
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
712
            # we fetch here so that we don't process data twice in the common
 
713
            # case of having something to pull, and so that the check for 
 
714
            # already merged can operate on the just fetched graph, which will
 
715
            # be cached in memory.
 
716
            self.fetch(other, stop_revision)
 
717
            # Check to see if one is an ancestor of the other
 
718
            if not overwrite:
 
719
                if graph is None:
 
720
                    graph = self.repository.get_graph()
 
721
                if self._check_if_descendant_or_diverged(
 
722
                        stop_revision, last_rev, graph, other):
 
723
                    # stop_revision is a descendant of last_rev, but we aren't
 
724
                    # overwriting, so we're done.
 
725
                    return
 
726
            if stop_revno is None:
 
727
                if graph is None:
 
728
                    graph = self.repository.get_graph()
 
729
                this_revno, this_last_revision = self.last_revision_info()
 
730
                stop_revno = graph.find_distance_to_null(stop_revision,
 
731
                                [(other_last_revision, other_revno),
 
732
                                 (this_last_revision, this_revno)])
 
733
            self.set_last_revision_info(stop_revno, stop_revision)
 
734
        finally:
 
735
            other.unlock()
983
736
 
984
737
    def revision_id_to_revno(self, revision_id):
985
738
        """Given a revision id, return its revno"""
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
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
767
    def push(self, target, overwrite=False, stop_revision=None):
1024
768
        """Mirror this branch into target.
1025
769
 
1026
770
        This branch is considered to be 'local', having low latency.
1027
771
        """
1028
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
772
        raise NotImplementedError(self.push)
1051
773
 
1052
774
    def basis_tree(self):
1053
775
        """Return `Tree` object for last revision."""
1056
778
    def get_parent(self):
1057
779
        """Return the parent location of the branch.
1058
780
 
1059
 
        This is the default location for pull/missing.  The usual
 
781
        This is the default location for push/pull/missing.  The usual
1060
782
        pattern is that the user can override it by specifying a
1061
783
        location.
1062
784
        """
1063
 
        parent = self._get_parent_location()
1064
 
        if parent is None:
1065
 
            return parent
1066
 
        # This is an old-format absolute path to a local branch
1067
 
        # turn it into a url
1068
 
        if parent.startswith('/'):
1069
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1070
 
        try:
1071
 
            return urlutils.join(self.base[:-1], parent)
1072
 
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
1074
 
 
1075
 
    def _get_parent_location(self):
1076
 
        raise NotImplementedError(self._get_parent_location)
 
785
        raise NotImplementedError(self.get_parent)
1077
786
 
1078
787
    def _set_config_location(self, name, url, config=None,
1079
788
                             make_relative=False):
1093
802
            location = None
1094
803
        return location
1095
804
 
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
805
    def get_submit_branch(self):
1101
806
        """Return the submit location of the branch.
1102
807
 
1119
824
    def get_public_branch(self):
1120
825
        """Return the public location of the branch.
1121
826
 
1122
 
        This is used by merge directives.
 
827
        This is is used by merge directives.
1123
828
        """
1124
829
        return self._get_config_location('public_branch')
1125
830
 
1161
866
        params = ChangeBranchTipParams(
1162
867
            self, old_revno, new_revno, old_revid, new_revid)
1163
868
        for hook in hooks:
1164
 
            hook(params)
 
869
            try:
 
870
                hook(params)
 
871
            except errors.TipChangeRejected:
 
872
                raise
 
873
            except Exception:
 
874
                exc_info = sys.exc_info()
 
875
                hook_name = Branch.hooks.get_hook_name(hook)
 
876
                raise errors.HookFailed(
 
877
                    'pre_change_branch_tip', hook_name, exc_info)
 
878
 
 
879
    def set_parent(self, url):
 
880
        raise NotImplementedError(self.set_parent)
1165
881
 
1166
882
    @needs_write_lock
1167
883
    def update(self):
1168
 
        """Synchronise this branch with the master branch if any.
 
884
        """Synchronise this branch with the master branch if any. 
1169
885
 
1170
886
        :return: None or the last_revision pivoted out during the update.
1171
887
        """
1178
894
        """
1179
895
        if revno != 0:
1180
896
            self.check_real_revno(revno)
1181
 
 
 
897
            
1182
898
    def check_real_revno(self, revno):
1183
899
        """\
1184
900
        Check whether a revno corresponds to a real revision.
1188
904
            raise errors.InvalidRevisionNumber(revno)
1189
905
 
1190
906
    @needs_read_lock
1191
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
907
    def clone(self, to_bzrdir, revision_id=None):
1192
908
        """Clone this branch into to_bzrdir preserving all semantic values.
1193
 
 
1194
 
        Most API users will want 'create_clone_on_transport', which creates a
1195
 
        new bzrdir and branch on the fly.
1196
 
 
 
909
        
1197
910
        revision_id: if not None, the revision history in the new branch will
1198
911
                     be truncated to end with revision_id.
1199
912
        """
1200
913
        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
 
914
        self.copy_content_into(result, revision_id=revision_id)
 
915
        return  result
1209
916
 
1210
917
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
918
    def sprout(self, to_bzrdir, revision_id=None):
1212
919
        """Create a new line of development from the branch, into to_bzrdir.
1213
920
 
1214
921
        to_bzrdir controls the branch format.
1216
923
        revision_id: if not None, the revision history in the new branch will
1217
924
                     be truncated to end with revision_id.
1218
925
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
926
        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()
 
927
        self.copy_content_into(result, revision_id=revision_id)
 
928
        result.set_parent(self.bzrdir.root_transport.base)
1231
929
        return result
1232
930
 
1233
931
    def _synchronize_history(self, destination, revision_id):
1245
943
        source_revno, source_revision_id = self.last_revision_info()
1246
944
        if revision_id is None:
1247
945
            revno, revision_id = source_revno, source_revision_id
 
946
        elif source_revision_id == revision_id:
 
947
            # we know the revno without needing to walk all of history
 
948
            revno = source_revno
1248
949
        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
 
950
            # To figure out the revno for a random revision, we need to build
 
951
            # the revision history, and count its length.
 
952
            # We don't care about the order, just how long it is.
 
953
            # Alternatively, we could start at the current location, and count
 
954
            # backwards. But there is no guarantee that we will find it since
 
955
            # it may be a merged revision.
 
956
            revno = len(list(self.repository.iter_reverse_revision_history(
 
957
                                                                revision_id)))
1256
958
        destination.set_last_revision_info(revno, revision_id)
1257
 
 
 
959
    
1258
960
    @needs_read_lock
1259
961
    def copy_content_into(self, destination, revision_id=None):
1260
962
        """Copy the content of self into destination.
1262
964
        revision_id: if not None, the revision history in the new branch will
1263
965
                     be truncated to end with revision_id.
1264
966
        """
1265
 
        self.update_references(destination)
1266
967
        self._synchronize_history(destination, revision_id)
1267
968
        try:
1268
969
            parent = self.get_parent()
1271
972
        else:
1272
973
            if parent:
1273
974
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
1276
 
 
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)
 
975
        self.tags.merge_to(destination.tags)
1293
976
 
1294
977
    @needs_read_lock
1295
 
    def check(self, refs):
 
978
    def check(self):
1296
979
        """Check consistency of the branch.
1297
980
 
1298
981
        In particular this checks that revisions given in the revision-history
1299
 
        do actually match up in the revision graph, and that they're all
 
982
        do actually match up in the revision graph, and that they're all 
1300
983
        present in the repository.
1301
 
 
 
984
        
1302
985
        Callers will typically also want to check the repository.
1303
986
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
987
        :return: A BranchCheckResult.
1307
988
        """
1308
 
        result = BranchCheckResult(self)
 
989
        mainline_parent_id = None
1309
990
        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
 
991
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
992
                                last_revision_id))
 
993
        real_rev_history.reverse()
 
994
        if len(real_rev_history) != last_revno:
 
995
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
996
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
997
        # TODO: We should probably also check that real_rev_history actually
 
998
        #       matches self.revision_history()
 
999
        for revision_id in real_rev_history:
 
1000
            try:
 
1001
                revision = self.repository.get_revision(revision_id)
 
1002
            except errors.NoSuchRevision, e:
 
1003
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1004
                            % revision_id)
 
1005
            # In general the first entry on the revision history has no parents.
 
1006
            # But it's not illegal for it to have parents listed; this can happen
 
1007
            # in imports from Arch when the parents weren't reachable.
 
1008
            if mainline_parent_id is not None:
 
1009
                if mainline_parent_id not in revision.parent_ids:
 
1010
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1011
                                        "parents of {%s}"
 
1012
                                        % (mainline_parent_id, revision_id))
 
1013
            mainline_parent_id = revision_id
 
1014
        return BranchCheckResult(self)
1321
1015
 
1322
1016
    def _get_checkout_format(self):
1323
1017
        """Return the most suitable metadir for a checkout of this branch.
1332
1026
            format.set_branch_format(self._format)
1333
1027
        return format
1334
1028
 
1335
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1337
 
        """Create a clone of this branch and its bzrdir.
1338
 
 
1339
 
        :param to_transport: The transport to clone onto.
1340
 
        :param revision_id: The revision id to use as tip in the new branch.
1341
 
            If None the tip is obtained from this branch.
1342
 
        :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
 
        """
1347
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
 
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
 
        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)
1354
 
        return dir_to.open_branch()
1355
 
 
1356
1029
    def create_checkout(self, to_location, revision_id=None,
1357
1030
                        lightweight=False, accelerator_tree=None,
1358
1031
                        hardlink=False):
1359
1032
        """Create a checkout of a branch.
1360
 
 
 
1033
        
1361
1034
        :param to_location: The url to produce the checkout at
1362
1035
        :param revision_id: The revision to check out
1363
1036
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1375
1048
        if lightweight:
1376
1049
            format = self._get_checkout_format()
1377
1050
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1051
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1052
        else:
1381
1053
            format = self._get_checkout_format()
1382
1054
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1383
1055
                to_location, force_new_tree=False, format=format)
1384
1056
            checkout = checkout_branch.bzrdir
1385
1057
            checkout_branch.bind(self)
1386
 
            # pull up to the specified revision_id to set the initial
 
1058
            # pull up to the specified revision_id to set the initial 
1387
1059
            # branch tip correctly, and seed it with history.
1388
1060
            checkout_branch.pull(self, stop_revision=revision_id)
1389
1061
            from_branch=None
1411
1083
        reconciler.reconcile()
1412
1084
        return reconciler
1413
1085
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1086
    def reference_parent(self, file_id, path):
1415
1087
        """Return the parent branch for a tree-reference file_id
1416
1088
        :param file_id: The file_id of the tree reference
1417
1089
        :param path: The path of the file_id in the tree
1418
1090
        :return: A branch associated with the file_id
1419
1091
        """
1420
1092
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1093
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1094
 
1424
1095
    def supports_tags(self):
1425
1096
        return self._format.supports_tags()
1426
1097
 
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
1098
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1099
                                         other_branch):
1441
1100
        """Ensure that revision_b is a descendant of revision_a.
1442
1101
 
1443
1102
        This is a helper function for update_revisions.
1444
 
 
 
1103
        
1445
1104
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1446
1105
        :returns: True if revision_b is a descendant of revision_a.
1447
1106
        """
1457
1116
 
1458
1117
    def _revision_relations(self, revision_a, revision_b, graph):
1459
1118
        """Determine the relationship between two revisions.
1460
 
 
 
1119
        
1461
1120
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1462
1121
        """
1463
1122
        heads = graph.heads([revision_a, revision_b])
1480
1139
     * a format string,
1481
1140
     * an open routine.
1482
1141
 
1483
 
    Formats are placed in an dict by their format string for reference
 
1142
    Formats are placed in an dict by their format string for reference 
1484
1143
    during branch opening. Its not required that these be instances, they
1485
 
    can be classes themselves with class methods - it simply depends on
 
1144
    can be classes themselves with class methods - it simply depends on 
1486
1145
    whether state is needed for a given format or not.
1487
1146
 
1488
1147
    Once a format is deprecated, just deprecate the initialize and open
1489
 
    methods on the format class. Do not deprecate the object, as the
 
1148
    methods on the format class. Do not deprecate the object, as the 
1490
1149
    object will be created every time regardless.
1491
1150
    """
1492
1151
 
1496
1155
    _formats = {}
1497
1156
    """The known formats."""
1498
1157
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1158
    def __eq__(self, other):
1502
1159
        return self.__class__ is other.__class__
1503
1160
 
1505
1162
        return not (self == other)
1506
1163
 
1507
1164
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1165
    def find_format(klass, a_bzrdir):
1509
1166
        """Return the format for the branch object in a_bzrdir."""
1510
1167
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1168
            transport = a_bzrdir.get_branch_transport(None)
 
1169
            format_string = transport.get("format").read()
1513
1170
            return klass._formats[format_string]
1514
1171
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1172
            raise errors.NotBranchError(path=transport.base)
1516
1173
        except KeyError:
1517
1174
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1175
 
1554
1211
        """Return the short format description for this format."""
1555
1212
        raise NotImplementedError(self.get_format_description)
1556
1213
 
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):
 
1214
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1215
                           set_format=True):
1567
1216
        """Initialize a branch in a bzrdir, with specified files
1568
1217
 
1569
1218
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1219
        :param utf8_files: The files to create as a list of
1571
1220
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1221
        :param set_format: If True, set the format with
1574
1222
            self.get_format_string.  (BzrBranch4 has its format set
1575
1223
            elsewhere)
1576
1224
        :return: a branch in this format
1577
1225
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1226
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1227
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1228
        lock_map = {
1581
1229
            'metadir': ('lock', lockdir.LockDir),
1582
1230
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1233
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1234
            lock_name, lock_class)
1587
1235
        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
 
1236
        control_files.lock_write()
1596
1237
        if set_format:
1597
1238
            utf8_files += [('format', self.get_format_string())]
1598
1239
        try:
1601
1242
                    filename, content,
1602
1243
                    mode=a_bzrdir._get_file_mode())
1603
1244
        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
 
1245
            control_files.unlock()
 
1246
        return self.open(a_bzrdir, _found=True)
1609
1247
 
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
 
        """
 
1248
    def initialize(self, a_bzrdir):
 
1249
        """Create a branch of this format in a_bzrdir."""
1615
1250
        raise NotImplementedError(self.initialize)
1616
1251
 
1617
1252
    def is_supported(self):
1618
1253
        """Is this format supported?
1619
1254
 
1620
1255
        Supported formats can be initialized and opened.
1621
 
        Unsupported formats may not support initialization or committing or
 
1256
        Unsupported formats may not support initialization or committing or 
1622
1257
        some other features depending on the reason for not being supported.
1623
1258
        """
1624
1259
        return True
1625
1260
 
1626
 
    def make_tags(self, branch):
1627
 
        """Create a tags object for branch.
1628
 
 
1629
 
        This method is on BranchFormat, because BranchFormats are reflected
1630
 
        over the wire via network_name(), whereas full Branch instances require
1631
 
        multiple VFS method calls to operate at all.
1632
 
 
1633
 
        The default implementation returns a disabled-tags instance.
1634
 
 
1635
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
 
        on a RemoteBranch.
1637
 
        """
1638
 
        return DisabledTags(branch)
1639
 
 
1640
 
    def network_name(self):
1641
 
        """A simple byte string uniquely identifying this format for RPC calls.
1642
 
 
1643
 
        MetaDir branch formats use their disk format string to identify the
1644
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1645
 
        foreign formats like svn/git and hg should use some marker which is
1646
 
        unique and immutable.
1647
 
        """
1648
 
        raise NotImplementedError(self.network_name)
1649
 
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1261
    def open(self, a_bzrdir, _found=False):
1651
1262
        """Return the branch object for a_bzrdir
1652
1263
 
1653
 
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
 
        :param _found: a private parameter, do not use it. It is used to
1656
 
            indicate if format probing has already be done.
1657
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1658
 
            (if there are any).  Default is to open fallbacks.
 
1264
        _found is a private parameter, do not use it. It is used to indicate
 
1265
               if format probing has already be done.
1659
1266
        """
1660
1267
        raise NotImplementedError(self.open)
1661
1268
 
1662
1269
    @classmethod
1663
1270
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
1665
1271
        klass._formats[format.get_format_string()] = format
1666
 
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1669
1272
 
1670
1273
    @classmethod
1671
1274
    def set_default_format(klass, format):
1672
1275
        klass._default_format = format
1673
1276
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1277
    def supports_stacking(self):
1679
1278
        """True if this format records a stacked-on branch."""
1680
1279
        return False
1684
1283
        del klass._formats[format.get_format_string()]
1685
1284
 
1686
1285
    def __str__(self):
1687
 
        return self.get_format_description().rstrip()
 
1286
        return self.get_format_string().rstrip()
1688
1287
 
1689
1288
    def supports_tags(self):
1690
1289
        """True if this format supports tags stored in the branch"""
1693
1292
 
1694
1293
class BranchHooks(Hooks):
1695
1294
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
 
 
 
1295
    
1697
1296
    e.g. ['set_rh'] Is the list of items to be called when the
1698
1297
    set_revision_history function is invoked.
1699
1298
    """
1705
1304
        notified.
1706
1305
        """
1707
1306
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
1709
 
            "Invoked whenever the revision history has been set via "
1710
 
            "set_revision_history. The api signature is (branch, "
1711
 
            "revision_history), and the branch will be write-locked. "
1712
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1713
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
 
        self.create_hook(HookPoint('open',
1715
 
            "Called with the Branch object that has been opened after a "
1716
 
            "branch is opened.", (1, 8), None))
1717
 
        self.create_hook(HookPoint('post_push',
1718
 
            "Called after a push operation completes. post_push is called "
1719
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
1722
 
            "Called after a pull operation completes. post_pull is called "
1723
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
 
            "bzr client.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
1727
 
            "completed. pre_commit is called with (local, master, old_revno, "
1728
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1730
 
            "tree_delta is a TreeDelta object describing changes from the "
1731
 
            "basis revision. hooks MUST NOT modify this delta. "
1732
 
            " future_tree is an in-memory tree obtained from "
1733
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
1736
 
            "Called in the bzr client after a commit has completed. "
1737
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
 
            "commit to a branch.", (0, 15), None))
1740
 
        self.create_hook(HookPoint('post_uncommit',
1741
 
            "Called in the bzr client after an uncommit completes. "
1742
 
            "post_uncommit is called with (local, master, old_revno, "
1743
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
 
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1747
 
            "Called in bzr client and server before a change to the tip of a "
1748
 
            "branch is made. pre_change_branch_tip is called with a "
1749
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1751
 
        self.create_hook(HookPoint('post_change_branch_tip',
1752
 
            "Called in bzr client and server after a change to the tip of a "
1753
 
            "branch is made. post_change_branch_tip is called with a "
1754
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1756
 
        self.create_hook(HookPoint('transform_fallback_location',
1757
 
            "Called when a stacked branch is activating its fallback "
1758
 
            "locations. transform_fallback_location is called with (branch, "
1759
 
            "url), and should return a new url. Returning the same url "
1760
 
            "allows it to be used as-is, returning a different one can be "
1761
 
            "used to cause the branch to stack on a closer copy of that "
1762
 
            "fallback_location. Note that the branch cannot have history "
1763
 
            "accessing methods called on it during this hook because the "
1764
 
            "fallback locations have not been activated. When there are "
1765
 
            "multiple hooks installed for transform_fallback_location, "
1766
 
            "all are called with the url returned from the previous hook."
1767
 
            "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
 
 
 
1307
        # Introduced in 0.15:
 
1308
        # invoked whenever the revision history has been set
 
1309
        # with set_revision_history. The api signature is
 
1310
        # (branch, revision_history), and the branch will
 
1311
        # be write-locked.
 
1312
        self['set_rh'] = []
 
1313
        # Invoked after a branch is opened. The api signature is (branch).
 
1314
        self['open'] = []
 
1315
        # invoked after a push operation completes.
 
1316
        # the api signature is
 
1317
        # (push_result)
 
1318
        # containing the members
 
1319
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1320
        # where local is the local target branch or None, master is the target 
 
1321
        # master branch, and the rest should be self explanatory. The source
 
1322
        # is read locked and the target branches write locked. Source will
 
1323
        # be the local low-latency branch.
 
1324
        self['post_push'] = []
 
1325
        # invoked after a pull operation completes.
 
1326
        # the api signature is
 
1327
        # (pull_result)
 
1328
        # containing the members
 
1329
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1330
        # where local is the local branch or None, master is the target 
 
1331
        # master branch, and the rest should be self explanatory. The source
 
1332
        # is read locked and the target branches write locked. The local
 
1333
        # branch is the low-latency branch.
 
1334
        self['post_pull'] = []
 
1335
        # invoked before a commit operation takes place.
 
1336
        # the api signature is
 
1337
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1338
        #  tree_delta, future_tree).
 
1339
        # old_revid is NULL_REVISION for the first commit to a branch
 
1340
        # tree_delta is a TreeDelta object describing changes from the basis
 
1341
        # revision, hooks MUST NOT modify this delta
 
1342
        # future_tree is an in-memory tree obtained from
 
1343
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1344
        self['pre_commit'] = []
 
1345
        # invoked after a commit operation completes.
 
1346
        # the api signature is 
 
1347
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1348
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1349
        self['post_commit'] = []
 
1350
        # invoked after a uncommit operation completes.
 
1351
        # the api signature is
 
1352
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1353
        # local is the local branch or None, master is the target branch,
 
1354
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1355
        self['post_uncommit'] = []
 
1356
        # Introduced in 1.6
 
1357
        # Invoked before the tip of a branch changes.
 
1358
        # the api signature is
 
1359
        # (params) where params is a ChangeBranchTipParams with the members
 
1360
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1361
        self['pre_change_branch_tip'] = []
 
1362
        # Introduced in 1.4
 
1363
        # Invoked after the tip of a branch changes.
 
1364
        # the api signature is
 
1365
        # (params) where params is a ChangeBranchTipParams with the members
 
1366
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1367
        self['post_change_branch_tip'] = []
 
1368
        # Introduced in 1.9
 
1369
        # Invoked when a stacked branch activates its fallback locations and
 
1370
        # allows the transformation of the url of said location.
 
1371
        # the api signature is
 
1372
        # (branch, url) where branch is the branch having its fallback
 
1373
        # location activated and url is the url for the fallback location.
 
1374
        # The hook should return a url.
 
1375
        self['transform_fallback_location'] = []
1785
1376
 
1786
1377
 
1787
1378
# install the default hooks into the Branch class.
1819
1410
 
1820
1411
    def __eq__(self, other):
1821
1412
        return self.__dict__ == other.__dict__
1822
 
 
 
1413
    
1823
1414
    def __repr__(self):
1824
1415
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1825
 
            self.__class__.__name__, self.branch,
 
1416
            self.__class__.__name__, self.branch, 
1826
1417
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1418
 
1828
1419
 
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
1420
class BzrBranchFormat4(BranchFormat):
1908
1421
    """Bzr branch format 4.
1909
1422
 
1916
1429
        """See BranchFormat.get_format_description()."""
1917
1430
        return "Branch format 4"
1918
1431
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1432
    def initialize(self, a_bzrdir):
1920
1433
        """Create a branch of this format in a_bzrdir."""
1921
1434
        utf8_files = [('revision-history', ''),
1922
1435
                      ('branch-name', ''),
1923
1436
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1437
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1438
                                       lock_type='branch4', set_format=False)
1926
1439
 
1927
1440
    def __init__(self):
1928
1441
        super(BzrBranchFormat4, self).__init__()
1929
1442
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1930
1443
 
1931
 
    def network_name(self):
1932
 
        """The network name for this format is the control dirs disk label."""
1933
 
        return self._matchingbzrdir.get_format_string()
 
1444
    def open(self, a_bzrdir, _found=False):
 
1445
        """Return the branch object for a_bzrdir
1934
1446
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
 
1447
        _found is a private parameter, do not use it. It is used to indicate
 
1448
               if format probing has already be done.
 
1449
        """
1937
1450
        if not _found:
1938
1451
            # we are being called directly and must probe.
1939
1452
            raise NotImplementedError
1940
1453
        return BzrBranch(_format=self,
1941
1454
                         _control_files=a_bzrdir._control_files,
1942
1455
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1456
                         _repository=a_bzrdir.open_repository())
1945
1457
 
1946
1458
    def __str__(self):
1954
1466
        """What class to instantiate on open calls."""
1955
1467
        raise NotImplementedError(self._branch_class)
1956
1468
 
1957
 
    def network_name(self):
1958
 
        """A simple byte string uniquely identifying this format for RPC calls.
 
1469
    def open(self, a_bzrdir, _found=False):
 
1470
        """Return the branch object for a_bzrdir.
1959
1471
 
1960
 
        Metadir branch formats use their format string.
 
1472
        _found is a private parameter, do not use it. It is used to indicate
 
1473
               if format probing has already be done.
1961
1474
        """
1962
 
        return self.get_format_string()
1963
 
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
 
        """See BranchFormat.open()."""
1966
1475
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1476
            format = BranchFormat.find_format(a_bzrdir)
1968
1477
            if format.__class__ != self.__class__:
1969
1478
                raise AssertionError("wrong format %r found for %r" %
1970
1479
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1480
        try:
 
1481
            transport = a_bzrdir.get_branch_transport(None)
1973
1482
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1483
                                                         lockdir.LockDir)
1975
1484
            return self._branch_class()(_format=self,
1976
1485
                              _control_files=control_files,
1977
 
                              name=name,
1978
1486
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
1487
                              _repository=a_bzrdir.find_repository())
1981
1488
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1489
            raise errors.NotBranchError(path=transport.base)
1983
1490
 
1984
1491
    def __init__(self):
1985
1492
        super(BranchFormatMetadir, self).__init__()
2013
1520
    def get_format_description(self):
2014
1521
        """See BranchFormat.get_format_description()."""
2015
1522
        return "Branch format 5"
2016
 
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1523
        
 
1524
    def initialize(self, a_bzrdir):
2018
1525
        """Create a branch of this format in a_bzrdir."""
2019
1526
        utf8_files = [('revision-history', ''),
2020
1527
                      ('branch-name', ''),
2021
1528
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1529
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1530
 
2024
1531
    def supports_tags(self):
2025
1532
        return False
2047
1554
        """See BranchFormat.get_format_description()."""
2048
1555
        return "Branch format 6"
2049
1556
 
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):
 
1557
    def initialize(self, a_bzrdir):
 
1558
        """Create a branch of this format in a_bzrdir."""
 
1559
        utf8_files = [('last-revision', '0 null:\n'),
 
1560
                      ('branch.conf', ''),
 
1561
                      ('tags', ''),
 
1562
                      ]
 
1563
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1564
 
 
1565
 
 
1566
class BzrBranchFormat7(BranchFormatMetadir):
2108
1567
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1568
 
2110
1569
    The stacked location pointer is passed down to the repository and requires
2113
1572
    This format was introduced in bzr 1.6.
2114
1573
    """
2115
1574
 
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
1575
    def _branch_class(self):
2125
1576
        return BzrBranch7
2126
1577
 
2132
1583
        """See BranchFormat.get_format_description()."""
2133
1584
        return "Branch format 7"
2134
1585
 
2135
 
    def supports_set_append_revisions_only(self):
 
1586
    def initialize(self, a_bzrdir):
 
1587
        """Create a branch of this format in a_bzrdir."""
 
1588
        utf8_files = [('last-revision', '0 null:\n'),
 
1589
                      ('branch.conf', ''),
 
1590
                      ('tags', ''),
 
1591
                      ]
 
1592
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1593
 
 
1594
    def __init__(self):
 
1595
        super(BzrBranchFormat7, self).__init__()
 
1596
        self._matchingbzrdir.repository_format = \
 
1597
            RepositoryFormatKnitPack5RichRoot()
 
1598
 
 
1599
    def supports_stacking(self):
2136
1600
        return True
2137
1601
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1602
 
2141
1603
class BranchReferenceFormat(BranchFormat):
2142
1604
    """Bzr branch reference format.
2160
1622
    def get_reference(self, a_bzrdir):
2161
1623
        """See BranchFormat.get_reference()."""
2162
1624
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1625
        return transport.get('location').read()
2164
1626
 
2165
1627
    def set_reference(self, a_bzrdir, to_branch):
2166
1628
        """See BranchFormat.set_reference()."""
2167
1629
        transport = a_bzrdir.get_branch_transport(None)
2168
1630
        location = transport.put_bytes('location', to_branch.base)
2169
1631
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1632
    def initialize(self, a_bzrdir, target_branch=None):
2171
1633
        """Create a branch of this format in a_bzrdir."""
2172
1634
        if target_branch is None:
2173
1635
            # this format does not implement branch itself, thus the implicit
2174
1636
            # creation contract must see it as uninitializable
2175
1637
            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)
 
1638
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1639
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1640
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1641
            target_branch.bzrdir.root_transport.base)
2180
1642
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1643
        return self.open(
 
1644
            a_bzrdir, _found=True,
2183
1645
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1646
 
2187
1647
    def __init__(self):
2188
1648
        super(BranchReferenceFormat, self).__init__()
2191
1651
 
2192
1652
    def _make_reference_clone_function(format, a_branch):
2193
1653
        """Create a clone() routine for a branch dynamically."""
2194
 
        def clone(to_bzrdir, revision_id=None,
2195
 
            repository_policy=None):
 
1654
        def clone(to_bzrdir, revision_id=None):
2196
1655
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1656
            return format.initialize(to_bzrdir, a_branch)
2198
1657
            # cannot obey revision_id limits when cloning a reference ...
2199
1658
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1659
            # emit some sort of warning/error to the caller ?!
2201
1660
        return clone
2202
1661
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
1662
    def open(self, a_bzrdir, _found=False, location=None,
 
1663
             possible_transports=None):
2205
1664
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1665
 
2207
 
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
 
        :param _found: a private parameter, do not use it. It is used to
2210
 
            indicate if format probing has already be done.
2211
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2212
 
            (if there are any).  Default is to open fallbacks.
2213
 
        :param location: The location of the referenced branch.  If
2214
 
            unspecified, this will be determined from the branch reference in
2215
 
            a_bzrdir.
2216
 
        :param possible_transports: An optional reusable transports list.
 
1666
        _found is a private parameter, do not use it. It is used to indicate
 
1667
               if format probing has already be done.
2217
1668
        """
2218
1669
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1670
            format = BranchFormat.find_format(a_bzrdir)
2220
1671
            if format.__class__ != self.__class__:
2221
1672
                raise AssertionError("wrong format %r found for %r" %
2222
1673
                    (format, self))
2224
1675
            location = self.get_reference(a_bzrdir)
2225
1676
        real_bzrdir = bzrdir.BzrDir.open(
2226
1677
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1678
        result = real_bzrdir.open_branch()
2229
1679
        # this changes the behaviour of result.clone to create a new reference
2230
1680
        # rather than a copy of the content of the branch.
2231
1681
        # I did not use a proxy object because that needs much more extensive
2238
1688
        return result
2239
1689
 
2240
1690
 
2241
 
network_format_registry = registry.FormatRegistry()
2242
 
"""Registry of formats indexed by their network name.
2243
 
 
2244
 
The network name for a branch format is an identifier that can be used when
2245
 
referring to formats with smart server operations. See
2246
 
BranchFormat.network_name() for more detail.
2247
 
"""
2248
 
 
2249
 
 
2250
1691
# formats which have no format string are not discoverable
2251
1692
# and not independently creatable, so are not registered.
2252
1693
__format5 = BzrBranchFormat5()
2253
1694
__format6 = BzrBranchFormat6()
2254
1695
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1696
BranchFormat.register_format(__format5)
2257
1697
BranchFormat.register_format(BranchReferenceFormat())
2258
1698
BranchFormat.register_format(__format6)
2259
1699
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1700
BranchFormat.set_default_format(__format6)
2262
1701
_legacy_formats = [BzrBranchFormat4(),
2263
 
    ]
2264
 
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
 
 
2267
 
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1702
                   ]
 
1703
 
 
1704
class BzrBranch(Branch):
2269
1705
    """A branch stored in the actual filesystem.
2270
1706
 
2271
1707
    Note that it's "local" in the context of the filesystem; it doesn't
2272
1708
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2273
1709
    it's writable, and can be accessed via the normal filesystem API.
2274
1710
 
2275
 
    :ivar _transport: Transport for file operations on this branch's
 
1711
    :ivar _transport: Transport for file operations on this branch's 
2276
1712
        control files, typically pointing to the .bzr/branch directory.
2277
1713
    :ivar repository: Repository for this branch.
2278
 
    :ivar base: The url of the base directory for this branch; the one
 
1714
    :ivar base: The url of the base directory for this branch; the one 
2279
1715
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1716
    """
2283
 
 
 
1717
    
2284
1718
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1719
                 _control_files=None, a_bzrdir=None, _repository=None):
2287
1720
        """Create new branch object at a particular location."""
2288
1721
        if a_bzrdir is None:
2289
1722
            raise ValueError('a_bzrdir must be supplied')
2290
1723
        else:
2291
1724
            self.bzrdir = a_bzrdir
2292
1725
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1726
        # XXX: We should be able to just do
2295
1727
        #   self.base = self.bzrdir.root_transport.base
2296
1728
        # but this does not quite work yet -- mbp 20080522
2303
1735
        Branch.__init__(self)
2304
1736
 
2305
1737
    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)
 
1738
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1739
 
2312
1740
    __repr__ = __str__
2313
1741
 
2317
1745
 
2318
1746
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
1747
 
2320
 
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
2322
 
 
2323
1748
    def is_locked(self):
2324
1749
        return self.control_files.is_locked()
2325
1750
 
2326
1751
    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
 
1752
        repo_token = self.repository.lock_write()
2337
1753
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1754
            token = self.control_files.lock_write(token=token)
2339
1755
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1756
            self.repository.unlock()
2342
1757
            raise
 
1758
        return token
2343
1759
 
2344
1760
    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
 
1761
        self.repository.lock_read()
2355
1762
        try:
2356
1763
            self.control_files.lock_read()
2357
1764
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1765
            self.repository.unlock()
2360
1766
            raise
2361
1767
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1768
    def unlock(self):
 
1769
        # TODO: test for failed two phase locks. This is known broken.
2364
1770
        try:
2365
1771
            self.control_files.unlock()
2366
1772
        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()
2375
 
 
 
1773
            self.repository.unlock()
 
1774
        if not self.control_files.is_locked():
 
1775
            # we just released the lock
 
1776
            self._clear_cached_state()
 
1777
        
2376
1778
    def peek_lock_mode(self):
2377
1779
        if self.control_files._lock_count == 0:
2378
1780
            return None
2458
1860
        for this revision id.
2459
1861
 
2460
1862
        It may be possible to set the branch last revision to an id not
2461
 
        present in the repository.  However, branches can also be
 
1863
        present in the repository.  However, branches can also be 
2462
1864
        configured to check constraints on history, in which case this may not
2463
1865
        be permitted.
2464
1866
        """
2496
1898
        """See Branch.basis_tree."""
2497
1899
        return self.repository.revision_tree(self.last_revision())
2498
1900
 
 
1901
    @needs_write_lock
 
1902
    def pull(self, source, overwrite=False, stop_revision=None,
 
1903
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1904
             _override_hook_target=None):
 
1905
        """See Branch.pull.
 
1906
 
 
1907
        :param _hook_master: Private parameter - set the branch to 
 
1908
            be supplied as the master to pull hooks.
 
1909
        :param run_hooks: Private parameter - if false, this branch
 
1910
            is being called because it's the master of the primary branch,
 
1911
            so it should not run its hooks.
 
1912
        :param _override_hook_target: Private parameter - set the branch to be
 
1913
            supplied as the target_branch to pull hooks.
 
1914
        """
 
1915
        result = PullResult()
 
1916
        result.source_branch = source
 
1917
        if _override_hook_target is None:
 
1918
            result.target_branch = self
 
1919
        else:
 
1920
            result.target_branch = _override_hook_target
 
1921
        source.lock_read()
 
1922
        try:
 
1923
            # We assume that during 'pull' the local repository is closer than
 
1924
            # the remote one.
 
1925
            graph = self.repository.get_graph(source.repository)
 
1926
            result.old_revno, result.old_revid = self.last_revision_info()
 
1927
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1928
                                  graph=graph)
 
1929
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1930
            result.new_revno, result.new_revid = self.last_revision_info()
 
1931
            if _hook_master:
 
1932
                result.master_branch = _hook_master
 
1933
                result.local_branch = result.target_branch
 
1934
            else:
 
1935
                result.master_branch = result.target_branch
 
1936
                result.local_branch = None
 
1937
            if run_hooks:
 
1938
                for hook in Branch.hooks['post_pull']:
 
1939
                    hook(result)
 
1940
        finally:
 
1941
            source.unlock()
 
1942
        return result
 
1943
 
2499
1944
    def _get_parent_location(self):
2500
1945
        _locs = ['parent', 'pull', 'x-pull']
2501
1946
        for l in _locs:
2505
1950
                pass
2506
1951
        return None
2507
1952
 
 
1953
    @needs_read_lock
 
1954
    def push(self, target, overwrite=False, stop_revision=None,
 
1955
             _override_hook_source_branch=None):
 
1956
        """See Branch.push.
 
1957
 
 
1958
        This is the basic concrete implementation of push()
 
1959
 
 
1960
        :param _override_hook_source_branch: If specified, run
 
1961
        the hooks passing this Branch as the source, rather than self.  
 
1962
        This is for use of RemoteBranch, where push is delegated to the
 
1963
        underlying vfs-based Branch. 
 
1964
        """
 
1965
        # TODO: Public option to disable running hooks - should be trivial but
 
1966
        # needs tests.
 
1967
        return _run_with_write_locked_target(
 
1968
            target, self._push_with_bound_branches, target, overwrite,
 
1969
            stop_revision,
 
1970
            _override_hook_source_branch=_override_hook_source_branch)
 
1971
 
 
1972
    def _push_with_bound_branches(self, target, overwrite,
 
1973
            stop_revision,
 
1974
            _override_hook_source_branch=None):
 
1975
        """Push from self into target, and into target's master if any.
 
1976
        
 
1977
        This is on the base BzrBranch class even though it doesn't support 
 
1978
        bound branches because the *target* might be bound.
 
1979
        """
 
1980
        def _run_hooks():
 
1981
            if _override_hook_source_branch:
 
1982
                result.source_branch = _override_hook_source_branch
 
1983
            for hook in Branch.hooks['post_push']:
 
1984
                hook(result)
 
1985
 
 
1986
        bound_location = target.get_bound_location()
 
1987
        if bound_location and target.base != bound_location:
 
1988
            # there is a master branch.
 
1989
            #
 
1990
            # XXX: Why the second check?  Is it even supported for a branch to
 
1991
            # be bound to itself? -- mbp 20070507
 
1992
            master_branch = target.get_master_branch()
 
1993
            master_branch.lock_write()
 
1994
            try:
 
1995
                # push into the master from this branch.
 
1996
                self._basic_push(master_branch, overwrite, stop_revision)
 
1997
                # and push into the target branch from this. Note that we push from
 
1998
                # this branch again, because its considered the highest bandwidth
 
1999
                # repository.
 
2000
                result = self._basic_push(target, overwrite, stop_revision)
 
2001
                result.master_branch = master_branch
 
2002
                result.local_branch = target
 
2003
                _run_hooks()
 
2004
                return result
 
2005
            finally:
 
2006
                master_branch.unlock()
 
2007
        else:
 
2008
            # no master branch
 
2009
            result = self._basic_push(target, overwrite, stop_revision)
 
2010
            # TODO: Why set master_branch and local_branch if there's no
 
2011
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2012
            # 20070504
 
2013
            result.master_branch = target
 
2014
            result.local_branch = None
 
2015
            _run_hooks()
 
2016
            return result
 
2017
 
2508
2018
    def _basic_push(self, target, overwrite, stop_revision):
2509
2019
        """Basic implementation of push without bound branches or hooks.
2510
2020
 
2511
 
        Must be called with source read locked and target write locked.
 
2021
        Must be called with self read locked and target write locked.
2512
2022
        """
2513
 
        result = BranchPushResult()
 
2023
        result = PushResult()
2514
2024
        result.source_branch = self
2515
2025
        result.target_branch = target
2516
2026
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2027
        if result.old_revid != self.last_revision():
2519
2028
            # We assume that during 'push' this repository is closer than
2520
2029
            # the target.
2521
2030
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2031
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2032
                                    graph=graph)
2524
2033
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2034
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2035
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2036
        return result
2529
2037
 
 
2038
    def _push_should_merge_tags(self):
 
2039
        """Should _basic_push merge this branch's tags into the target?
 
2040
        
 
2041
        The default implementation returns False if this branch has no tags,
 
2042
        and True the rest of the time.  Subclasses may override this.
 
2043
        """
 
2044
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
2045
 
 
2046
    def get_parent(self):
 
2047
        """See Branch.get_parent."""
 
2048
        parent = self._get_parent_location()
 
2049
        if parent is None:
 
2050
            return parent
 
2051
        # This is an old-format absolute path to a local branch
 
2052
        # turn it into a url
 
2053
        if parent.startswith('/'):
 
2054
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2055
        try:
 
2056
            return urlutils.join(self.base[:-1], parent)
 
2057
        except errors.InvalidURLJoin, e:
 
2058
            raise errors.InaccessibleParent(parent, self.base)
 
2059
 
2530
2060
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2061
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2062
 
2533
2063
    def set_push_location(self, location):
2534
2064
        """See Branch.set_push_location."""
2536
2066
            'push_location', location,
2537
2067
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2068
 
 
2069
    @needs_write_lock
 
2070
    def set_parent(self, url):
 
2071
        """See Branch.set_parent."""
 
2072
        # TODO: Maybe delete old location files?
 
2073
        # URLs should never be unicode, even on the local fs,
 
2074
        # FIXUP this and get_parent in a future branch format bump:
 
2075
        # read and rewrite the file. RBC 20060125
 
2076
        if url is not None:
 
2077
            if isinstance(url, unicode):
 
2078
                try:
 
2079
                    url = url.encode('ascii')
 
2080
                except UnicodeEncodeError:
 
2081
                    raise errors.InvalidURL(url,
 
2082
                        "Urls must be 7-bit ascii, "
 
2083
                        "use bzrlib.urlutils.escape")
 
2084
            url = urlutils.relative_url(self.base, url)
 
2085
        self._set_parent_location(url)
 
2086
 
2539
2087
    def _set_parent_location(self, url):
2540
2088
        if url is None:
2541
2089
            self._transport.delete('parent')
2543
2091
            self._transport.put_bytes('parent', url + '\n',
2544
2092
                mode=self.bzrdir._get_file_mode())
2545
2093
 
 
2094
    def set_stacked_on_url(self, url):
 
2095
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2096
 
2546
2097
 
2547
2098
class BzrBranch5(BzrBranch):
2548
2099
    """A format 5 branch. This supports new features over plain branches.
2550
2101
    It has support for a master_branch which is the data for bound branches.
2551
2102
    """
2552
2103
 
 
2104
    @needs_write_lock
 
2105
    def pull(self, source, overwrite=False, stop_revision=None,
 
2106
             run_hooks=True, possible_transports=None,
 
2107
             _override_hook_target=None):
 
2108
        """Pull from source into self, updating my master if any.
 
2109
        
 
2110
        :param run_hooks: Private parameter - if false, this branch
 
2111
            is being called because it's the master of the primary branch,
 
2112
            so it should not run its hooks.
 
2113
        """
 
2114
        bound_location = self.get_bound_location()
 
2115
        master_branch = None
 
2116
        if bound_location and source.base != bound_location:
 
2117
            # not pulling from master, so we need to update master.
 
2118
            master_branch = self.get_master_branch(possible_transports)
 
2119
            master_branch.lock_write()
 
2120
        try:
 
2121
            if master_branch:
 
2122
                # pull from source into master.
 
2123
                master_branch.pull(source, overwrite, stop_revision,
 
2124
                    run_hooks=False)
 
2125
            return super(BzrBranch5, self).pull(source, overwrite,
 
2126
                stop_revision, _hook_master=master_branch,
 
2127
                run_hooks=run_hooks,
 
2128
                _override_hook_target=_override_hook_target)
 
2129
        finally:
 
2130
            if master_branch:
 
2131
                master_branch.unlock()
 
2132
 
2553
2133
    def get_bound_location(self):
2554
2134
        try:
2555
2135
            return self._transport.get_bytes('bound')[:-1]
2559
2139
    @needs_read_lock
2560
2140
    def get_master_branch(self, possible_transports=None):
2561
2141
        """Return the branch we are bound to.
2562
 
 
 
2142
        
2563
2143
        :return: Either a Branch, or None
2564
2144
 
2565
2145
        This could memoise the branch, but if thats done
2601
2181
        check for divergence to raise an error when the branches are not
2602
2182
        either the same, or one a prefix of the other. That behaviour may not
2603
2183
        be useful, so that check may be removed in future.
2604
 
 
 
2184
        
2605
2185
        :param other: The branch to bind to
2606
2186
        :type other: Branch
2607
2187
        """
2626
2206
 
2627
2207
    @needs_write_lock
2628
2208
    def update(self, possible_transports=None):
2629
 
        """Synchronise this branch with the master branch if any.
 
2209
        """Synchronise this branch with the master branch if any. 
2630
2210
 
2631
2211
        :return: None or the last_revision that was pivoted out during the
2632
2212
                 update.
2642
2222
        return None
2643
2223
 
2644
2224
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
2225
class BzrBranch7(BzrBranch5):
 
2226
    """A branch with support for a fallback repository."""
 
2227
 
 
2228
    def _get_fallback_repository(self, url):
 
2229
        """Get the repository we fallback to at url."""
 
2230
        url = urlutils.join(self.base, url)
 
2231
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2232
                                      possible_transports=[self._transport])
 
2233
        return a_bzrdir.open_branch().repository
 
2234
 
 
2235
    def _activate_fallback_location(self, url):
 
2236
        """Activate the branch/repository from url as a fallback repository."""
 
2237
        self.repository.add_fallback_repository(
 
2238
            self._get_fallback_repository(url))
2647
2239
 
2648
2240
    def _open_hook(self):
2649
 
        if self._ignore_fallbacks:
2650
 
            return
2651
2241
        try:
2652
2242
            url = self.get_stacked_on_url()
2653
2243
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2663
2253
                        "None, not a URL." % hook_name)
2664
2254
            self._activate_fallback_location(url)
2665
2255
 
 
2256
    def _check_stackable_repo(self):
 
2257
        if not self.repository._format.supports_external_lookups:
 
2258
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2259
                self.repository.base)
 
2260
 
2666
2261
    def __init__(self, *args, **kwargs):
2667
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2262
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2263
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2264
        self._partial_revision_history_cache = []
2671
2265
 
2672
2266
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2267
        super(BzrBranch7, self)._clear_cached_state()
2674
2268
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2269
        self._partial_revision_history_cache = []
2676
2270
 
2677
2271
    def _last_revision_info(self):
2678
2272
        revision_string = self._transport.get_bytes('last-revision')
2709
2303
 
2710
2304
    def _synchronize_history(self, destination, revision_id):
2711
2305
        """Synchronize last revision and revision history between branches.
2712
 
 
 
2306
        
2713
2307
        :see: Branch._synchronize_history
2714
2308
        """
2715
2309
        # XXX: The base Branch has a fast implementation of this method based
2724
2318
        if _mod_revision.is_null(last_revision):
2725
2319
            return
2726
2320
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2321
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2322
 
2729
2323
    def _gen_revision_history(self):
2730
2324
        """Generate the revision history from last revision
2733
2327
        self._extend_partial_history(stop_index=last_revno-1)
2734
2328
        return list(reversed(self._partial_revision_history_cache))
2735
2329
 
 
2330
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2331
        """Extend the partial history to include a given index
 
2332
 
 
2333
        If a stop_index is supplied, stop when that index has been reached.
 
2334
        If a stop_revision is supplied, stop when that revision is
 
2335
        encountered.  Otherwise, stop when the beginning of history is
 
2336
        reached.
 
2337
 
 
2338
        :param stop_index: The index which should be present.  When it is
 
2339
            present, history extension will stop.
 
2340
        :param revision_id: The revision id which should be present.  When
 
2341
            it is encountered, history extension will stop.
 
2342
        """
 
2343
        repo = self.repository
 
2344
        if len(self._partial_revision_history_cache) == 0:
 
2345
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2346
        else:
 
2347
            start_revision = self._partial_revision_history_cache[-1]
 
2348
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2349
            #skip the last revision in the list
 
2350
            next_revision = iterator.next()
 
2351
        for revision_id in iterator:
 
2352
            self._partial_revision_history_cache.append(revision_id)
 
2353
            if (stop_index is not None and
 
2354
                len(self._partial_revision_history_cache) > stop_index):
 
2355
                break
 
2356
            if revision_id == stop_revision:
 
2357
                break
 
2358
 
2736
2359
    def _write_revision_history(self, history):
2737
2360
        """Factored out of set_revision_history.
2738
2361
 
2759
2382
        """Set the parent branch"""
2760
2383
        return self._get_config_location('parent_location')
2761
2384
 
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
2385
    def set_push_location(self, location):
2838
2386
        """See Branch.set_push_location."""
2839
2387
        self._set_config_location('push_location', location)
2881
2429
            raise errors.NotStacked(self)
2882
2430
        return stacked_url
2883
2431
 
 
2432
    def set_append_revisions_only(self, enabled):
 
2433
        if enabled:
 
2434
            value = 'True'
 
2435
        else:
 
2436
            value = 'False'
 
2437
        self.get_config().set_user_option('append_revisions_only', value,
 
2438
            warn_masked=True)
 
2439
 
 
2440
    def set_stacked_on_url(self, url):
 
2441
        self._check_stackable_repo()
 
2442
        if not url:
 
2443
            try:
 
2444
                old_url = self.get_stacked_on_url()
 
2445
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2446
                errors.UnstackableRepositoryFormat):
 
2447
                return
 
2448
            url = ''
 
2449
            # repositories don't offer an interface to remove fallback
 
2450
            # repositories today; take the conceptually simpler option and just
 
2451
            # reopen it.
 
2452
            self.repository = self.bzrdir.find_repository()
 
2453
            # for every revision reference the branch has, ensure it is pulled
 
2454
            # in.
 
2455
            source_repository = self._get_fallback_repository(old_url)
 
2456
            for revision_id in chain([self.last_revision()],
 
2457
                self.tags.get_reverse_tag_dict()):
 
2458
                self.repository.fetch(source_repository, revision_id,
 
2459
                    find_ghosts=True)
 
2460
        else:
 
2461
            self._activate_fallback_location(url)
 
2462
        # write this out after the repository is stacked to avoid setting a
 
2463
        # stacked config that doesn't work.
 
2464
        self._set_config_location('stacked_on_location', url)
 
2465
 
2884
2466
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2467
        value = self.get_config().get_user_option('append_revisions_only')
 
2468
        return value == 'True'
 
2469
 
 
2470
    def _make_tags(self):
 
2471
        return BasicTags(self)
2887
2472
 
2888
2473
    @needs_write_lock
2889
2474
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2514
        return self.revno() - index
2930
2515
 
2931
2516
 
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
2517
class BzrBranch6(BzrBranch7):
2947
2518
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2519
 
2951
2522
    """
2952
2523
 
2953
2524
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2525
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2526
 
 
2527
    def set_stacked_on_url(self, url):
 
2528
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2529
 
2956
2530
 
2957
2531
######################################################################
2975
2549
    :ivar new_revno: Revision number after pull.
2976
2550
    :ivar old_revid: Tip revision id before pull.
2977
2551
    :ivar new_revid: Tip revision id after pull.
2978
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2552
    :ivar source_branch: Source (local) branch object.
2979
2553
    :ivar master_branch: Master branch of the target, or the target if no
2980
2554
        Master
2981
2555
    :ivar local_branch: target branch if there is a Master, else None
2982
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2556
    :ivar target_branch: Target/destination branch object.
2983
2557
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
2558
    """
2985
2559
 
2996
2570
        self._show_tag_conficts(to_file)
2997
2571
 
2998
2572
 
2999
 
class BranchPushResult(_Result):
 
2573
class PushResult(_Result):
3000
2574
    """Result of a Branch.push operation.
3001
2575
 
3002
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3003
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3004
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3005
 
        before the push.
3006
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3007
 
        after the push.
3008
 
    :ivar source_branch: Source branch object that the push was from. This is
3009
 
        read locked, and generally is a local (and thus low latency) branch.
3010
 
    :ivar master_branch: If target is a bound branch, the master branch of
3011
 
        target, or target itself. Always write locked.
3012
 
    :ivar target_branch: The direct Branch where data is being sent (write
3013
 
        locked).
3014
 
    :ivar local_branch: If the target is a bound branch this will be the
3015
 
        target, otherwise it will be None.
 
2576
    :ivar old_revno: Revision number before push.
 
2577
    :ivar new_revno: Revision number after push.
 
2578
    :ivar old_revid: Tip revision id before push.
 
2579
    :ivar new_revid: Tip revision id after push.
 
2580
    :ivar source_branch: Source branch object.
 
2581
    :ivar master_branch: Master branch of the target, or None.
 
2582
    :ivar target_branch: Target/destination branch object.
3016
2583
    """
3017
2584
 
3018
2585
    def __int__(self):
3022
2589
    def report(self, to_file):
3023
2590
        """Write a human-readable description of the result."""
3024
2591
        if self.old_revid == self.new_revid:
3025
 
            note('No new revisions to push.')
 
2592
            to_file.write('No new revisions to push.\n')
3026
2593
        else:
3027
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2594
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3028
2595
        self._show_tag_conficts(to_file)
3029
2596
 
3030
2597
 
3036
2603
 
3037
2604
    def __init__(self, branch):
3038
2605
        self.branch = branch
3039
 
        self.errors = []
3040
2606
 
3041
2607
    def report_results(self, verbose):
3042
2608
        """Report the check results via trace.note.
3043
 
 
 
2609
        
3044
2610
        :param verbose: Requests more detailed display of what was checked,
3045
2611
            if any.
3046
2612
        """
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)
 
2613
        note('checked branch %s format %s',
 
2614
             self.branch.base,
 
2615
             self.branch._format)
3051
2616
 
3052
2617
 
3053
2618
class Converter5to6(object):
3091
2656
        branch._transport.put_bytes('format', format.get_format_string())
3092
2657
 
3093
2658
 
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
2659
 
3104
2660
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2661
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3116
2672
            return callable(*args, **kwargs)
3117
2673
        finally:
3118
2674
            target.unlock()
3119
 
 
 
2675
    
3120
2676
    """
3121
2677
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3122
2678
    # should share code?
3132
2688
    else:
3133
2689
        target.unlock()
3134
2690
        return result
3135
 
 
3136
 
 
3137
 
class InterBranch(InterObject):
3138
 
    """This class represents operations taking place between two branches.
3139
 
 
3140
 
    Its instances have methods like pull() and push() and contain
3141
 
    references to the source and target repositories these operations
3142
 
    can be carried out on.
3143
 
    """
3144
 
 
3145
 
    _optimisers = []
3146
 
    """The available optimised InterBranch types."""
3147
 
 
3148
 
    @staticmethod
3149
 
    def _get_branch_formats_to_test():
3150
 
        """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)
3162
 
 
3163
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
3165
 
        """Pull in new perfect-fit revisions.
3166
 
 
3167
 
        :param stop_revision: Updated until the given revision
3168
 
        :param overwrite: Always set the branch pointer, rather than checking
3169
 
            to see if it is a proper descendant.
3170
 
        :param graph: A Graph object that can be used to query history
3171
 
            information. This can be None.
3172
 
        :return: None
3173
 
        """
3174
 
        raise NotImplementedError(self.update_revisions)
3175
 
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
3177
 
             _override_hook_source_branch=None):
3178
 
        """Mirror the source branch into the target branch.
3179
 
 
3180
 
        The source branch is considered to be 'local', having low latency.
3181
 
        """
3182
 
        raise NotImplementedError(self.push)
3183
 
 
3184
 
 
3185
 
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
3188
 
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
3192
 
 
3193
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
3195
 
        """See InterBranch.update_revisions()."""
3196
 
        self.source.lock_read()
3197
 
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
3206
 
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3233
 
        finally:
3234
 
            self.source.unlock()
3235
 
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
 
    @classmethod
3358
 
    def is_compatible(self, source, target):
3359
 
        # GenericBranch uses the public API, so always compatible
3360
 
        return True
3361
 
 
3362
 
 
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
 
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)