~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

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