~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2009-03-04 07:10:07 UTC
  • mto: (4086.1.2 hpss-integration)
  • mto: This revision was merged to the branch mainline in revision 4087.
  • Revision ID: andrew.bennetts@canonical.com-20090304071007-8iqoi1m44ypmzg2a
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.

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
25
24
        bzrdir,
26
25
        cache_utf8,
27
26
        config as _mod_config,
28
 
        controldir,
29
27
        debug,
30
28
        errors,
31
29
        lockdir,
32
30
        lockable_files,
33
 
        remote,
34
31
        repository,
35
32
        revision as _mod_revision,
36
 
        rio,
37
 
        symbol_versioning,
38
33
        transport,
39
34
        tsort,
40
35
        ui,
41
36
        urlutils,
42
37
        )
43
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
44
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
45
40
from bzrlib.tag import (
46
41
    BasicTags,
48
43
    )
49
44
""")
50
45
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
 
from bzrlib.hooks import HookPoint, Hooks
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
53
48
from bzrlib.inter import InterObject
54
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
49
from bzrlib import registry
56
50
from bzrlib.symbol_versioning import (
57
51
    deprecated_in,
65
59
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
60
 
67
61
 
68
 
class Branch(controldir.ControlComponent):
 
62
# TODO: Maybe include checks for common corruption of newlines, etc?
 
63
 
 
64
# TODO: Some operations like log might retrieve the same revisions
 
65
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
66
# cache in memory to make this faster.  In general anything can be
 
67
# cached in memory between lock and unlock operations. .. nb thats
 
68
# what the transaction identity map provides
 
69
 
 
70
 
 
71
######################################################################
 
72
# branch objects
 
73
 
 
74
class Branch(object):
69
75
    """Branch holding a history of revisions.
70
76
 
71
 
    :ivar base:
72
 
        Base directory/url of the branch; using control_url and
73
 
        control_transport is more standardized.
 
77
    base
 
78
        Base directory/url of the branch.
74
79
 
75
80
    hooks: An instance of BranchHooks.
76
81
    """
78
83
    # - RBC 20060112
79
84
    base = None
80
85
 
81
 
    @property
82
 
    def control_transport(self):
83
 
        return self._transport
84
 
 
85
 
    @property
86
 
    def user_transport(self):
87
 
        return self.bzrdir.user_transport
 
86
    # override this to set the strategy for storing tags
 
87
    def _make_tags(self):
 
88
        return DisabledTags(self)
88
89
 
89
90
    def __init__(self, *ignored, **ignored_too):
90
 
        self.tags = self._format.make_tags(self)
 
91
        self.tags = self._make_tags()
91
92
        self._revision_history_cache = None
92
93
        self._revision_id_to_revno_cache = None
93
94
        self._partial_revision_id_to_revno_cache = {}
94
 
        self._partial_revision_history_cache = []
95
95
        self._last_revision_info_cache = None
96
96
        self._merge_sorted_revisions_cache = None
97
97
        self._open_hook()
102
102
    def _open_hook(self):
103
103
        """Called by init to allow simpler extension of the base class."""
104
104
 
105
 
    def _activate_fallback_location(self, url):
106
 
        """Activate the branch/repository from url as a fallback repository."""
107
 
        repo = self._get_fallback_repository(url)
108
 
        if repo.has_same_location(self.repository):
109
 
            raise errors.UnstackableLocationError(self.user_url, url)
110
 
        self.repository.add_fallback_repository(repo)
111
 
 
112
105
    def break_lock(self):
113
106
        """Break a lock if one is present from another instance.
114
107
 
123
116
        if master is not None:
124
117
            master.break_lock()
125
118
 
126
 
    def _check_stackable_repo(self):
127
 
        if not self.repository._format.supports_external_lookups:
128
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
129
 
                self.repository.base)
130
 
 
131
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
 
        """Extend the partial history to include a given index
133
 
 
134
 
        If a stop_index is supplied, stop when that index has been reached.
135
 
        If a stop_revision is supplied, stop when that revision is
136
 
        encountered.  Otherwise, stop when the beginning of history is
137
 
        reached.
138
 
 
139
 
        :param stop_index: The index which should be present.  When it is
140
 
            present, history extension will stop.
141
 
        :param stop_revision: The revision id which should be present.  When
142
 
            it is encountered, history extension will stop.
143
 
        """
144
 
        if len(self._partial_revision_history_cache) == 0:
145
 
            self._partial_revision_history_cache = [self.last_revision()]
146
 
        repository._iter_for_revno(
147
 
            self.repository, self._partial_revision_history_cache,
148
 
            stop_index=stop_index, stop_revision=stop_revision)
149
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
 
            self._partial_revision_history_cache.pop()
151
 
 
152
 
    def _get_check_refs(self):
153
 
        """Get the references needed for check().
154
 
 
155
 
        See bzrlib.check.
156
 
        """
157
 
        revid = self.last_revision()
158
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
159
 
 
160
119
    @staticmethod
161
120
    def open(base, _unsupported=False, possible_transports=None):
162
121
        """Open the branch rooted at base.
166
125
        """
167
126
        control = bzrdir.BzrDir.open(base, _unsupported,
168
127
                                     possible_transports=possible_transports)
169
 
        return control.open_branch(unsupported=_unsupported)
 
128
        return control.open_branch(_unsupported)
170
129
 
171
130
    @staticmethod
172
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
131
    def open_from_transport(transport, _unsupported=False):
173
132
        """Open the branch rooted at transport"""
174
133
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
134
        return control.open_branch(_unsupported)
176
135
 
177
136
    @staticmethod
178
137
    def open_containing(url, possible_transports=None):
196
155
        The default implementation returns False if this branch has no tags,
197
156
        and True the rest of the time.  Subclasses may override this.
198
157
        """
199
 
        return self.supports_tags() and self.tags.get_tag_dict()
 
158
        return self.tags.supports_tags() and self.tags.get_tag_dict()
200
159
 
201
160
    def get_config(self):
202
 
        """Get a bzrlib.config.BranchConfig for this Branch.
203
 
 
204
 
        This can then be used to get and set configuration options for the
205
 
        branch.
206
 
 
207
 
        :return: A bzrlib.config.BranchConfig.
208
 
        """
209
161
        return BranchConfig(self)
210
162
 
211
 
    def _get_config(self):
212
 
        """Get the concrete config for just the config in this branch.
213
 
 
214
 
        This is not intended for client use; see Branch.get_config for the
215
 
        public API.
216
 
 
217
 
        Added in 1.14.
218
 
 
219
 
        :return: An object supporting get_option and set_option.
220
 
        """
221
 
        raise NotImplementedError(self._get_config)
222
 
 
223
 
    def _get_fallback_repository(self, url):
224
 
        """Get the repository we fallback to at url."""
225
 
        url = urlutils.join(self.base, url)
226
 
        a_branch = Branch.open(url,
227
 
            possible_transports=[self.bzrdir.root_transport])
228
 
        return a_branch.repository
229
 
 
230
 
    def _get_tags_bytes(self):
231
 
        """Get the bytes of a serialised tags dict.
232
 
 
233
 
        Note that not all branches support tags, nor do all use the same tags
234
 
        logic: this method is specific to BasicTags. Other tag implementations
235
 
        may use the same method name and behave differently, safely, because
236
 
        of the double-dispatch via
237
 
        format.make_tags->tags_instance->get_tags_dict.
238
 
 
239
 
        :return: The bytes of the tags file.
240
 
        :seealso: Branch._set_tags_bytes.
241
 
        """
242
 
        return self._transport.get_bytes('tags')
243
 
 
244
163
    def _get_nick(self, local=False, possible_transports=None):
245
164
        config = self.get_config()
246
165
        # explicit overrides master, but don't look for master if local is True
247
166
        if not local and not config.has_explicit_nickname():
248
167
            try:
249
168
                master = self.get_master_branch(possible_transports)
250
 
                if master and self.user_url == master.user_url:
251
 
                    raise errors.RecursiveBind(self.user_url)
252
169
                if master is not None:
253
170
                    # return the master branch value
254
171
                    return master.nick
255
 
            except errors.RecursiveBind, e:
256
 
                raise e
257
172
            except errors.BzrError, e:
258
173
                # Silently fall back to local implicit nick if the master is
259
174
                # unavailable
296
211
        new_history.reverse()
297
212
        return new_history
298
213
 
299
 
    def lock_write(self, token=None):
300
 
        """Lock the branch for write operations.
301
 
 
302
 
        :param token: A token to permit reacquiring a previously held and
303
 
            preserved lock.
304
 
        :return: A BranchWriteLockResult.
305
 
        """
 
214
    def lock_write(self):
306
215
        raise NotImplementedError(self.lock_write)
307
216
 
308
217
    def lock_read(self):
309
 
        """Lock the branch for read operations.
310
 
 
311
 
        :return: A bzrlib.lock.LogicalLockResult.
312
 
        """
313
218
        raise NotImplementedError(self.lock_read)
314
219
 
315
220
    def unlock(self):
440
345
            * 'include' - the stop revision is the last item in the result
441
346
            * 'with-merges' - include the stop revision and all of its
442
347
              merged revisions in the result
443
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
444
 
              that are in both ancestries
445
348
        :param direction: either 'reverse' or 'forward':
446
349
            * reverse means return the start_revision_id first, i.e.
447
350
              start at the most recent revision and go backwards in history
469
372
        # start_revision_id.
470
373
        if self._merge_sorted_revisions_cache is None:
471
374
            last_revision = self.last_revision()
472
 
            known_graph = self.repository.get_known_graph_ancestry(
473
 
                [last_revision])
474
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
475
 
                last_revision)
 
375
            graph = self.repository.get_graph()
 
376
            parent_map = dict(((key, value) for key, value in
 
377
                     graph.iter_ancestry([last_revision]) if value is not None))
 
378
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
379
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
380
                generate_revno=True)
 
381
            # Drop the sequence # before caching
 
382
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
383
 
476
384
        filtered = self._filter_merge_sorted_revisions(
477
385
            self._merge_sorted_revisions_cache, start_revision_id,
478
386
            stop_revision_id, stop_rule)
479
 
        # Make sure we don't return revisions that are not part of the
480
 
        # start_revision_id ancestry.
481
 
        filtered = self._filter_start_non_ancestors(filtered)
482
387
        if direction == 'reverse':
483
388
            return filtered
484
389
        if direction == 'forward':
491
396
        """Iterate over an inclusive range of sorted revisions."""
492
397
        rev_iter = iter(merge_sorted_revisions)
493
398
        if start_revision_id is not None:
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
 
399
            for rev_id, depth, revno, end_of_merge in rev_iter:
496
400
                if rev_id != start_revision_id:
497
401
                    continue
498
402
                else:
499
403
                    # The decision to include the start or not
500
404
                    # depends on the stop_rule if a stop is provided
501
 
                    # so pop this node back into the iterator
502
 
                    rev_iter = chain(iter([node]), rev_iter)
 
405
                    rev_iter = chain(
 
406
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
407
                        rev_iter)
503
408
                    break
504
409
        if stop_revision_id is None:
505
 
            # Yield everything
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
411
                yield rev_id, depth, revno, end_of_merge
510
412
        elif stop_rule == 'exclude':
511
 
            for node in rev_iter:
512
 
                rev_id = node.key[-1]
 
413
            for rev_id, depth, revno, end_of_merge in rev_iter:
513
414
                if rev_id == stop_revision_id:
514
415
                    return
515
 
                yield (rev_id, node.merge_depth, node.revno,
516
 
                       node.end_of_merge)
 
416
                yield rev_id, depth, revno, end_of_merge
517
417
        elif stop_rule == 'include':
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                yield (rev_id, node.merge_depth, node.revno,
521
 
                       node.end_of_merge)
 
418
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
419
                yield rev_id, depth, revno, end_of_merge
522
420
                if rev_id == stop_revision_id:
523
421
                    return
524
 
        elif stop_rule == 'with-merges-without-common-ancestry':
525
 
            # We want to exclude all revisions that are already part of the
526
 
            # stop_revision_id ancestry.
527
 
            graph = self.repository.get_graph()
528
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
529
 
                                                    [stop_revision_id])
530
 
            for node in rev_iter:
531
 
                rev_id = node.key[-1]
532
 
                if rev_id not in ancestors:
533
 
                    continue
534
 
                yield (rev_id, node.merge_depth, node.revno,
535
 
                       node.end_of_merge)
536
422
        elif stop_rule == 'with-merges':
537
423
            stop_rev = self.repository.get_revision(stop_revision_id)
538
424
            if stop_rev.parent_ids:
539
425
                left_parent = stop_rev.parent_ids[0]
540
426
            else:
541
427
                left_parent = _mod_revision.NULL_REVISION
542
 
            # left_parent is the actual revision we want to stop logging at,
543
 
            # since we want to show the merged revisions after the stop_rev too
544
 
            reached_stop_revision_id = False
545
 
            revision_id_whitelist = []
546
 
            for node in rev_iter:
547
 
                rev_id = node.key[-1]
 
428
            for rev_id, depth, revno, end_of_merge in rev_iter:
548
429
                if rev_id == left_parent:
549
 
                    # reached the left parent after the stop_revision
550
430
                    return
551
 
                if (not reached_stop_revision_id or
552
 
                        rev_id in revision_id_whitelist):
553
 
                    yield (rev_id, node.merge_depth, node.revno,
554
 
                       node.end_of_merge)
555
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
556
 
                        # only do the merged revs of rev_id from now on
557
 
                        rev = self.repository.get_revision(rev_id)
558
 
                        if rev.parent_ids:
559
 
                            reached_stop_revision_id = True
560
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
431
                yield rev_id, depth, revno, end_of_merge
561
432
        else:
562
433
            raise ValueError('invalid stop_rule %r' % stop_rule)
563
434
 
564
 
    def _filter_start_non_ancestors(self, rev_iter):
565
 
        # If we started from a dotted revno, we want to consider it as a tip
566
 
        # and don't want to yield revisions that are not part of its
567
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
568
 
        # uninteresting descendants of the first parent of our tip before the
569
 
        # tip itself.
570
 
        first = rev_iter.next()
571
 
        (rev_id, merge_depth, revno, end_of_merge) = first
572
 
        yield first
573
 
        if not merge_depth:
574
 
            # We start at a mainline revision so by definition, all others
575
 
            # revisions in rev_iter are ancestors
576
 
            for node in rev_iter:
577
 
                yield node
578
 
 
579
 
        clean = False
580
 
        whitelist = set()
581
 
        pmap = self.repository.get_parent_map([rev_id])
582
 
        parents = pmap.get(rev_id, [])
583
 
        if parents:
584
 
            whitelist.update(parents)
585
 
        else:
586
 
            # If there is no parents, there is nothing of interest left
587
 
 
588
 
            # FIXME: It's hard to test this scenario here as this code is never
589
 
            # called in that case. -- vila 20100322
590
 
            return
591
 
 
592
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
593
 
            if not clean:
594
 
                if rev_id in whitelist:
595
 
                    pmap = self.repository.get_parent_map([rev_id])
596
 
                    parents = pmap.get(rev_id, [])
597
 
                    whitelist.remove(rev_id)
598
 
                    whitelist.update(parents)
599
 
                    if merge_depth == 0:
600
 
                        # We've reached the mainline, there is nothing left to
601
 
                        # filter
602
 
                        clean = True
603
 
                else:
604
 
                    # A revision that is not part of the ancestry of our
605
 
                    # starting revision.
606
 
                    continue
607
 
            yield (rev_id, merge_depth, revno, end_of_merge)
608
 
 
609
435
    def leave_lock_in_place(self):
610
436
        """Tell this branch object not to release the physical lock when this
611
437
        object is unlocked.
628
454
        :param other: The branch to bind to
629
455
        :type other: Branch
630
456
        """
631
 
        raise errors.UpgradeRequired(self.user_url)
632
 
 
633
 
    def set_append_revisions_only(self, enabled):
634
 
        if not self._format.supports_set_append_revisions_only():
635
 
            raise errors.UpgradeRequired(self.user_url)
636
 
        if enabled:
637
 
            value = 'True'
638
 
        else:
639
 
            value = 'False'
640
 
        self.get_config().set_user_option('append_revisions_only', value,
641
 
            warn_masked=True)
642
 
 
643
 
    def set_reference_info(self, file_id, tree_path, branch_location):
644
 
        """Set the branch location to use for a tree reference."""
645
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
646
 
 
647
 
    def get_reference_info(self, file_id):
648
 
        """Get the tree_path and branch_location for a tree reference."""
649
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
457
        raise errors.UpgradeRequired(self.base)
650
458
 
651
459
    @needs_write_lock
652
460
    def fetch(self, from_branch, last_revision=None, pb=None):
660
468
        """
661
469
        if self.base == from_branch.base:
662
470
            return (0, [])
663
 
        if pb is not None:
664
 
            symbol_versioning.warn(
665
 
                symbol_versioning.deprecated_in((1, 14, 0))
666
 
                % "pb parameter to fetch()")
 
471
        if pb is None:
 
472
            nested_pb = ui.ui_factory.nested_progress_bar()
 
473
            pb = nested_pb
 
474
        else:
 
475
            nested_pb = None
 
476
 
667
477
        from_branch.lock_read()
668
478
        try:
669
479
            if last_revision is None:
 
480
                pb.update('get source history')
670
481
                last_revision = from_branch.last_revision()
671
482
                last_revision = _mod_revision.ensure_null(last_revision)
672
483
            return self.repository.fetch(from_branch.repository,
673
484
                                         revision_id=last_revision,
674
 
                                         pb=pb)
 
485
                                         pb=nested_pb)
675
486
        finally:
 
487
            if nested_pb is not None:
 
488
                nested_pb.finished()
676
489
            from_branch.unlock()
677
490
 
678
491
    def get_bound_location(self):
686
499
    def get_old_bound_location(self):
687
500
        """Return the URL of the branch we used to be bound to
688
501
        """
689
 
        raise errors.UpgradeRequired(self.user_url)
 
502
        raise errors.UpgradeRequired(self.base)
690
503
 
691
504
    def get_commit_builder(self, parents, config=None, timestamp=None,
692
505
                           timezone=None, committer=None, revprops=None,
742
555
    def set_revision_history(self, rev_history):
743
556
        raise NotImplementedError(self.set_revision_history)
744
557
 
745
 
    @needs_write_lock
746
 
    def set_parent(self, url):
747
 
        """See Branch.set_parent."""
748
 
        # TODO: Maybe delete old location files?
749
 
        # URLs should never be unicode, even on the local fs,
750
 
        # FIXUP this and get_parent in a future branch format bump:
751
 
        # read and rewrite the file. RBC 20060125
752
 
        if url is not None:
753
 
            if isinstance(url, unicode):
754
 
                try:
755
 
                    url = url.encode('ascii')
756
 
                except UnicodeEncodeError:
757
 
                    raise errors.InvalidURL(url,
758
 
                        "Urls must be 7-bit ascii, "
759
 
                        "use bzrlib.urlutils.escape")
760
 
            url = urlutils.relative_url(self.base, url)
761
 
        self._set_parent_location(url)
762
 
 
763
 
    @needs_write_lock
764
558
    def set_stacked_on_url(self, url):
765
559
        """Set the URL this branch is stacked against.
766
560
 
769
563
        :raises UnstackableRepositoryFormat: If the repository does not support
770
564
            stacking.
771
565
        """
772
 
        if not self._format.supports_stacking():
773
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
774
 
        # XXX: Changing from one fallback repository to another does not check
775
 
        # that all the data you need is present in the new fallback.
776
 
        # Possibly it should.
777
 
        self._check_stackable_repo()
778
 
        if not url:
779
 
            try:
780
 
                old_url = self.get_stacked_on_url()
781
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
782
 
                errors.UnstackableRepositoryFormat):
783
 
                return
784
 
            self._unstack()
785
 
        else:
786
 
            self._activate_fallback_location(url)
787
 
        # write this out after the repository is stacked to avoid setting a
788
 
        # stacked config that doesn't work.
789
 
        self._set_config_location('stacked_on_location', url)
790
 
 
791
 
    def _unstack(self):
792
 
        """Change a branch to be unstacked, copying data as needed.
793
 
        
794
 
        Don't call this directly, use set_stacked_on_url(None).
795
 
        """
796
 
        pb = ui.ui_factory.nested_progress_bar()
797
 
        try:
798
 
            pb.update("Unstacking")
799
 
            # The basic approach here is to fetch the tip of the branch,
800
 
            # including all available ghosts, from the existing stacked
801
 
            # repository into a new repository object without the fallbacks. 
802
 
            #
803
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
804
 
            # correct for CHKMap repostiories
805
 
            old_repository = self.repository
806
 
            if len(old_repository._fallback_repositories) != 1:
807
 
                raise AssertionError("can't cope with fallback repositories "
808
 
                    "of %r" % (self.repository,))
809
 
            # Open the new repository object.
810
 
            # Repositories don't offer an interface to remove fallback
811
 
            # repositories today; take the conceptually simpler option and just
812
 
            # reopen it.  We reopen it starting from the URL so that we
813
 
            # get a separate connection for RemoteRepositories and can
814
 
            # stream from one of them to the other.  This does mean doing
815
 
            # separate SSH connection setup, but unstacking is not a
816
 
            # common operation so it's tolerable.
817
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
818
 
            new_repository = new_bzrdir.find_repository()
819
 
            if new_repository._fallback_repositories:
820
 
                raise AssertionError("didn't expect %r to have "
821
 
                    "fallback_repositories"
822
 
                    % (self.repository,))
823
 
            # Replace self.repository with the new repository.
824
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
825
 
            # lock count) of self.repository to the new repository.
826
 
            lock_token = old_repository.lock_write().repository_token
827
 
            self.repository = new_repository
828
 
            if isinstance(self, remote.RemoteBranch):
829
 
                # Remote branches can have a second reference to the old
830
 
                # repository that need to be replaced.
831
 
                if self._real_branch is not None:
832
 
                    self._real_branch.repository = new_repository
833
 
            self.repository.lock_write(token=lock_token)
834
 
            if lock_token is not None:
835
 
                old_repository.leave_lock_in_place()
836
 
            old_repository.unlock()
837
 
            if lock_token is not None:
838
 
                # XXX: self.repository.leave_lock_in_place() before this
839
 
                # function will not be preserved.  Fortunately that doesn't
840
 
                # affect the current default format (2a), and would be a
841
 
                # corner-case anyway.
842
 
                #  - Andrew Bennetts, 2010/06/30
843
 
                self.repository.dont_leave_lock_in_place()
844
 
            old_lock_count = 0
845
 
            while True:
846
 
                try:
847
 
                    old_repository.unlock()
848
 
                except errors.LockNotHeld:
849
 
                    break
850
 
                old_lock_count += 1
851
 
            if old_lock_count == 0:
852
 
                raise AssertionError(
853
 
                    'old_repository should have been locked at least once.')
854
 
            for i in range(old_lock_count-1):
855
 
                self.repository.lock_write()
856
 
            # Fetch from the old repository into the new.
857
 
            old_repository.lock_read()
858
 
            try:
859
 
                # XXX: If you unstack a branch while it has a working tree
860
 
                # with a pending merge, the pending-merged revisions will no
861
 
                # longer be present.  You can (probably) revert and remerge.
862
 
                #
863
 
                # XXX: This only fetches up to the tip of the repository; it
864
 
                # doesn't bring across any tags.  That's fairly consistent
865
 
                # with how branch works, but perhaps not ideal.
866
 
                self.repository.fetch(old_repository,
867
 
                    revision_id=self.last_revision(),
868
 
                    find_ghosts=True)
869
 
            finally:
870
 
                old_repository.unlock()
871
 
        finally:
872
 
            pb.finished()
873
 
 
874
 
    def _set_tags_bytes(self, bytes):
875
 
        """Mirror method for _get_tags_bytes.
876
 
 
877
 
        :seealso: Branch._get_tags_bytes.
878
 
        """
879
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
880
 
            'tags', bytes)
 
566
        raise NotImplementedError(self.set_stacked_on_url)
881
567
 
882
568
    def _cache_revision_history(self, rev_history):
883
569
        """Set the cached revision history to rev_history.
911
597
        self._revision_id_to_revno_cache = None
912
598
        self._last_revision_info_cache = None
913
599
        self._merge_sorted_revisions_cache = None
914
 
        self._partial_revision_history_cache = []
915
 
        self._partial_revision_id_to_revno_cache = {}
916
600
 
917
601
    def _gen_revision_history(self):
918
602
        """Return sequence of revision hashes on to this branch.
955
639
 
956
640
    def unbind(self):
957
641
        """Older format branches cannot bind or unbind."""
958
 
        raise errors.UpgradeRequired(self.user_url)
 
642
        raise errors.UpgradeRequired(self.base)
 
643
 
 
644
    def set_append_revisions_only(self, enabled):
 
645
        """Older format branches are never restricted to append-only"""
 
646
        raise errors.UpgradeRequired(self.base)
959
647
 
960
648
    def last_revision(self):
961
649
        """Return last revision id, or NULL_REVISION."""
1002
690
                raise errors.NoSuchRevision(self, stop_revision)
1003
691
        return other_history[self_len:stop_revision]
1004
692
 
 
693
    @needs_write_lock
1005
694
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1006
695
                         graph=None):
1007
696
        """Pull in new perfect-fit revisions.
1017
706
        return InterBranch.get(other, self).update_revisions(stop_revision,
1018
707
            overwrite, graph)
1019
708
 
1020
 
    def import_last_revision_info(self, source_repo, revno, revid):
1021
 
        """Set the last revision info, importing from another repo if necessary.
1022
 
 
1023
 
        This is used by the bound branch code to upload a revision to
1024
 
        the master branch first before updating the tip of the local branch.
1025
 
 
1026
 
        :param source_repo: Source repository to optionally fetch from
1027
 
        :param revno: Revision number of the new tip
1028
 
        :param revid: Revision id of the new tip
1029
 
        """
1030
 
        if not self.repository.has_same_location(source_repo):
1031
 
            self.repository.fetch(source_repo, revision_id=revid)
1032
 
        self.set_last_revision_info(revno, revid)
1033
 
 
1034
709
    def revision_id_to_revno(self, revision_id):
1035
710
        """Given a revision id, return its revno"""
1036
711
        if _mod_revision.is_null(revision_id):
1041
716
        except ValueError:
1042
717
            raise errors.NoSuchRevision(self, revision_id)
1043
718
 
1044
 
    @needs_read_lock
1045
719
    def get_rev_id(self, revno, history=None):
1046
720
        """Find the revision id of the specified revno."""
1047
721
        if revno == 0:
1048
722
            return _mod_revision.NULL_REVISION
1049
 
        last_revno, last_revid = self.last_revision_info()
1050
 
        if revno == last_revno:
1051
 
            return last_revid
1052
 
        if revno <= 0 or revno > last_revno:
 
723
        if history is None:
 
724
            history = self.revision_history()
 
725
        if revno <= 0 or revno > len(history):
1053
726
            raise errors.NoSuchRevision(self, revno)
1054
 
        distance_from_last = last_revno - revno
1055
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1056
 
            self._extend_partial_history(distance_from_last)
1057
 
        return self._partial_revision_history_cache[distance_from_last]
 
727
        return history[revno - 1]
1058
728
 
1059
729
    def pull(self, source, overwrite=False, stop_revision=None,
1060
 
             possible_transports=None, *args, **kwargs):
 
730
             possible_transports=None, _override_hook_target=None):
1061
731
        """Mirror source into this branch.
1062
732
 
1063
733
        This branch is considered to be 'local', having low latency.
1064
734
 
1065
735
        :returns: PullResult instance
1066
736
        """
1067
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1068
 
            stop_revision=stop_revision,
1069
 
            possible_transports=possible_transports, *args, **kwargs)
 
737
        raise NotImplementedError(self.pull)
1070
738
 
1071
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1072
 
        **kwargs):
 
739
    def push(self, target, overwrite=False, stop_revision=None):
1073
740
        """Mirror this branch into target.
1074
741
 
1075
742
        This branch is considered to be 'local', having low latency.
1076
743
        """
1077
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1078
 
            *args, **kwargs)
1079
 
 
1080
 
    def lossy_push(self, target, stop_revision=None):
1081
 
        """Push deltas into another branch.
1082
 
 
1083
 
        :note: This does not, like push, retain the revision ids from 
1084
 
            the source branch and will, rather than adding bzr-specific 
1085
 
            metadata, push only those semantics of the revision that can be 
1086
 
            natively represented by this branch' VCS.
1087
 
 
1088
 
        :param target: Target branch
1089
 
        :param stop_revision: Revision to push, defaults to last revision.
1090
 
        :return: BranchPushResult with an extra member revidmap: 
1091
 
            A dictionary mapping revision ids from the target branch 
1092
 
            to new revision ids in the target branch, for each 
1093
 
            revision that was pushed.
1094
 
        """
1095
 
        inter = InterBranch.get(self, target)
1096
 
        lossy_push = getattr(inter, "lossy_push", None)
1097
 
        if lossy_push is None:
1098
 
            raise errors.LossyPushToSameVCS(self, target)
1099
 
        return lossy_push(stop_revision)
 
744
        raise NotImplementedError(self.push)
1100
745
 
1101
746
    def basis_tree(self):
1102
747
        """Return `Tree` object for last revision."""
1109
754
        pattern is that the user can override it by specifying a
1110
755
        location.
1111
756
        """
1112
 
        parent = self._get_parent_location()
1113
 
        if parent is None:
1114
 
            return parent
1115
 
        # This is an old-format absolute path to a local branch
1116
 
        # turn it into a url
1117
 
        if parent.startswith('/'):
1118
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1119
 
        try:
1120
 
            return urlutils.join(self.base[:-1], parent)
1121
 
        except errors.InvalidURLJoin, e:
1122
 
            raise errors.InaccessibleParent(parent, self.user_url)
1123
 
 
1124
 
    def _get_parent_location(self):
1125
 
        raise NotImplementedError(self._get_parent_location)
 
757
        raise NotImplementedError(self.get_parent)
1126
758
 
1127
759
    def _set_config_location(self, name, url, config=None,
1128
760
                             make_relative=False):
1142
774
            location = None
1143
775
        return location
1144
776
 
1145
 
    def get_child_submit_format(self):
1146
 
        """Return the preferred format of submissions to this branch."""
1147
 
        return self.get_config().get_user_option("child_submit_format")
1148
 
 
1149
777
    def get_submit_branch(self):
1150
778
        """Return the submit location of the branch.
1151
779
 
1168
796
    def get_public_branch(self):
1169
797
        """Return the public location of the branch.
1170
798
 
1171
 
        This is used by merge directives.
 
799
        This is is used by merge directives.
1172
800
        """
1173
801
        return self._get_config_location('public_branch')
1174
802
 
1210
838
        params = ChangeBranchTipParams(
1211
839
            self, old_revno, new_revno, old_revid, new_revid)
1212
840
        for hook in hooks:
1213
 
            hook(params)
 
841
            try:
 
842
                hook(params)
 
843
            except errors.TipChangeRejected:
 
844
                raise
 
845
            except Exception:
 
846
                exc_info = sys.exc_info()
 
847
                hook_name = Branch.hooks.get_hook_name(hook)
 
848
                raise errors.HookFailed(
 
849
                    'pre_change_branch_tip', hook_name, exc_info)
 
850
 
 
851
    def set_parent(self, url):
 
852
        raise NotImplementedError(self.set_parent)
1214
853
 
1215
854
    @needs_write_lock
1216
855
    def update(self):
1247
886
                     be truncated to end with revision_id.
1248
887
        """
1249
888
        result = to_bzrdir.create_branch()
1250
 
        result.lock_write()
1251
 
        try:
1252
 
            if repository_policy is not None:
1253
 
                repository_policy.configure_branch(result)
1254
 
            self.copy_content_into(result, revision_id=revision_id)
1255
 
        finally:
1256
 
            result.unlock()
1257
 
        return result
 
889
        if repository_policy is not None:
 
890
            repository_policy.configure_branch(result)
 
891
        self.copy_content_into(result, revision_id=revision_id)
 
892
        return  result
1258
893
 
1259
894
    @needs_read_lock
1260
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
895
    def sprout(self, to_bzrdir, revision_id=None):
1261
896
        """Create a new line of development from the branch, into to_bzrdir.
1262
897
 
1263
898
        to_bzrdir controls the branch format.
1265
900
        revision_id: if not None, the revision history in the new branch will
1266
901
                     be truncated to end with revision_id.
1267
902
        """
1268
 
        if (repository_policy is not None and
1269
 
            repository_policy.requires_stacking()):
1270
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1271
903
        result = to_bzrdir.create_branch()
1272
 
        result.lock_write()
1273
 
        try:
1274
 
            if repository_policy is not None:
1275
 
                repository_policy.configure_branch(result)
1276
 
            self.copy_content_into(result, revision_id=revision_id)
1277
 
            result.set_parent(self.bzrdir.root_transport.base)
1278
 
        finally:
1279
 
            result.unlock()
 
904
        self.copy_content_into(result, revision_id=revision_id)
 
905
        result.set_parent(self.bzrdir.root_transport.base)
1280
906
        return result
1281
907
 
1282
908
    def _synchronize_history(self, destination, revision_id):
1294
920
        source_revno, source_revision_id = self.last_revision_info()
1295
921
        if revision_id is None:
1296
922
            revno, revision_id = source_revno, source_revision_id
 
923
        elif source_revision_id == revision_id:
 
924
            # we know the revno without needing to walk all of history
 
925
            revno = source_revno
1297
926
        else:
1298
 
            graph = self.repository.get_graph()
1299
 
            try:
1300
 
                revno = graph.find_distance_to_null(revision_id, 
1301
 
                    [(source_revision_id, source_revno)])
1302
 
            except errors.GhostRevisionsHaveNoRevno:
1303
 
                # Default to 1, if we can't find anything else
1304
 
                revno = 1
 
927
            # To figure out the revno for a random revision, we need to build
 
928
            # the revision history, and count its length.
 
929
            # We don't care about the order, just how long it is.
 
930
            # Alternatively, we could start at the current location, and count
 
931
            # backwards. But there is no guarantee that we will find it since
 
932
            # it may be a merged revision.
 
933
            revno = len(list(self.repository.iter_reverse_revision_history(
 
934
                                                                revision_id)))
1305
935
        destination.set_last_revision_info(revno, revision_id)
1306
936
 
 
937
    @needs_read_lock
1307
938
    def copy_content_into(self, destination, revision_id=None):
1308
939
        """Copy the content of self into destination.
1309
940
 
1310
941
        revision_id: if not None, the revision history in the new branch will
1311
942
                     be truncated to end with revision_id.
1312
943
        """
1313
 
        return InterBranch.get(self, destination).copy_content_into(
1314
 
            revision_id=revision_id)
1315
 
 
1316
 
    def update_references(self, target):
1317
 
        if not getattr(self._format, 'supports_reference_locations', False):
1318
 
            return
1319
 
        reference_dict = self._get_all_reference_info()
1320
 
        if len(reference_dict) == 0:
1321
 
            return
1322
 
        old_base = self.base
1323
 
        new_base = target.base
1324
 
        target_reference_dict = target._get_all_reference_info()
1325
 
        for file_id, (tree_path, branch_location) in (
1326
 
            reference_dict.items()):
1327
 
            branch_location = urlutils.rebase_url(branch_location,
1328
 
                                                  old_base, new_base)
1329
 
            target_reference_dict.setdefault(
1330
 
                file_id, (tree_path, branch_location))
1331
 
        target._set_all_reference_info(target_reference_dict)
 
944
        self._synchronize_history(destination, revision_id)
 
945
        try:
 
946
            parent = self.get_parent()
 
947
        except errors.InaccessibleParent, e:
 
948
            mutter('parent was not accessible to copy: %s', e)
 
949
        else:
 
950
            if parent:
 
951
                destination.set_parent(parent)
 
952
        if self._push_should_merge_tags():
 
953
            self.tags.merge_to(destination.tags)
1332
954
 
1333
955
    @needs_read_lock
1334
 
    def check(self, refs):
 
956
    def check(self):
1335
957
        """Check consistency of the branch.
1336
958
 
1337
959
        In particular this checks that revisions given in the revision-history
1340
962
 
1341
963
        Callers will typically also want to check the repository.
1342
964
 
1343
 
        :param refs: Calculated refs for this branch as specified by
1344
 
            branch._get_check_refs()
1345
965
        :return: A BranchCheckResult.
1346
966
        """
1347
 
        result = BranchCheckResult(self)
 
967
        mainline_parent_id = None
1348
968
        last_revno, last_revision_id = self.last_revision_info()
1349
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1350
 
        if actual_revno != last_revno:
1351
 
            result.errors.append(errors.BzrCheckError(
1352
 
                'revno does not match len(mainline) %s != %s' % (
1353
 
                last_revno, actual_revno)))
1354
 
        # TODO: We should probably also check that self.revision_history
1355
 
        # matches the repository for older branch formats.
1356
 
        # If looking for the code that cross-checks repository parents against
1357
 
        # the iter_reverse_revision_history output, that is now a repository
1358
 
        # specific check.
1359
 
        return result
 
969
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
970
                                last_revision_id))
 
971
        real_rev_history.reverse()
 
972
        if len(real_rev_history) != last_revno:
 
973
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
974
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
975
        # TODO: We should probably also check that real_rev_history actually
 
976
        #       matches self.revision_history()
 
977
        for revision_id in real_rev_history:
 
978
            try:
 
979
                revision = self.repository.get_revision(revision_id)
 
980
            except errors.NoSuchRevision, e:
 
981
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
982
                            % revision_id)
 
983
            # In general the first entry on the revision history has no parents.
 
984
            # But it's not illegal for it to have parents listed; this can happen
 
985
            # in imports from Arch when the parents weren't reachable.
 
986
            if mainline_parent_id is not None:
 
987
                if mainline_parent_id not in revision.parent_ids:
 
988
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
989
                                        "parents of {%s}"
 
990
                                        % (mainline_parent_id, revision_id))
 
991
            mainline_parent_id = revision_id
 
992
        return BranchCheckResult(self)
1360
993
 
1361
994
    def _get_checkout_format(self):
1362
995
        """Return the most suitable metadir for a checkout of this branch.
1372
1005
        return format
1373
1006
 
1374
1007
    def create_clone_on_transport(self, to_transport, revision_id=None,
1375
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1008
        stacked_on=None):
1376
1009
        """Create a clone of this branch and its bzrdir.
1377
1010
 
1378
1011
        :param to_transport: The transport to clone onto.
1379
1012
        :param revision_id: The revision id to use as tip in the new branch.
1380
1013
            If None the tip is obtained from this branch.
1381
1014
        :param stacked_on: An optional URL to stack the clone on.
1382
 
        :param create_prefix: Create any missing directories leading up to
1383
 
            to_transport.
1384
 
        :param use_existing_dir: Use an existing directory if one exists.
1385
1015
        """
1386
1016
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1387
1017
        # clone call. Or something. 20090224 RBC/spiv.
1388
 
        # XXX: Should this perhaps clone colocated branches as well, 
1389
 
        # rather than just the default branch? 20100319 JRV
1390
 
        if revision_id is None:
1391
 
            revision_id = self.last_revision()
1392
1018
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1393
 
            revision_id=revision_id, stacked_on=stacked_on,
1394
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1019
            revision_id=revision_id, stacked_on=stacked_on)
1395
1020
        return dir_to.open_branch()
1396
1021
 
1397
1022
    def create_checkout(self, to_location, revision_id=None,
1416
1041
        if lightweight:
1417
1042
            format = self._get_checkout_format()
1418
1043
            checkout = format.initialize_on_transport(t)
1419
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1420
 
                target_branch=self)
 
1044
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1421
1045
        else:
1422
1046
            format = self._get_checkout_format()
1423
1047
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1452
1076
        reconciler.reconcile()
1453
1077
        return reconciler
1454
1078
 
1455
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1079
    def reference_parent(self, file_id, path):
1456
1080
        """Return the parent branch for a tree-reference file_id
1457
1081
        :param file_id: The file_id of the tree reference
1458
1082
        :param path: The path of the file_id in the tree
1459
1083
        :return: A branch associated with the file_id
1460
1084
        """
1461
1085
        # FIXME should provide multiple branches, based on config
1462
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1463
 
                           possible_transports=possible_transports)
 
1086
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1464
1087
 
1465
1088
    def supports_tags(self):
1466
1089
        return self._format.supports_tags()
1467
1090
 
1468
 
    def automatic_tag_name(self, revision_id):
1469
 
        """Try to automatically find the tag name for a revision.
1470
 
 
1471
 
        :param revision_id: Revision id of the revision.
1472
 
        :return: A tag name or None if no tag name could be determined.
1473
 
        """
1474
 
        for hook in Branch.hooks['automatic_tag_name']:
1475
 
            ret = hook(self, revision_id)
1476
 
            if ret is not None:
1477
 
                return ret
1478
 
        return None
1479
 
 
1480
1091
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1481
1092
                                         other_branch):
1482
1093
        """Ensure that revision_b is a descendant of revision_a.
1537
1148
    _formats = {}
1538
1149
    """The known formats."""
1539
1150
 
1540
 
    can_set_append_revisions_only = True
1541
 
 
1542
1151
    def __eq__(self, other):
1543
1152
        return self.__class__ is other.__class__
1544
1153
 
1546
1155
        return not (self == other)
1547
1156
 
1548
1157
    @classmethod
1549
 
    def find_format(klass, a_bzrdir, name=None):
 
1158
    def find_format(klass, a_bzrdir):
1550
1159
        """Return the format for the branch object in a_bzrdir."""
1551
1160
        try:
1552
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1553
 
            format_string = transport.get_bytes("format")
1554
 
            format = klass._formats[format_string]
1555
 
            if isinstance(format, MetaDirBranchFormatFactory):
1556
 
                return format()
1557
 
            return format
 
1161
            transport = a_bzrdir.get_branch_transport(None)
 
1162
            format_string = transport.get("format").read()
 
1163
            return klass._formats[format_string]
1558
1164
        except errors.NoSuchFile:
1559
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1165
            raise errors.NotBranchError(path=transport.base)
1560
1166
        except KeyError:
1561
1167
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1562
1168
 
1565
1171
        """Return the current default format."""
1566
1172
        return klass._default_format
1567
1173
 
1568
 
    @classmethod
1569
 
    def get_formats(klass):
1570
 
        """Get all the known formats.
1571
 
 
1572
 
        Warning: This triggers a load of all lazy registered formats: do not
1573
 
        use except when that is desireed.
1574
 
        """
1575
 
        result = []
1576
 
        for fmt in klass._formats.values():
1577
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1578
 
                fmt = fmt()
1579
 
            result.append(fmt)
1580
 
        return result
1581
 
 
1582
 
    def get_reference(self, a_bzrdir, name=None):
 
1174
    def get_reference(self, a_bzrdir):
1583
1175
        """Get the target reference of the branch in a_bzrdir.
1584
1176
 
1585
1177
        format probing must have been completed before calling
1587
1179
        in a_bzrdir is correct.
1588
1180
 
1589
1181
        :param a_bzrdir: The bzrdir to get the branch data from.
1590
 
        :param name: Name of the colocated branch to fetch
1591
1182
        :return: None if the branch is not a reference branch.
1592
1183
        """
1593
1184
        return None
1594
1185
 
1595
1186
    @classmethod
1596
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1187
    def set_reference(self, a_bzrdir, to_branch):
1597
1188
        """Set the target reference of the branch in a_bzrdir.
1598
1189
 
1599
1190
        format probing must have been completed before calling
1601
1192
        in a_bzrdir is correct.
1602
1193
 
1603
1194
        :param a_bzrdir: The bzrdir to set the branch reference for.
1604
 
        :param name: Name of colocated branch to set, None for default
1605
1195
        :param to_branch: branch that the checkout is to reference
1606
1196
        """
1607
1197
        raise NotImplementedError(self.set_reference)
1614
1204
        """Return the short format description for this format."""
1615
1205
        raise NotImplementedError(self.get_format_description)
1616
1206
 
1617
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1618
 
        hooks = Branch.hooks['post_branch_init']
1619
 
        if not hooks:
1620
 
            return
1621
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1622
 
        for hook in hooks:
1623
 
            hook(params)
1624
 
 
1625
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
 
                           lock_type='metadir', set_format=True):
 
1207
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1208
                           set_format=True):
1627
1209
        """Initialize a branch in a bzrdir, with specified files
1628
1210
 
1629
1211
        :param a_bzrdir: The bzrdir to initialize the branch in
1630
1212
        :param utf8_files: The files to create as a list of
1631
1213
            (filename, content) tuples
1632
 
        :param name: Name of colocated branch to create, if any
1633
1214
        :param set_format: If True, set the format with
1634
1215
            self.get_format_string.  (BzrBranch4 has its format set
1635
1216
            elsewhere)
1636
1217
        :return: a branch in this format
1637
1218
        """
1638
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1219
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1220
        branch_transport = a_bzrdir.get_branch_transport(self)
1640
1221
        lock_map = {
1641
1222
            'metadir': ('lock', lockdir.LockDir),
1642
1223
            'branch4': ('branch-lock', lockable_files.TransportLock),
1645
1226
        control_files = lockable_files.LockableFiles(branch_transport,
1646
1227
            lock_name, lock_class)
1647
1228
        control_files.create_lock()
1648
 
        try:
1649
 
            control_files.lock_write()
1650
 
        except errors.LockContention:
1651
 
            if lock_type != 'branch4':
1652
 
                raise
1653
 
            lock_taken = False
1654
 
        else:
1655
 
            lock_taken = True
 
1229
        control_files.lock_write()
1656
1230
        if set_format:
1657
1231
            utf8_files += [('format', self.get_format_string())]
1658
1232
        try:
1661
1235
                    filename, content,
1662
1236
                    mode=a_bzrdir._get_file_mode())
1663
1237
        finally:
1664
 
            if lock_taken:
1665
 
                control_files.unlock()
1666
 
        branch = self.open(a_bzrdir, name, _found=True)
1667
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1668
 
        return branch
 
1238
            control_files.unlock()
 
1239
        return self.open(a_bzrdir, _found=True)
1669
1240
 
1670
 
    def initialize(self, a_bzrdir, name=None):
1671
 
        """Create a branch of this format in a_bzrdir.
1672
 
        
1673
 
        :param name: Name of the colocated branch to create.
1674
 
        """
 
1241
    def initialize(self, a_bzrdir):
 
1242
        """Create a branch of this format in a_bzrdir."""
1675
1243
        raise NotImplementedError(self.initialize)
1676
1244
 
1677
1245
    def is_supported(self):
1683
1251
        """
1684
1252
        return True
1685
1253
 
1686
 
    def make_tags(self, branch):
1687
 
        """Create a tags object for branch.
1688
 
 
1689
 
        This method is on BranchFormat, because BranchFormats are reflected
1690
 
        over the wire via network_name(), whereas full Branch instances require
1691
 
        multiple VFS method calls to operate at all.
1692
 
 
1693
 
        The default implementation returns a disabled-tags instance.
1694
 
 
1695
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1696
 
        on a RemoteBranch.
1697
 
        """
1698
 
        return DisabledTags(branch)
1699
 
 
1700
1254
    def network_name(self):
1701
1255
        """A simple byte string uniquely identifying this format for RPC calls.
1702
1256
 
1707
1261
        """
1708
1262
        raise NotImplementedError(self.network_name)
1709
1263
 
1710
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1264
    def open(self, a_bzrdir, _found=False):
1711
1265
        """Return the branch object for a_bzrdir
1712
1266
 
1713
 
        :param a_bzrdir: A BzrDir that contains a branch.
1714
 
        :param name: Name of colocated branch to open
1715
 
        :param _found: a private parameter, do not use it. It is used to
1716
 
            indicate if format probing has already be done.
1717
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1718
 
            (if there are any).  Default is to open fallbacks.
 
1267
        _found is a private parameter, do not use it. It is used to indicate
 
1268
               if format probing has already be done.
1719
1269
        """
1720
1270
        raise NotImplementedError(self.open)
1721
1271
 
1722
1272
    @classmethod
1723
1273
    def register_format(klass, format):
1724
 
        """Register a metadir format.
1725
 
        
1726
 
        See MetaDirBranchFormatFactory for the ability to register a format
1727
 
        without loading the code the format needs until it is actually used.
1728
 
        """
 
1274
        """Register a metadir format."""
1729
1275
        klass._formats[format.get_format_string()] = format
1730
 
        # Metadir formats have a network name of their format string, and get
1731
 
        # registered as factories.
1732
 
        if isinstance(format, MetaDirBranchFormatFactory):
1733
 
            network_format_registry.register(format.get_format_string(), format)
1734
 
        else:
1735
 
            network_format_registry.register(format.get_format_string(),
1736
 
                format.__class__)
 
1276
        # Metadir formats have a network name of their format string.
 
1277
        network_format_registry.register(format.get_format_string(), format)
1737
1278
 
1738
1279
    @classmethod
1739
1280
    def set_default_format(klass, format):
1740
1281
        klass._default_format = format
1741
1282
 
1742
 
    def supports_set_append_revisions_only(self):
1743
 
        """True if this format supports set_append_revisions_only."""
1744
 
        return False
1745
 
 
1746
1283
    def supports_stacking(self):
1747
1284
        """True if this format records a stacked-on branch."""
1748
1285
        return False
1759
1296
        return False  # by default
1760
1297
 
1761
1298
 
1762
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1764
 
    
1765
 
    While none of the built in BranchFormats are lazy registered yet,
1766
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
 
    use it, and the bzr-loom plugin uses it as well (see
1768
 
    bzrlib.plugins.loom.formats).
1769
 
    """
1770
 
 
1771
 
    def __init__(self, format_string, module_name, member_name):
1772
 
        """Create a MetaDirBranchFormatFactory.
1773
 
 
1774
 
        :param format_string: The format string the format has.
1775
 
        :param module_name: Module to load the format class from.
1776
 
        :param member_name: Attribute name within the module for the format class.
1777
 
        """
1778
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
 
        self._format_string = format_string
1780
 
        
1781
 
    def get_format_string(self):
1782
 
        """See BranchFormat.get_format_string."""
1783
 
        return self._format_string
1784
 
 
1785
 
    def __call__(self):
1786
 
        """Used for network_format_registry support."""
1787
 
        return self.get_obj()()
1788
 
 
1789
 
 
1790
1299
class BranchHooks(Hooks):
1791
1300
    """A dictionary mapping hook name to a list of callables for branch hooks.
1792
1301
 
1801
1310
        notified.
1802
1311
        """
1803
1312
        Hooks.__init__(self)
1804
 
        self.create_hook(HookPoint('set_rh',
1805
 
            "Invoked whenever the revision history has been set via "
1806
 
            "set_revision_history. The api signature is (branch, "
1807
 
            "revision_history), and the branch will be write-locked. "
1808
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1809
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1810
 
        self.create_hook(HookPoint('open',
1811
 
            "Called with the Branch object that has been opened after a "
1812
 
            "branch is opened.", (1, 8), None))
1813
 
        self.create_hook(HookPoint('post_push',
1814
 
            "Called after a push operation completes. post_push is called "
1815
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
 
            "bzr client.", (0, 15), None))
1817
 
        self.create_hook(HookPoint('post_pull',
1818
 
            "Called after a pull operation completes. post_pull is called "
1819
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1820
 
            "bzr client.", (0, 15), None))
1821
 
        self.create_hook(HookPoint('pre_commit',
1822
 
            "Called after a commit is calculated but before it is is "
1823
 
            "completed. pre_commit is called with (local, master, old_revno, "
1824
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1825
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1826
 
            "tree_delta is a TreeDelta object describing changes from the "
1827
 
            "basis revision. hooks MUST NOT modify this delta. "
1828
 
            " future_tree is an in-memory tree obtained from "
1829
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1830
 
            "tree.", (0,91), None))
1831
 
        self.create_hook(HookPoint('post_commit',
1832
 
            "Called in the bzr client after a commit has completed. "
1833
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1834
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
 
            "commit to a branch.", (0, 15), None))
1836
 
        self.create_hook(HookPoint('post_uncommit',
1837
 
            "Called in the bzr client after an uncommit completes. "
1838
 
            "post_uncommit is called with (local, master, old_revno, "
1839
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1840
 
            "or None, master is the target branch, and an empty branch "
1841
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1842
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1843
 
            "Called in bzr client and server before a change to the tip of a "
1844
 
            "branch is made. pre_change_branch_tip is called with a "
1845
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1847
 
        self.create_hook(HookPoint('post_change_branch_tip',
1848
 
            "Called in bzr client and server after a change to the tip of a "
1849
 
            "branch is made. post_change_branch_tip is called with a "
1850
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1852
 
        self.create_hook(HookPoint('transform_fallback_location',
1853
 
            "Called when a stacked branch is activating its fallback "
1854
 
            "locations. transform_fallback_location is called with (branch, "
1855
 
            "url), and should return a new url. Returning the same url "
1856
 
            "allows it to be used as-is, returning a different one can be "
1857
 
            "used to cause the branch to stack on a closer copy of that "
1858
 
            "fallback_location. Note that the branch cannot have history "
1859
 
            "accessing methods called on it during this hook because the "
1860
 
            "fallback locations have not been activated. When there are "
1861
 
            "multiple hooks installed for transform_fallback_location, "
1862
 
            "all are called with the url returned from the previous hook."
1863
 
            "The order is however undefined.", (1, 9), None))
1864
 
        self.create_hook(HookPoint('automatic_tag_name',
1865
 
            "Called to determine an automatic tag name for a revision. "
1866
 
            "automatic_tag_name is called with (branch, revision_id) and "
1867
 
            "should return a tag name or None if no tag name could be "
1868
 
            "determined. The first non-None tag name returned will be used.",
1869
 
            (2, 2), None))
1870
 
        self.create_hook(HookPoint('post_branch_init',
1871
 
            "Called after new branch initialization completes. "
1872
 
            "post_branch_init is called with a "
1873
 
            "bzrlib.branch.BranchInitHookParams. "
1874
 
            "Note that init, branch and checkout (both heavyweight and "
1875
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1876
 
        self.create_hook(HookPoint('post_switch',
1877
 
            "Called after a checkout switches branch. "
1878
 
            "post_switch is called with a "
1879
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1880
 
 
 
1313
        # Introduced in 0.15:
 
1314
        # invoked whenever the revision history has been set
 
1315
        # with set_revision_history. The api signature is
 
1316
        # (branch, revision_history), and the branch will
 
1317
        # be write-locked.
 
1318
        self['set_rh'] = []
 
1319
        # Invoked after a branch is opened. The api signature is (branch).
 
1320
        self['open'] = []
 
1321
        # invoked after a push operation completes.
 
1322
        # the api signature is
 
1323
        # (push_result)
 
1324
        # containing the members
 
1325
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1326
        # where local is the local target branch or None, master is the target
 
1327
        # master branch, and the rest should be self explanatory. The source
 
1328
        # is read locked and the target branches write locked. Source will
 
1329
        # be the local low-latency branch.
 
1330
        self['post_push'] = []
 
1331
        # invoked after a pull operation completes.
 
1332
        # the api signature is
 
1333
        # (pull_result)
 
1334
        # containing the members
 
1335
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1336
        # where local is the local branch or None, master is the target
 
1337
        # master branch, and the rest should be self explanatory. The source
 
1338
        # is read locked and the target branches write locked. The local
 
1339
        # branch is the low-latency branch.
 
1340
        self['post_pull'] = []
 
1341
        # invoked before a commit operation takes place.
 
1342
        # the api signature is
 
1343
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1344
        #  tree_delta, future_tree).
 
1345
        # old_revid is NULL_REVISION for the first commit to a branch
 
1346
        # tree_delta is a TreeDelta object describing changes from the basis
 
1347
        # revision, hooks MUST NOT modify this delta
 
1348
        # future_tree is an in-memory tree obtained from
 
1349
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1350
        self['pre_commit'] = []
 
1351
        # invoked after a commit operation completes.
 
1352
        # the api signature is
 
1353
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1354
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1355
        self['post_commit'] = []
 
1356
        # invoked after a uncommit operation completes.
 
1357
        # the api signature is
 
1358
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1359
        # local is the local branch or None, master is the target branch,
 
1360
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1361
        self['post_uncommit'] = []
 
1362
        # Introduced in 1.6
 
1363
        # Invoked before 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['pre_change_branch_tip'] = []
 
1368
        # Introduced in 1.4
 
1369
        # Invoked after the tip of a branch changes.
 
1370
        # the api signature is
 
1371
        # (params) where params is a ChangeBranchTipParams with the members
 
1372
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1373
        self['post_change_branch_tip'] = []
 
1374
        # Introduced in 1.9
 
1375
        # Invoked when a stacked branch activates its fallback locations and
 
1376
        # allows the transformation of the url of said location.
 
1377
        # the api signature is
 
1378
        # (branch, url) where branch is the branch having its fallback
 
1379
        # location activated and url is the url for the fallback location.
 
1380
        # The hook should return a url.
 
1381
        self['transform_fallback_location'] = []
1881
1382
 
1882
1383
 
1883
1384
# install the default hooks into the Branch class.
1922
1423
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1923
1424
 
1924
1425
 
1925
 
class BranchInitHookParams(object):
1926
 
    """Object holding parameters passed to *_branch_init hooks.
1927
 
 
1928
 
    There are 4 fields that hooks may wish to access:
1929
 
 
1930
 
    :ivar format: the branch format
1931
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1932
 
    :ivar name: name of colocated branch, if any (or None)
1933
 
    :ivar branch: the branch created
1934
 
 
1935
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
 
    the checkout, hence they are different from the corresponding fields in
1937
 
    branch, which refer to the original branch.
1938
 
    """
1939
 
 
1940
 
    def __init__(self, format, a_bzrdir, name, branch):
1941
 
        """Create a group of BranchInitHook parameters.
1942
 
 
1943
 
        :param format: the branch format
1944
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1945
 
            initialized
1946
 
        :param name: name of colocated branch, if any (or None)
1947
 
        :param branch: the branch created
1948
 
 
1949
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1950
 
        to the checkout, hence they are different from the corresponding fields
1951
 
        in branch, which refer to the original branch.
1952
 
        """
1953
 
        self.format = format
1954
 
        self.bzrdir = a_bzrdir
1955
 
        self.name = name
1956
 
        self.branch = branch
1957
 
 
1958
 
    def __eq__(self, other):
1959
 
        return self.__dict__ == other.__dict__
1960
 
 
1961
 
    def __repr__(self):
1962
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
 
1964
 
 
1965
 
class SwitchHookParams(object):
1966
 
    """Object holding parameters passed to *_switch hooks.
1967
 
 
1968
 
    There are 4 fields that hooks may wish to access:
1969
 
 
1970
 
    :ivar control_dir: BzrDir of the checkout to change
1971
 
    :ivar to_branch: branch that the checkout is to reference
1972
 
    :ivar force: skip the check for local commits in a heavy checkout
1973
 
    :ivar revision_id: revision ID to switch to (or None)
1974
 
    """
1975
 
 
1976
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1977
 
        """Create a group of SwitchHook parameters.
1978
 
 
1979
 
        :param control_dir: BzrDir of the checkout to change
1980
 
        :param to_branch: branch that the checkout is to reference
1981
 
        :param force: skip the check for local commits in a heavy checkout
1982
 
        :param revision_id: revision ID to switch to (or None)
1983
 
        """
1984
 
        self.control_dir = control_dir
1985
 
        self.to_branch = to_branch
1986
 
        self.force = force
1987
 
        self.revision_id = revision_id
1988
 
 
1989
 
    def __eq__(self, other):
1990
 
        return self.__dict__ == other.__dict__
1991
 
 
1992
 
    def __repr__(self):
1993
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
 
            self.control_dir, self.to_branch,
1995
 
            self.revision_id)
1996
 
 
1997
 
 
1998
1426
class BzrBranchFormat4(BranchFormat):
1999
1427
    """Bzr branch format 4.
2000
1428
 
2007
1435
        """See BranchFormat.get_format_description()."""
2008
1436
        return "Branch format 4"
2009
1437
 
2010
 
    def initialize(self, a_bzrdir, name=None):
 
1438
    def initialize(self, a_bzrdir):
2011
1439
        """Create a branch of this format in a_bzrdir."""
2012
1440
        utf8_files = [('revision-history', ''),
2013
1441
                      ('branch-name', ''),
2014
1442
                      ]
2015
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1443
        return self._initialize_helper(a_bzrdir, utf8_files,
2016
1444
                                       lock_type='branch4', set_format=False)
2017
1445
 
2018
1446
    def __init__(self):
2023
1451
        """The network name for this format is the control dirs disk label."""
2024
1452
        return self._matchingbzrdir.get_format_string()
2025
1453
 
2026
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
 
        """See BranchFormat.open()."""
 
1454
    def open(self, a_bzrdir, _found=False):
 
1455
        """Return the branch object for a_bzrdir
 
1456
 
 
1457
        _found is a private parameter, do not use it. It is used to indicate
 
1458
               if format probing has already be done.
 
1459
        """
2028
1460
        if not _found:
2029
1461
            # we are being called directly and must probe.
2030
1462
            raise NotImplementedError
2031
1463
        return BzrBranch(_format=self,
2032
1464
                         _control_files=a_bzrdir._control_files,
2033
1465
                         a_bzrdir=a_bzrdir,
2034
 
                         name=name,
2035
1466
                         _repository=a_bzrdir.open_repository())
2036
1467
 
2037
1468
    def __str__(self):
2052
1483
        """
2053
1484
        return self.get_format_string()
2054
1485
 
2055
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2056
 
        """See BranchFormat.open()."""
 
1486
    def open(self, a_bzrdir, _found=False):
 
1487
        """Return the branch object for a_bzrdir.
 
1488
 
 
1489
        _found is a private parameter, do not use it. It is used to indicate
 
1490
               if format probing has already be done.
 
1491
        """
2057
1492
        if not _found:
2058
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1493
            format = BranchFormat.find_format(a_bzrdir)
2059
1494
            if format.__class__ != self.__class__:
2060
1495
                raise AssertionError("wrong format %r found for %r" %
2061
1496
                    (format, self))
2062
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2063
1497
        try:
 
1498
            transport = a_bzrdir.get_branch_transport(None)
2064
1499
            control_files = lockable_files.LockableFiles(transport, 'lock',
2065
1500
                                                         lockdir.LockDir)
2066
1501
            return self._branch_class()(_format=self,
2067
1502
                              _control_files=control_files,
2068
 
                              name=name,
2069
1503
                              a_bzrdir=a_bzrdir,
2070
 
                              _repository=a_bzrdir.find_repository(),
2071
 
                              ignore_fallbacks=ignore_fallbacks)
 
1504
                              _repository=a_bzrdir.find_repository())
2072
1505
        except errors.NoSuchFile:
2073
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1506
            raise errors.NotBranchError(path=transport.base)
2074
1507
 
2075
1508
    def __init__(self):
2076
1509
        super(BranchFormatMetadir, self).__init__()
2105
1538
        """See BranchFormat.get_format_description()."""
2106
1539
        return "Branch format 5"
2107
1540
 
2108
 
    def initialize(self, a_bzrdir, name=None):
 
1541
    def initialize(self, a_bzrdir):
2109
1542
        """Create a branch of this format in a_bzrdir."""
2110
1543
        utf8_files = [('revision-history', ''),
2111
1544
                      ('branch-name', ''),
2112
1545
                      ]
2113
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1546
        return self._initialize_helper(a_bzrdir, utf8_files)
2114
1547
 
2115
1548
    def supports_tags(self):
2116
1549
        return False
2138
1571
        """See BranchFormat.get_format_description()."""
2139
1572
        return "Branch format 6"
2140
1573
 
2141
 
    def initialize(self, a_bzrdir, name=None):
2142
 
        """Create a branch of this format in a_bzrdir."""
2143
 
        utf8_files = [('last-revision', '0 null:\n'),
2144
 
                      ('branch.conf', ''),
2145
 
                      ('tags', ''),
2146
 
                      ]
2147
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2148
 
 
2149
 
    def make_tags(self, branch):
2150
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2151
 
        return BasicTags(branch)
2152
 
 
2153
 
    def supports_set_append_revisions_only(self):
2154
 
        return True
2155
 
 
2156
 
 
2157
 
class BzrBranchFormat8(BranchFormatMetadir):
2158
 
    """Metadir format supporting storing locations of subtree branches."""
2159
 
 
2160
 
    def _branch_class(self):
2161
 
        return BzrBranch8
2162
 
 
2163
 
    def get_format_string(self):
2164
 
        """See BranchFormat.get_format_string()."""
2165
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2166
 
 
2167
 
    def get_format_description(self):
2168
 
        """See BranchFormat.get_format_description()."""
2169
 
        return "Branch format 8"
2170
 
 
2171
 
    def initialize(self, a_bzrdir, name=None):
2172
 
        """Create a branch of this format in a_bzrdir."""
2173
 
        utf8_files = [('last-revision', '0 null:\n'),
2174
 
                      ('branch.conf', ''),
2175
 
                      ('tags', ''),
2176
 
                      ('references', '')
2177
 
                      ]
2178
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2179
 
 
2180
 
    def __init__(self):
2181
 
        super(BzrBranchFormat8, self).__init__()
2182
 
        self._matchingbzrdir.repository_format = \
2183
 
            RepositoryFormatKnitPack5RichRoot()
2184
 
 
2185
 
    def make_tags(self, branch):
2186
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2187
 
        return BasicTags(branch)
2188
 
 
2189
 
    def supports_set_append_revisions_only(self):
2190
 
        return True
2191
 
 
2192
 
    def supports_stacking(self):
2193
 
        return True
2194
 
 
2195
 
    supports_reference_locations = True
2196
 
 
2197
 
 
2198
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1574
    def initialize(self, a_bzrdir):
 
1575
        """Create a branch of this format in a_bzrdir."""
 
1576
        utf8_files = [('last-revision', '0 null:\n'),
 
1577
                      ('branch.conf', ''),
 
1578
                      ('tags', ''),
 
1579
                      ]
 
1580
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1581
 
 
1582
 
 
1583
class BzrBranchFormat7(BranchFormatMetadir):
2199
1584
    """Branch format with last-revision, tags, and a stacked location pointer.
2200
1585
 
2201
1586
    The stacked location pointer is passed down to the repository and requires
2204
1589
    This format was introduced in bzr 1.6.
2205
1590
    """
2206
1591
 
2207
 
    def initialize(self, a_bzrdir, name=None):
2208
 
        """Create a branch of this format in a_bzrdir."""
2209
 
        utf8_files = [('last-revision', '0 null:\n'),
2210
 
                      ('branch.conf', ''),
2211
 
                      ('tags', ''),
2212
 
                      ]
2213
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2214
 
 
2215
1592
    def _branch_class(self):
2216
1593
        return BzrBranch7
2217
1594
 
2223
1600
        """See BranchFormat.get_format_description()."""
2224
1601
        return "Branch format 7"
2225
1602
 
2226
 
    def supports_set_append_revisions_only(self):
 
1603
    def initialize(self, a_bzrdir):
 
1604
        """Create a branch of this format in a_bzrdir."""
 
1605
        utf8_files = [('last-revision', '0 null:\n'),
 
1606
                      ('branch.conf', ''),
 
1607
                      ('tags', ''),
 
1608
                      ]
 
1609
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1610
 
 
1611
    def __init__(self):
 
1612
        super(BzrBranchFormat7, self).__init__()
 
1613
        self._matchingbzrdir.repository_format = \
 
1614
            RepositoryFormatKnitPack5RichRoot()
 
1615
 
 
1616
    def supports_stacking(self):
2227
1617
        return True
2228
1618
 
2229
 
    supports_reference_locations = False
2230
 
 
2231
1619
 
2232
1620
class BranchReferenceFormat(BranchFormat):
2233
1621
    """Bzr branch reference format.
2248
1636
        """See BranchFormat.get_format_description()."""
2249
1637
        return "Checkout reference format 1"
2250
1638
 
2251
 
    def get_reference(self, a_bzrdir, name=None):
 
1639
    def get_reference(self, a_bzrdir):
2252
1640
        """See BranchFormat.get_reference()."""
2253
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2254
 
        return transport.get_bytes('location')
 
1641
        transport = a_bzrdir.get_branch_transport(None)
 
1642
        return transport.get('location').read()
2255
1643
 
2256
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1644
    def set_reference(self, a_bzrdir, to_branch):
2257
1645
        """See BranchFormat.set_reference()."""
2258
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1646
        transport = a_bzrdir.get_branch_transport(None)
2259
1647
        location = transport.put_bytes('location', to_branch.base)
2260
1648
 
2261
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1649
    def initialize(self, a_bzrdir, target_branch=None):
2262
1650
        """Create a branch of this format in a_bzrdir."""
2263
1651
        if target_branch is None:
2264
1652
            # this format does not implement branch itself, thus the implicit
2265
1653
            # creation contract must see it as uninitializable
2266
1654
            raise errors.UninitializableFormat(self)
2267
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1655
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1656
        branch_transport = a_bzrdir.get_branch_transport(self)
2269
1657
        branch_transport.put_bytes('location',
2270
 
            target_branch.bzrdir.user_url)
 
1658
            target_branch.bzrdir.root_transport.base)
2271
1659
        branch_transport.put_bytes('format', self.get_format_string())
2272
 
        branch = self.open(
2273
 
            a_bzrdir, name, _found=True,
 
1660
        return self.open(
 
1661
            a_bzrdir, _found=True,
2274
1662
            possible_transports=[target_branch.bzrdir.root_transport])
2275
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2276
 
        return branch
2277
1663
 
2278
1664
    def __init__(self):
2279
1665
        super(BranchReferenceFormat, self).__init__()
2285
1671
        def clone(to_bzrdir, revision_id=None,
2286
1672
            repository_policy=None):
2287
1673
            """See Branch.clone()."""
2288
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1674
            return format.initialize(to_bzrdir, a_branch)
2289
1675
            # cannot obey revision_id limits when cloning a reference ...
2290
1676
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2291
1677
            # emit some sort of warning/error to the caller ?!
2292
1678
        return clone
2293
1679
 
2294
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
 
             possible_transports=None, ignore_fallbacks=False):
 
1680
    def open(self, a_bzrdir, _found=False, location=None,
 
1681
             possible_transports=None):
2296
1682
        """Return the branch that the branch reference in a_bzrdir points at.
2297
1683
 
2298
 
        :param a_bzrdir: A BzrDir that contains a branch.
2299
 
        :param name: Name of colocated branch to open, if any
2300
 
        :param _found: a private parameter, do not use it. It is used to
2301
 
            indicate if format probing has already be done.
2302
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2303
 
            (if there are any).  Default is to open fallbacks.
2304
 
        :param location: The location of the referenced branch.  If
2305
 
            unspecified, this will be determined from the branch reference in
2306
 
            a_bzrdir.
2307
 
        :param possible_transports: An optional reusable transports list.
 
1684
        _found is a private parameter, do not use it. It is used to indicate
 
1685
               if format probing has already be done.
2308
1686
        """
2309
1687
        if not _found:
2310
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1688
            format = BranchFormat.find_format(a_bzrdir)
2311
1689
            if format.__class__ != self.__class__:
2312
1690
                raise AssertionError("wrong format %r found for %r" %
2313
1691
                    (format, self))
2314
1692
        if location is None:
2315
 
            location = self.get_reference(a_bzrdir, name)
 
1693
            location = self.get_reference(a_bzrdir)
2316
1694
        real_bzrdir = bzrdir.BzrDir.open(
2317
1695
            location, possible_transports=possible_transports)
2318
 
        result = real_bzrdir.open_branch(name=name, 
2319
 
            ignore_fallbacks=ignore_fallbacks)
 
1696
        result = real_bzrdir.open_branch()
2320
1697
        # this changes the behaviour of result.clone to create a new reference
2321
1698
        # rather than a copy of the content of the branch.
2322
1699
        # I did not use a proxy object because that needs much more extensive
2332
1709
network_format_registry = registry.FormatRegistry()
2333
1710
"""Registry of formats indexed by their network name.
2334
1711
 
2335
 
The network name for a branch format is an identifier that can be used when
 
1712
The network name for a repository format is an identifier that can be used when
2336
1713
referring to formats with smart server operations. See
2337
1714
BranchFormat.network_name() for more detail.
2338
1715
"""
2343
1720
__format5 = BzrBranchFormat5()
2344
1721
__format6 = BzrBranchFormat6()
2345
1722
__format7 = BzrBranchFormat7()
2346
 
__format8 = BzrBranchFormat8()
2347
1723
BranchFormat.register_format(__format5)
2348
1724
BranchFormat.register_format(BranchReferenceFormat())
2349
1725
BranchFormat.register_format(__format6)
2350
1726
BranchFormat.register_format(__format7)
2351
 
BranchFormat.register_format(__format8)
2352
 
BranchFormat.set_default_format(__format7)
 
1727
BranchFormat.set_default_format(__format6)
2353
1728
_legacy_formats = [BzrBranchFormat4(),
2354
1729
    ]
2355
1730
network_format_registry.register(
2356
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2357
 
 
2358
 
 
2359
 
class BranchWriteLockResult(LogicalLockResult):
2360
 
    """The result of write locking a branch.
2361
 
 
2362
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2363
 
        None.
2364
 
    :ivar unlock: A callable which will unlock the lock.
2365
 
    """
2366
 
 
2367
 
    def __init__(self, unlock, branch_token):
2368
 
        LogicalLockResult.__init__(self, unlock)
2369
 
        self.branch_token = branch_token
2370
 
 
2371
 
    def __repr__(self):
2372
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2373
 
            self.unlock)
2374
 
 
2375
 
 
2376
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1731
    _legacy_formats[0].network_name(), _legacy_formats[0])
 
1732
 
 
1733
 
 
1734
class BzrBranch(Branch):
2377
1735
    """A branch stored in the actual filesystem.
2378
1736
 
2379
1737
    Note that it's "local" in the context of the filesystem; it doesn't
2385
1743
    :ivar repository: Repository for this branch.
2386
1744
    :ivar base: The url of the base directory for this branch; the one
2387
1745
        containing the .bzr directory.
2388
 
    :ivar name: Optional colocated branch name as it exists in the control
2389
 
        directory.
2390
1746
    """
2391
1747
 
2392
1748
    def __init__(self, _format=None,
2393
 
                 _control_files=None, a_bzrdir=None, name=None,
2394
 
                 _repository=None, ignore_fallbacks=False):
 
1749
                 _control_files=None, a_bzrdir=None, _repository=None):
2395
1750
        """Create new branch object at a particular location."""
2396
1751
        if a_bzrdir is None:
2397
1752
            raise ValueError('a_bzrdir must be supplied')
2398
1753
        else:
2399
1754
            self.bzrdir = a_bzrdir
2400
1755
        self._base = self.bzrdir.transport.clone('..').base
2401
 
        self.name = name
2402
1756
        # XXX: We should be able to just do
2403
1757
        #   self.base = self.bzrdir.root_transport.base
2404
1758
        # but this does not quite work yet -- mbp 20080522
2411
1765
        Branch.__init__(self)
2412
1766
 
2413
1767
    def __str__(self):
2414
 
        if self.name is None:
2415
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2416
 
        else:
2417
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2418
 
                self.name)
 
1768
        return '%s(%r)' % (self.__class__.__name__, self.base)
2419
1769
 
2420
1770
    __repr__ = __str__
2421
1771
 
2425
1775
 
2426
1776
    base = property(_get_base, doc="The URL for the root of this branch.")
2427
1777
 
2428
 
    def _get_config(self):
2429
 
        return TransportConfig(self._transport, 'branch.conf')
2430
 
 
2431
1778
    def is_locked(self):
2432
1779
        return self.control_files.is_locked()
2433
1780
 
2434
1781
    def lock_write(self, token=None):
2435
 
        """Lock the branch for write operations.
2436
 
 
2437
 
        :param token: A token to permit reacquiring a previously held and
2438
 
            preserved lock.
2439
 
        :return: A BranchWriteLockResult.
2440
 
        """
2441
 
        if not self.is_locked():
2442
 
            self._note_lock('w')
2443
 
        # All-in-one needs to always unlock/lock.
2444
 
        repo_control = getattr(self.repository, 'control_files', None)
2445
 
        if self.control_files == repo_control or not self.is_locked():
2446
 
            self.repository._warn_if_deprecated(self)
2447
 
            self.repository.lock_write()
2448
 
            took_lock = True
2449
 
        else:
2450
 
            took_lock = False
 
1782
        repo_token = self.repository.lock_write()
2451
1783
        try:
2452
 
            return BranchWriteLockResult(self.unlock,
2453
 
                self.control_files.lock_write(token=token))
 
1784
            token = self.control_files.lock_write(token=token)
2454
1785
        except:
2455
 
            if took_lock:
2456
 
                self.repository.unlock()
 
1786
            self.repository.unlock()
2457
1787
            raise
 
1788
        return token
2458
1789
 
2459
1790
    def lock_read(self):
2460
 
        """Lock the branch for read operations.
2461
 
 
2462
 
        :return: A bzrlib.lock.LogicalLockResult.
2463
 
        """
2464
 
        if not self.is_locked():
2465
 
            self._note_lock('r')
2466
 
        # All-in-one needs to always unlock/lock.
2467
 
        repo_control = getattr(self.repository, 'control_files', None)
2468
 
        if self.control_files == repo_control or not self.is_locked():
2469
 
            self.repository._warn_if_deprecated(self)
2470
 
            self.repository.lock_read()
2471
 
            took_lock = True
2472
 
        else:
2473
 
            took_lock = False
 
1791
        self.repository.lock_read()
2474
1792
        try:
2475
1793
            self.control_files.lock_read()
2476
 
            return LogicalLockResult(self.unlock)
2477
1794
        except:
2478
 
            if took_lock:
2479
 
                self.repository.unlock()
 
1795
            self.repository.unlock()
2480
1796
            raise
2481
1797
 
2482
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2483
1798
    def unlock(self):
 
1799
        # TODO: test for failed two phase locks. This is known broken.
2484
1800
        try:
2485
1801
            self.control_files.unlock()
2486
1802
        finally:
2487
 
            # All-in-one needs to always unlock/lock.
2488
 
            repo_control = getattr(self.repository, 'control_files', None)
2489
 
            if (self.control_files == repo_control or
2490
 
                not self.control_files.is_locked()):
2491
 
                self.repository.unlock()
2492
 
            if not self.control_files.is_locked():
2493
 
                # we just released the lock
2494
 
                self._clear_cached_state()
 
1803
            self.repository.unlock()
 
1804
        if not self.control_files.is_locked():
 
1805
            # we just released the lock
 
1806
            self._clear_cached_state()
2495
1807
 
2496
1808
    def peek_lock_mode(self):
2497
1809
        if self.control_files._lock_count == 0:
2616
1928
        """See Branch.basis_tree."""
2617
1929
        return self.repository.revision_tree(self.last_revision())
2618
1930
 
 
1931
    @needs_write_lock
 
1932
    def pull(self, source, overwrite=False, stop_revision=None,
 
1933
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1934
             _override_hook_target=None):
 
1935
        """See Branch.pull.
 
1936
 
 
1937
        :param _hook_master: Private parameter - set the branch to
 
1938
            be supplied as the master to pull hooks.
 
1939
        :param run_hooks: Private parameter - if false, this branch
 
1940
            is being called because it's the master of the primary branch,
 
1941
            so it should not run its hooks.
 
1942
        :param _override_hook_target: Private parameter - set the branch to be
 
1943
            supplied as the target_branch to pull hooks.
 
1944
        """
 
1945
        result = PullResult()
 
1946
        result.source_branch = source
 
1947
        if _override_hook_target is None:
 
1948
            result.target_branch = self
 
1949
        else:
 
1950
            result.target_branch = _override_hook_target
 
1951
        source.lock_read()
 
1952
        try:
 
1953
            # We assume that during 'pull' the local repository is closer than
 
1954
            # the remote one.
 
1955
            graph = self.repository.get_graph(source.repository)
 
1956
            result.old_revno, result.old_revid = self.last_revision_info()
 
1957
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1958
                                  graph=graph)
 
1959
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1960
            result.new_revno, result.new_revid = self.last_revision_info()
 
1961
            if _hook_master:
 
1962
                result.master_branch = _hook_master
 
1963
                result.local_branch = result.target_branch
 
1964
            else:
 
1965
                result.master_branch = result.target_branch
 
1966
                result.local_branch = None
 
1967
            if run_hooks:
 
1968
                for hook in Branch.hooks['post_pull']:
 
1969
                    hook(result)
 
1970
        finally:
 
1971
            source.unlock()
 
1972
        return result
 
1973
 
2619
1974
    def _get_parent_location(self):
2620
1975
        _locs = ['parent', 'pull', 'x-pull']
2621
1976
        for l in _locs:
2625
1980
                pass
2626
1981
        return None
2627
1982
 
 
1983
    @needs_read_lock
 
1984
    def push(self, target, overwrite=False, stop_revision=None,
 
1985
             _override_hook_source_branch=None):
 
1986
        """See Branch.push.
 
1987
 
 
1988
        This is the basic concrete implementation of push()
 
1989
 
 
1990
        :param _override_hook_source_branch: If specified, run
 
1991
        the hooks passing this Branch as the source, rather than self.
 
1992
        This is for use of RemoteBranch, where push is delegated to the
 
1993
        underlying vfs-based Branch.
 
1994
        """
 
1995
        # TODO: Public option to disable running hooks - should be trivial but
 
1996
        # needs tests.
 
1997
        return _run_with_write_locked_target(
 
1998
            target, self._push_with_bound_branches, target, overwrite,
 
1999
            stop_revision,
 
2000
            _override_hook_source_branch=_override_hook_source_branch)
 
2001
 
 
2002
    def _push_with_bound_branches(self, target, overwrite,
 
2003
            stop_revision,
 
2004
            _override_hook_source_branch=None):
 
2005
        """Push from self into target, and into target's master if any.
 
2006
 
 
2007
        This is on the base BzrBranch class even though it doesn't support
 
2008
        bound branches because the *target* might be bound.
 
2009
        """
 
2010
        def _run_hooks():
 
2011
            if _override_hook_source_branch:
 
2012
                result.source_branch = _override_hook_source_branch
 
2013
            for hook in Branch.hooks['post_push']:
 
2014
                hook(result)
 
2015
 
 
2016
        bound_location = target.get_bound_location()
 
2017
        if bound_location and target.base != bound_location:
 
2018
            # there is a master branch.
 
2019
            #
 
2020
            # XXX: Why the second check?  Is it even supported for a branch to
 
2021
            # be bound to itself? -- mbp 20070507
 
2022
            master_branch = target.get_master_branch()
 
2023
            master_branch.lock_write()
 
2024
            try:
 
2025
                # push into the master from this branch.
 
2026
                self._basic_push(master_branch, overwrite, stop_revision)
 
2027
                # and push into the target branch from this. Note that we push from
 
2028
                # this branch again, because its considered the highest bandwidth
 
2029
                # repository.
 
2030
                result = self._basic_push(target, overwrite, stop_revision)
 
2031
                result.master_branch = master_branch
 
2032
                result.local_branch = target
 
2033
                _run_hooks()
 
2034
                return result
 
2035
            finally:
 
2036
                master_branch.unlock()
 
2037
        else:
 
2038
            # no master branch
 
2039
            result = self._basic_push(target, overwrite, stop_revision)
 
2040
            # TODO: Why set master_branch and local_branch if there's no
 
2041
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2042
            # 20070504
 
2043
            result.master_branch = target
 
2044
            result.local_branch = None
 
2045
            _run_hooks()
 
2046
            return result
 
2047
 
2628
2048
    def _basic_push(self, target, overwrite, stop_revision):
2629
2049
        """Basic implementation of push without bound branches or hooks.
2630
2050
 
2631
 
        Must be called with source read locked and target write locked.
 
2051
        Must be called with self read locked and target write locked.
2632
2052
        """
2633
 
        result = BranchPushResult()
 
2053
        result = PushResult()
2634
2054
        result.source_branch = self
2635
2055
        result.target_branch = target
2636
2056
        result.old_revno, result.old_revid = target.last_revision_info()
2637
 
        self.update_references(target)
2638
2057
        if result.old_revid != self.last_revision():
2639
2058
            # We assume that during 'push' this repository is closer than
2640
2059
            # the target.
2641
2060
            graph = self.repository.get_graph(target.repository)
2642
 
            target.update_revisions(self, stop_revision,
2643
 
                overwrite=overwrite, graph=graph)
 
2061
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2062
                                    graph=graph)
2644
2063
        if self._push_should_merge_tags():
2645
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2646
 
                overwrite)
 
2064
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2647
2065
        result.new_revno, result.new_revid = target.last_revision_info()
2648
2066
        return result
2649
2067
 
 
2068
    def get_parent(self):
 
2069
        """See Branch.get_parent."""
 
2070
        parent = self._get_parent_location()
 
2071
        if parent is None:
 
2072
            return parent
 
2073
        # This is an old-format absolute path to a local branch
 
2074
        # turn it into a url
 
2075
        if parent.startswith('/'):
 
2076
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2077
        try:
 
2078
            return urlutils.join(self.base[:-1], parent)
 
2079
        except errors.InvalidURLJoin, e:
 
2080
            raise errors.InaccessibleParent(parent, self.base)
 
2081
 
2650
2082
    def get_stacked_on_url(self):
2651
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2083
        raise errors.UnstackableBranchFormat(self._format, self.base)
2652
2084
 
2653
2085
    def set_push_location(self, location):
2654
2086
        """See Branch.set_push_location."""
2656
2088
            'push_location', location,
2657
2089
            store=_mod_config.STORE_LOCATION_NORECURSE)
2658
2090
 
 
2091
    @needs_write_lock
 
2092
    def set_parent(self, url):
 
2093
        """See Branch.set_parent."""
 
2094
        # TODO: Maybe delete old location files?
 
2095
        # URLs should never be unicode, even on the local fs,
 
2096
        # FIXUP this and get_parent in a future branch format bump:
 
2097
        # read and rewrite the file. RBC 20060125
 
2098
        if url is not None:
 
2099
            if isinstance(url, unicode):
 
2100
                try:
 
2101
                    url = url.encode('ascii')
 
2102
                except UnicodeEncodeError:
 
2103
                    raise errors.InvalidURL(url,
 
2104
                        "Urls must be 7-bit ascii, "
 
2105
                        "use bzrlib.urlutils.escape")
 
2106
            url = urlutils.relative_url(self.base, url)
 
2107
        self._set_parent_location(url)
 
2108
 
2659
2109
    def _set_parent_location(self, url):
2660
2110
        if url is None:
2661
2111
            self._transport.delete('parent')
2663
2113
            self._transport.put_bytes('parent', url + '\n',
2664
2114
                mode=self.bzrdir._get_file_mode())
2665
2115
 
 
2116
    def set_stacked_on_url(self, url):
 
2117
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2118
 
2666
2119
 
2667
2120
class BzrBranch5(BzrBranch):
2668
2121
    """A format 5 branch. This supports new features over plain branches.
2670
2123
    It has support for a master_branch which is the data for bound branches.
2671
2124
    """
2672
2125
 
 
2126
    @needs_write_lock
 
2127
    def pull(self, source, overwrite=False, stop_revision=None,
 
2128
             run_hooks=True, possible_transports=None,
 
2129
             _override_hook_target=None):
 
2130
        """Pull from source into self, updating my master if any.
 
2131
 
 
2132
        :param run_hooks: Private parameter - if false, this branch
 
2133
            is being called because it's the master of the primary branch,
 
2134
            so it should not run its hooks.
 
2135
        """
 
2136
        bound_location = self.get_bound_location()
 
2137
        master_branch = None
 
2138
        if bound_location and source.base != bound_location:
 
2139
            # not pulling from master, so we need to update master.
 
2140
            master_branch = self.get_master_branch(possible_transports)
 
2141
            master_branch.lock_write()
 
2142
        try:
 
2143
            if master_branch:
 
2144
                # pull from source into master.
 
2145
                master_branch.pull(source, overwrite, stop_revision,
 
2146
                    run_hooks=False)
 
2147
            return super(BzrBranch5, self).pull(source, overwrite,
 
2148
                stop_revision, _hook_master=master_branch,
 
2149
                run_hooks=run_hooks,
 
2150
                _override_hook_target=_override_hook_target)
 
2151
        finally:
 
2152
            if master_branch:
 
2153
                master_branch.unlock()
 
2154
 
2673
2155
    def get_bound_location(self):
2674
2156
        try:
2675
2157
            return self._transport.get_bytes('bound')[:-1]
2762
2244
        return None
2763
2245
 
2764
2246
 
2765
 
class BzrBranch8(BzrBranch5):
2766
 
    """A branch that stores tree-reference locations."""
 
2247
class BzrBranch7(BzrBranch5):
 
2248
    """A branch with support for a fallback repository."""
 
2249
 
 
2250
    def _get_fallback_repository(self, url):
 
2251
        """Get the repository we fallback to at url."""
 
2252
        url = urlutils.join(self.base, url)
 
2253
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2254
                                      possible_transports=[self._transport])
 
2255
        return a_bzrdir.open_branch().repository
 
2256
 
 
2257
    def _activate_fallback_location(self, url):
 
2258
        """Activate the branch/repository from url as a fallback repository."""
 
2259
        self.repository.add_fallback_repository(
 
2260
            self._get_fallback_repository(url))
2767
2261
 
2768
2262
    def _open_hook(self):
2769
 
        if self._ignore_fallbacks:
2770
 
            return
2771
2263
        try:
2772
2264
            url = self.get_stacked_on_url()
2773
2265
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2783
2275
                        "None, not a URL." % hook_name)
2784
2276
            self._activate_fallback_location(url)
2785
2277
 
 
2278
    def _check_stackable_repo(self):
 
2279
        if not self.repository._format.supports_external_lookups:
 
2280
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2281
                self.repository.base)
 
2282
 
2786
2283
    def __init__(self, *args, **kwargs):
2787
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2284
        super(BzrBranch7, self).__init__(*args, **kwargs)
2789
2285
        self._last_revision_info_cache = None
2790
 
        self._reference_info = None
 
2286
        self._partial_revision_history_cache = []
2791
2287
 
2792
2288
    def _clear_cached_state(self):
2793
 
        super(BzrBranch8, self)._clear_cached_state()
 
2289
        super(BzrBranch7, self)._clear_cached_state()
2794
2290
        self._last_revision_info_cache = None
2795
 
        self._reference_info = None
 
2291
        self._partial_revision_history_cache = []
2796
2292
 
2797
2293
    def _last_revision_info(self):
2798
2294
        revision_string = self._transport.get_bytes('last-revision')
2844
2340
        if _mod_revision.is_null(last_revision):
2845
2341
            return
2846
2342
        if last_revision not in self._lefthand_history(revision_id):
2847
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2343
            raise errors.AppendRevisionsOnlyViolation(self.base)
2848
2344
 
2849
2345
    def _gen_revision_history(self):
2850
2346
        """Generate the revision history from last revision
2853
2349
        self._extend_partial_history(stop_index=last_revno-1)
2854
2350
        return list(reversed(self._partial_revision_history_cache))
2855
2351
 
 
2352
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2353
        """Extend the partial history to include a given index
 
2354
 
 
2355
        If a stop_index is supplied, stop when that index has been reached.
 
2356
        If a stop_revision is supplied, stop when that revision is
 
2357
        encountered.  Otherwise, stop when the beginning of history is
 
2358
        reached.
 
2359
 
 
2360
        :param stop_index: The index which should be present.  When it is
 
2361
            present, history extension will stop.
 
2362
        :param revision_id: The revision id which should be present.  When
 
2363
            it is encountered, history extension will stop.
 
2364
        """
 
2365
        repo = self.repository
 
2366
        if len(self._partial_revision_history_cache) == 0:
 
2367
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2368
        else:
 
2369
            start_revision = self._partial_revision_history_cache[-1]
 
2370
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2371
            #skip the last revision in the list
 
2372
            next_revision = iterator.next()
 
2373
        for revision_id in iterator:
 
2374
            self._partial_revision_history_cache.append(revision_id)
 
2375
            if (stop_index is not None and
 
2376
                len(self._partial_revision_history_cache) > stop_index):
 
2377
                break
 
2378
            if revision_id == stop_revision:
 
2379
                break
 
2380
 
2856
2381
    def _write_revision_history(self, history):
2857
2382
        """Factored out of set_revision_history.
2858
2383
 
2879
2404
        """Set the parent branch"""
2880
2405
        return self._get_config_location('parent_location')
2881
2406
 
2882
 
    @needs_write_lock
2883
 
    def _set_all_reference_info(self, info_dict):
2884
 
        """Replace all reference info stored in a branch.
2885
 
 
2886
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2887
 
        """
2888
 
        s = StringIO()
2889
 
        writer = rio.RioWriter(s)
2890
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2891
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2892
 
                                branch_location=branch_location)
2893
 
            writer.write_stanza(stanza)
2894
 
        self._transport.put_bytes('references', s.getvalue())
2895
 
        self._reference_info = info_dict
2896
 
 
2897
 
    @needs_read_lock
2898
 
    def _get_all_reference_info(self):
2899
 
        """Return all the reference info stored in a branch.
2900
 
 
2901
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2902
 
        """
2903
 
        if self._reference_info is not None:
2904
 
            return self._reference_info
2905
 
        rio_file = self._transport.get('references')
2906
 
        try:
2907
 
            stanzas = rio.read_stanzas(rio_file)
2908
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2909
 
                             s['branch_location'])) for s in stanzas)
2910
 
        finally:
2911
 
            rio_file.close()
2912
 
        self._reference_info = info_dict
2913
 
        return info_dict
2914
 
 
2915
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2916
 
        """Set the branch location to use for a tree reference.
2917
 
 
2918
 
        :param file_id: The file-id of the tree reference.
2919
 
        :param tree_path: The path of the tree reference in the tree.
2920
 
        :param branch_location: The location of the branch to retrieve tree
2921
 
            references from.
2922
 
        """
2923
 
        info_dict = self._get_all_reference_info()
2924
 
        info_dict[file_id] = (tree_path, branch_location)
2925
 
        if None in (tree_path, branch_location):
2926
 
            if tree_path is not None:
2927
 
                raise ValueError('tree_path must be None when branch_location'
2928
 
                                 ' is None.')
2929
 
            if branch_location is not None:
2930
 
                raise ValueError('branch_location must be None when tree_path'
2931
 
                                 ' is None.')
2932
 
            del info_dict[file_id]
2933
 
        self._set_all_reference_info(info_dict)
2934
 
 
2935
 
    def get_reference_info(self, file_id):
2936
 
        """Get the tree_path and branch_location for a tree reference.
2937
 
 
2938
 
        :return: a tuple of (tree_path, branch_location)
2939
 
        """
2940
 
        return self._get_all_reference_info().get(file_id, (None, None))
2941
 
 
2942
 
    def reference_parent(self, file_id, path, possible_transports=None):
2943
 
        """Return the parent branch for a tree-reference file_id.
2944
 
 
2945
 
        :param file_id: The file_id of the tree reference
2946
 
        :param path: The path of the file_id in the tree
2947
 
        :return: A branch associated with the file_id
2948
 
        """
2949
 
        branch_location = self.get_reference_info(file_id)[1]
2950
 
        if branch_location is None:
2951
 
            return Branch.reference_parent(self, file_id, path,
2952
 
                                           possible_transports)
2953
 
        branch_location = urlutils.join(self.user_url, branch_location)
2954
 
        return Branch.open(branch_location,
2955
 
                           possible_transports=possible_transports)
2956
 
 
2957
2407
    def set_push_location(self, location):
2958
2408
        """See Branch.set_push_location."""
2959
2409
        self._set_config_location('push_location', location)
3001
2451
            raise errors.NotStacked(self)
3002
2452
        return stacked_url
3003
2453
 
 
2454
    def set_append_revisions_only(self, enabled):
 
2455
        if enabled:
 
2456
            value = 'True'
 
2457
        else:
 
2458
            value = 'False'
 
2459
        self.get_config().set_user_option('append_revisions_only', value,
 
2460
            warn_masked=True)
 
2461
 
 
2462
    def set_stacked_on_url(self, url):
 
2463
        self._check_stackable_repo()
 
2464
        if not url:
 
2465
            try:
 
2466
                old_url = self.get_stacked_on_url()
 
2467
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2468
                errors.UnstackableRepositoryFormat):
 
2469
                return
 
2470
            url = ''
 
2471
            # repositories don't offer an interface to remove fallback
 
2472
            # repositories today; take the conceptually simpler option and just
 
2473
            # reopen it.
 
2474
            self.repository = self.bzrdir.find_repository()
 
2475
            # for every revision reference the branch has, ensure it is pulled
 
2476
            # in.
 
2477
            source_repository = self._get_fallback_repository(old_url)
 
2478
            for revision_id in chain([self.last_revision()],
 
2479
                self.tags.get_reverse_tag_dict()):
 
2480
                self.repository.fetch(source_repository, revision_id,
 
2481
                    find_ghosts=True)
 
2482
        else:
 
2483
            self._activate_fallback_location(url)
 
2484
        # write this out after the repository is stacked to avoid setting a
 
2485
        # stacked config that doesn't work.
 
2486
        self._set_config_location('stacked_on_location', url)
 
2487
 
3004
2488
    def _get_append_revisions_only(self):
3005
 
        return self.get_config(
3006
 
            ).get_user_option_as_bool('append_revisions_only')
 
2489
        value = self.get_config().get_user_option('append_revisions_only')
 
2490
        return value == 'True'
 
2491
 
 
2492
    def _make_tags(self):
 
2493
        return BasicTags(self)
3007
2494
 
3008
2495
    @needs_write_lock
3009
2496
    def generate_revision_history(self, revision_id, last_rev=None,
3049
2536
        return self.revno() - index
3050
2537
 
3051
2538
 
3052
 
class BzrBranch7(BzrBranch8):
3053
 
    """A branch with support for a fallback repository."""
3054
 
 
3055
 
    def set_reference_info(self, file_id, tree_path, branch_location):
3056
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
3057
 
 
3058
 
    def get_reference_info(self, file_id):
3059
 
        Branch.get_reference_info(self, file_id)
3060
 
 
3061
 
    def reference_parent(self, file_id, path, possible_transports=None):
3062
 
        return Branch.reference_parent(self, file_id, path,
3063
 
                                       possible_transports)
3064
 
 
3065
 
 
3066
2539
class BzrBranch6(BzrBranch7):
3067
2540
    """See BzrBranchFormat6 for the capabilities of this branch.
3068
2541
 
3071
2544
    """
3072
2545
 
3073
2546
    def get_stacked_on_url(self):
3074
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2547
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2548
 
 
2549
    def set_stacked_on_url(self, url):
 
2550
        raise errors.UnstackableBranchFormat(self._format, self.base)
3075
2551
 
3076
2552
 
3077
2553
######################################################################
3095
2571
    :ivar new_revno: Revision number after pull.
3096
2572
    :ivar old_revid: Tip revision id before pull.
3097
2573
    :ivar new_revid: Tip revision id after pull.
3098
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2574
    :ivar source_branch: Source (local) branch object.
3099
2575
    :ivar master_branch: Master branch of the target, or the target if no
3100
2576
        Master
3101
2577
    :ivar local_branch: target branch if there is a Master, else None
3102
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2578
    :ivar target_branch: Target/destination branch object.
3103
2579
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3104
2580
    """
3105
2581
 
3116
2592
        self._show_tag_conficts(to_file)
3117
2593
 
3118
2594
 
3119
 
class BranchPushResult(_Result):
 
2595
class PushResult(_Result):
3120
2596
    """Result of a Branch.push operation.
3121
2597
 
3122
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3123
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3124
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3125
 
        before the push.
3126
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3127
 
        after the push.
3128
 
    :ivar source_branch: Source branch object that the push was from. This is
3129
 
        read locked, and generally is a local (and thus low latency) branch.
3130
 
    :ivar master_branch: If target is a bound branch, the master branch of
3131
 
        target, or target itself. Always write locked.
3132
 
    :ivar target_branch: The direct Branch where data is being sent (write
3133
 
        locked).
3134
 
    :ivar local_branch: If the target is a bound branch this will be the
3135
 
        target, otherwise it will be None.
 
2598
    :ivar old_revno: Revision number before push.
 
2599
    :ivar new_revno: Revision number after push.
 
2600
    :ivar old_revid: Tip revision id before push.
 
2601
    :ivar new_revid: Tip revision id after push.
 
2602
    :ivar source_branch: Source branch object.
 
2603
    :ivar master_branch: Master branch of the target, or None.
 
2604
    :ivar target_branch: Target/destination branch object.
3136
2605
    """
3137
2606
 
3138
2607
    def __int__(self):
3156
2625
 
3157
2626
    def __init__(self, branch):
3158
2627
        self.branch = branch
3159
 
        self.errors = []
3160
2628
 
3161
2629
    def report_results(self, verbose):
3162
2630
        """Report the check results via trace.note.
3164
2632
        :param verbose: Requests more detailed display of what was checked,
3165
2633
            if any.
3166
2634
        """
3167
 
        note('checked branch %s format %s', self.branch.user_url,
3168
 
            self.branch._format)
3169
 
        for error in self.errors:
3170
 
            note('found error:%s', error)
 
2635
        note('checked branch %s format %s',
 
2636
             self.branch.base,
 
2637
             self.branch._format)
3171
2638
 
3172
2639
 
3173
2640
class Converter5to6(object):
3211
2678
        branch._transport.put_bytes('format', format.get_format_string())
3212
2679
 
3213
2680
 
3214
 
class Converter7to8(object):
3215
 
    """Perform an in-place upgrade of format 6 to format 7"""
3216
 
 
3217
 
    def convert(self, branch):
3218
 
        format = BzrBranchFormat8()
3219
 
        branch._transport.put_bytes('references', '')
3220
 
        # update target format
3221
 
        branch._transport.put_bytes('format', format.get_format_string())
3222
 
 
3223
2681
 
3224
2682
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
2683
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3265
2723
    _optimisers = []
3266
2724
    """The available optimised InterBranch types."""
3267
2725
 
3268
 
    @classmethod
3269
 
    def _get_branch_formats_to_test(klass):
3270
 
        """Return an iterable of format tuples for testing.
3271
 
        
3272
 
        :return: An iterable of (from_format, to_format) to use when testing
3273
 
            this InterBranch class. Each InterBranch class should define this
3274
 
            method itself.
3275
 
        """
3276
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
3277
 
 
3278
 
    @needs_write_lock
3279
 
    def pull(self, overwrite=False, stop_revision=None,
3280
 
             possible_transports=None, local=False):
3281
 
        """Mirror source into target branch.
3282
 
 
3283
 
        The target branch is considered to be 'local', having low latency.
3284
 
 
3285
 
        :returns: PullResult instance
3286
 
        """
3287
 
        raise NotImplementedError(self.pull)
3288
 
 
3289
 
    @needs_write_lock
 
2726
    @staticmethod
 
2727
    def _get_branch_formats_to_test():
 
2728
        """Return a tuple with the Branch formats to use when testing."""
 
2729
        raise NotImplementedError(self._get_branch_formats_to_test)
 
2730
 
3290
2731
    def update_revisions(self, stop_revision=None, overwrite=False,
3291
2732
                         graph=None):
3292
2733
        """Pull in new perfect-fit revisions.
3300
2741
        """
3301
2742
        raise NotImplementedError(self.update_revisions)
3302
2743
 
3303
 
    @needs_write_lock
3304
 
    def push(self, overwrite=False, stop_revision=None,
3305
 
             _override_hook_source_branch=None):
3306
 
        """Mirror the source branch into the target branch.
3307
 
 
3308
 
        The source branch is considered to be 'local', having low latency.
3309
 
        """
3310
 
        raise NotImplementedError(self.push)
3311
 
 
3312
 
    @needs_write_lock
3313
 
    def copy_content_into(self, revision_id=None):
3314
 
        """Copy the content of source into target
3315
 
 
3316
 
        revision_id: if not None, the revision history in the new branch will
3317
 
                     be truncated to end with revision_id.
3318
 
        """
3319
 
        raise NotImplementedError(self.copy_content_into)
3320
 
 
3321
2744
 
3322
2745
class GenericInterBranch(InterBranch):
3323
 
    """InterBranch implementation that uses public Branch functions."""
3324
 
 
3325
 
    @classmethod
3326
 
    def is_compatible(klass, source, target):
3327
 
        # GenericBranch uses the public API, so always compatible
3328
 
        return True
3329
 
 
3330
 
    @classmethod
3331
 
    def _get_branch_formats_to_test(klass):
3332
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3333
 
 
3334
 
    @classmethod
3335
 
    def unwrap_format(klass, format):
3336
 
        if isinstance(format, remote.RemoteBranchFormat):
3337
 
            format._ensure_real()
3338
 
            return format._custom_format
3339
 
        return format                                                                                                  
3340
 
 
3341
 
    @needs_write_lock
3342
 
    def copy_content_into(self, revision_id=None):
3343
 
        """Copy the content of source into target
3344
 
 
3345
 
        revision_id: if not None, the revision history in the new branch will
3346
 
                     be truncated to end with revision_id.
3347
 
        """
3348
 
        self.source.update_references(self.target)
3349
 
        self.source._synchronize_history(self.target, revision_id)
3350
 
        try:
3351
 
            parent = self.source.get_parent()
3352
 
        except errors.InaccessibleParent, e:
3353
 
            mutter('parent was not accessible to copy: %s', e)
3354
 
        else:
3355
 
            if parent:
3356
 
                self.target.set_parent(parent)
3357
 
        if self.source._push_should_merge_tags():
3358
 
            self.source.tags.merge_to(self.target.tags)
3359
 
 
3360
 
    @needs_write_lock
 
2746
    """InterBranch implementation that uses public Branch functions.
 
2747
    """
 
2748
 
 
2749
    @staticmethod
 
2750
    def _get_branch_formats_to_test():
 
2751
        return BranchFormat._default_format, BranchFormat._default_format
 
2752
 
3361
2753
    def update_revisions(self, stop_revision=None, overwrite=False,
3362
2754
        graph=None):
3363
2755
        """See InterBranch.update_revisions()."""
3364
 
        other_revno, other_last_revision = self.source.last_revision_info()
3365
 
        stop_revno = None # unknown
3366
 
        if stop_revision is None:
3367
 
            stop_revision = other_last_revision
3368
 
            if _mod_revision.is_null(stop_revision):
3369
 
                # if there are no commits, we're done.
3370
 
                return
3371
 
            stop_revno = other_revno
3372
 
 
3373
 
        # what's the current last revision, before we fetch [and change it
3374
 
        # possibly]
3375
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3376
 
        # we fetch here so that we don't process data twice in the common
3377
 
        # case of having something to pull, and so that the check for
3378
 
        # already merged can operate on the just fetched graph, which will
3379
 
        # be cached in memory.
3380
 
        self.target.fetch(self.source, stop_revision)
3381
 
        # Check to see if one is an ancestor of the other
3382
 
        if not overwrite:
3383
 
            if graph is None:
3384
 
                graph = self.target.repository.get_graph()
3385
 
            if self.target._check_if_descendant_or_diverged(
3386
 
                    stop_revision, last_rev, graph, self.source):
3387
 
                # stop_revision is a descendant of last_rev, but we aren't
3388
 
                # overwriting, so we're done.
3389
 
                return
3390
 
        if stop_revno is None:
3391
 
            if graph is None:
3392
 
                graph = self.target.repository.get_graph()
3393
 
            this_revno, this_last_revision = \
3394
 
                    self.target.last_revision_info()
3395
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3396
 
                            [(other_last_revision, other_revno),
3397
 
                             (this_last_revision, this_revno)])
3398
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3399
 
 
3400
 
    @needs_write_lock
3401
 
    def pull(self, overwrite=False, stop_revision=None,
3402
 
             possible_transports=None, run_hooks=True,
3403
 
             _override_hook_target=None, local=False):
3404
 
        """Pull from source into self, updating my master if any.
3405
 
 
3406
 
        :param run_hooks: Private parameter - if false, this branch
3407
 
            is being called because it's the master of the primary branch,
3408
 
            so it should not run its hooks.
3409
 
        """
3410
 
        bound_location = self.target.get_bound_location()
3411
 
        if local and not bound_location:
3412
 
            raise errors.LocalRequiresBoundBranch()
3413
 
        master_branch = None
3414
 
        if not local and bound_location and self.source.user_url != bound_location:
3415
 
            # not pulling from master, so we need to update master.
3416
 
            master_branch = self.target.get_master_branch(possible_transports)
3417
 
            master_branch.lock_write()
3418
 
        try:
3419
 
            if master_branch:
3420
 
                # pull from source into master.
3421
 
                master_branch.pull(self.source, overwrite, stop_revision,
3422
 
                    run_hooks=False)
3423
 
            return self._pull(overwrite,
3424
 
                stop_revision, _hook_master=master_branch,
3425
 
                run_hooks=run_hooks,
3426
 
                _override_hook_target=_override_hook_target)
3427
 
        finally:
3428
 
            if master_branch:
3429
 
                master_branch.unlock()
3430
 
 
3431
 
    def push(self, overwrite=False, stop_revision=None,
3432
 
             _override_hook_source_branch=None):
3433
 
        """See InterBranch.push.
3434
 
 
3435
 
        This is the basic concrete implementation of push()
3436
 
 
3437
 
        :param _override_hook_source_branch: If specified, run
3438
 
        the hooks passing this Branch as the source, rather than self.
3439
 
        This is for use of RemoteBranch, where push is delegated to the
3440
 
        underlying vfs-based Branch.
3441
 
        """
3442
 
        # TODO: Public option to disable running hooks - should be trivial but
3443
 
        # needs tests.
3444
 
        self.source.lock_read()
3445
 
        try:
3446
 
            return _run_with_write_locked_target(
3447
 
                self.target, self._push_with_bound_branches, overwrite,
3448
 
                stop_revision,
3449
 
                _override_hook_source_branch=_override_hook_source_branch)
3450
 
        finally:
3451
 
            self.source.unlock()
3452
 
 
3453
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3454
 
            _override_hook_source_branch=None):
3455
 
        """Push from source into target, and into target's master if any.
3456
 
        """
3457
 
        def _run_hooks():
3458
 
            if _override_hook_source_branch:
3459
 
                result.source_branch = _override_hook_source_branch
3460
 
            for hook in Branch.hooks['post_push']:
3461
 
                hook(result)
3462
 
 
3463
 
        bound_location = self.target.get_bound_location()
3464
 
        if bound_location and self.target.base != bound_location:
3465
 
            # there is a master branch.
3466
 
            #
3467
 
            # XXX: Why the second check?  Is it even supported for a branch to
3468
 
            # be bound to itself? -- mbp 20070507
3469
 
            master_branch = self.target.get_master_branch()
3470
 
            master_branch.lock_write()
3471
 
            try:
3472
 
                # push into the master from the source branch.
3473
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3474
 
                # and push into the target branch from the source. Note that we
3475
 
                # push from the source branch again, because its considered the
3476
 
                # highest bandwidth repository.
3477
 
                result = self.source._basic_push(self.target, overwrite,
3478
 
                    stop_revision)
3479
 
                result.master_branch = master_branch
3480
 
                result.local_branch = self.target
3481
 
                _run_hooks()
3482
 
                return result
3483
 
            finally:
3484
 
                master_branch.unlock()
3485
 
        else:
3486
 
            # no master branch
3487
 
            result = self.source._basic_push(self.target, overwrite,
3488
 
                stop_revision)
3489
 
            # TODO: Why set master_branch and local_branch if there's no
3490
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3491
 
            # 20070504
3492
 
            result.master_branch = self.target
3493
 
            result.local_branch = None
3494
 
            _run_hooks()
3495
 
            return result
3496
 
 
3497
 
    def _pull(self, overwrite=False, stop_revision=None,
3498
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3499
 
             _override_hook_target=None, local=False):
3500
 
        """See Branch.pull.
3501
 
 
3502
 
        This function is the core worker, used by GenericInterBranch.pull to
3503
 
        avoid duplication when pulling source->master and source->local.
3504
 
 
3505
 
        :param _hook_master: Private parameter - set the branch to
3506
 
            be supplied as the master to pull hooks.
3507
 
        :param run_hooks: Private parameter - if false, this branch
3508
 
            is being called because it's the master of the primary branch,
3509
 
            so it should not run its hooks.
3510
 
        :param _override_hook_target: Private parameter - set the branch to be
3511
 
            supplied as the target_branch to pull hooks.
3512
 
        :param local: Only update the local branch, and not the bound branch.
3513
 
        """
3514
 
        # This type of branch can't be bound.
3515
 
        if local:
3516
 
            raise errors.LocalRequiresBoundBranch()
3517
 
        result = PullResult()
3518
 
        result.source_branch = self.source
3519
 
        if _override_hook_target is None:
3520
 
            result.target_branch = self.target
3521
 
        else:
3522
 
            result.target_branch = _override_hook_target
3523
 
        self.source.lock_read()
3524
 
        try:
3525
 
            # We assume that during 'pull' the target repository is closer than
3526
 
            # the source one.
3527
 
            self.source.update_references(self.target)
3528
 
            graph = self.target.repository.get_graph(self.source.repository)
3529
 
            # TODO: Branch formats should have a flag that indicates 
3530
 
            # that revno's are expensive, and pull() should honor that flag.
3531
 
            # -- JRV20090506
3532
 
            result.old_revno, result.old_revid = \
3533
 
                self.target.last_revision_info()
3534
 
            self.target.update_revisions(self.source, stop_revision,
3535
 
                overwrite=overwrite, graph=graph)
3536
 
            # TODO: The old revid should be specified when merging tags, 
3537
 
            # so a tags implementation that versions tags can only 
3538
 
            # pull in the most recent changes. -- JRV20090506
3539
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3540
 
                overwrite)
3541
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3542
 
            if _hook_master:
3543
 
                result.master_branch = _hook_master
3544
 
                result.local_branch = result.target_branch
3545
 
            else:
3546
 
                result.master_branch = result.target_branch
3547
 
                result.local_branch = None
3548
 
            if run_hooks:
3549
 
                for hook in Branch.hooks['post_pull']:
3550
 
                    hook(result)
3551
 
        finally:
3552
 
            self.source.unlock()
3553
 
        return result
 
2756
        self.source.lock_read()
 
2757
        try:
 
2758
            other_revno, other_last_revision = self.source.last_revision_info()
 
2759
            stop_revno = None # unknown
 
2760
            if stop_revision is None:
 
2761
                stop_revision = other_last_revision
 
2762
                if _mod_revision.is_null(stop_revision):
 
2763
                    # if there are no commits, we're done.
 
2764
                    return
 
2765
                stop_revno = other_revno
 
2766
 
 
2767
            # what's the current last revision, before we fetch [and change it
 
2768
            # possibly]
 
2769
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2770
            # we fetch here so that we don't process data twice in the common
 
2771
            # case of having something to pull, and so that the check for
 
2772
            # already merged can operate on the just fetched graph, which will
 
2773
            # be cached in memory.
 
2774
            self.target.fetch(self.source, stop_revision)
 
2775
            # Check to see if one is an ancestor of the other
 
2776
            if not overwrite:
 
2777
                if graph is None:
 
2778
                    graph = self.target.repository.get_graph()
 
2779
                if self.target._check_if_descendant_or_diverged(
 
2780
                        stop_revision, last_rev, graph, self.source):
 
2781
                    # stop_revision is a descendant of last_rev, but we aren't
 
2782
                    # overwriting, so we're done.
 
2783
                    return
 
2784
            if stop_revno is None:
 
2785
                if graph is None:
 
2786
                    graph = self.target.repository.get_graph()
 
2787
                this_revno, this_last_revision = \
 
2788
                        self.target.last_revision_info()
 
2789
                stop_revno = graph.find_distance_to_null(stop_revision,
 
2790
                                [(other_last_revision, other_revno),
 
2791
                                 (this_last_revision, this_revno)])
 
2792
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
2793
        finally:
 
2794
            self.source.unlock()
 
2795
 
 
2796
    @classmethod
 
2797
    def is_compatible(self, source, target):
 
2798
        # GenericBranch uses the public API, so always compatible
 
2799
        return True
3554
2800
 
3555
2801
 
3556
2802
InterBranch.register_optimiser(GenericInterBranch)