~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2009-12-03 02:24:54 UTC
  • mfrom: (4634.101.4 2.0)
  • mto: This revision was merged to the branch mainline in revision 4857.
  • Revision ID: andrew.bennetts@canonical.com-20091203022454-m2gyhbcdqi1t7ujz
Merge lp:bzr/2.0 into lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
 
import bzrlib.bzrdir
20
17
 
21
18
from cStringIO import StringIO
 
19
import sys
22
20
 
23
21
from bzrlib.lazy_import import lazy_import
24
22
lazy_import(globals(), """
25
 
import itertools
 
23
from itertools import chain
26
24
from bzrlib import (
27
 
    bzrdir,
28
 
    controldir,
29
 
    cache_utf8,
30
 
    cleanup,
31
 
    config as _mod_config,
32
 
    debug,
33
 
    errors,
34
 
    fetch,
35
 
    graph as _mod_graph,
36
 
    lockdir,
37
 
    lockable_files,
38
 
    remote,
39
 
    repository,
40
 
    revision as _mod_revision,
41
 
    rio,
42
 
    tag as _mod_tag,
43
 
    transport,
44
 
    ui,
45
 
    urlutils,
46
 
    vf_search,
 
25
        bzrdir,
 
26
        cache_utf8,
 
27
        config as _mod_config,
 
28
        debug,
 
29
        errors,
 
30
        lockdir,
 
31
        lockable_files,
 
32
        repository,
 
33
        revision as _mod_revision,
 
34
        rio,
 
35
        symbol_versioning,
 
36
        transport,
 
37
        tsort,
 
38
        ui,
 
39
        urlutils,
 
40
        )
 
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
43
from bzrlib.tag import (
 
44
    BasicTags,
 
45
    DisabledTags,
47
46
    )
48
 
from bzrlib.i18n import gettext, ngettext
49
47
""")
50
48
 
51
 
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
 
# is guaranteed to be registered.
53
 
import bzrlib.bzrdir
54
 
 
55
 
from bzrlib import (
56
 
    controldir,
57
 
    )
58
 
from bzrlib.decorators import (
59
 
    needs_read_lock,
60
 
    needs_write_lock,
61
 
    only_raises,
62
 
    )
63
 
from bzrlib.hooks import Hooks
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.hooks import HookPoint, Hooks
64
51
from bzrlib.inter import InterObject
65
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
66
53
from bzrlib import registry
67
54
from bzrlib.symbol_versioning import (
68
55
    deprecated_in,
71
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
72
59
 
73
60
 
74
 
class Branch(controldir.ControlComponent):
 
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
64
 
 
65
 
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
75
79
    """Branch holding a history of revisions.
76
80
 
77
 
    :ivar base:
78
 
        Base directory/url of the branch; using control_url and
79
 
        control_transport is more standardized.
80
 
    :ivar hooks: An instance of BranchHooks.
81
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
82
 
        _clear_cached_state.
 
81
    base
 
82
        Base directory/url of the branch.
 
83
 
 
84
    hooks: An instance of BranchHooks.
83
85
    """
84
86
    # this is really an instance variable - FIXME move it there
85
87
    # - RBC 20060112
86
88
    base = None
87
89
 
88
 
    @property
89
 
    def control_transport(self):
90
 
        return self._transport
91
 
 
92
 
    @property
93
 
    def user_transport(self):
94
 
        return self.bzrdir.user_transport
95
 
 
96
 
    def __init__(self, possible_transports=None):
 
90
    def __init__(self, *ignored, **ignored_too):
97
91
        self.tags = self._format.make_tags(self)
98
92
        self._revision_history_cache = None
99
93
        self._revision_id_to_revno_cache = None
100
94
        self._partial_revision_id_to_revno_cache = {}
101
95
        self._partial_revision_history_cache = []
102
 
        self._tags_bytes = None
103
96
        self._last_revision_info_cache = None
104
 
        self._master_branch_cache = None
105
97
        self._merge_sorted_revisions_cache = None
106
 
        self._open_hook(possible_transports)
 
98
        self._open_hook()
107
99
        hooks = Branch.hooks['open']
108
100
        for hook in hooks:
109
101
            hook(self)
110
102
 
111
 
    def _open_hook(self, possible_transports):
 
103
    def _open_hook(self):
112
104
        """Called by init to allow simpler extension of the base class."""
113
105
 
114
 
    def _activate_fallback_location(self, url, possible_transports):
 
106
    def _activate_fallback_location(self, url):
115
107
        """Activate the branch/repository from url as a fallback repository."""
116
 
        for existing_fallback_repo in self.repository._fallback_repositories:
117
 
            if existing_fallback_repo.user_url == url:
118
 
                # This fallback is already configured.  This probably only
119
 
                # happens because ControlDir.sprout is a horrible mess.  To avoid
120
 
                # confusing _unstack we don't add this a second time.
121
 
                mutter('duplicate activation of fallback %r on %r', url, self)
122
 
                return
123
 
        repo = self._get_fallback_repository(url, possible_transports)
 
108
        repo = self._get_fallback_repository(url)
124
109
        if repo.has_same_location(self.repository):
125
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
126
111
        self.repository.add_fallback_repository(repo)
127
112
 
128
113
    def break_lock(self):
180
165
        For instance, if the branch is at URL/.bzr/branch,
181
166
        Branch.open(URL) -> a Branch instance.
182
167
        """
183
 
        control = controldir.ControlDir.open(base, _unsupported,
 
168
        control = bzrdir.BzrDir.open(base, _unsupported,
184
169
                                     possible_transports=possible_transports)
185
 
        return control.open_branch(unsupported=_unsupported,
186
 
            possible_transports=possible_transports)
 
170
        return control.open_branch(_unsupported)
187
171
 
188
172
    @staticmethod
189
 
    def open_from_transport(transport, name=None, _unsupported=False,
190
 
            possible_transports=None):
 
173
    def open_from_transport(transport, _unsupported=False):
191
174
        """Open the branch rooted at transport"""
192
 
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
193
 
        return control.open_branch(name=name, unsupported=_unsupported,
194
 
            possible_transports=possible_transports)
 
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
 
176
        return control.open_branch(_unsupported)
195
177
 
196
178
    @staticmethod
197
179
    def open_containing(url, possible_transports=None):
205
187
        format, UnknownFormatError or UnsupportedFormatError are raised.
206
188
        If there is one, it is returned, along with the unused portion of url.
207
189
        """
208
 
        control, relpath = controldir.ControlDir.open_containing(url,
 
190
        control, relpath = bzrdir.BzrDir.open_containing(url,
209
191
                                                         possible_transports)
210
 
        branch = control.open_branch(possible_transports=possible_transports)
211
 
        return (branch, relpath)
 
192
        return control.open_branch(), relpath
212
193
 
213
194
    def _push_should_merge_tags(self):
214
195
        """Should _basic_push merge this branch's tags into the target?
219
200
        return self.supports_tags() and self.tags.get_tag_dict()
220
201
 
221
202
    def get_config(self):
222
 
        """Get a bzrlib.config.BranchConfig for this Branch.
223
 
 
224
 
        This can then be used to get and set configuration options for the
225
 
        branch.
226
 
 
227
 
        :return: A bzrlib.config.BranchConfig.
228
 
        """
229
 
        return _mod_config.BranchConfig(self)
230
 
 
231
 
    def get_config_stack(self):
232
 
        """Get a bzrlib.config.BranchStack for this Branch.
233
 
 
234
 
        This can then be used to get and set configuration options for the
235
 
        branch.
236
 
 
237
 
        :return: A bzrlib.config.BranchStack.
238
 
        """
239
 
        return _mod_config.BranchStack(self)
 
203
        return BranchConfig(self)
240
204
 
241
205
    def _get_config(self):
242
206
        """Get the concrete config for just the config in this branch.
250
214
        """
251
215
        raise NotImplementedError(self._get_config)
252
216
 
253
 
    def _get_fallback_repository(self, url, possible_transports):
 
217
    def _get_fallback_repository(self, url):
254
218
        """Get the repository we fallback to at url."""
255
219
        url = urlutils.join(self.base, url)
256
 
        a_branch = Branch.open(url, possible_transports=possible_transports)
257
 
        return a_branch.repository
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
 
221
            possible_transports=[self.bzrdir.root_transport])
 
222
        return a_bzrdir.open_branch().repository
258
223
 
259
 
    @needs_read_lock
260
224
    def _get_tags_bytes(self):
261
225
        """Get the bytes of a serialised tags dict.
262
226
 
269
233
        :return: The bytes of the tags file.
270
234
        :seealso: Branch._set_tags_bytes.
271
235
        """
272
 
        if self._tags_bytes is None:
273
 
            self._tags_bytes = self._transport.get_bytes('tags')
274
 
        return self._tags_bytes
 
236
        return self._transport.get_bytes('tags')
275
237
 
276
238
    def _get_nick(self, local=False, possible_transports=None):
277
239
        config = self.get_config()
279
241
        if not local and not config.has_explicit_nickname():
280
242
            try:
281
243
                master = self.get_master_branch(possible_transports)
282
 
                if master and self.user_url == master.user_url:
283
 
                    raise errors.RecursiveBind(self.user_url)
284
244
                if master is not None:
285
245
                    # return the master branch value
286
246
                    return master.nick
287
 
            except errors.RecursiveBind, e:
288
 
                raise e
289
247
            except errors.BzrError, e:
290
248
                # Silently fall back to local implicit nick if the master is
291
249
                # unavailable
328
286
        new_history.reverse()
329
287
        return new_history
330
288
 
331
 
    def lock_write(self, token=None):
332
 
        """Lock the branch for write operations.
333
 
 
334
 
        :param token: A token to permit reacquiring a previously held and
335
 
            preserved lock.
336
 
        :return: A BranchWriteLockResult.
337
 
        """
 
289
    def lock_write(self):
338
290
        raise NotImplementedError(self.lock_write)
339
291
 
340
292
    def lock_read(self):
341
 
        """Lock the branch for read operations.
342
 
 
343
 
        :return: A bzrlib.lock.LogicalLockResult.
344
 
        """
345
293
        raise NotImplementedError(self.lock_read)
346
294
 
347
295
    def unlock(self):
468
416
            after. If None, the rest of history is included.
469
417
        :param stop_rule: if stop_revision_id is not None, the precise rule
470
418
            to use for termination:
471
 
 
472
419
            * 'exclude' - leave the stop revision out of the result (default)
473
420
            * 'include' - the stop revision is the last item in the result
474
421
            * 'with-merges' - include the stop revision and all of its
475
422
              merged revisions in the result
476
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
477
 
              that are in both ancestries
478
423
        :param direction: either 'reverse' or 'forward':
479
 
 
480
424
            * reverse means return the start_revision_id first, i.e.
481
425
              start at the most recent revision and go backwards in history
482
426
            * forward returns tuples in the opposite order to reverse.
503
447
        # start_revision_id.
504
448
        if self._merge_sorted_revisions_cache is None:
505
449
            last_revision = self.last_revision()
506
 
            known_graph = self.repository.get_known_graph_ancestry(
507
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
508
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
509
 
                last_revision)
 
454
                last_key)
510
455
        filtered = self._filter_merge_sorted_revisions(
511
456
            self._merge_sorted_revisions_cache, start_revision_id,
512
457
            stop_revision_id, stop_rule)
513
 
        # Make sure we don't return revisions that are not part of the
514
 
        # start_revision_id ancestry.
515
 
        filtered = self._filter_start_non_ancestors(filtered)
516
458
        if direction == 'reverse':
517
459
            return filtered
518
460
        if direction == 'forward':
526
468
        rev_iter = iter(merge_sorted_revisions)
527
469
        if start_revision_id is not None:
528
470
            for node in rev_iter:
529
 
                rev_id = node.key
 
471
                rev_id = node.key[-1]
530
472
                if rev_id != start_revision_id:
531
473
                    continue
532
474
                else:
533
475
                    # The decision to include the start or not
534
476
                    # depends on the stop_rule if a stop is provided
535
477
                    # so pop this node back into the iterator
536
 
                    rev_iter = itertools.chain(iter([node]), rev_iter)
 
478
                    rev_iter = chain(iter([node]), rev_iter)
537
479
                    break
538
480
        if stop_revision_id is None:
539
481
            # Yield everything
540
482
            for node in rev_iter:
541
 
                rev_id = node.key
 
483
                rev_id = node.key[-1]
542
484
                yield (rev_id, node.merge_depth, node.revno,
543
485
                       node.end_of_merge)
544
486
        elif stop_rule == 'exclude':
545
487
            for node in rev_iter:
546
 
                rev_id = node.key
 
488
                rev_id = node.key[-1]
547
489
                if rev_id == stop_revision_id:
548
490
                    return
549
491
                yield (rev_id, node.merge_depth, node.revno,
550
492
                       node.end_of_merge)
551
493
        elif stop_rule == 'include':
552
494
            for node in rev_iter:
553
 
                rev_id = node.key
 
495
                rev_id = node.key[-1]
554
496
                yield (rev_id, node.merge_depth, node.revno,
555
497
                       node.end_of_merge)
556
498
                if rev_id == stop_revision_id:
557
499
                    return
558
 
        elif stop_rule == 'with-merges-without-common-ancestry':
559
 
            # We want to exclude all revisions that are already part of the
560
 
            # stop_revision_id ancestry.
561
 
            graph = self.repository.get_graph()
562
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
563
 
                                                    [stop_revision_id])
564
 
            for node in rev_iter:
565
 
                rev_id = node.key
566
 
                if rev_id not in ancestors:
567
 
                    continue
568
 
                yield (rev_id, node.merge_depth, node.revno,
569
 
                       node.end_of_merge)
570
500
        elif stop_rule == 'with-merges':
571
501
            stop_rev = self.repository.get_revision(stop_revision_id)
572
502
            if stop_rev.parent_ids:
573
503
                left_parent = stop_rev.parent_ids[0]
574
504
            else:
575
505
                left_parent = _mod_revision.NULL_REVISION
576
 
            # left_parent is the actual revision we want to stop logging at,
577
 
            # since we want to show the merged revisions after the stop_rev too
578
 
            reached_stop_revision_id = False
579
 
            revision_id_whitelist = []
580
506
            for node in rev_iter:
581
 
                rev_id = node.key
 
507
                rev_id = node.key[-1]
582
508
                if rev_id == left_parent:
583
 
                    # reached the left parent after the stop_revision
584
509
                    return
585
 
                if (not reached_stop_revision_id or
586
 
                        rev_id in revision_id_whitelist):
587
 
                    yield (rev_id, node.merge_depth, node.revno,
 
510
                yield (rev_id, node.merge_depth, node.revno,
588
511
                       node.end_of_merge)
589
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
590
 
                        # only do the merged revs of rev_id from now on
591
 
                        rev = self.repository.get_revision(rev_id)
592
 
                        if rev.parent_ids:
593
 
                            reached_stop_revision_id = True
594
 
                            revision_id_whitelist.extend(rev.parent_ids)
595
512
        else:
596
513
            raise ValueError('invalid stop_rule %r' % stop_rule)
597
514
 
598
 
    def _filter_start_non_ancestors(self, rev_iter):
599
 
        # If we started from a dotted revno, we want to consider it as a tip
600
 
        # and don't want to yield revisions that are not part of its
601
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
602
 
        # uninteresting descendants of the first parent of our tip before the
603
 
        # tip itself.
604
 
        first = rev_iter.next()
605
 
        (rev_id, merge_depth, revno, end_of_merge) = first
606
 
        yield first
607
 
        if not merge_depth:
608
 
            # We start at a mainline revision so by definition, all others
609
 
            # revisions in rev_iter are ancestors
610
 
            for node in rev_iter:
611
 
                yield node
612
 
 
613
 
        clean = False
614
 
        whitelist = set()
615
 
        pmap = self.repository.get_parent_map([rev_id])
616
 
        parents = pmap.get(rev_id, [])
617
 
        if parents:
618
 
            whitelist.update(parents)
619
 
        else:
620
 
            # If there is no parents, there is nothing of interest left
621
 
 
622
 
            # FIXME: It's hard to test this scenario here as this code is never
623
 
            # called in that case. -- vila 20100322
624
 
            return
625
 
 
626
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
627
 
            if not clean:
628
 
                if rev_id in whitelist:
629
 
                    pmap = self.repository.get_parent_map([rev_id])
630
 
                    parents = pmap.get(rev_id, [])
631
 
                    whitelist.remove(rev_id)
632
 
                    whitelist.update(parents)
633
 
                    if merge_depth == 0:
634
 
                        # We've reached the mainline, there is nothing left to
635
 
                        # filter
636
 
                        clean = True
637
 
                else:
638
 
                    # A revision that is not part of the ancestry of our
639
 
                    # starting revision.
640
 
                    continue
641
 
            yield (rev_id, merge_depth, revno, end_of_merge)
642
 
 
643
515
    def leave_lock_in_place(self):
644
516
        """Tell this branch object not to release the physical lock when this
645
517
        object is unlocked.
662
534
        :param other: The branch to bind to
663
535
        :type other: Branch
664
536
        """
665
 
        raise errors.UpgradeRequired(self.user_url)
666
 
 
667
 
    def get_append_revisions_only(self):
668
 
        """Whether it is only possible to append revisions to the history.
669
 
        """
670
 
        if not self._format.supports_set_append_revisions_only():
671
 
            return False
672
 
        return self.get_config_stack().get('append_revisions_only')
 
537
        raise errors.UpgradeRequired(self.base)
673
538
 
674
539
    def set_append_revisions_only(self, enabled):
675
540
        if not self._format.supports_set_append_revisions_only():
676
 
            raise errors.UpgradeRequired(self.user_url)
677
 
        self.get_config_stack().set('append_revisions_only', enabled)
 
541
            raise errors.UpgradeRequired(self.base)
 
542
        if enabled:
 
543
            value = 'True'
 
544
        else:
 
545
            value = 'False'
 
546
        self.get_config().set_user_option('append_revisions_only', value,
 
547
            warn_masked=True)
678
548
 
679
549
    def set_reference_info(self, file_id, tree_path, branch_location):
680
550
        """Set the branch location to use for a tree reference."""
685
555
        raise errors.UnsupportedOperation(self.get_reference_info, self)
686
556
 
687
557
    @needs_write_lock
688
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
558
    def fetch(self, from_branch, last_revision=None, pb=None):
689
559
        """Copy revisions from from_branch into this branch.
690
560
 
691
561
        :param from_branch: Where to copy from.
692
562
        :param last_revision: What revision to stop at (None for at the end
693
563
                              of the branch.
694
 
        :param limit: Optional rough limit of revisions to fetch
 
564
        :param pb: An optional progress bar to use.
695
565
        :return: None
696
566
        """
697
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
567
        if self.base == from_branch.base:
 
568
            return (0, [])
 
569
        if pb is not None:
 
570
            symbol_versioning.warn(
 
571
                symbol_versioning.deprecated_in((1, 14, 0))
 
572
                % "pb parameter to fetch()")
 
573
        from_branch.lock_read()
 
574
        try:
 
575
            if last_revision is None:
 
576
                last_revision = from_branch.last_revision()
 
577
                last_revision = _mod_revision.ensure_null(last_revision)
 
578
            return self.repository.fetch(from_branch.repository,
 
579
                                         revision_id=last_revision,
 
580
                                         pb=pb)
 
581
        finally:
 
582
            from_branch.unlock()
698
583
 
699
584
    def get_bound_location(self):
700
585
        """Return the URL of the branch we are bound to.
707
592
    def get_old_bound_location(self):
708
593
        """Return the URL of the branch we used to be bound to
709
594
        """
710
 
        raise errors.UpgradeRequired(self.user_url)
 
595
        raise errors.UpgradeRequired(self.base)
711
596
 
712
 
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
 
597
    def get_commit_builder(self, parents, config=None, timestamp=None,
713
598
                           timezone=None, committer=None, revprops=None,
714
 
                           revision_id=None, lossy=False):
 
599
                           revision_id=None):
715
600
        """Obtain a CommitBuilder for this branch.
716
601
 
717
602
        :param parents: Revision ids of the parents of the new revision.
721
606
        :param committer: Optional committer to set for commit.
722
607
        :param revprops: Optional dictionary of revision properties.
723
608
        :param revision_id: Optional revision id.
724
 
        :param lossy: Whether to discard data that can not be natively
725
 
            represented, when pushing to a foreign VCS 
726
609
        """
727
610
 
728
 
        if config_stack is None:
729
 
            config_stack = self.get_config_stack()
 
611
        if config is None:
 
612
            config = self.get_config()
730
613
 
731
 
        return self.repository.get_commit_builder(self, parents, config_stack,
732
 
            timestamp, timezone, committer, revprops, revision_id,
733
 
            lossy)
 
614
        return self.repository.get_commit_builder(self, parents, config,
 
615
            timestamp, timezone, committer, revprops, revision_id)
734
616
 
735
617
    def get_master_branch(self, possible_transports=None):
736
618
        """Return the branch we are bound to.
739
621
        """
740
622
        return None
741
623
 
742
 
    @deprecated_method(deprecated_in((2, 5, 0)))
743
624
    def get_revision_delta(self, revno):
744
625
        """Return the delta for one revision.
745
626
 
746
627
        The delta is relative to its mainline predecessor, or the
747
628
        empty tree for revision 1.
748
629
        """
749
 
        try:
750
 
            revid = self.get_rev_id(revno)
751
 
        except errors.NoSuchRevision:
 
630
        rh = self.revision_history()
 
631
        if not (1 <= revno <= len(rh)):
752
632
            raise errors.InvalidRevisionNumber(revno)
753
 
        return self.repository.get_revision_delta(revid)
 
633
        return self.repository.get_revision_delta(rh[revno-1])
754
634
 
755
635
    def get_stacked_on_url(self):
756
636
        """Get the URL this branch is stacked against.
765
645
        """Print `file` to stdout."""
766
646
        raise NotImplementedError(self.print_file)
767
647
 
768
 
    @deprecated_method(deprecated_in((2, 4, 0)))
769
648
    def set_revision_history(self, rev_history):
770
 
        """See Branch.set_revision_history."""
771
 
        self._set_revision_history(rev_history)
772
 
 
773
 
    @needs_write_lock
774
 
    def _set_revision_history(self, rev_history):
775
 
        if len(rev_history) == 0:
776
 
            revid = _mod_revision.NULL_REVISION
777
 
        else:
778
 
            revid = rev_history[-1]
779
 
        if rev_history != self._lefthand_history(revid):
780
 
            raise errors.NotLefthandHistory(rev_history)
781
 
        self.set_last_revision_info(len(rev_history), revid)
782
 
        self._cache_revision_history(rev_history)
783
 
        for hook in Branch.hooks['set_rh']:
784
 
            hook(self, rev_history)
785
 
 
786
 
    @needs_write_lock
787
 
    def set_last_revision_info(self, revno, revision_id):
788
 
        """Set the last revision of this branch.
789
 
 
790
 
        The caller is responsible for checking that the revno is correct
791
 
        for this revision id.
792
 
 
793
 
        It may be possible to set the branch last revision to an id not
794
 
        present in the repository.  However, branches can also be
795
 
        configured to check constraints on history, in which case this may not
796
 
        be permitted.
797
 
        """
798
 
        raise NotImplementedError(self.set_last_revision_info)
799
 
 
800
 
    @needs_write_lock
801
 
    def generate_revision_history(self, revision_id, last_rev=None,
802
 
                                  other_branch=None):
803
 
        """See Branch.generate_revision_history"""
804
 
        graph = self.repository.get_graph()
805
 
        (last_revno, last_revid) = self.last_revision_info()
806
 
        known_revision_ids = [
807
 
            (last_revid, last_revno),
808
 
            (_mod_revision.NULL_REVISION, 0),
809
 
            ]
810
 
        if last_rev is not None:
811
 
            if not graph.is_ancestor(last_rev, revision_id):
812
 
                # our previous tip is not merged into stop_revision
813
 
                raise errors.DivergedBranches(self, other_branch)
814
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
815
 
        self.set_last_revision_info(revno, revision_id)
 
649
        raise NotImplementedError(self.set_revision_history)
816
650
 
817
651
    @needs_write_lock
818
652
    def set_parent(self, url):
842
676
            stacking.
843
677
        """
844
678
        if not self._format.supports_stacking():
845
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
679
            raise errors.UnstackableBranchFormat(self._format, self.base)
846
680
        # XXX: Changing from one fallback repository to another does not check
847
681
        # that all the data you need is present in the new fallback.
848
682
        # Possibly it should.
855
689
                return
856
690
            self._unstack()
857
691
        else:
858
 
            self._activate_fallback_location(url,
859
 
                possible_transports=[self.bzrdir.root_transport])
 
692
            self._activate_fallback_location(url)
860
693
        # write this out after the repository is stacked to avoid setting a
861
694
        # stacked config that doesn't work.
862
695
        self._set_config_location('stacked_on_location', url)
863
696
 
864
697
    def _unstack(self):
865
698
        """Change a branch to be unstacked, copying data as needed.
866
 
 
 
699
        
867
700
        Don't call this directly, use set_stacked_on_url(None).
868
701
        """
869
702
        pb = ui.ui_factory.nested_progress_bar()
870
703
        try:
871
 
            pb.update(gettext("Unstacking"))
 
704
            pb.update("Unstacking")
872
705
            # The basic approach here is to fetch the tip of the branch,
873
706
            # including all available ghosts, from the existing stacked
874
707
            # repository into a new repository object without the fallbacks. 
878
711
            old_repository = self.repository
879
712
            if len(old_repository._fallback_repositories) != 1:
880
713
                raise AssertionError("can't cope with fallback repositories "
881
 
                    "of %r (fallbacks: %r)" % (old_repository,
882
 
                        old_repository._fallback_repositories))
883
 
            # Open the new repository object.
884
 
            # Repositories don't offer an interface to remove fallback
885
 
            # repositories today; take the conceptually simpler option and just
886
 
            # reopen it.  We reopen it starting from the URL so that we
887
 
            # get a separate connection for RemoteRepositories and can
888
 
            # stream from one of them to the other.  This does mean doing
889
 
            # separate SSH connection setup, but unstacking is not a
890
 
            # common operation so it's tolerable.
891
 
            new_bzrdir = controldir.ControlDir.open(
892
 
                self.bzrdir.root_transport.base)
893
 
            new_repository = new_bzrdir.find_repository()
894
 
            if new_repository._fallback_repositories:
895
 
                raise AssertionError("didn't expect %r to have "
896
 
                    "fallback_repositories"
897
 
                    % (self.repository,))
898
 
            # Replace self.repository with the new repository.
899
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
900
 
            # lock count) of self.repository to the new repository.
901
 
            lock_token = old_repository.lock_write().repository_token
902
 
            self.repository = new_repository
903
 
            if isinstance(self, remote.RemoteBranch):
904
 
                # Remote branches can have a second reference to the old
905
 
                # repository that need to be replaced.
906
 
                if self._real_branch is not None:
907
 
                    self._real_branch.repository = new_repository
908
 
            self.repository.lock_write(token=lock_token)
909
 
            if lock_token is not None:
910
 
                old_repository.leave_lock_in_place()
 
714
                    "of %r" % (self.repository,))
 
715
            # unlock it, including unlocking the fallback
911
716
            old_repository.unlock()
912
 
            if lock_token is not None:
913
 
                # XXX: self.repository.leave_lock_in_place() before this
914
 
                # function will not be preserved.  Fortunately that doesn't
915
 
                # affect the current default format (2a), and would be a
916
 
                # corner-case anyway.
917
 
                #  - Andrew Bennetts, 2010/06/30
918
 
                self.repository.dont_leave_lock_in_place()
919
 
            old_lock_count = 0
920
 
            while True:
921
 
                try:
922
 
                    old_repository.unlock()
923
 
                except errors.LockNotHeld:
924
 
                    break
925
 
                old_lock_count += 1
926
 
            if old_lock_count == 0:
927
 
                raise AssertionError(
928
 
                    'old_repository should have been locked at least once.')
929
 
            for i in range(old_lock_count-1):
 
717
            old_repository.lock_read()
 
718
            try:
 
719
                # Repositories don't offer an interface to remove fallback
 
720
                # repositories today; take the conceptually simpler option and just
 
721
                # reopen it.  We reopen it starting from the URL so that we
 
722
                # get a separate connection for RemoteRepositories and can
 
723
                # stream from one of them to the other.  This does mean doing
 
724
                # separate SSH connection setup, but unstacking is not a
 
725
                # common operation so it's tolerable.
 
726
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
727
                new_repository = new_bzrdir.find_repository()
 
728
                self.repository = new_repository
 
729
                if self.repository._fallback_repositories:
 
730
                    raise AssertionError("didn't expect %r to have "
 
731
                        "fallback_repositories"
 
732
                        % (self.repository,))
 
733
                # this is not paired with an unlock because it's just restoring
 
734
                # the previous state; the lock's released when set_stacked_on_url
 
735
                # returns
930
736
                self.repository.lock_write()
931
 
            # Fetch from the old repository into the new.
932
 
            old_repository.lock_read()
933
 
            try:
934
737
                # XXX: If you unstack a branch while it has a working tree
935
738
                # with a pending merge, the pending-merged revisions will no
936
739
                # longer be present.  You can (probably) revert and remerge.
937
 
                try:
938
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
939
 
                except errors.TagsNotSupported:
940
 
                    tags_to_fetch = set()
941
 
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
942
 
                    old_repository, required_ids=[self.last_revision()],
943
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
944
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
 
740
                #
 
741
                # XXX: This only fetches up to the tip of the repository; it
 
742
                # doesn't bring across any tags.  That's fairly consistent
 
743
                # with how branch works, but perhaps not ideal.
 
744
                self.repository.fetch(old_repository,
 
745
                    revision_id=self.last_revision(),
 
746
                    find_ghosts=True)
945
747
            finally:
946
748
                old_repository.unlock()
947
749
        finally:
952
754
 
953
755
        :seealso: Branch._get_tags_bytes.
954
756
        """
955
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
956
 
        op.add_cleanup(self.lock_write().unlock)
957
 
        return op.run_simple(bytes)
958
 
 
959
 
    def _set_tags_bytes_locked(self, bytes):
960
 
        self._tags_bytes = bytes
961
 
        return self._transport.put_bytes('tags', bytes)
 
757
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
758
            'tags', bytes)
962
759
 
963
760
    def _cache_revision_history(self, rev_history):
964
761
        """Set the cached revision history to rev_history.
991
788
        self._revision_history_cache = None
992
789
        self._revision_id_to_revno_cache = None
993
790
        self._last_revision_info_cache = None
994
 
        self._master_branch_cache = None
995
791
        self._merge_sorted_revisions_cache = None
996
792
        self._partial_revision_history_cache = []
997
793
        self._partial_revision_id_to_revno_cache = {}
998
 
        self._tags_bytes = None
999
794
 
1000
795
    def _gen_revision_history(self):
1001
796
        """Return sequence of revision hashes on to this branch.
1012
807
        """
1013
808
        raise NotImplementedError(self._gen_revision_history)
1014
809
 
1015
 
    @deprecated_method(deprecated_in((2, 5, 0)))
1016
810
    @needs_read_lock
1017
811
    def revision_history(self):
1018
812
        """Return sequence of revision ids on this branch.
1020
814
        This method will cache the revision history for as long as it is safe to
1021
815
        do so.
1022
816
        """
1023
 
        return self._revision_history()
1024
 
 
1025
 
    def _revision_history(self):
1026
817
        if 'evil' in debug.debug_flags:
1027
818
            mutter_callsite(3, "revision_history scales with history.")
1028
819
        if self._revision_history_cache is not None:
1042
833
 
1043
834
    def unbind(self):
1044
835
        """Older format branches cannot bind or unbind."""
1045
 
        raise errors.UpgradeRequired(self.user_url)
 
836
        raise errors.UpgradeRequired(self.base)
1046
837
 
1047
838
    def last_revision(self):
1048
839
        """Return last revision id, or NULL_REVISION."""
1055
846
        :return: A tuple (revno, revision_id).
1056
847
        """
1057
848
        if self._last_revision_info_cache is None:
1058
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
849
            self._last_revision_info_cache = self._last_revision_info()
1059
850
        return self._last_revision_info_cache
1060
851
 
1061
 
    def _read_last_revision_info(self):
1062
 
        raise NotImplementedError(self._read_last_revision_info)
1063
 
 
1064
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
852
    def _last_revision_info(self):
 
853
        rh = self.revision_history()
 
854
        revno = len(rh)
 
855
        if revno:
 
856
            return (revno, rh[-1])
 
857
        else:
 
858
            return (0, _mod_revision.NULL_REVISION)
 
859
 
 
860
    @deprecated_method(deprecated_in((1, 6, 0)))
 
861
    def missing_revisions(self, other, stop_revision=None):
 
862
        """Return a list of new revisions that would perfectly fit.
 
863
 
 
864
        If self and other have not diverged, return a list of the revisions
 
865
        present in other, but missing from self.
 
866
        """
 
867
        self_history = self.revision_history()
 
868
        self_len = len(self_history)
 
869
        other_history = other.revision_history()
 
870
        other_len = len(other_history)
 
871
        common_index = min(self_len, other_len) -1
 
872
        if common_index >= 0 and \
 
873
            self_history[common_index] != other_history[common_index]:
 
874
            raise errors.DivergedBranches(self, other)
 
875
 
 
876
        if stop_revision is None:
 
877
            stop_revision = other_len
 
878
        else:
 
879
            if stop_revision > other_len:
 
880
                raise errors.NoSuchRevision(self, stop_revision)
 
881
        return other_history[self_len:stop_revision]
 
882
 
 
883
    @needs_write_lock
 
884
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
885
                         graph=None):
 
886
        """Pull in new perfect-fit revisions.
 
887
 
 
888
        :param other: Another Branch to pull from
 
889
        :param stop_revision: Updated until the given revision
 
890
        :param overwrite: Always set the branch pointer, rather than checking
 
891
            to see if it is a proper descendant.
 
892
        :param graph: A Graph object that can be used to query history
 
893
            information. This can be None.
 
894
        :return: None
 
895
        """
 
896
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
897
            overwrite, graph)
 
898
 
1065
899
    def import_last_revision_info(self, source_repo, revno, revid):
1066
900
        """Set the last revision info, importing from another repo if necessary.
1067
901
 
 
902
        This is used by the bound branch code to upload a revision to
 
903
        the master branch first before updating the tip of the local branch.
 
904
 
1068
905
        :param source_repo: Source repository to optionally fetch from
1069
906
        :param revno: Revision number of the new tip
1070
907
        :param revid: Revision id of the new tip
1073
910
            self.repository.fetch(source_repo, revision_id=revid)
1074
911
        self.set_last_revision_info(revno, revid)
1075
912
 
1076
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1077
 
                                           lossy=False):
1078
 
        """Set the last revision info, importing from another repo if necessary.
1079
 
 
1080
 
        This is used by the bound branch code to upload a revision to
1081
 
        the master branch first before updating the tip of the local branch.
1082
 
        Revisions referenced by source's tags are also transferred.
1083
 
 
1084
 
        :param source: Source branch to optionally fetch from
1085
 
        :param revno: Revision number of the new tip
1086
 
        :param revid: Revision id of the new tip
1087
 
        :param lossy: Whether to discard metadata that can not be
1088
 
            natively represented
1089
 
        :return: Tuple with the new revision number and revision id
1090
 
            (should only be different from the arguments when lossy=True)
1091
 
        """
1092
 
        if not self.repository.has_same_location(source.repository):
1093
 
            self.fetch(source, revid)
1094
 
        self.set_last_revision_info(revno, revid)
1095
 
        return (revno, revid)
1096
 
 
1097
913
    def revision_id_to_revno(self, revision_id):
1098
914
        """Given a revision id, return its revno"""
1099
915
        if _mod_revision.is_null(revision_id):
1100
916
            return 0
1101
 
        history = self._revision_history()
 
917
        history = self.revision_history()
1102
918
        try:
1103
919
            return history.index(revision_id) + 1
1104
920
        except ValueError:
1119
935
            self._extend_partial_history(distance_from_last)
1120
936
        return self._partial_revision_history_cache[distance_from_last]
1121
937
 
 
938
    @needs_write_lock
1122
939
    def pull(self, source, overwrite=False, stop_revision=None,
1123
940
             possible_transports=None, *args, **kwargs):
1124
941
        """Mirror source into this branch.
1131
948
            stop_revision=stop_revision,
1132
949
            possible_transports=possible_transports, *args, **kwargs)
1133
950
 
1134
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1135
 
            *args, **kwargs):
 
951
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
952
        **kwargs):
1136
953
        """Mirror this branch into target.
1137
954
 
1138
955
        This branch is considered to be 'local', having low latency.
1139
956
        """
1140
957
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1141
 
            lossy, *args, **kwargs)
 
958
            *args, **kwargs)
 
959
 
 
960
    def lossy_push(self, target, stop_revision=None):
 
961
        """Push deltas into another branch.
 
962
 
 
963
        :note: This does not, like push, retain the revision ids from 
 
964
            the source branch and will, rather than adding bzr-specific 
 
965
            metadata, push only those semantics of the revision that can be 
 
966
            natively represented by this branch' VCS.
 
967
 
 
968
        :param target: Target branch
 
969
        :param stop_revision: Revision to push, defaults to last revision.
 
970
        :return: BranchPushResult with an extra member revidmap: 
 
971
            A dictionary mapping revision ids from the target branch 
 
972
            to new revision ids in the target branch, for each 
 
973
            revision that was pushed.
 
974
        """
 
975
        inter = InterBranch.get(self, target)
 
976
        lossy_push = getattr(inter, "lossy_push", None)
 
977
        if lossy_push is None:
 
978
            raise errors.LossyPushToSameVCS(self, target)
 
979
        return lossy_push(stop_revision)
1142
980
 
1143
981
    def basis_tree(self):
1144
982
        """Return `Tree` object for last revision."""
1161
999
        try:
1162
1000
            return urlutils.join(self.base[:-1], parent)
1163
1001
        except errors.InvalidURLJoin, e:
1164
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1002
            raise errors.InaccessibleParent(parent, self.base)
1165
1003
 
1166
1004
    def _get_parent_location(self):
1167
1005
        raise NotImplementedError(self._get_parent_location)
1252
1090
        params = ChangeBranchTipParams(
1253
1091
            self, old_revno, new_revno, old_revid, new_revid)
1254
1092
        for hook in hooks:
1255
 
            hook(params)
 
1093
            try:
 
1094
                hook(params)
 
1095
            except errors.TipChangeRejected:
 
1096
                raise
 
1097
            except Exception:
 
1098
                exc_info = sys.exc_info()
 
1099
                hook_name = Branch.hooks.get_hook_name(hook)
 
1100
                raise errors.HookFailed(
 
1101
                    'pre_change_branch_tip', hook_name, exc_info)
1256
1102
 
1257
1103
    @needs_write_lock
1258
1104
    def update(self):
1299
1145
        return result
1300
1146
 
1301
1147
    @needs_read_lock
1302
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1303
 
            repository=None):
 
1148
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1304
1149
        """Create a new line of development from the branch, into to_bzrdir.
1305
1150
 
1306
1151
        to_bzrdir controls the branch format.
1311
1156
        if (repository_policy is not None and
1312
1157
            repository_policy.requires_stacking()):
1313
1158
            to_bzrdir._format.require_stacking(_skip_repo=True)
1314
 
        result = to_bzrdir.create_branch(repository=repository)
 
1159
        result = to_bzrdir.create_branch()
1315
1160
        result.lock_write()
1316
1161
        try:
1317
1162
            if repository_policy is not None:
1318
1163
                repository_policy.configure_branch(result)
1319
1164
            self.copy_content_into(result, revision_id=revision_id)
1320
 
            master_url = self.get_bound_location()
1321
 
            if master_url is None:
1322
 
                result.set_parent(self.bzrdir.root_transport.base)
1323
 
            else:
1324
 
                result.set_parent(master_url)
 
1165
            result.set_parent(self.bzrdir.root_transport.base)
1325
1166
        finally:
1326
1167
            result.unlock()
1327
1168
        return result
1351
1192
                revno = 1
1352
1193
        destination.set_last_revision_info(revno, revision_id)
1353
1194
 
 
1195
    @needs_read_lock
1354
1196
    def copy_content_into(self, destination, revision_id=None):
1355
1197
        """Copy the content of self into destination.
1356
1198
 
1357
1199
        revision_id: if not None, the revision history in the new branch will
1358
1200
                     be truncated to end with revision_id.
1359
1201
        """
1360
 
        return InterBranch.get(self, destination).copy_content_into(
1361
 
            revision_id=revision_id)
 
1202
        self.update_references(destination)
 
1203
        self._synchronize_history(destination, revision_id)
 
1204
        try:
 
1205
            parent = self.get_parent()
 
1206
        except errors.InaccessibleParent, e:
 
1207
            mutter('parent was not accessible to copy: %s', e)
 
1208
        else:
 
1209
            if parent:
 
1210
                destination.set_parent(parent)
 
1211
        if self._push_should_merge_tags():
 
1212
            self.tags.merge_to(destination.tags)
1362
1213
 
1363
1214
    def update_references(self, target):
1364
1215
        if not getattr(self._format, 'supports_reference_locations', False):
1401
1252
        # TODO: We should probably also check that self.revision_history
1402
1253
        # matches the repository for older branch formats.
1403
1254
        # If looking for the code that cross-checks repository parents against
1404
 
        # the Graph.iter_lefthand_ancestry output, that is now a repository
 
1255
        # the iter_reverse_revision_history output, that is now a repository
1405
1256
        # specific check.
1406
1257
        return result
1407
1258
 
1408
 
    def _get_checkout_format(self, lightweight=False):
 
1259
    def _get_checkout_format(self):
1409
1260
        """Return the most suitable metadir for a checkout of this branch.
1410
1261
        Weaves are used if this branch's repository uses weaves.
1411
1262
        """
1412
 
        format = self.repository.bzrdir.checkout_metadir()
1413
 
        format.set_branch_format(self._format)
 
1263
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1264
            from bzrlib.repofmt import weaverepo
 
1265
            format = bzrdir.BzrDirMetaFormat1()
 
1266
            format.repository_format = weaverepo.RepositoryFormat7()
 
1267
        else:
 
1268
            format = self.repository.bzrdir.checkout_metadir()
 
1269
            format.set_branch_format(self._format)
1414
1270
        return format
1415
1271
 
1416
1272
    def create_clone_on_transport(self, to_transport, revision_id=None,
1417
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1418
 
        no_tree=None):
 
1273
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1419
1274
        """Create a clone of this branch and its bzrdir.
1420
1275
 
1421
1276
        :param to_transport: The transport to clone onto.
1428
1283
        """
1429
1284
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1430
1285
        # clone call. Or something. 20090224 RBC/spiv.
1431
 
        # XXX: Should this perhaps clone colocated branches as well, 
1432
 
        # rather than just the default branch? 20100319 JRV
1433
1286
        if revision_id is None:
1434
1287
            revision_id = self.last_revision()
1435
1288
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1436
1289
            revision_id=revision_id, stacked_on=stacked_on,
1437
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1438
 
            no_tree=no_tree)
 
1290
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1439
1291
        return dir_to.open_branch()
1440
1292
 
1441
1293
    def create_checkout(self, to_location, revision_id=None,
1446
1298
        :param to_location: The url to produce the checkout at
1447
1299
        :param revision_id: The revision to check out
1448
1300
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1449
 
            produce a bound branch (heavyweight checkout)
 
1301
        produce a bound branch (heavyweight checkout)
1450
1302
        :param accelerator_tree: A tree which can be used for retrieving file
1451
1303
            contents more quickly than the revision tree, i.e. a workingtree.
1452
1304
            The revision tree will be used for cases where accelerator_tree's
1457
1309
        """
1458
1310
        t = transport.get_transport(to_location)
1459
1311
        t.ensure_base()
1460
 
        format = self._get_checkout_format(lightweight=lightweight)
1461
1312
        if lightweight:
 
1313
            format = self._get_checkout_format()
1462
1314
            checkout = format.initialize_on_transport(t)
1463
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1464
 
                target_branch=self)
 
1315
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1465
1316
        else:
1466
 
            checkout_branch = controldir.ControlDir.create_branch_convenience(
 
1317
            format = self._get_checkout_format()
 
1318
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1467
1319
                to_location, force_new_tree=False, format=format)
1468
1320
            checkout = checkout_branch.bzrdir
1469
1321
            checkout_branch.bind(self)
1497
1349
 
1498
1350
    def reference_parent(self, file_id, path, possible_transports=None):
1499
1351
        """Return the parent branch for a tree-reference file_id
1500
 
 
1501
1352
        :param file_id: The file_id of the tree reference
1502
1353
        :param path: The path of the file_id in the tree
1503
1354
        :return: A branch associated with the file_id
1509
1360
    def supports_tags(self):
1510
1361
        return self._format.supports_tags()
1511
1362
 
1512
 
    def automatic_tag_name(self, revision_id):
1513
 
        """Try to automatically find the tag name for a revision.
1514
 
 
1515
 
        :param revision_id: Revision id of the revision.
1516
 
        :return: A tag name or None if no tag name could be determined.
1517
 
        """
1518
 
        for hook in Branch.hooks['automatic_tag_name']:
1519
 
            ret = hook(self, revision_id)
1520
 
            if ret is not None:
1521
 
                return ret
1522
 
        return None
1523
 
 
1524
1363
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1525
1364
                                         other_branch):
1526
1365
        """Ensure that revision_b is a descendant of revision_a.
1556
1395
        else:
1557
1396
            raise AssertionError("invalid heads: %r" % (heads,))
1558
1397
 
1559
 
    def heads_to_fetch(self):
1560
 
        """Return the heads that must and that should be fetched to copy this
1561
 
        branch into another repo.
1562
 
 
1563
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1564
 
            set of heads that must be fetched.  if_present_fetch is a set of
1565
 
            heads that must be fetched if present, but no error is necessary if
1566
 
            they are not present.
1567
 
        """
1568
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1569
 
        # are the tags.
1570
 
        must_fetch = set([self.last_revision()])
1571
 
        if_present_fetch = set()
1572
 
        c = self.get_config()
1573
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1574
 
                                                 default=False)
1575
 
        if include_tags:
1576
 
            try:
1577
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1578
 
            except errors.TagsNotSupported:
1579
 
                pass
1580
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1581
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1582
 
        return must_fetch, if_present_fetch
1583
 
 
1584
 
 
1585
 
class BranchFormat(controldir.ControlComponentFormat):
 
1398
 
 
1399
class BranchFormat(object):
1586
1400
    """An encapsulation of the initialization and open routines for a format.
1587
1401
 
1588
1402
    Formats provide three things:
1591
1405
     * an open routine.
1592
1406
 
1593
1407
    Formats are placed in an dict by their format string for reference
1594
 
    during branch opening. It's not required that these be instances, they
 
1408
    during branch opening. Its not required that these be instances, they
1595
1409
    can be classes themselves with class methods - it simply depends on
1596
1410
    whether state is needed for a given format or not.
1597
1411
 
1600
1414
    object will be created every time regardless.
1601
1415
    """
1602
1416
 
 
1417
    _default_format = None
 
1418
    """The default format used for new branches."""
 
1419
 
 
1420
    _formats = {}
 
1421
    """The known formats."""
 
1422
 
 
1423
    can_set_append_revisions_only = True
 
1424
 
1603
1425
    def __eq__(self, other):
1604
1426
        return self.__class__ is other.__class__
1605
1427
 
1607
1429
        return not (self == other)
1608
1430
 
1609
1431
    @classmethod
1610
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1432
    def find_format(klass, a_bzrdir):
 
1433
        """Return the format for the branch object in a_bzrdir."""
 
1434
        try:
 
1435
            transport = a_bzrdir.get_branch_transport(None)
 
1436
            format_string = transport.get_bytes("format")
 
1437
            return klass._formats[format_string]
 
1438
        except errors.NoSuchFile:
 
1439
            raise errors.NotBranchError(path=transport.base)
 
1440
        except KeyError:
 
1441
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
1442
 
 
1443
    @classmethod
1611
1444
    def get_default_format(klass):
1612
1445
        """Return the current default format."""
1613
 
        return format_registry.get_default()
1614
 
 
1615
 
    @classmethod
1616
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1617
 
    def get_formats(klass):
1618
 
        """Get all the known formats.
1619
 
 
1620
 
        Warning: This triggers a load of all lazy registered formats: do not
1621
 
        use except when that is desireed.
1622
 
        """
1623
 
        return format_registry._get_all()
1624
 
 
1625
 
    def get_reference(self, controldir, name=None):
1626
 
        """Get the target reference of the branch in controldir.
 
1446
        return klass._default_format
 
1447
 
 
1448
    def get_reference(self, a_bzrdir):
 
1449
        """Get the target reference of the branch in a_bzrdir.
1627
1450
 
1628
1451
        format probing must have been completed before calling
1629
1452
        this method - it is assumed that the format of the branch
1630
 
        in controldir is correct.
 
1453
        in a_bzrdir is correct.
1631
1454
 
1632
 
        :param controldir: The controldir to get the branch data from.
1633
 
        :param name: Name of the colocated branch to fetch
 
1455
        :param a_bzrdir: The bzrdir to get the branch data from.
1634
1456
        :return: None if the branch is not a reference branch.
1635
1457
        """
1636
1458
        return None
1637
1459
 
1638
1460
    @classmethod
1639
 
    def set_reference(self, controldir, name, to_branch):
1640
 
        """Set the target reference of the branch in controldir.
 
1461
    def set_reference(self, a_bzrdir, to_branch):
 
1462
        """Set the target reference of the branch in a_bzrdir.
1641
1463
 
1642
1464
        format probing must have been completed before calling
1643
1465
        this method - it is assumed that the format of the branch
1644
 
        in controldir is correct.
 
1466
        in a_bzrdir is correct.
1645
1467
 
1646
 
        :param controldir: The controldir to set the branch reference for.
1647
 
        :param name: Name of colocated branch to set, None for default
 
1468
        :param a_bzrdir: The bzrdir to set the branch reference for.
1648
1469
        :param to_branch: branch that the checkout is to reference
1649
1470
        """
1650
1471
        raise NotImplementedError(self.set_reference)
1651
1472
 
 
1473
    def get_format_string(self):
 
1474
        """Return the ASCII format string that identifies this format."""
 
1475
        raise NotImplementedError(self.get_format_string)
 
1476
 
1652
1477
    def get_format_description(self):
1653
1478
        """Return the short format description for this format."""
1654
1479
        raise NotImplementedError(self.get_format_description)
1655
1480
 
1656
 
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1657
 
        hooks = Branch.hooks['post_branch_init']
1658
 
        if not hooks:
1659
 
            return
1660
 
        params = BranchInitHookParams(self, controldir, name, branch)
1661
 
        for hook in hooks:
1662
 
            hook(params)
1663
 
 
1664
 
    def initialize(self, controldir, name=None, repository=None,
1665
 
                   append_revisions_only=None):
1666
 
        """Create a branch of this format in controldir.
1667
 
 
1668
 
        :param name: Name of the colocated branch to create.
 
1481
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1482
                           set_format=True):
 
1483
        """Initialize a branch in a bzrdir, with specified files
 
1484
 
 
1485
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1486
        :param utf8_files: The files to create as a list of
 
1487
            (filename, content) tuples
 
1488
        :param set_format: If True, set the format with
 
1489
            self.get_format_string.  (BzrBranch4 has its format set
 
1490
            elsewhere)
 
1491
        :return: a branch in this format
1669
1492
        """
 
1493
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1494
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1495
        lock_map = {
 
1496
            'metadir': ('lock', lockdir.LockDir),
 
1497
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1498
        }
 
1499
        lock_name, lock_class = lock_map[lock_type]
 
1500
        control_files = lockable_files.LockableFiles(branch_transport,
 
1501
            lock_name, lock_class)
 
1502
        control_files.create_lock()
 
1503
        try:
 
1504
            control_files.lock_write()
 
1505
        except errors.LockContention:
 
1506
            if lock_type != 'branch4':
 
1507
                raise
 
1508
            lock_taken = False
 
1509
        else:
 
1510
            lock_taken = True
 
1511
        if set_format:
 
1512
            utf8_files += [('format', self.get_format_string())]
 
1513
        try:
 
1514
            for (filename, content) in utf8_files:
 
1515
                branch_transport.put_bytes(
 
1516
                    filename, content,
 
1517
                    mode=a_bzrdir._get_file_mode())
 
1518
        finally:
 
1519
            if lock_taken:
 
1520
                control_files.unlock()
 
1521
        return self.open(a_bzrdir, _found=True)
 
1522
 
 
1523
    def initialize(self, a_bzrdir):
 
1524
        """Create a branch of this format in a_bzrdir."""
1670
1525
        raise NotImplementedError(self.initialize)
1671
1526
 
1672
1527
    def is_supported(self):
1690
1545
        Note that it is normal for branch to be a RemoteBranch when using tags
1691
1546
        on a RemoteBranch.
1692
1547
        """
1693
 
        return _mod_tag.DisabledTags(branch)
 
1548
        return DisabledTags(branch)
1694
1549
 
1695
1550
    def network_name(self):
1696
1551
        """A simple byte string uniquely identifying this format for RPC calls.
1702
1557
        """
1703
1558
        raise NotImplementedError(self.network_name)
1704
1559
 
1705
 
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1706
 
            found_repository=None, possible_transports=None):
1707
 
        """Return the branch object for controldir.
 
1560
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1561
        """Return the branch object for a_bzrdir
1708
1562
 
1709
 
        :param controldir: A ControlDir that contains a branch.
1710
 
        :param name: Name of colocated branch to open
 
1563
        :param a_bzrdir: A BzrDir that contains a branch.
1711
1564
        :param _found: a private parameter, do not use it. It is used to
1712
1565
            indicate if format probing has already be done.
1713
1566
        :param ignore_fallbacks: when set, no fallback branches will be opened
1716
1569
        raise NotImplementedError(self.open)
1717
1570
 
1718
1571
    @classmethod
1719
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1720
1572
    def register_format(klass, format):
1721
 
        """Register a metadir format.
1722
 
 
1723
 
        See MetaDirBranchFormatFactory for the ability to register a format
1724
 
        without loading the code the format needs until it is actually used.
1725
 
        """
1726
 
        format_registry.register(format)
 
1573
        """Register a metadir format."""
 
1574
        klass._formats[format.get_format_string()] = format
 
1575
        # Metadir formats have a network name of their format string, and get
 
1576
        # registered as class factories.
 
1577
        network_format_registry.register(format.get_format_string(), format.__class__)
1727
1578
 
1728
1579
    @classmethod
1729
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1730
1580
    def set_default_format(klass, format):
1731
 
        format_registry.set_default(format)
 
1581
        klass._default_format = format
1732
1582
 
1733
1583
    def supports_set_append_revisions_only(self):
1734
1584
        """True if this format supports set_append_revisions_only."""
1738
1588
        """True if this format records a stacked-on branch."""
1739
1589
        return False
1740
1590
 
1741
 
    def supports_leaving_lock(self):
1742
 
        """True if this format supports leaving locks in place."""
1743
 
        return False # by default
1744
 
 
1745
1591
    @classmethod
1746
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1747
1592
    def unregister_format(klass, format):
1748
 
        format_registry.remove(format)
 
1593
        del klass._formats[format.get_format_string()]
1749
1594
 
1750
1595
    def __str__(self):
1751
1596
        return self.get_format_description().rstrip()
1754
1599
        """True if this format supports tags stored in the branch"""
1755
1600
        return False  # by default
1756
1601
 
1757
 
    def tags_are_versioned(self):
1758
 
        """Whether the tag container for this branch versions tags."""
1759
 
        return False
1760
 
 
1761
 
    def supports_tags_referencing_ghosts(self):
1762
 
        """True if tags can reference ghost revisions."""
1763
 
        return True
1764
 
 
1765
 
 
1766
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1767
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1768
 
    
1769
 
    While none of the built in BranchFormats are lazy registered yet,
1770
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1771
 
    use it, and the bzr-loom plugin uses it as well (see
1772
 
    bzrlib.plugins.loom.formats).
1773
 
    """
1774
 
 
1775
 
    def __init__(self, format_string, module_name, member_name):
1776
 
        """Create a MetaDirBranchFormatFactory.
1777
 
 
1778
 
        :param format_string: The format string the format has.
1779
 
        :param module_name: Module to load the format class from.
1780
 
        :param member_name: Attribute name within the module for the format class.
1781
 
        """
1782
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1783
 
        self._format_string = format_string
1784
 
 
1785
 
    def get_format_string(self):
1786
 
        """See BranchFormat.get_format_string."""
1787
 
        return self._format_string
1788
 
 
1789
 
    def __call__(self):
1790
 
        """Used for network_format_registry support."""
1791
 
        return self.get_obj()()
1792
 
 
1793
1602
 
1794
1603
class BranchHooks(Hooks):
1795
1604
    """A dictionary mapping hook name to a list of callables for branch hooks.
1804
1613
        These are all empty initially, because by default nothing should get
1805
1614
        notified.
1806
1615
        """
1807
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1808
 
        self.add_hook('set_rh',
 
1616
        Hooks.__init__(self)
 
1617
        self.create_hook(HookPoint('set_rh',
1809
1618
            "Invoked whenever the revision history has been set via "
1810
1619
            "set_revision_history. The api signature is (branch, "
1811
1620
            "revision_history), and the branch will be write-locked. "
1812
1621
            "The set_rh hook can be expensive for bzr to trigger, a better "
1813
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1814
 
        self.add_hook('open',
 
1622
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1623
        self.create_hook(HookPoint('open',
1815
1624
            "Called with the Branch object that has been opened after a "
1816
 
            "branch is opened.", (1, 8))
1817
 
        self.add_hook('post_push',
 
1625
            "branch is opened.", (1, 8), None))
 
1626
        self.create_hook(HookPoint('post_push',
1818
1627
            "Called after a push operation completes. post_push is called "
1819
1628
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1820
 
            "bzr client.", (0, 15))
1821
 
        self.add_hook('post_pull',
 
1629
            "bzr client.", (0, 15), None))
 
1630
        self.create_hook(HookPoint('post_pull',
1822
1631
            "Called after a pull operation completes. post_pull is called "
1823
1632
            "with a bzrlib.branch.PullResult object and only runs in the "
1824
 
            "bzr client.", (0, 15))
1825
 
        self.add_hook('pre_commit',
1826
 
            "Called after a commit is calculated but before it is "
 
1633
            "bzr client.", (0, 15), None))
 
1634
        self.create_hook(HookPoint('pre_commit',
 
1635
            "Called after a commit is calculated but before it is is "
1827
1636
            "completed. pre_commit is called with (local, master, old_revno, "
1828
1637
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1829
1638
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1831
1640
            "basis revision. hooks MUST NOT modify this delta. "
1832
1641
            " future_tree is an in-memory tree obtained from "
1833
1642
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1834
 
            "tree.", (0,91))
1835
 
        self.add_hook('post_commit',
 
1643
            "tree.", (0,91), None))
 
1644
        self.create_hook(HookPoint('post_commit',
1836
1645
            "Called in the bzr client after a commit has completed. "
1837
1646
            "post_commit is called with (local, master, old_revno, old_revid, "
1838
1647
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1839
 
            "commit to a branch.", (0, 15))
1840
 
        self.add_hook('post_uncommit',
 
1648
            "commit to a branch.", (0, 15), None))
 
1649
        self.create_hook(HookPoint('post_uncommit',
1841
1650
            "Called in the bzr client after an uncommit completes. "
1842
1651
            "post_uncommit is called with (local, master, old_revno, "
1843
1652
            "old_revid, new_revno, new_revid) where local is the local branch "
1844
1653
            "or None, master is the target branch, and an empty branch "
1845
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1846
 
        self.add_hook('pre_change_branch_tip',
 
1654
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1655
        self.create_hook(HookPoint('pre_change_branch_tip',
1847
1656
            "Called in bzr client and server before a change to the tip of a "
1848
1657
            "branch is made. pre_change_branch_tip is called with a "
1849
1658
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1850
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1851
 
        self.add_hook('post_change_branch_tip',
 
1659
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1660
        self.create_hook(HookPoint('post_change_branch_tip',
1852
1661
            "Called in bzr client and server after a change to the tip of a "
1853
1662
            "branch is made. post_change_branch_tip is called with a "
1854
1663
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1855
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1856
 
        self.add_hook('transform_fallback_location',
 
1664
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1665
        self.create_hook(HookPoint('transform_fallback_location',
1857
1666
            "Called when a stacked branch is activating its fallback "
1858
1667
            "locations. transform_fallback_location is called with (branch, "
1859
1668
            "url), and should return a new url. Returning the same url "
1864
1673
            "fallback locations have not been activated. When there are "
1865
1674
            "multiple hooks installed for transform_fallback_location, "
1866
1675
            "all are called with the url returned from the previous hook."
1867
 
            "The order is however undefined.", (1, 9))
1868
 
        self.add_hook('automatic_tag_name',
1869
 
            "Called to determine an automatic tag name for a revision. "
1870
 
            "automatic_tag_name is called with (branch, revision_id) and "
1871
 
            "should return a tag name or None if no tag name could be "
1872
 
            "determined. The first non-None tag name returned will be used.",
1873
 
            (2, 2))
1874
 
        self.add_hook('post_branch_init',
1875
 
            "Called after new branch initialization completes. "
1876
 
            "post_branch_init is called with a "
1877
 
            "bzrlib.branch.BranchInitHookParams. "
1878
 
            "Note that init, branch and checkout (both heavyweight and "
1879
 
            "lightweight) will all trigger this hook.", (2, 2))
1880
 
        self.add_hook('post_switch',
1881
 
            "Called after a checkout switches branch. "
1882
 
            "post_switch is called with a "
1883
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1884
 
 
 
1676
            "The order is however undefined.", (1, 9), None))
1885
1677
 
1886
1678
 
1887
1679
# install the default hooks into the Branch class.
1889
1681
 
1890
1682
 
1891
1683
class ChangeBranchTipParams(object):
1892
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1684
    """Object holding parameters passed to *_change_branch_tip hooks.
1893
1685
 
1894
1686
    There are 5 fields that hooks may wish to access:
1895
1687
 
1926
1718
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1927
1719
 
1928
1720
 
1929
 
class BranchInitHookParams(object):
1930
 
    """Object holding parameters passed to `*_branch_init` hooks.
1931
 
 
1932
 
    There are 4 fields that hooks may wish to access:
1933
 
 
1934
 
    :ivar format: the branch format
1935
 
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1936
 
    :ivar name: name of colocated branch, if any (or None)
1937
 
    :ivar branch: the branch created
1938
 
 
1939
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1940
 
    the checkout, hence they are different from the corresponding fields in
1941
 
    branch, which refer to the original branch.
1942
 
    """
1943
 
 
1944
 
    def __init__(self, format, controldir, name, branch):
1945
 
        """Create a group of BranchInitHook parameters.
1946
 
 
1947
 
        :param format: the branch format
1948
 
        :param controldir: the ControlDir where the branch will be/has been
1949
 
            initialized
1950
 
        :param name: name of colocated branch, if any (or None)
1951
 
        :param branch: the branch created
1952
 
 
1953
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1954
 
        to the checkout, hence they are different from the corresponding fields
1955
 
        in branch, which refer to the original branch.
1956
 
        """
1957
 
        self.format = format
1958
 
        self.bzrdir = controldir
1959
 
        self.name = name
1960
 
        self.branch = branch
1961
 
 
1962
 
    def __eq__(self, other):
1963
 
        return self.__dict__ == other.__dict__
1964
 
 
1965
 
    def __repr__(self):
1966
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1967
 
 
1968
 
 
1969
 
class SwitchHookParams(object):
1970
 
    """Object holding parameters passed to `*_switch` hooks.
1971
 
 
1972
 
    There are 4 fields that hooks may wish to access:
1973
 
 
1974
 
    :ivar control_dir: ControlDir of the checkout to change
1975
 
    :ivar to_branch: branch that the checkout is to reference
1976
 
    :ivar force: skip the check for local commits in a heavy checkout
1977
 
    :ivar revision_id: revision ID to switch to (or None)
1978
 
    """
1979
 
 
1980
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1981
 
        """Create a group of SwitchHook parameters.
1982
 
 
1983
 
        :param control_dir: ControlDir of the checkout to change
1984
 
        :param to_branch: branch that the checkout is to reference
1985
 
        :param force: skip the check for local commits in a heavy checkout
1986
 
        :param revision_id: revision ID to switch to (or None)
1987
 
        """
1988
 
        self.control_dir = control_dir
1989
 
        self.to_branch = to_branch
1990
 
        self.force = force
1991
 
        self.revision_id = revision_id
1992
 
 
1993
 
    def __eq__(self, other):
1994
 
        return self.__dict__ == other.__dict__
1995
 
 
1996
 
    def __repr__(self):
1997
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
 
            self.control_dir, self.to_branch,
1999
 
            self.revision_id)
2000
 
 
2001
 
 
2002
 
class BranchFormatMetadir(bzrdir.BzrDirMetaComponentFormat, BranchFormat):
2003
 
    """Base class for branch formats that live in meta directories.
2004
 
    """
 
1721
class BzrBranchFormat4(BranchFormat):
 
1722
    """Bzr branch format 4.
 
1723
 
 
1724
    This format has:
 
1725
     - a revision-history file.
 
1726
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1727
    """
 
1728
 
 
1729
    def get_format_description(self):
 
1730
        """See BranchFormat.get_format_description()."""
 
1731
        return "Branch format 4"
 
1732
 
 
1733
    def initialize(self, a_bzrdir):
 
1734
        """Create a branch of this format in a_bzrdir."""
 
1735
        utf8_files = [('revision-history', ''),
 
1736
                      ('branch-name', ''),
 
1737
                      ]
 
1738
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1739
                                       lock_type='branch4', set_format=False)
2005
1740
 
2006
1741
    def __init__(self):
2007
 
        BranchFormat.__init__(self)
2008
 
        bzrdir.BzrDirMetaComponentFormat.__init__(self)
2009
 
 
2010
 
    @classmethod
2011
 
    def find_format(klass, controldir, name=None):
2012
 
        """Return the format for the branch object in controldir."""
2013
 
        try:
2014
 
            transport = controldir.get_branch_transport(None, name=name)
2015
 
        except errors.NoSuchFile:
2016
 
            raise errors.NotBranchError(path=name, bzrdir=controldir)
2017
 
        try:
2018
 
            format_string = transport.get_bytes("format")
2019
 
        except errors.NoSuchFile:
2020
 
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2021
 
        return klass._find_format(format_registry, 'branch', format_string)
 
1742
        super(BzrBranchFormat4, self).__init__()
 
1743
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1744
 
 
1745
    def network_name(self):
 
1746
        """The network name for this format is the control dirs disk label."""
 
1747
        return self._matchingbzrdir.get_format_string()
 
1748
 
 
1749
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1750
        """See BranchFormat.open()."""
 
1751
        if not _found:
 
1752
            # we are being called directly and must probe.
 
1753
            raise NotImplementedError
 
1754
        return BzrBranch(_format=self,
 
1755
                         _control_files=a_bzrdir._control_files,
 
1756
                         a_bzrdir=a_bzrdir,
 
1757
                         _repository=a_bzrdir.open_repository())
 
1758
 
 
1759
    def __str__(self):
 
1760
        return "Bazaar-NG branch format 4"
 
1761
 
 
1762
 
 
1763
class BranchFormatMetadir(BranchFormat):
 
1764
    """Common logic for meta-dir based branch formats."""
2022
1765
 
2023
1766
    def _branch_class(self):
2024
1767
        """What class to instantiate on open calls."""
2025
1768
        raise NotImplementedError(self._branch_class)
2026
1769
 
2027
 
    def _get_initial_config(self, append_revisions_only=None):
2028
 
        if append_revisions_only:
2029
 
            return "append_revisions_only = True\n"
2030
 
        else:
2031
 
            # Avoid writing anything if append_revisions_only is disabled,
2032
 
            # as that is the default.
2033
 
            return ""
2034
 
 
2035
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2036
 
                           repository=None):
2037
 
        """Initialize a branch in a bzrdir, with specified files
2038
 
 
2039
 
        :param a_bzrdir: The bzrdir to initialize the branch in
2040
 
        :param utf8_files: The files to create as a list of
2041
 
            (filename, content) tuples
2042
 
        :param name: Name of colocated branch to create, if any
2043
 
        :return: a branch in this format
 
1770
    def network_name(self):
 
1771
        """A simple byte string uniquely identifying this format for RPC calls.
 
1772
 
 
1773
        Metadir branch formats use their format string.
2044
1774
        """
2045
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2046
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2047
 
        control_files = lockable_files.LockableFiles(branch_transport,
2048
 
            'lock', lockdir.LockDir)
2049
 
        control_files.create_lock()
2050
 
        control_files.lock_write()
2051
 
        try:
2052
 
            utf8_files += [('format', self.get_format_string())]
2053
 
            for (filename, content) in utf8_files:
2054
 
                branch_transport.put_bytes(
2055
 
                    filename, content,
2056
 
                    mode=a_bzrdir._get_file_mode())
2057
 
        finally:
2058
 
            control_files.unlock()
2059
 
        branch = self.open(a_bzrdir, name, _found=True,
2060
 
                found_repository=repository)
2061
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2062
 
        return branch
 
1775
        return self.get_format_string()
2063
1776
 
2064
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2065
 
            found_repository=None, possible_transports=None):
 
1777
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2066
1778
        """See BranchFormat.open()."""
2067
1779
        if not _found:
2068
 
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
 
1780
            format = BranchFormat.find_format(a_bzrdir)
2069
1781
            if format.__class__ != self.__class__:
2070
1782
                raise AssertionError("wrong format %r found for %r" %
2071
1783
                    (format, self))
2072
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2073
1784
        try:
 
1785
            transport = a_bzrdir.get_branch_transport(None)
2074
1786
            control_files = lockable_files.LockableFiles(transport, 'lock',
2075
1787
                                                         lockdir.LockDir)
2076
 
            if found_repository is None:
2077
 
                found_repository = a_bzrdir.find_repository()
2078
1788
            return self._branch_class()(_format=self,
2079
1789
                              _control_files=control_files,
2080
 
                              name=name,
2081
1790
                              a_bzrdir=a_bzrdir,
2082
 
                              _repository=found_repository,
2083
 
                              ignore_fallbacks=ignore_fallbacks,
2084
 
                              possible_transports=possible_transports)
 
1791
                              _repository=a_bzrdir.find_repository(),
 
1792
                              ignore_fallbacks=ignore_fallbacks)
2085
1793
        except errors.NoSuchFile:
2086
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1794
            raise errors.NotBranchError(path=transport.base)
2087
1795
 
2088
 
    @property
2089
 
    def _matchingbzrdir(self):
2090
 
        ret = bzrdir.BzrDirMetaFormat1()
2091
 
        ret.set_branch_format(self)
2092
 
        return ret
 
1796
    def __init__(self):
 
1797
        super(BranchFormatMetadir, self).__init__()
 
1798
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1799
        self._matchingbzrdir.set_branch_format(self)
2093
1800
 
2094
1801
    def supports_tags(self):
2095
1802
        return True
2096
1803
 
2097
 
    def supports_leaving_lock(self):
2098
 
        return True
2099
 
 
2100
1804
 
2101
1805
class BzrBranchFormat5(BranchFormatMetadir):
2102
1806
    """Bzr branch format 5.
2114
1818
    def _branch_class(self):
2115
1819
        return BzrBranch5
2116
1820
 
2117
 
    @classmethod
2118
 
    def get_format_string(cls):
 
1821
    def get_format_string(self):
2119
1822
        """See BranchFormat.get_format_string()."""
2120
1823
        return "Bazaar-NG branch format 5\n"
2121
1824
 
2123
1826
        """See BranchFormat.get_format_description()."""
2124
1827
        return "Branch format 5"
2125
1828
 
2126
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2127
 
                   append_revisions_only=None):
 
1829
    def initialize(self, a_bzrdir):
2128
1830
        """Create a branch of this format in a_bzrdir."""
2129
 
        if append_revisions_only:
2130
 
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2131
1831
        utf8_files = [('revision-history', ''),
2132
1832
                      ('branch-name', ''),
2133
1833
                      ]
2134
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1834
        return self._initialize_helper(a_bzrdir, utf8_files)
2135
1835
 
2136
1836
    def supports_tags(self):
2137
1837
        return False
2151
1851
    def _branch_class(self):
2152
1852
        return BzrBranch6
2153
1853
 
2154
 
    @classmethod
2155
 
    def get_format_string(cls):
 
1854
    def get_format_string(self):
2156
1855
        """See BranchFormat.get_format_string()."""
2157
1856
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2158
1857
 
2160
1859
        """See BranchFormat.get_format_description()."""
2161
1860
        return "Branch format 6"
2162
1861
 
2163
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2164
 
                   append_revisions_only=None):
 
1862
    def initialize(self, a_bzrdir):
2165
1863
        """Create a branch of this format in a_bzrdir."""
2166
1864
        utf8_files = [('last-revision', '0 null:\n'),
2167
 
                      ('branch.conf',
2168
 
                          self._get_initial_config(append_revisions_only)),
 
1865
                      ('branch.conf', ''),
2169
1866
                      ('tags', ''),
2170
1867
                      ]
2171
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1868
        return self._initialize_helper(a_bzrdir, utf8_files)
2172
1869
 
2173
1870
    def make_tags(self, branch):
2174
1871
        """See bzrlib.branch.BranchFormat.make_tags()."""
2175
 
        return _mod_tag.BasicTags(branch)
 
1872
        return BasicTags(branch)
2176
1873
 
2177
1874
    def supports_set_append_revisions_only(self):
2178
1875
        return True
2184
1881
    def _branch_class(self):
2185
1882
        return BzrBranch8
2186
1883
 
2187
 
    @classmethod
2188
 
    def get_format_string(cls):
 
1884
    def get_format_string(self):
2189
1885
        """See BranchFormat.get_format_string()."""
2190
1886
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2191
1887
 
2193
1889
        """See BranchFormat.get_format_description()."""
2194
1890
        return "Branch format 8"
2195
1891
 
2196
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2197
 
                   append_revisions_only=None):
 
1892
    def initialize(self, a_bzrdir):
2198
1893
        """Create a branch of this format in a_bzrdir."""
2199
1894
        utf8_files = [('last-revision', '0 null:\n'),
2200
 
                      ('branch.conf',
2201
 
                          self._get_initial_config(append_revisions_only)),
 
1895
                      ('branch.conf', ''),
2202
1896
                      ('tags', ''),
2203
1897
                      ('references', '')
2204
1898
                      ]
2205
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1899
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1900
 
 
1901
    def __init__(self):
 
1902
        super(BzrBranchFormat8, self).__init__()
 
1903
        self._matchingbzrdir.repository_format = \
 
1904
            RepositoryFormatKnitPack5RichRoot()
2206
1905
 
2207
1906
    def make_tags(self, branch):
2208
1907
        """See bzrlib.branch.BranchFormat.make_tags()."""
2209
 
        return _mod_tag.BasicTags(branch)
 
1908
        return BasicTags(branch)
2210
1909
 
2211
1910
    def supports_set_append_revisions_only(self):
2212
1911
        return True
2217
1916
    supports_reference_locations = True
2218
1917
 
2219
1918
 
2220
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1919
class BzrBranchFormat7(BzrBranchFormat8):
2221
1920
    """Branch format with last-revision, tags, and a stacked location pointer.
2222
1921
 
2223
1922
    The stacked location pointer is passed down to the repository and requires
2226
1925
    This format was introduced in bzr 1.6.
2227
1926
    """
2228
1927
 
2229
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2230
 
                   append_revisions_only=None):
 
1928
    def initialize(self, a_bzrdir):
2231
1929
        """Create a branch of this format in a_bzrdir."""
2232
1930
        utf8_files = [('last-revision', '0 null:\n'),
2233
 
                      ('branch.conf',
2234
 
                          self._get_initial_config(append_revisions_only)),
 
1931
                      ('branch.conf', ''),
2235
1932
                      ('tags', ''),
2236
1933
                      ]
2237
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1934
        return self._initialize_helper(a_bzrdir, utf8_files)
2238
1935
 
2239
1936
    def _branch_class(self):
2240
1937
        return BzrBranch7
2241
1938
 
2242
 
    @classmethod
2243
 
    def get_format_string(cls):
 
1939
    def get_format_string(self):
2244
1940
        """See BranchFormat.get_format_string()."""
2245
1941
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2246
1942
 
2251
1947
    def supports_set_append_revisions_only(self):
2252
1948
        return True
2253
1949
 
2254
 
    def supports_stacking(self):
2255
 
        return True
2256
 
 
2257
 
    def make_tags(self, branch):
2258
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2259
 
        return _mod_tag.BasicTags(branch)
2260
 
 
2261
1950
    supports_reference_locations = False
2262
1951
 
2263
1952
 
2264
 
class BranchReferenceFormat(BranchFormatMetadir):
 
1953
class BranchReferenceFormat(BranchFormat):
2265
1954
    """Bzr branch reference format.
2266
1955
 
2267
1956
    Branch references are used in implementing checkouts, they
2272
1961
     - a format string
2273
1962
    """
2274
1963
 
2275
 
    @classmethod
2276
 
    def get_format_string(cls):
 
1964
    def get_format_string(self):
2277
1965
        """See BranchFormat.get_format_string()."""
2278
1966
        return "Bazaar-NG Branch Reference Format 1\n"
2279
1967
 
2281
1969
        """See BranchFormat.get_format_description()."""
2282
1970
        return "Checkout reference format 1"
2283
1971
 
2284
 
    def get_reference(self, a_bzrdir, name=None):
 
1972
    def get_reference(self, a_bzrdir):
2285
1973
        """See BranchFormat.get_reference()."""
2286
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1974
        transport = a_bzrdir.get_branch_transport(None)
2287
1975
        return transport.get_bytes('location')
2288
1976
 
2289
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1977
    def set_reference(self, a_bzrdir, to_branch):
2290
1978
        """See BranchFormat.set_reference()."""
2291
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1979
        transport = a_bzrdir.get_branch_transport(None)
2292
1980
        location = transport.put_bytes('location', to_branch.base)
2293
1981
 
2294
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2295
 
            repository=None, append_revisions_only=None):
 
1982
    def initialize(self, a_bzrdir, target_branch=None):
2296
1983
        """Create a branch of this format in a_bzrdir."""
2297
1984
        if target_branch is None:
2298
1985
            # this format does not implement branch itself, thus the implicit
2299
1986
            # creation contract must see it as uninitializable
2300
1987
            raise errors.UninitializableFormat(self)
2301
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2302
 
        if a_bzrdir._format.fixed_components:
2303
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2304
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1988
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1989
        branch_transport = a_bzrdir.get_branch_transport(self)
2305
1990
        branch_transport.put_bytes('location',
2306
 
            target_branch.user_url)
 
1991
            target_branch.bzrdir.root_transport.base)
2307
1992
        branch_transport.put_bytes('format', self.get_format_string())
2308
 
        branch = self.open(
2309
 
            a_bzrdir, name, _found=True,
 
1993
        return self.open(
 
1994
            a_bzrdir, _found=True,
2310
1995
            possible_transports=[target_branch.bzrdir.root_transport])
2311
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2312
 
        return branch
 
1996
 
 
1997
    def __init__(self):
 
1998
        super(BranchReferenceFormat, self).__init__()
 
1999
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
2000
        self._matchingbzrdir.set_branch_format(self)
2313
2001
 
2314
2002
    def _make_reference_clone_function(format, a_branch):
2315
2003
        """Create a clone() routine for a branch dynamically."""
2316
2004
        def clone(to_bzrdir, revision_id=None,
2317
2005
            repository_policy=None):
2318
2006
            """See Branch.clone()."""
2319
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2007
            return format.initialize(to_bzrdir, a_branch)
2320
2008
            # cannot obey revision_id limits when cloning a reference ...
2321
2009
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2322
2010
            # emit some sort of warning/error to the caller ?!
2323
2011
        return clone
2324
2012
 
2325
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2326
 
             possible_transports=None, ignore_fallbacks=False,
2327
 
             found_repository=None):
 
2013
    def open(self, a_bzrdir, _found=False, location=None,
 
2014
             possible_transports=None, ignore_fallbacks=False):
2328
2015
        """Return the branch that the branch reference in a_bzrdir points at.
2329
2016
 
2330
2017
        :param a_bzrdir: A BzrDir that contains a branch.
2331
 
        :param name: Name of colocated branch to open, if any
2332
2018
        :param _found: a private parameter, do not use it. It is used to
2333
2019
            indicate if format probing has already be done.
2334
2020
        :param ignore_fallbacks: when set, no fallback branches will be opened
2339
2025
        :param possible_transports: An optional reusable transports list.
2340
2026
        """
2341
2027
        if not _found:
2342
 
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
 
2028
            format = BranchFormat.find_format(a_bzrdir)
2343
2029
            if format.__class__ != self.__class__:
2344
2030
                raise AssertionError("wrong format %r found for %r" %
2345
2031
                    (format, self))
2346
2032
        if location is None:
2347
 
            location = self.get_reference(a_bzrdir, name)
2348
 
        real_bzrdir = controldir.ControlDir.open(
 
2033
            location = self.get_reference(a_bzrdir)
 
2034
        real_bzrdir = bzrdir.BzrDir.open(
2349
2035
            location, possible_transports=possible_transports)
2350
 
        result = real_bzrdir.open_branch(name=name, 
2351
 
            ignore_fallbacks=ignore_fallbacks,
2352
 
            possible_transports=possible_transports)
 
2036
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2353
2037
        # this changes the behaviour of result.clone to create a new reference
2354
2038
        # rather than a copy of the content of the branch.
2355
2039
        # I did not use a proxy object because that needs much more extensive
2362
2046
        return result
2363
2047
 
2364
2048
 
2365
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2366
 
    """Branch format registry."""
2367
 
 
2368
 
    def __init__(self, other_registry=None):
2369
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2370
 
        self._default_format = None
2371
 
 
2372
 
    def set_default(self, format):
2373
 
        self._default_format = format
2374
 
 
2375
 
    def get_default(self):
2376
 
        return self._default_format
2377
 
 
2378
 
 
2379
2049
network_format_registry = registry.FormatRegistry()
2380
2050
"""Registry of formats indexed by their network name.
2381
2051
 
2384
2054
BranchFormat.network_name() for more detail.
2385
2055
"""
2386
2056
 
2387
 
format_registry = BranchFormatRegistry(network_format_registry)
2388
 
 
2389
2057
 
2390
2058
# formats which have no format string are not discoverable
2391
2059
# and not independently creatable, so are not registered.
2393
2061
__format6 = BzrBranchFormat6()
2394
2062
__format7 = BzrBranchFormat7()
2395
2063
__format8 = BzrBranchFormat8()
2396
 
format_registry.register(__format5)
2397
 
format_registry.register(BranchReferenceFormat())
2398
 
format_registry.register(__format6)
2399
 
format_registry.register(__format7)
2400
 
format_registry.register(__format8)
2401
 
format_registry.set_default(__format7)
2402
 
 
2403
 
 
2404
 
class BranchWriteLockResult(LogicalLockResult):
2405
 
    """The result of write locking a branch.
2406
 
 
2407
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2408
 
        None.
2409
 
    :ivar unlock: A callable which will unlock the lock.
2410
 
    """
2411
 
 
2412
 
    def __init__(self, unlock, branch_token):
2413
 
        LogicalLockResult.__init__(self, unlock)
2414
 
        self.branch_token = branch_token
2415
 
 
2416
 
    def __repr__(self):
2417
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2418
 
            self.unlock)
 
2064
BranchFormat.register_format(__format5)
 
2065
BranchFormat.register_format(BranchReferenceFormat())
 
2066
BranchFormat.register_format(__format6)
 
2067
BranchFormat.register_format(__format7)
 
2068
BranchFormat.register_format(__format8)
 
2069
BranchFormat.set_default_format(__format7)
 
2070
_legacy_formats = [BzrBranchFormat4(),
 
2071
    ]
 
2072
network_format_registry.register(
 
2073
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2419
2074
 
2420
2075
 
2421
2076
class BzrBranch(Branch, _RelockDebugMixin):
2430
2085
    :ivar repository: Repository for this branch.
2431
2086
    :ivar base: The url of the base directory for this branch; the one
2432
2087
        containing the .bzr directory.
2433
 
    :ivar name: Optional colocated branch name as it exists in the control
2434
 
        directory.
2435
2088
    """
2436
2089
 
2437
2090
    def __init__(self, _format=None,
2438
 
                 _control_files=None, a_bzrdir=None, name=None,
2439
 
                 _repository=None, ignore_fallbacks=False,
2440
 
                 possible_transports=None):
 
2091
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2092
                 ignore_fallbacks=False):
2441
2093
        """Create new branch object at a particular location."""
2442
2094
        if a_bzrdir is None:
2443
2095
            raise ValueError('a_bzrdir must be supplied')
2444
2096
        else:
2445
2097
            self.bzrdir = a_bzrdir
2446
 
        self._user_transport = self.bzrdir.transport.clone('..')
2447
 
        if name is not None:
2448
 
            self._user_transport.set_segment_parameter(
2449
 
                "branch", urlutils.escape(name))
2450
 
        self._base = self._user_transport.base
2451
 
        self.name = name
 
2098
        self._base = self.bzrdir.transport.clone('..').base
 
2099
        # XXX: We should be able to just do
 
2100
        #   self.base = self.bzrdir.root_transport.base
 
2101
        # but this does not quite work yet -- mbp 20080522
2452
2102
        self._format = _format
2453
2103
        if _control_files is None:
2454
2104
            raise ValueError('BzrBranch _control_files is None')
2455
2105
        self.control_files = _control_files
2456
2106
        self._transport = _control_files._transport
2457
2107
        self.repository = _repository
2458
 
        Branch.__init__(self, possible_transports)
 
2108
        Branch.__init__(self)
2459
2109
 
2460
2110
    def __str__(self):
2461
 
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2111
        return '%s(%r)' % (self.__class__.__name__, self.base)
2462
2112
 
2463
2113
    __repr__ = __str__
2464
2114
 
2468
2118
 
2469
2119
    base = property(_get_base, doc="The URL for the root of this branch.")
2470
2120
 
2471
 
    @property
2472
 
    def user_transport(self):
2473
 
        return self._user_transport
2474
 
 
2475
2121
    def _get_config(self):
2476
 
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
2477
 
 
2478
 
    def _get_config_store(self):
2479
 
        return _mod_config.BranchStore(self)
 
2122
        return TransportConfig(self._transport, 'branch.conf')
2480
2123
 
2481
2124
    def is_locked(self):
2482
2125
        return self.control_files.is_locked()
2483
2126
 
2484
2127
    def lock_write(self, token=None):
2485
 
        """Lock the branch for write operations.
2486
 
 
2487
 
        :param token: A token to permit reacquiring a previously held and
2488
 
            preserved lock.
2489
 
        :return: A BranchWriteLockResult.
2490
 
        """
2491
2128
        if not self.is_locked():
2492
2129
            self._note_lock('w')
2493
2130
        # All-in-one needs to always unlock/lock.
2494
2131
        repo_control = getattr(self.repository, 'control_files', None)
2495
2132
        if self.control_files == repo_control or not self.is_locked():
2496
 
            self.repository._warn_if_deprecated(self)
2497
2133
            self.repository.lock_write()
2498
2134
            took_lock = True
2499
2135
        else:
2500
2136
            took_lock = False
2501
2137
        try:
2502
 
            return BranchWriteLockResult(self.unlock,
2503
 
                self.control_files.lock_write(token=token))
 
2138
            return self.control_files.lock_write(token=token)
2504
2139
        except:
2505
2140
            if took_lock:
2506
2141
                self.repository.unlock()
2507
2142
            raise
2508
2143
 
2509
2144
    def lock_read(self):
2510
 
        """Lock the branch for read operations.
2511
 
 
2512
 
        :return: A bzrlib.lock.LogicalLockResult.
2513
 
        """
2514
2145
        if not self.is_locked():
2515
2146
            self._note_lock('r')
2516
2147
        # All-in-one needs to always unlock/lock.
2517
2148
        repo_control = getattr(self.repository, 'control_files', None)
2518
2149
        if self.control_files == repo_control or not self.is_locked():
2519
 
            self.repository._warn_if_deprecated(self)
2520
2150
            self.repository.lock_read()
2521
2151
            took_lock = True
2522
2152
        else:
2523
2153
            took_lock = False
2524
2154
        try:
2525
2155
            self.control_files.lock_read()
2526
 
            return LogicalLockResult(self.unlock)
2527
2156
        except:
2528
2157
            if took_lock:
2529
2158
                self.repository.unlock()
2557
2186
        """See Branch.print_file."""
2558
2187
        return self.repository.print_file(file, revision_id)
2559
2188
 
 
2189
    def _write_revision_history(self, history):
 
2190
        """Factored out of set_revision_history.
 
2191
 
 
2192
        This performs the actual writing to disk.
 
2193
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2194
        self._transport.put_bytes(
 
2195
            'revision-history', '\n'.join(history),
 
2196
            mode=self.bzrdir._get_file_mode())
 
2197
 
 
2198
    @needs_write_lock
 
2199
    def set_revision_history(self, rev_history):
 
2200
        """See Branch.set_revision_history."""
 
2201
        if 'evil' in debug.debug_flags:
 
2202
            mutter_callsite(3, "set_revision_history scales with history.")
 
2203
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2204
        for rev_id in rev_history:
 
2205
            check_not_reserved_id(rev_id)
 
2206
        if Branch.hooks['post_change_branch_tip']:
 
2207
            # Don't calculate the last_revision_info() if there are no hooks
 
2208
            # that will use it.
 
2209
            old_revno, old_revid = self.last_revision_info()
 
2210
        if len(rev_history) == 0:
 
2211
            revid = _mod_revision.NULL_REVISION
 
2212
        else:
 
2213
            revid = rev_history[-1]
 
2214
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2215
        self._write_revision_history(rev_history)
 
2216
        self._clear_cached_state()
 
2217
        self._cache_revision_history(rev_history)
 
2218
        for hook in Branch.hooks['set_rh']:
 
2219
            hook(self, rev_history)
 
2220
        if Branch.hooks['post_change_branch_tip']:
 
2221
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2222
 
 
2223
    def _synchronize_history(self, destination, revision_id):
 
2224
        """Synchronize last revision and revision history between branches.
 
2225
 
 
2226
        This version is most efficient when the destination is also a
 
2227
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2228
        history is the true lefthand parent history, and all of the revisions
 
2229
        are in the destination's repository.  If not, set_revision_history
 
2230
        will fail.
 
2231
 
 
2232
        :param destination: The branch to copy the history into
 
2233
        :param revision_id: The revision-id to truncate history at.  May
 
2234
          be None to copy complete history.
 
2235
        """
 
2236
        if not isinstance(destination._format, BzrBranchFormat5):
 
2237
            super(BzrBranch, self)._synchronize_history(
 
2238
                destination, revision_id)
 
2239
            return
 
2240
        if revision_id == _mod_revision.NULL_REVISION:
 
2241
            new_history = []
 
2242
        else:
 
2243
            new_history = self.revision_history()
 
2244
        if revision_id is not None and new_history != []:
 
2245
            try:
 
2246
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2247
            except ValueError:
 
2248
                rev = self.repository.get_revision(revision_id)
 
2249
                new_history = rev.get_history(self.repository)[1:]
 
2250
        destination.set_revision_history(new_history)
 
2251
 
2560
2252
    @needs_write_lock
2561
2253
    def set_last_revision_info(self, revno, revision_id):
2562
 
        if not revision_id or not isinstance(revision_id, basestring):
2563
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2254
        """Set the last revision of this branch.
 
2255
 
 
2256
        The caller is responsible for checking that the revno is correct
 
2257
        for this revision id.
 
2258
 
 
2259
        It may be possible to set the branch last revision to an id not
 
2260
        present in the repository.  However, branches can also be
 
2261
        configured to check constraints on history, in which case this may not
 
2262
        be permitted.
 
2263
        """
2564
2264
        revision_id = _mod_revision.ensure_null(revision_id)
2565
 
        old_revno, old_revid = self.last_revision_info()
2566
 
        if self.get_append_revisions_only():
2567
 
            self._check_history_violation(revision_id)
2568
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2569
 
        self._write_last_revision_info(revno, revision_id)
2570
 
        self._clear_cached_state()
2571
 
        self._last_revision_info_cache = revno, revision_id
2572
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2265
        # this old format stores the full history, but this api doesn't
 
2266
        # provide it, so we must generate, and might as well check it's
 
2267
        # correct
 
2268
        history = self._lefthand_history(revision_id)
 
2269
        if len(history) != revno:
 
2270
            raise AssertionError('%d != %d' % (len(history), revno))
 
2271
        self.set_revision_history(history)
 
2272
 
 
2273
    def _gen_revision_history(self):
 
2274
        history = self._transport.get_bytes('revision-history').split('\n')
 
2275
        if history[-1:] == ['']:
 
2276
            # There shouldn't be a trailing newline, but just in case.
 
2277
            history.pop()
 
2278
        return history
 
2279
 
 
2280
    @needs_write_lock
 
2281
    def generate_revision_history(self, revision_id, last_rev=None,
 
2282
        other_branch=None):
 
2283
        """Create a new revision history that will finish with revision_id.
 
2284
 
 
2285
        :param revision_id: the new tip to use.
 
2286
        :param last_rev: The previous last_revision. If not None, then this
 
2287
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2288
        :param other_branch: The other branch that DivergedBranches should
 
2289
            raise with respect to.
 
2290
        """
 
2291
        self.set_revision_history(self._lefthand_history(revision_id,
 
2292
            last_rev, other_branch))
2573
2293
 
2574
2294
    def basis_tree(self):
2575
2295
        """See Branch.basis_tree."""
2584
2304
                pass
2585
2305
        return None
2586
2306
 
 
2307
    def _basic_push(self, target, overwrite, stop_revision):
 
2308
        """Basic implementation of push without bound branches or hooks.
 
2309
 
 
2310
        Must be called with source read locked and target write locked.
 
2311
        """
 
2312
        result = BranchPushResult()
 
2313
        result.source_branch = self
 
2314
        result.target_branch = target
 
2315
        result.old_revno, result.old_revid = target.last_revision_info()
 
2316
        self.update_references(target)
 
2317
        if result.old_revid != self.last_revision():
 
2318
            # We assume that during 'push' this repository is closer than
 
2319
            # the target.
 
2320
            graph = self.repository.get_graph(target.repository)
 
2321
            target.update_revisions(self, stop_revision,
 
2322
                overwrite=overwrite, graph=graph)
 
2323
        if self._push_should_merge_tags():
 
2324
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2325
                overwrite)
 
2326
        result.new_revno, result.new_revid = target.last_revision_info()
 
2327
        return result
 
2328
 
2587
2329
    def get_stacked_on_url(self):
2588
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2330
        raise errors.UnstackableBranchFormat(self._format, self.base)
2589
2331
 
2590
2332
    def set_push_location(self, location):
2591
2333
        """See Branch.set_push_location."""
2600
2342
            self._transport.put_bytes('parent', url + '\n',
2601
2343
                mode=self.bzrdir._get_file_mode())
2602
2344
 
 
2345
 
 
2346
class BzrBranch5(BzrBranch):
 
2347
    """A format 5 branch. This supports new features over plain branches.
 
2348
 
 
2349
    It has support for a master_branch which is the data for bound branches.
 
2350
    """
 
2351
 
 
2352
    def get_bound_location(self):
 
2353
        try:
 
2354
            return self._transport.get_bytes('bound')[:-1]
 
2355
        except errors.NoSuchFile:
 
2356
            return None
 
2357
 
 
2358
    @needs_read_lock
 
2359
    def get_master_branch(self, possible_transports=None):
 
2360
        """Return the branch we are bound to.
 
2361
 
 
2362
        :return: Either a Branch, or None
 
2363
 
 
2364
        This could memoise the branch, but if thats done
 
2365
        it must be revalidated on each new lock.
 
2366
        So for now we just don't memoise it.
 
2367
        # RBC 20060304 review this decision.
 
2368
        """
 
2369
        bound_loc = self.get_bound_location()
 
2370
        if not bound_loc:
 
2371
            return None
 
2372
        try:
 
2373
            return Branch.open(bound_loc,
 
2374
                               possible_transports=possible_transports)
 
2375
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2376
            raise errors.BoundBranchConnectionFailure(
 
2377
                    self, bound_loc, e)
 
2378
 
2603
2379
    @needs_write_lock
2604
 
    def unbind(self):
2605
 
        """If bound, unbind"""
2606
 
        return self.set_bound_location(None)
 
2380
    def set_bound_location(self, location):
 
2381
        """Set the target where this branch is bound to.
 
2382
 
 
2383
        :param location: URL to the target branch
 
2384
        """
 
2385
        if location:
 
2386
            self._transport.put_bytes('bound', location+'\n',
 
2387
                mode=self.bzrdir._get_file_mode())
 
2388
        else:
 
2389
            try:
 
2390
                self._transport.delete('bound')
 
2391
            except errors.NoSuchFile:
 
2392
                return False
 
2393
            return True
2607
2394
 
2608
2395
    @needs_write_lock
2609
2396
    def bind(self, other):
2631
2418
        # history around
2632
2419
        self.set_bound_location(other.base)
2633
2420
 
2634
 
    def get_bound_location(self):
2635
 
        try:
2636
 
            return self._transport.get_bytes('bound')[:-1]
2637
 
        except errors.NoSuchFile:
2638
 
            return None
2639
 
 
2640
 
    @needs_read_lock
2641
 
    def get_master_branch(self, possible_transports=None):
2642
 
        """Return the branch we are bound to.
2643
 
 
2644
 
        :return: Either a Branch, or None
2645
 
        """
2646
 
        if self._master_branch_cache is None:
2647
 
            self._master_branch_cache = self._get_master_branch(
2648
 
                possible_transports)
2649
 
        return self._master_branch_cache
2650
 
 
2651
 
    def _get_master_branch(self, possible_transports):
2652
 
        bound_loc = self.get_bound_location()
2653
 
        if not bound_loc:
2654
 
            return None
2655
 
        try:
2656
 
            return Branch.open(bound_loc,
2657
 
                               possible_transports=possible_transports)
2658
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2659
 
            raise errors.BoundBranchConnectionFailure(
2660
 
                    self, bound_loc, e)
2661
 
 
2662
2421
    @needs_write_lock
2663
 
    def set_bound_location(self, location):
2664
 
        """Set the target where this branch is bound to.
2665
 
 
2666
 
        :param location: URL to the target branch
2667
 
        """
2668
 
        self._master_branch_cache = None
2669
 
        if location:
2670
 
            self._transport.put_bytes('bound', location+'\n',
2671
 
                mode=self.bzrdir._get_file_mode())
2672
 
        else:
2673
 
            try:
2674
 
                self._transport.delete('bound')
2675
 
            except errors.NoSuchFile:
2676
 
                return False
2677
 
            return True
 
2422
    def unbind(self):
 
2423
        """If bound, unbind"""
 
2424
        return self.set_bound_location(None)
2678
2425
 
2679
2426
    @needs_write_lock
2680
2427
    def update(self, possible_transports=None):
2693
2440
            return old_tip
2694
2441
        return None
2695
2442
 
2696
 
    def _read_last_revision_info(self):
2697
 
        revision_string = self._transport.get_bytes('last-revision')
2698
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2699
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2700
 
        revno = int(revno)
2701
 
        return revno, revision_id
2702
 
 
2703
 
    def _write_last_revision_info(self, revno, revision_id):
2704
 
        """Simply write out the revision id, with no checks.
2705
 
 
2706
 
        Use set_last_revision_info to perform this safely.
2707
 
 
2708
 
        Does not update the revision_history cache.
2709
 
        """
2710
 
        revision_id = _mod_revision.ensure_null(revision_id)
2711
 
        out_string = '%d %s\n' % (revno, revision_id)
2712
 
        self._transport.put_bytes('last-revision', out_string,
2713
 
            mode=self.bzrdir._get_file_mode())
2714
 
 
2715
 
 
2716
 
class FullHistoryBzrBranch(BzrBranch):
2717
 
    """Bzr branch which contains the full revision history."""
2718
 
 
2719
 
    @needs_write_lock
2720
 
    def set_last_revision_info(self, revno, revision_id):
2721
 
        if not revision_id or not isinstance(revision_id, basestring):
2722
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2723
 
        revision_id = _mod_revision.ensure_null(revision_id)
2724
 
        # this old format stores the full history, but this api doesn't
2725
 
        # provide it, so we must generate, and might as well check it's
2726
 
        # correct
2727
 
        history = self._lefthand_history(revision_id)
2728
 
        if len(history) != revno:
2729
 
            raise AssertionError('%d != %d' % (len(history), revno))
2730
 
        self._set_revision_history(history)
2731
 
 
2732
 
    def _read_last_revision_info(self):
2733
 
        rh = self._revision_history()
2734
 
        revno = len(rh)
2735
 
        if revno:
2736
 
            return (revno, rh[-1])
2737
 
        else:
2738
 
            return (0, _mod_revision.NULL_REVISION)
2739
 
 
2740
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2741
 
    @needs_write_lock
2742
 
    def set_revision_history(self, rev_history):
2743
 
        """See Branch.set_revision_history."""
2744
 
        self._set_revision_history(rev_history)
2745
 
 
2746
 
    def _set_revision_history(self, rev_history):
2747
 
        if 'evil' in debug.debug_flags:
2748
 
            mutter_callsite(3, "set_revision_history scales with history.")
2749
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2750
 
        for rev_id in rev_history:
2751
 
            check_not_reserved_id(rev_id)
2752
 
        if Branch.hooks['post_change_branch_tip']:
2753
 
            # Don't calculate the last_revision_info() if there are no hooks
2754
 
            # that will use it.
2755
 
            old_revno, old_revid = self.last_revision_info()
2756
 
        if len(rev_history) == 0:
2757
 
            revid = _mod_revision.NULL_REVISION
2758
 
        else:
2759
 
            revid = rev_history[-1]
2760
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2761
 
        self._write_revision_history(rev_history)
2762
 
        self._clear_cached_state()
2763
 
        self._cache_revision_history(rev_history)
2764
 
        for hook in Branch.hooks['set_rh']:
2765
 
            hook(self, rev_history)
2766
 
        if Branch.hooks['post_change_branch_tip']:
2767
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2768
 
 
2769
 
    def _write_revision_history(self, history):
2770
 
        """Factored out of set_revision_history.
2771
 
 
2772
 
        This performs the actual writing to disk.
2773
 
        It is intended to be called by set_revision_history."""
2774
 
        self._transport.put_bytes(
2775
 
            'revision-history', '\n'.join(history),
2776
 
            mode=self.bzrdir._get_file_mode())
2777
 
 
2778
 
    def _gen_revision_history(self):
2779
 
        history = self._transport.get_bytes('revision-history').split('\n')
2780
 
        if history[-1:] == ['']:
2781
 
            # There shouldn't be a trailing newline, but just in case.
2782
 
            history.pop()
2783
 
        return history
2784
 
 
2785
 
    def _synchronize_history(self, destination, revision_id):
2786
 
        if not isinstance(destination, FullHistoryBzrBranch):
2787
 
            super(BzrBranch, self)._synchronize_history(
2788
 
                destination, revision_id)
2789
 
            return
2790
 
        if revision_id == _mod_revision.NULL_REVISION:
2791
 
            new_history = []
2792
 
        else:
2793
 
            new_history = self._revision_history()
2794
 
        if revision_id is not None and new_history != []:
2795
 
            try:
2796
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2797
 
            except ValueError:
2798
 
                rev = self.repository.get_revision(revision_id)
2799
 
                new_history = rev.get_history(self.repository)[1:]
2800
 
        destination._set_revision_history(new_history)
2801
 
 
2802
 
    @needs_write_lock
2803
 
    def generate_revision_history(self, revision_id, last_rev=None,
2804
 
        other_branch=None):
2805
 
        """Create a new revision history that will finish with revision_id.
2806
 
 
2807
 
        :param revision_id: the new tip to use.
2808
 
        :param last_rev: The previous last_revision. If not None, then this
2809
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2810
 
        :param other_branch: The other branch that DivergedBranches should
2811
 
            raise with respect to.
2812
 
        """
2813
 
        self._set_revision_history(self._lefthand_history(revision_id,
2814
 
            last_rev, other_branch))
2815
 
 
2816
 
 
2817
 
class BzrBranch5(FullHistoryBzrBranch):
2818
 
    """A format 5 branch. This supports new features over plain branches.
2819
 
 
2820
 
    It has support for a master_branch which is the data for bound branches.
2821
 
    """
2822
 
 
2823
 
 
2824
 
class BzrBranch8(BzrBranch):
 
2443
 
 
2444
class BzrBranch8(BzrBranch5):
2825
2445
    """A branch that stores tree-reference locations."""
2826
2446
 
2827
 
    def _open_hook(self, possible_transports=None):
 
2447
    def _open_hook(self):
2828
2448
        if self._ignore_fallbacks:
2829
2449
            return
2830
 
        if possible_transports is None:
2831
 
            possible_transports = [self.bzrdir.root_transport]
2832
2450
        try:
2833
2451
            url = self.get_stacked_on_url()
2834
2452
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2842
2460
                    raise AssertionError(
2843
2461
                        "'transform_fallback_location' hook %s returned "
2844
2462
                        "None, not a URL." % hook_name)
2845
 
            self._activate_fallback_location(url,
2846
 
                possible_transports=possible_transports)
 
2463
            self._activate_fallback_location(url)
2847
2464
 
2848
2465
    def __init__(self, *args, **kwargs):
2849
2466
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2856
2473
        self._last_revision_info_cache = None
2857
2474
        self._reference_info = None
2858
2475
 
 
2476
    def _last_revision_info(self):
 
2477
        revision_string = self._transport.get_bytes('last-revision')
 
2478
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2479
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2480
        revno = int(revno)
 
2481
        return revno, revision_id
 
2482
 
 
2483
    def _write_last_revision_info(self, revno, revision_id):
 
2484
        """Simply write out the revision id, with no checks.
 
2485
 
 
2486
        Use set_last_revision_info to perform this safely.
 
2487
 
 
2488
        Does not update the revision_history cache.
 
2489
        Intended to be called by set_last_revision_info and
 
2490
        _write_revision_history.
 
2491
        """
 
2492
        revision_id = _mod_revision.ensure_null(revision_id)
 
2493
        out_string = '%d %s\n' % (revno, revision_id)
 
2494
        self._transport.put_bytes('last-revision', out_string,
 
2495
            mode=self.bzrdir._get_file_mode())
 
2496
 
 
2497
    @needs_write_lock
 
2498
    def set_last_revision_info(self, revno, revision_id):
 
2499
        revision_id = _mod_revision.ensure_null(revision_id)
 
2500
        old_revno, old_revid = self.last_revision_info()
 
2501
        if self._get_append_revisions_only():
 
2502
            self._check_history_violation(revision_id)
 
2503
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2504
        self._write_last_revision_info(revno, revision_id)
 
2505
        self._clear_cached_state()
 
2506
        self._last_revision_info_cache = revno, revision_id
 
2507
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2508
 
 
2509
    def _synchronize_history(self, destination, revision_id):
 
2510
        """Synchronize last revision and revision history between branches.
 
2511
 
 
2512
        :see: Branch._synchronize_history
 
2513
        """
 
2514
        # XXX: The base Branch has a fast implementation of this method based
 
2515
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2516
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2517
        # but wants the fast implementation, so it calls
 
2518
        # Branch._synchronize_history directly.
 
2519
        Branch._synchronize_history(self, destination, revision_id)
 
2520
 
2859
2521
    def _check_history_violation(self, revision_id):
2860
 
        current_revid = self.last_revision()
2861
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2522
        last_revision = _mod_revision.ensure_null(self.last_revision())
2862
2523
        if _mod_revision.is_null(last_revision):
2863
2524
            return
2864
 
        graph = self.repository.get_graph()
2865
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2866
 
            if lh_ancestor == current_revid:
2867
 
                return
2868
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2525
        if last_revision not in self._lefthand_history(revision_id):
 
2526
            raise errors.AppendRevisionsOnlyViolation(self.base)
2869
2527
 
2870
2528
    def _gen_revision_history(self):
2871
2529
        """Generate the revision history from last revision
2874
2532
        self._extend_partial_history(stop_index=last_revno-1)
2875
2533
        return list(reversed(self._partial_revision_history_cache))
2876
2534
 
 
2535
    def _write_revision_history(self, history):
 
2536
        """Factored out of set_revision_history.
 
2537
 
 
2538
        This performs the actual writing to disk, with format-specific checks.
 
2539
        It is intended to be called by BzrBranch5.set_revision_history.
 
2540
        """
 
2541
        if len(history) == 0:
 
2542
            last_revision = 'null:'
 
2543
        else:
 
2544
            if history != self._lefthand_history(history[-1]):
 
2545
                raise errors.NotLefthandHistory(history)
 
2546
            last_revision = history[-1]
 
2547
        if self._get_append_revisions_only():
 
2548
            self._check_history_violation(last_revision)
 
2549
        self._write_last_revision_info(len(history), last_revision)
 
2550
 
2877
2551
    @needs_write_lock
2878
2552
    def _set_parent_location(self, url):
2879
2553
        """Set the parent branch"""
2955
2629
        if branch_location is None:
2956
2630
            return Branch.reference_parent(self, file_id, path,
2957
2631
                                           possible_transports)
2958
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2632
        branch_location = urlutils.join(self.base, branch_location)
2959
2633
        return Branch.open(branch_location,
2960
2634
                           possible_transports=possible_transports)
2961
2635
 
2965
2639
 
2966
2640
    def set_bound_location(self, location):
2967
2641
        """See Branch.set_push_location."""
2968
 
        self._master_branch_cache = None
2969
2642
        result = None
2970
2643
        config = self.get_config()
2971
2644
        if location is None:
3002
2675
        # you can always ask for the URL; but you might not be able to use it
3003
2676
        # if the repo can't support stacking.
3004
2677
        ## self._check_stackable_repo()
3005
 
        # stacked_on_location is only ever defined in branch.conf, so don't
3006
 
        # waste effort reading the whole stack of config files.
3007
 
        config = self.get_config()._get_branch_data_config()
3008
 
        stacked_url = self._get_config_location('stacked_on_location',
3009
 
            config=config)
 
2678
        stacked_url = self._get_config_location('stacked_on_location')
3010
2679
        if stacked_url is None:
3011
2680
            raise errors.NotStacked(self)
3012
2681
        return stacked_url
3013
2682
 
 
2683
    def _get_append_revisions_only(self):
 
2684
        value = self.get_config().get_user_option('append_revisions_only')
 
2685
        return value == 'True'
 
2686
 
 
2687
    @needs_write_lock
 
2688
    def generate_revision_history(self, revision_id, last_rev=None,
 
2689
                                  other_branch=None):
 
2690
        """See BzrBranch5.generate_revision_history"""
 
2691
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2692
        revno = len(history)
 
2693
        self.set_last_revision_info(revno, revision_id)
 
2694
 
3014
2695
    @needs_read_lock
3015
2696
    def get_rev_id(self, revno, history=None):
3016
2697
        """Find the revision id of the specified revno."""
3040
2721
        try:
3041
2722
            index = self._partial_revision_history_cache.index(revision_id)
3042
2723
        except ValueError:
3043
 
            try:
3044
 
                self._extend_partial_history(stop_revision=revision_id)
3045
 
            except errors.RevisionNotPresent, e:
3046
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2724
            self._extend_partial_history(stop_revision=revision_id)
3047
2725
            index = len(self._partial_revision_history_cache) - 1
3048
 
            if index < 0:
3049
 
                raise errors.NoSuchRevision(self, revision_id)
3050
2726
            if self._partial_revision_history_cache[index] != revision_id:
3051
2727
                raise errors.NoSuchRevision(self, revision_id)
3052
2728
        return self.revno() - index
3074
2750
    """
3075
2751
 
3076
2752
    def get_stacked_on_url(self):
3077
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2753
        raise errors.UnstackableBranchFormat(self._format, self.base)
3078
2754
 
3079
2755
 
3080
2756
######################################################################
3104
2780
    :ivar local_branch: target branch if there is a Master, else None
3105
2781
    :ivar target_branch: Target/destination branch object. (write locked)
3106
2782
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3107
 
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3108
2783
    """
3109
2784
 
3110
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3111
2785
    def __int__(self):
3112
 
        """Return the relative change in revno.
3113
 
 
3114
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3115
 
        """
 
2786
        # DEPRECATED: pull used to return the change in revno
3116
2787
        return self.new_revno - self.old_revno
3117
2788
 
3118
2789
    def report(self, to_file):
3119
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3120
 
        tag_updates = getattr(self, "tag_updates", None)
3121
2790
        if not is_quiet():
3122
 
            if self.old_revid != self.new_revid:
 
2791
            if self.old_revid == self.new_revid:
 
2792
                to_file.write('No revisions to pull.\n')
 
2793
            else:
3123
2794
                to_file.write('Now on revision %d.\n' % self.new_revno)
3124
 
            if tag_updates:
3125
 
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3126
 
            if self.old_revid == self.new_revid and not tag_updates:
3127
 
                if not tag_conflicts:
3128
 
                    to_file.write('No revisions or tags to pull.\n')
3129
 
                else:
3130
 
                    to_file.write('No revisions to pull.\n')
3131
2795
        self._show_tag_conficts(to_file)
3132
2796
 
3133
2797
 
3150
2814
        target, otherwise it will be None.
3151
2815
    """
3152
2816
 
3153
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3154
2817
    def __int__(self):
3155
 
        """Return the relative change in revno.
3156
 
 
3157
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3158
 
        """
 
2818
        # DEPRECATED: push used to return the change in revno
3159
2819
        return self.new_revno - self.old_revno
3160
2820
 
3161
2821
    def report(self, to_file):
3162
 
        # TODO: This function gets passed a to_file, but then
3163
 
        # ignores it and calls note() instead. This is also
3164
 
        # inconsistent with PullResult(), which writes to stdout.
3165
 
        # -- JRV20110901, bug #838853
3166
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3167
 
        tag_updates = getattr(self, "tag_updates", None)
3168
 
        if not is_quiet():
3169
 
            if self.old_revid != self.new_revid:
3170
 
                note(gettext('Pushed up to revision %d.') % self.new_revno)
3171
 
            if tag_updates:
3172
 
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3173
 
            if self.old_revid == self.new_revid and not tag_updates:
3174
 
                if not tag_conflicts:
3175
 
                    note(gettext('No new revisions or tags to push.'))
3176
 
                else:
3177
 
                    note(gettext('No new revisions to push.'))
 
2822
        """Write a human-readable description of the result."""
 
2823
        if self.old_revid == self.new_revid:
 
2824
            note('No new revisions to push.')
 
2825
        else:
 
2826
            note('Pushed up to revision %d.' % self.new_revno)
3178
2827
        self._show_tag_conficts(to_file)
3179
2828
 
3180
2829
 
3194
2843
        :param verbose: Requests more detailed display of what was checked,
3195
2844
            if any.
3196
2845
        """
3197
 
        note(gettext('checked branch {0} format {1}').format(
3198
 
                                self.branch.user_url, self.branch._format))
 
2846
        note('checked branch %s format %s', self.branch.base,
 
2847
            self.branch._format)
3199
2848
        for error in self.errors:
3200
 
            note(gettext('found error:%s'), error)
 
2849
            note('found error:%s', error)
3201
2850
 
3202
2851
 
3203
2852
class Converter5to6(object):
3242
2891
 
3243
2892
 
3244
2893
class Converter7to8(object):
3245
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
2894
    """Perform an in-place upgrade of format 6 to format 7"""
3246
2895
 
3247
2896
    def convert(self, branch):
3248
2897
        format = BzrBranchFormat8()
3251
2900
        branch._transport.put_bytes('format', format.get_format_string())
3252
2901
 
3253
2902
 
 
2903
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2904
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2905
    duration.
 
2906
 
 
2907
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2908
 
 
2909
    If an exception is raised by callable, then that exception *will* be
 
2910
    propagated, even if the unlock attempt raises its own error.  Thus
 
2911
    _run_with_write_locked_target should be preferred to simply doing::
 
2912
 
 
2913
        target.lock_write()
 
2914
        try:
 
2915
            return callable(*args, **kwargs)
 
2916
        finally:
 
2917
            target.unlock()
 
2918
 
 
2919
    """
 
2920
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2921
    # should share code?
 
2922
    target.lock_write()
 
2923
    try:
 
2924
        result = callable(*args, **kwargs)
 
2925
    except:
 
2926
        exc_info = sys.exc_info()
 
2927
        try:
 
2928
            target.unlock()
 
2929
        finally:
 
2930
            raise exc_info[0], exc_info[1], exc_info[2]
 
2931
    else:
 
2932
        target.unlock()
 
2933
        return result
 
2934
 
 
2935
 
3254
2936
class InterBranch(InterObject):
3255
2937
    """This class represents operations taking place between two branches.
3256
2938
 
3262
2944
    _optimisers = []
3263
2945
    """The available optimised InterBranch types."""
3264
2946
 
3265
 
    @classmethod
3266
 
    def _get_branch_formats_to_test(klass):
3267
 
        """Return an iterable of format tuples for testing.
3268
 
        
3269
 
        :return: An iterable of (from_format, to_format) to use when testing
3270
 
            this InterBranch class. Each InterBranch class should define this
3271
 
            method itself.
3272
 
        """
3273
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2947
    @staticmethod
 
2948
    def _get_branch_formats_to_test():
 
2949
        """Return a tuple with the Branch formats to use when testing."""
 
2950
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3274
2951
 
3275
 
    @needs_write_lock
3276
2952
    def pull(self, overwrite=False, stop_revision=None,
3277
2953
             possible_transports=None, local=False):
3278
2954
        """Mirror source into target branch.
3283
2959
        """
3284
2960
        raise NotImplementedError(self.pull)
3285
2961
 
3286
 
    @needs_write_lock
3287
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
2962
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2963
                         graph=None):
 
2964
        """Pull in new perfect-fit revisions.
 
2965
 
 
2966
        :param stop_revision: Updated until the given revision
 
2967
        :param overwrite: Always set the branch pointer, rather than checking
 
2968
            to see if it is a proper descendant.
 
2969
        :param graph: A Graph object that can be used to query history
 
2970
            information. This can be None.
 
2971
        :return: None
 
2972
        """
 
2973
        raise NotImplementedError(self.update_revisions)
 
2974
 
 
2975
    def push(self, overwrite=False, stop_revision=None,
3288
2976
             _override_hook_source_branch=None):
3289
2977
        """Mirror the source branch into the target branch.
3290
2978
 
3292
2980
        """
3293
2981
        raise NotImplementedError(self.push)
3294
2982
 
3295
 
    @needs_write_lock
3296
 
    def copy_content_into(self, revision_id=None):
3297
 
        """Copy the content of source into target
3298
 
 
3299
 
        revision_id: if not None, the revision history in the new branch will
3300
 
                     be truncated to end with revision_id.
3301
 
        """
3302
 
        raise NotImplementedError(self.copy_content_into)
3303
 
 
3304
 
    @needs_write_lock
3305
 
    def fetch(self, stop_revision=None, limit=None):
3306
 
        """Fetch revisions.
3307
 
 
3308
 
        :param stop_revision: Last revision to fetch
3309
 
        :param limit: Optional rough limit of revisions to fetch
3310
 
        """
3311
 
        raise NotImplementedError(self.fetch)
3312
 
 
3313
2983
 
3314
2984
class GenericInterBranch(InterBranch):
3315
 
    """InterBranch implementation that uses public Branch functions."""
3316
 
 
3317
 
    @classmethod
3318
 
    def is_compatible(klass, source, target):
3319
 
        # GenericBranch uses the public API, so always compatible
3320
 
        return True
3321
 
 
3322
 
    @classmethod
3323
 
    def _get_branch_formats_to_test(klass):
3324
 
        return [(format_registry.get_default(), format_registry.get_default())]
3325
 
 
3326
 
    @classmethod
3327
 
    def unwrap_format(klass, format):
3328
 
        if isinstance(format, remote.RemoteBranchFormat):
3329
 
            format._ensure_real()
3330
 
            return format._custom_format
3331
 
        return format
3332
 
 
3333
 
    @needs_write_lock
3334
 
    def copy_content_into(self, revision_id=None):
3335
 
        """Copy the content of source into target
3336
 
 
3337
 
        revision_id: if not None, the revision history in the new branch will
3338
 
                     be truncated to end with revision_id.
3339
 
        """
3340
 
        self.source.update_references(self.target)
3341
 
        self.source._synchronize_history(self.target, revision_id)
3342
 
        try:
3343
 
            parent = self.source.get_parent()
3344
 
        except errors.InaccessibleParent, e:
3345
 
            mutter('parent was not accessible to copy: %s', e)
3346
 
        else:
3347
 
            if parent:
3348
 
                self.target.set_parent(parent)
3349
 
        if self.source._push_should_merge_tags():
3350
 
            self.source.tags.merge_to(self.target.tags)
3351
 
 
3352
 
    @needs_write_lock
3353
 
    def fetch(self, stop_revision=None, limit=None):
3354
 
        if self.target.base == self.source.base:
3355
 
            return (0, [])
 
2985
    """InterBranch implementation that uses public Branch functions.
 
2986
    """
 
2987
 
 
2988
    @staticmethod
 
2989
    def _get_branch_formats_to_test():
 
2990
        return BranchFormat._default_format, BranchFormat._default_format
 
2991
 
 
2992
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2993
        graph=None):
 
2994
        """See InterBranch.update_revisions()."""
3356
2995
        self.source.lock_read()
3357
2996
        try:
3358
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3359
 
            fetch_spec_factory.source_branch = self.source
3360
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3361
 
            fetch_spec_factory.source_repo = self.source.repository
3362
 
            fetch_spec_factory.target_repo = self.target.repository
3363
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3364
 
            fetch_spec_factory.limit = limit
3365
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3366
 
            return self.target.repository.fetch(self.source.repository,
3367
 
                fetch_spec=fetch_spec)
 
2997
            other_revno, other_last_revision = self.source.last_revision_info()
 
2998
            stop_revno = None # unknown
 
2999
            if stop_revision is None:
 
3000
                stop_revision = other_last_revision
 
3001
                if _mod_revision.is_null(stop_revision):
 
3002
                    # if there are no commits, we're done.
 
3003
                    return
 
3004
                stop_revno = other_revno
 
3005
 
 
3006
            # what's the current last revision, before we fetch [and change it
 
3007
            # possibly]
 
3008
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3009
            # we fetch here so that we don't process data twice in the common
 
3010
            # case of having something to pull, and so that the check for
 
3011
            # already merged can operate on the just fetched graph, which will
 
3012
            # be cached in memory.
 
3013
            self.target.fetch(self.source, stop_revision)
 
3014
            # Check to see if one is an ancestor of the other
 
3015
            if not overwrite:
 
3016
                if graph is None:
 
3017
                    graph = self.target.repository.get_graph()
 
3018
                if self.target._check_if_descendant_or_diverged(
 
3019
                        stop_revision, last_rev, graph, self.source):
 
3020
                    # stop_revision is a descendant of last_rev, but we aren't
 
3021
                    # overwriting, so we're done.
 
3022
                    return
 
3023
            if stop_revno is None:
 
3024
                if graph is None:
 
3025
                    graph = self.target.repository.get_graph()
 
3026
                this_revno, this_last_revision = \
 
3027
                        self.target.last_revision_info()
 
3028
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3029
                                [(other_last_revision, other_revno),
 
3030
                                 (this_last_revision, this_revno)])
 
3031
            self.target.set_last_revision_info(stop_revno, stop_revision)
3368
3032
        finally:
3369
3033
            self.source.unlock()
3370
3034
 
3371
 
    @needs_write_lock
3372
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3373
 
            graph=None):
3374
 
        other_revno, other_last_revision = self.source.last_revision_info()
3375
 
        stop_revno = None # unknown
3376
 
        if stop_revision is None:
3377
 
            stop_revision = other_last_revision
3378
 
            if _mod_revision.is_null(stop_revision):
3379
 
                # if there are no commits, we're done.
3380
 
                return
3381
 
            stop_revno = other_revno
3382
 
 
3383
 
        # what's the current last revision, before we fetch [and change it
3384
 
        # possibly]
3385
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3386
 
        # we fetch here so that we don't process data twice in the common
3387
 
        # case of having something to pull, and so that the check for
3388
 
        # already merged can operate on the just fetched graph, which will
3389
 
        # be cached in memory.
3390
 
        self.fetch(stop_revision=stop_revision)
3391
 
        # Check to see if one is an ancestor of the other
3392
 
        if not overwrite:
3393
 
            if graph is None:
3394
 
                graph = self.target.repository.get_graph()
3395
 
            if self.target._check_if_descendant_or_diverged(
3396
 
                    stop_revision, last_rev, graph, self.source):
3397
 
                # stop_revision is a descendant of last_rev, but we aren't
3398
 
                # overwriting, so we're done.
3399
 
                return
3400
 
        if stop_revno is None:
3401
 
            if graph is None:
3402
 
                graph = self.target.repository.get_graph()
3403
 
            this_revno, this_last_revision = \
3404
 
                    self.target.last_revision_info()
3405
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3406
 
                            [(other_last_revision, other_revno),
3407
 
                             (this_last_revision, this_revno)])
3408
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3409
 
 
3410
 
    @needs_write_lock
3411
3035
    def pull(self, overwrite=False, stop_revision=None,
3412
 
             possible_transports=None, run_hooks=True,
3413
 
             _override_hook_target=None, local=False):
3414
 
        """Pull from source into self, updating my master if any.
3415
 
 
3416
 
        :param run_hooks: Private parameter - if false, this branch
3417
 
            is being called because it's the master of the primary branch,
3418
 
            so it should not run its hooks.
3419
 
        """
3420
 
        bound_location = self.target.get_bound_location()
3421
 
        if local and not bound_location:
3422
 
            raise errors.LocalRequiresBoundBranch()
3423
 
        master_branch = None
3424
 
        source_is_master = False
3425
 
        if bound_location:
3426
 
            # bound_location comes from a config file, some care has to be
3427
 
            # taken to relate it to source.user_url
3428
 
            normalized = urlutils.normalize_url(bound_location)
3429
 
            try:
3430
 
                relpath = self.source.user_transport.relpath(normalized)
3431
 
                source_is_master = (relpath == '')
3432
 
            except (errors.PathNotChild, errors.InvalidURL):
3433
 
                source_is_master = False
3434
 
        if not local and bound_location and not source_is_master:
3435
 
            # not pulling from master, so we need to update master.
3436
 
            master_branch = self.target.get_master_branch(possible_transports)
3437
 
            master_branch.lock_write()
3438
 
        try:
3439
 
            if master_branch:
3440
 
                # pull from source into master.
3441
 
                master_branch.pull(self.source, overwrite, stop_revision,
3442
 
                    run_hooks=False)
3443
 
            return self._pull(overwrite,
3444
 
                stop_revision, _hook_master=master_branch,
3445
 
                run_hooks=run_hooks,
3446
 
                _override_hook_target=_override_hook_target,
3447
 
                merge_tags_to_master=not source_is_master)
3448
 
        finally:
3449
 
            if master_branch:
3450
 
                master_branch.unlock()
3451
 
 
3452
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3453
 
             _override_hook_source_branch=None):
3454
 
        """See InterBranch.push.
3455
 
 
3456
 
        This is the basic concrete implementation of push()
3457
 
 
3458
 
        :param _override_hook_source_branch: If specified, run the hooks
3459
 
            passing this Branch as the source, rather than self.  This is for
3460
 
            use of RemoteBranch, where push is delegated to the underlying
3461
 
            vfs-based Branch.
3462
 
        """
3463
 
        if lossy:
3464
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3465
 
        # TODO: Public option to disable running hooks - should be trivial but
3466
 
        # needs tests.
3467
 
 
3468
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3469
 
        op.add_cleanup(self.source.lock_read().unlock)
3470
 
        op.add_cleanup(self.target.lock_write().unlock)
3471
 
        return op.run(overwrite, stop_revision,
3472
 
            _override_hook_source_branch=_override_hook_source_branch)
3473
 
 
3474
 
    def _basic_push(self, overwrite, stop_revision):
3475
 
        """Basic implementation of push without bound branches or hooks.
3476
 
 
3477
 
        Must be called with source read locked and target write locked.
3478
 
        """
3479
 
        result = BranchPushResult()
3480
 
        result.source_branch = self.source
3481
 
        result.target_branch = self.target
3482
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3483
 
        self.source.update_references(self.target)
3484
 
        if result.old_revid != stop_revision:
3485
 
            # We assume that during 'push' this repository is closer than
3486
 
            # the target.
3487
 
            graph = self.source.repository.get_graph(self.target.repository)
3488
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3489
 
                    graph=graph)
3490
 
        if self.source._push_should_merge_tags():
3491
 
            result.tag_updates, result.tag_conflicts = (
3492
 
                self.source.tags.merge_to(self.target.tags, overwrite))
3493
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3494
 
        return result
3495
 
 
3496
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3497
 
            _override_hook_source_branch=None):
3498
 
        """Push from source into target, and into target's master if any.
3499
 
        """
3500
 
        def _run_hooks():
3501
 
            if _override_hook_source_branch:
3502
 
                result.source_branch = _override_hook_source_branch
3503
 
            for hook in Branch.hooks['post_push']:
3504
 
                hook(result)
3505
 
 
3506
 
        bound_location = self.target.get_bound_location()
3507
 
        if bound_location and self.target.base != bound_location:
3508
 
            # there is a master branch.
3509
 
            #
3510
 
            # XXX: Why the second check?  Is it even supported for a branch to
3511
 
            # be bound to itself? -- mbp 20070507
3512
 
            master_branch = self.target.get_master_branch()
3513
 
            master_branch.lock_write()
3514
 
            operation.add_cleanup(master_branch.unlock)
3515
 
            # push into the master from the source branch.
3516
 
            master_inter = InterBranch.get(self.source, master_branch)
3517
 
            master_inter._basic_push(overwrite, stop_revision)
3518
 
            # and push into the target branch from the source. Note that
3519
 
            # we push from the source branch again, because it's considered
3520
 
            # the highest bandwidth repository.
3521
 
            result = self._basic_push(overwrite, stop_revision)
3522
 
            result.master_branch = master_branch
3523
 
            result.local_branch = self.target
3524
 
        else:
3525
 
            master_branch = None
3526
 
            # no master branch
3527
 
            result = self._basic_push(overwrite, stop_revision)
3528
 
            # TODO: Why set master_branch and local_branch if there's no
3529
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3530
 
            # 20070504
3531
 
            result.master_branch = self.target
3532
 
            result.local_branch = None
3533
 
        _run_hooks()
3534
 
        return result
3535
 
 
3536
 
    def _pull(self, overwrite=False, stop_revision=None,
3537
3036
             possible_transports=None, _hook_master=None, run_hooks=True,
3538
 
             _override_hook_target=None, local=False,
3539
 
             merge_tags_to_master=True):
 
3037
             _override_hook_target=None, local=False):
3540
3038
        """See Branch.pull.
3541
3039
 
3542
 
        This function is the core worker, used by GenericInterBranch.pull to
3543
 
        avoid duplication when pulling source->master and source->local.
3544
 
 
3545
3040
        :param _hook_master: Private parameter - set the branch to
3546
3041
            be supplied as the master to pull hooks.
3547
3042
        :param run_hooks: Private parameter - if false, this branch
3548
3043
            is being called because it's the master of the primary branch,
3549
3044
            so it should not run its hooks.
3550
 
            is being called because it's the master of the primary branch,
3551
 
            so it should not run its hooks.
3552
3045
        :param _override_hook_target: Private parameter - set the branch to be
3553
3046
            supplied as the target_branch to pull hooks.
3554
3047
        :param local: Only update the local branch, and not the bound branch.
3573
3066
            # -- JRV20090506
3574
3067
            result.old_revno, result.old_revid = \
3575
3068
                self.target.last_revision_info()
3576
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3577
 
                graph=graph)
 
3069
            self.target.update_revisions(self.source, stop_revision,
 
3070
                overwrite=overwrite, graph=graph)
3578
3071
            # TODO: The old revid should be specified when merging tags, 
3579
3072
            # so a tags implementation that versions tags can only 
3580
3073
            # pull in the most recent changes. -- JRV20090506
3581
 
            result.tag_updates, result.tag_conflicts = (
3582
 
                self.source.tags.merge_to(self.target.tags, overwrite,
3583
 
                    ignore_master=not merge_tags_to_master))
 
3074
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3075
                overwrite)
3584
3076
            result.new_revno, result.new_revid = self.target.last_revision_info()
3585
3077
            if _hook_master:
3586
3078
                result.master_branch = _hook_master
3595
3087
            self.source.unlock()
3596
3088
        return result
3597
3089
 
 
3090
    def push(self, overwrite=False, stop_revision=None,
 
3091
             _override_hook_source_branch=None):
 
3092
        """See InterBranch.push.
 
3093
 
 
3094
        This is the basic concrete implementation of push()
 
3095
 
 
3096
        :param _override_hook_source_branch: If specified, run
 
3097
        the hooks passing this Branch as the source, rather than self.
 
3098
        This is for use of RemoteBranch, where push is delegated to the
 
3099
        underlying vfs-based Branch.
 
3100
        """
 
3101
        # TODO: Public option to disable running hooks - should be trivial but
 
3102
        # needs tests.
 
3103
        self.source.lock_read()
 
3104
        try:
 
3105
            return _run_with_write_locked_target(
 
3106
                self.target, self._push_with_bound_branches, overwrite,
 
3107
                stop_revision,
 
3108
                _override_hook_source_branch=_override_hook_source_branch)
 
3109
        finally:
 
3110
            self.source.unlock()
 
3111
 
 
3112
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3113
            _override_hook_source_branch=None):
 
3114
        """Push from source into target, and into target's master if any.
 
3115
        """
 
3116
        def _run_hooks():
 
3117
            if _override_hook_source_branch:
 
3118
                result.source_branch = _override_hook_source_branch
 
3119
            for hook in Branch.hooks['post_push']:
 
3120
                hook(result)
 
3121
 
 
3122
        bound_location = self.target.get_bound_location()
 
3123
        if bound_location and self.target.base != bound_location:
 
3124
            # there is a master branch.
 
3125
            #
 
3126
            # XXX: Why the second check?  Is it even supported for a branch to
 
3127
            # be bound to itself? -- mbp 20070507
 
3128
            master_branch = self.target.get_master_branch()
 
3129
            master_branch.lock_write()
 
3130
            try:
 
3131
                # push into the master from the source branch.
 
3132
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3133
                # and push into the target branch from the source. Note that we
 
3134
                # push from the source branch again, because its considered the
 
3135
                # highest bandwidth repository.
 
3136
                result = self.source._basic_push(self.target, overwrite,
 
3137
                    stop_revision)
 
3138
                result.master_branch = master_branch
 
3139
                result.local_branch = self.target
 
3140
                _run_hooks()
 
3141
                return result
 
3142
            finally:
 
3143
                master_branch.unlock()
 
3144
        else:
 
3145
            # no master branch
 
3146
            result = self.source._basic_push(self.target, overwrite,
 
3147
                stop_revision)
 
3148
            # TODO: Why set master_branch and local_branch if there's no
 
3149
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3150
            # 20070504
 
3151
            result.master_branch = self.target
 
3152
            result.local_branch = None
 
3153
            _run_hooks()
 
3154
            return result
 
3155
 
 
3156
    @classmethod
 
3157
    def is_compatible(self, source, target):
 
3158
        # GenericBranch uses the public API, so always compatible
 
3159
        return True
 
3160
 
 
3161
 
 
3162
class InterToBranch5(GenericInterBranch):
 
3163
 
 
3164
    @staticmethod
 
3165
    def _get_branch_formats_to_test():
 
3166
        return BranchFormat._default_format, BzrBranchFormat5()
 
3167
 
 
3168
    def pull(self, overwrite=False, stop_revision=None,
 
3169
             possible_transports=None, run_hooks=True,
 
3170
             _override_hook_target=None, local=False):
 
3171
        """Pull from source into self, updating my master if any.
 
3172
 
 
3173
        :param run_hooks: Private parameter - if false, this branch
 
3174
            is being called because it's the master of the primary branch,
 
3175
            so it should not run its hooks.
 
3176
        """
 
3177
        bound_location = self.target.get_bound_location()
 
3178
        if local and not bound_location:
 
3179
            raise errors.LocalRequiresBoundBranch()
 
3180
        master_branch = None
 
3181
        if not local and bound_location and self.source.base != bound_location:
 
3182
            # not pulling from master, so we need to update master.
 
3183
            master_branch = self.target.get_master_branch(possible_transports)
 
3184
            master_branch.lock_write()
 
3185
        try:
 
3186
            if master_branch:
 
3187
                # pull from source into master.
 
3188
                master_branch.pull(self.source, overwrite, stop_revision,
 
3189
                    run_hooks=False)
 
3190
            return super(InterToBranch5, self).pull(overwrite,
 
3191
                stop_revision, _hook_master=master_branch,
 
3192
                run_hooks=run_hooks,
 
3193
                _override_hook_target=_override_hook_target)
 
3194
        finally:
 
3195
            if master_branch:
 
3196
                master_branch.unlock()
 
3197
 
3598
3198
 
3599
3199
InterBranch.register_optimiser(GenericInterBranch)
 
3200
InterBranch.register_optimiser(InterToBranch5)