~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
 
from cStringIO import StringIO
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
24
23
from bzrlib import (
25
24
        bzrdir,
26
25
        cache_utf8,
27
 
        cleanup,
28
26
        config as _mod_config,
29
27
        debug,
30
28
        errors,
31
 
        fetch,
32
 
        graph as _mod_graph,
33
29
        lockdir,
34
30
        lockable_files,
35
 
        remote,
36
31
        repository,
37
32
        revision as _mod_revision,
38
 
        rio,
 
33
        symbol_versioning,
39
34
        transport,
 
35
        tsort,
40
36
        ui,
41
37
        urlutils,
42
38
        )
43
39
from bzrlib.config import BranchConfig, TransportConfig
 
40
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
41
from bzrlib.tag import (
45
42
    BasicTags,
46
43
    DisabledTags,
47
44
    )
48
45
""")
49
46
 
50
 
from bzrlib import (
51
 
    controldir,
52
 
    )
53
 
from bzrlib.decorators import (
54
 
    needs_read_lock,
55
 
    needs_write_lock,
56
 
    only_raises,
57
 
    )
58
 
from bzrlib.hooks import Hooks
 
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
48
from bzrlib.hooks import HookPoint, Hooks
59
49
from bzrlib.inter import InterObject
60
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
61
50
from bzrlib import registry
62
51
from bzrlib.symbol_versioning import (
63
52
    deprecated_in,
66
55
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
56
 
68
57
 
69
 
class Branch(controldir.ControlComponent):
 
58
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
59
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
 
61
 
 
62
 
 
63
# TODO: Maybe include checks for common corruption of newlines, etc?
 
64
 
 
65
# TODO: Some operations like log might retrieve the same revisions
 
66
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
67
# cache in memory to make this faster.  In general anything can be
 
68
# cached in memory between lock and unlock operations. .. nb thats
 
69
# what the transaction identity map provides
 
70
 
 
71
 
 
72
######################################################################
 
73
# branch objects
 
74
 
 
75
class Branch(object):
70
76
    """Branch holding a history of revisions.
71
77
 
72
 
    :ivar base:
73
 
        Base directory/url of the branch; using control_url and
74
 
        control_transport is more standardized.
75
 
    :ivar hooks: An instance of BranchHooks.
76
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
77
 
        _clear_cached_state.
 
78
    base
 
79
        Base directory/url of the branch.
 
80
 
 
81
    hooks: An instance of BranchHooks.
78
82
    """
79
83
    # this is really an instance variable - FIXME move it there
80
84
    # - RBC 20060112
81
85
    base = None
82
86
 
83
 
    @property
84
 
    def control_transport(self):
85
 
        return self._transport
86
 
 
87
 
    @property
88
 
    def user_transport(self):
89
 
        return self.bzrdir.user_transport
90
 
 
91
87
    def __init__(self, *ignored, **ignored_too):
92
88
        self.tags = self._format.make_tags(self)
93
89
        self._revision_history_cache = None
94
90
        self._revision_id_to_revno_cache = None
95
91
        self._partial_revision_id_to_revno_cache = {}
96
 
        self._partial_revision_history_cache = []
97
 
        self._tags_bytes = None
98
92
        self._last_revision_info_cache = None
99
 
        self._master_branch_cache = None
100
93
        self._merge_sorted_revisions_cache = None
101
94
        self._open_hook()
102
95
        hooks = Branch.hooks['open']
108
101
 
109
102
    def _activate_fallback_location(self, url):
110
103
        """Activate the branch/repository from url as a fallback repository."""
111
 
        for existing_fallback_repo in self.repository._fallback_repositories:
112
 
            if existing_fallback_repo.user_url == url:
113
 
                # This fallback is already configured.  This probably only
114
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
115
 
                # confusing _unstack we don't add this a second time.
116
 
                mutter('duplicate activation of fallback %r on %r', url, self)
117
 
                return
118
 
        repo = self._get_fallback_repository(url)
119
 
        if repo.has_same_location(self.repository):
120
 
            raise errors.UnstackableLocationError(self.user_url, url)
121
 
        self.repository.add_fallback_repository(repo)
 
104
        self.repository.add_fallback_repository(
 
105
            self._get_fallback_repository(url))
122
106
 
123
107
    def break_lock(self):
124
108
        """Break a lock if one is present from another instance.
139
123
            raise errors.UnstackableRepositoryFormat(self.repository._format,
140
124
                self.repository.base)
141
125
 
142
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
143
 
        """Extend the partial history to include a given index
144
 
 
145
 
        If a stop_index is supplied, stop when that index has been reached.
146
 
        If a stop_revision is supplied, stop when that revision is
147
 
        encountered.  Otherwise, stop when the beginning of history is
148
 
        reached.
149
 
 
150
 
        :param stop_index: The index which should be present.  When it is
151
 
            present, history extension will stop.
152
 
        :param stop_revision: The revision id which should be present.  When
153
 
            it is encountered, history extension will stop.
154
 
        """
155
 
        if len(self._partial_revision_history_cache) == 0:
156
 
            self._partial_revision_history_cache = [self.last_revision()]
157
 
        repository._iter_for_revno(
158
 
            self.repository, self._partial_revision_history_cache,
159
 
            stop_index=stop_index, stop_revision=stop_revision)
160
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
161
 
            self._partial_revision_history_cache.pop()
162
 
 
163
 
    def _get_check_refs(self):
164
 
        """Get the references needed for check().
165
 
 
166
 
        See bzrlib.check.
167
 
        """
168
 
        revid = self.last_revision()
169
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
170
 
 
171
126
    @staticmethod
172
127
    def open(base, _unsupported=False, possible_transports=None):
173
128
        """Open the branch rooted at base.
177
132
        """
178
133
        control = bzrdir.BzrDir.open(base, _unsupported,
179
134
                                     possible_transports=possible_transports)
180
 
        return control.open_branch(unsupported=_unsupported)
 
135
        return control.open_branch(_unsupported)
181
136
 
182
137
    @staticmethod
183
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
138
    def open_from_transport(transport, _unsupported=False):
184
139
        """Open the branch rooted at transport"""
185
140
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
186
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
187
142
 
188
143
    @staticmethod
189
144
    def open_containing(url, possible_transports=None):
210
165
        return self.supports_tags() and self.tags.get_tag_dict()
211
166
 
212
167
    def get_config(self):
213
 
        """Get a bzrlib.config.BranchConfig for this Branch.
214
 
 
215
 
        This can then be used to get and set configuration options for the
216
 
        branch.
217
 
 
218
 
        :return: A bzrlib.config.BranchConfig.
219
 
        """
220
168
        return BranchConfig(self)
221
169
 
222
170
    def _get_config(self):
234
182
    def _get_fallback_repository(self, url):
235
183
        """Get the repository we fallback to at url."""
236
184
        url = urlutils.join(self.base, url)
237
 
        a_branch = Branch.open(url,
 
185
        a_bzrdir = bzrdir.BzrDir.open(url,
238
186
            possible_transports=[self.bzrdir.root_transport])
239
 
        return a_branch.repository
 
187
        return a_bzrdir.open_branch().repository
240
188
 
241
 
    @needs_read_lock
242
189
    def _get_tags_bytes(self):
243
190
        """Get the bytes of a serialised tags dict.
244
191
 
251
198
        :return: The bytes of the tags file.
252
199
        :seealso: Branch._set_tags_bytes.
253
200
        """
254
 
        if self._tags_bytes is None:
255
 
            self._tags_bytes = self._transport.get_bytes('tags')
256
 
        return self._tags_bytes
 
201
        return self._transport.get_bytes('tags')
257
202
 
258
203
    def _get_nick(self, local=False, possible_transports=None):
259
204
        config = self.get_config()
261
206
        if not local and not config.has_explicit_nickname():
262
207
            try:
263
208
                master = self.get_master_branch(possible_transports)
264
 
                if master and self.user_url == master.user_url:
265
 
                    raise errors.RecursiveBind(self.user_url)
266
209
                if master is not None:
267
210
                    # return the master branch value
268
211
                    return master.nick
269
 
            except errors.RecursiveBind, e:
270
 
                raise e
271
212
            except errors.BzrError, e:
272
213
                # Silently fall back to local implicit nick if the master is
273
214
                # unavailable
310
251
        new_history.reverse()
311
252
        return new_history
312
253
 
313
 
    def lock_write(self, token=None):
314
 
        """Lock the branch for write operations.
315
 
 
316
 
        :param token: A token to permit reacquiring a previously held and
317
 
            preserved lock.
318
 
        :return: A BranchWriteLockResult.
319
 
        """
 
254
    def lock_write(self):
320
255
        raise NotImplementedError(self.lock_write)
321
256
 
322
257
    def lock_read(self):
323
 
        """Lock the branch for read operations.
324
 
 
325
 
        :return: A bzrlib.lock.LogicalLockResult.
326
 
        """
327
258
        raise NotImplementedError(self.lock_read)
328
259
 
329
260
    def unlock(self):
450
381
            after. If None, the rest of history is included.
451
382
        :param stop_rule: if stop_revision_id is not None, the precise rule
452
383
            to use for termination:
453
 
 
454
384
            * 'exclude' - leave the stop revision out of the result (default)
455
385
            * 'include' - the stop revision is the last item in the result
456
386
            * 'with-merges' - include the stop revision and all of its
457
387
              merged revisions in the result
458
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
459
 
              that are in both ancestries
460
388
        :param direction: either 'reverse' or 'forward':
461
 
 
462
389
            * reverse means return the start_revision_id first, i.e.
463
390
              start at the most recent revision and go backwards in history
464
391
            * forward returns tuples in the opposite order to reverse.
485
412
        # start_revision_id.
486
413
        if self._merge_sorted_revisions_cache is None:
487
414
            last_revision = self.last_revision()
488
 
            known_graph = self.repository.get_known_graph_ancestry(
489
 
                [last_revision])
490
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
491
 
                last_revision)
 
415
            graph = self.repository.get_graph()
 
416
            parent_map = dict(((key, value) for key, value in
 
417
                     graph.iter_ancestry([last_revision]) if value is not None))
 
418
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
419
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
420
                generate_revno=True)
 
421
            # Drop the sequence # before caching
 
422
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
423
 
492
424
        filtered = self._filter_merge_sorted_revisions(
493
425
            self._merge_sorted_revisions_cache, start_revision_id,
494
426
            stop_revision_id, stop_rule)
495
 
        # Make sure we don't return revisions that are not part of the
496
 
        # start_revision_id ancestry.
497
 
        filtered = self._filter_start_non_ancestors(filtered)
498
427
        if direction == 'reverse':
499
428
            return filtered
500
429
        if direction == 'forward':
507
436
        """Iterate over an inclusive range of sorted revisions."""
508
437
        rev_iter = iter(merge_sorted_revisions)
509
438
        if start_revision_id is not None:
510
 
            for node in rev_iter:
511
 
                rev_id = node.key
 
439
            for rev_id, depth, revno, end_of_merge in rev_iter:
512
440
                if rev_id != start_revision_id:
513
441
                    continue
514
442
                else:
515
443
                    # The decision to include the start or not
516
444
                    # depends on the stop_rule if a stop is provided
517
 
                    # so pop this node back into the iterator
518
 
                    rev_iter = chain(iter([node]), rev_iter)
 
445
                    rev_iter = chain(
 
446
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
447
                        rev_iter)
519
448
                    break
520
449
        if stop_revision_id is None:
521
 
            # Yield everything
522
 
            for node in rev_iter:
523
 
                rev_id = node.key
524
 
                yield (rev_id, node.merge_depth, node.revno,
525
 
                       node.end_of_merge)
 
450
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
451
                yield rev_id, depth, revno, end_of_merge
526
452
        elif stop_rule == 'exclude':
527
 
            for node in rev_iter:
528
 
                rev_id = node.key
 
453
            for rev_id, depth, revno, end_of_merge in rev_iter:
529
454
                if rev_id == stop_revision_id:
530
455
                    return
531
 
                yield (rev_id, node.merge_depth, node.revno,
532
 
                       node.end_of_merge)
 
456
                yield rev_id, depth, revno, end_of_merge
533
457
        elif stop_rule == 'include':
534
 
            for node in rev_iter:
535
 
                rev_id = node.key
536
 
                yield (rev_id, node.merge_depth, node.revno,
537
 
                       node.end_of_merge)
 
458
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
459
                yield rev_id, depth, revno, end_of_merge
538
460
                if rev_id == stop_revision_id:
539
461
                    return
540
 
        elif stop_rule == 'with-merges-without-common-ancestry':
541
 
            # We want to exclude all revisions that are already part of the
542
 
            # stop_revision_id ancestry.
543
 
            graph = self.repository.get_graph()
544
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
545
 
                                                    [stop_revision_id])
546
 
            for node in rev_iter:
547
 
                rev_id = node.key
548
 
                if rev_id not in ancestors:
549
 
                    continue
550
 
                yield (rev_id, node.merge_depth, node.revno,
551
 
                       node.end_of_merge)
552
462
        elif stop_rule == 'with-merges':
553
463
            stop_rev = self.repository.get_revision(stop_revision_id)
554
464
            if stop_rev.parent_ids:
555
465
                left_parent = stop_rev.parent_ids[0]
556
466
            else:
557
467
                left_parent = _mod_revision.NULL_REVISION
558
 
            # left_parent is the actual revision we want to stop logging at,
559
 
            # since we want to show the merged revisions after the stop_rev too
560
 
            reached_stop_revision_id = False
561
 
            revision_id_whitelist = []
562
 
            for node in rev_iter:
563
 
                rev_id = node.key
 
468
            for rev_id, depth, revno, end_of_merge in rev_iter:
564
469
                if rev_id == left_parent:
565
 
                    # reached the left parent after the stop_revision
566
470
                    return
567
 
                if (not reached_stop_revision_id or
568
 
                        rev_id in revision_id_whitelist):
569
 
                    yield (rev_id, node.merge_depth, node.revno,
570
 
                       node.end_of_merge)
571
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
572
 
                        # only do the merged revs of rev_id from now on
573
 
                        rev = self.repository.get_revision(rev_id)
574
 
                        if rev.parent_ids:
575
 
                            reached_stop_revision_id = True
576
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
471
                yield rev_id, depth, revno, end_of_merge
577
472
        else:
578
473
            raise ValueError('invalid stop_rule %r' % stop_rule)
579
474
 
580
 
    def _filter_start_non_ancestors(self, rev_iter):
581
 
        # If we started from a dotted revno, we want to consider it as a tip
582
 
        # and don't want to yield revisions that are not part of its
583
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
584
 
        # uninteresting descendants of the first parent of our tip before the
585
 
        # tip itself.
586
 
        first = rev_iter.next()
587
 
        (rev_id, merge_depth, revno, end_of_merge) = first
588
 
        yield first
589
 
        if not merge_depth:
590
 
            # We start at a mainline revision so by definition, all others
591
 
            # revisions in rev_iter are ancestors
592
 
            for node in rev_iter:
593
 
                yield node
594
 
 
595
 
        clean = False
596
 
        whitelist = set()
597
 
        pmap = self.repository.get_parent_map([rev_id])
598
 
        parents = pmap.get(rev_id, [])
599
 
        if parents:
600
 
            whitelist.update(parents)
601
 
        else:
602
 
            # If there is no parents, there is nothing of interest left
603
 
 
604
 
            # FIXME: It's hard to test this scenario here as this code is never
605
 
            # called in that case. -- vila 20100322
606
 
            return
607
 
 
608
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
609
 
            if not clean:
610
 
                if rev_id in whitelist:
611
 
                    pmap = self.repository.get_parent_map([rev_id])
612
 
                    parents = pmap.get(rev_id, [])
613
 
                    whitelist.remove(rev_id)
614
 
                    whitelist.update(parents)
615
 
                    if merge_depth == 0:
616
 
                        # We've reached the mainline, there is nothing left to
617
 
                        # filter
618
 
                        clean = True
619
 
                else:
620
 
                    # A revision that is not part of the ancestry of our
621
 
                    # starting revision.
622
 
                    continue
623
 
            yield (rev_id, merge_depth, revno, end_of_merge)
624
 
 
625
475
    def leave_lock_in_place(self):
626
476
        """Tell this branch object not to release the physical lock when this
627
477
        object is unlocked.
644
494
        :param other: The branch to bind to
645
495
        :type other: Branch
646
496
        """
647
 
        raise errors.UpgradeRequired(self.user_url)
648
 
 
649
 
    def set_append_revisions_only(self, enabled):
650
 
        if not self._format.supports_set_append_revisions_only():
651
 
            raise errors.UpgradeRequired(self.user_url)
652
 
        if enabled:
653
 
            value = 'True'
654
 
        else:
655
 
            value = 'False'
656
 
        self.get_config().set_user_option('append_revisions_only', value,
657
 
            warn_masked=True)
658
 
 
659
 
    def set_reference_info(self, file_id, tree_path, branch_location):
660
 
        """Set the branch location to use for a tree reference."""
661
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
662
 
 
663
 
    def get_reference_info(self, file_id):
664
 
        """Get the tree_path and branch_location for a tree reference."""
665
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
497
        raise errors.UpgradeRequired(self.base)
666
498
 
667
499
    @needs_write_lock
668
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
500
    def fetch(self, from_branch, last_revision=None, pb=None):
669
501
        """Copy revisions from from_branch into this branch.
670
502
 
671
503
        :param from_branch: Where to copy from.
672
504
        :param last_revision: What revision to stop at (None for at the end
673
505
                              of the branch.
674
 
        :param limit: Optional rough limit of revisions to fetch
 
506
        :param pb: An optional progress bar to use.
675
507
        :return: None
676
508
        """
677
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
509
        if self.base == from_branch.base:
 
510
            return (0, [])
 
511
        if pb is not None:
 
512
            symbol_versioning.warn(
 
513
                symbol_versioning.deprecated_in((1, 14, 0))
 
514
                % "pb parameter to fetch()")
 
515
        from_branch.lock_read()
 
516
        try:
 
517
            if last_revision is None:
 
518
                last_revision = from_branch.last_revision()
 
519
                last_revision = _mod_revision.ensure_null(last_revision)
 
520
            return self.repository.fetch(from_branch.repository,
 
521
                                         revision_id=last_revision,
 
522
                                         pb=pb)
 
523
        finally:
 
524
            from_branch.unlock()
678
525
 
679
526
    def get_bound_location(self):
680
527
        """Return the URL of the branch we are bound to.
687
534
    def get_old_bound_location(self):
688
535
        """Return the URL of the branch we used to be bound to
689
536
        """
690
 
        raise errors.UpgradeRequired(self.user_url)
 
537
        raise errors.UpgradeRequired(self.base)
691
538
 
692
539
    def get_commit_builder(self, parents, config=None, timestamp=None,
693
540
                           timezone=None, committer=None, revprops=None,
694
 
                           revision_id=None, lossy=False):
 
541
                           revision_id=None):
695
542
        """Obtain a CommitBuilder for this branch.
696
543
 
697
544
        :param parents: Revision ids of the parents of the new revision.
701
548
        :param committer: Optional committer to set for commit.
702
549
        :param revprops: Optional dictionary of revision properties.
703
550
        :param revision_id: Optional revision id.
704
 
        :param lossy: Whether to discard data that can not be natively
705
 
            represented, when pushing to a foreign VCS 
706
551
        """
707
552
 
708
553
        if config is None:
709
554
            config = self.get_config()
710
555
 
711
556
        return self.repository.get_commit_builder(self, parents, config,
712
 
            timestamp, timezone, committer, revprops, revision_id,
713
 
            lossy)
 
557
            timestamp, timezone, committer, revprops, revision_id)
714
558
 
715
559
    def get_master_branch(self, possible_transports=None):
716
560
        """Return the branch we are bound to.
743
587
        """Print `file` to stdout."""
744
588
        raise NotImplementedError(self.print_file)
745
589
 
746
 
    @deprecated_method(deprecated_in((2, 4, 0)))
747
590
    def set_revision_history(self, rev_history):
748
 
        """See Branch.set_revision_history."""
749
 
        self._set_revision_history(rev_history)
750
 
 
751
 
    @needs_write_lock
752
 
    def _set_revision_history(self, rev_history):
753
 
        if len(rev_history) == 0:
754
 
            revid = _mod_revision.NULL_REVISION
755
 
        else:
756
 
            revid = rev_history[-1]
757
 
        if rev_history != self._lefthand_history(revid):
758
 
            raise errors.NotLefthandHistory(rev_history)
759
 
        self.set_last_revision_info(len(rev_history), revid)
760
 
        self._cache_revision_history(rev_history)
761
 
        for hook in Branch.hooks['set_rh']:
762
 
            hook(self, rev_history)
763
 
 
764
 
    @needs_write_lock
765
 
    def set_last_revision_info(self, revno, revision_id):
766
 
        """Set the last revision of this branch.
767
 
 
768
 
        The caller is responsible for checking that the revno is correct
769
 
        for this revision id.
770
 
 
771
 
        It may be possible to set the branch last revision to an id not
772
 
        present in the repository.  However, branches can also be
773
 
        configured to check constraints on history, in which case this may not
774
 
        be permitted.
775
 
        """
776
 
        raise NotImplementedError(self.set_last_revision_info)
777
 
 
778
 
    @needs_write_lock
779
 
    def generate_revision_history(self, revision_id, last_rev=None,
780
 
                                  other_branch=None):
781
 
        """See Branch.generate_revision_history"""
782
 
        graph = self.repository.get_graph()
783
 
        (last_revno, last_revid) = self.last_revision_info()
784
 
        known_revision_ids = [
785
 
            (last_revid, last_revno),
786
 
            (_mod_revision.NULL_REVISION, 0),
787
 
            ]
788
 
        if last_rev is not None:
789
 
            if not graph.is_ancestor(last_rev, revision_id):
790
 
                # our previous tip is not merged into stop_revision
791
 
                raise errors.DivergedBranches(self, other_branch)
792
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
793
 
        self.set_last_revision_info(revno, revision_id)
794
 
 
795
 
    @needs_write_lock
796
 
    def set_parent(self, url):
797
 
        """See Branch.set_parent."""
798
 
        # TODO: Maybe delete old location files?
799
 
        # URLs should never be unicode, even on the local fs,
800
 
        # FIXUP this and get_parent in a future branch format bump:
801
 
        # read and rewrite the file. RBC 20060125
802
 
        if url is not None:
803
 
            if isinstance(url, unicode):
804
 
                try:
805
 
                    url = url.encode('ascii')
806
 
                except UnicodeEncodeError:
807
 
                    raise errors.InvalidURL(url,
808
 
                        "Urls must be 7-bit ascii, "
809
 
                        "use bzrlib.urlutils.escape")
810
 
            url = urlutils.relative_url(self.base, url)
811
 
        self._set_parent_location(url)
812
 
 
813
 
    @needs_write_lock
 
591
        raise NotImplementedError(self.set_revision_history)
 
592
 
814
593
    def set_stacked_on_url(self, url):
815
594
        """Set the URL this branch is stacked against.
816
595
 
820
599
            stacking.
821
600
        """
822
601
        if not self._format.supports_stacking():
823
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
824
 
        # XXX: Changing from one fallback repository to another does not check
825
 
        # that all the data you need is present in the new fallback.
826
 
        # Possibly it should.
 
602
            raise errors.UnstackableBranchFormat(self._format, self.base)
827
603
        self._check_stackable_repo()
828
604
        if not url:
829
605
            try:
831
607
            except (errors.NotStacked, errors.UnstackableBranchFormat,
832
608
                errors.UnstackableRepositoryFormat):
833
609
                return
834
 
            self._unstack()
 
610
            url = ''
 
611
            # repositories don't offer an interface to remove fallback
 
612
            # repositories today; take the conceptually simpler option and just
 
613
            # reopen it.
 
614
            self.repository = self.bzrdir.find_repository()
 
615
            # for every revision reference the branch has, ensure it is pulled
 
616
            # in.
 
617
            source_repository = self._get_fallback_repository(old_url)
 
618
            for revision_id in chain([self.last_revision()],
 
619
                self.tags.get_reverse_tag_dict()):
 
620
                self.repository.fetch(source_repository, revision_id,
 
621
                    find_ghosts=True)
835
622
        else:
836
623
            self._activate_fallback_location(url)
837
624
        # write this out after the repository is stacked to avoid setting a
838
625
        # stacked config that doesn't work.
839
626
        self._set_config_location('stacked_on_location', url)
840
627
 
841
 
    def _unstack(self):
842
 
        """Change a branch to be unstacked, copying data as needed.
843
 
 
844
 
        Don't call this directly, use set_stacked_on_url(None).
845
 
        """
846
 
        pb = ui.ui_factory.nested_progress_bar()
847
 
        try:
848
 
            pb.update("Unstacking")
849
 
            # The basic approach here is to fetch the tip of the branch,
850
 
            # including all available ghosts, from the existing stacked
851
 
            # repository into a new repository object without the fallbacks. 
852
 
            #
853
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
854
 
            # correct for CHKMap repostiories
855
 
            old_repository = self.repository
856
 
            if len(old_repository._fallback_repositories) != 1:
857
 
                raise AssertionError("can't cope with fallback repositories "
858
 
                    "of %r (fallbacks: %r)" % (old_repository,
859
 
                        old_repository._fallback_repositories))
860
 
            # Open the new repository object.
861
 
            # Repositories don't offer an interface to remove fallback
862
 
            # repositories today; take the conceptually simpler option and just
863
 
            # reopen it.  We reopen it starting from the URL so that we
864
 
            # get a separate connection for RemoteRepositories and can
865
 
            # stream from one of them to the other.  This does mean doing
866
 
            # separate SSH connection setup, but unstacking is not a
867
 
            # common operation so it's tolerable.
868
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
869
 
            new_repository = new_bzrdir.find_repository()
870
 
            if new_repository._fallback_repositories:
871
 
                raise AssertionError("didn't expect %r to have "
872
 
                    "fallback_repositories"
873
 
                    % (self.repository,))
874
 
            # Replace self.repository with the new repository.
875
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
876
 
            # lock count) of self.repository to the new repository.
877
 
            lock_token = old_repository.lock_write().repository_token
878
 
            self.repository = new_repository
879
 
            if isinstance(self, remote.RemoteBranch):
880
 
                # Remote branches can have a second reference to the old
881
 
                # repository that need to be replaced.
882
 
                if self._real_branch is not None:
883
 
                    self._real_branch.repository = new_repository
884
 
            self.repository.lock_write(token=lock_token)
885
 
            if lock_token is not None:
886
 
                old_repository.leave_lock_in_place()
887
 
            old_repository.unlock()
888
 
            if lock_token is not None:
889
 
                # XXX: self.repository.leave_lock_in_place() before this
890
 
                # function will not be preserved.  Fortunately that doesn't
891
 
                # affect the current default format (2a), and would be a
892
 
                # corner-case anyway.
893
 
                #  - Andrew Bennetts, 2010/06/30
894
 
                self.repository.dont_leave_lock_in_place()
895
 
            old_lock_count = 0
896
 
            while True:
897
 
                try:
898
 
                    old_repository.unlock()
899
 
                except errors.LockNotHeld:
900
 
                    break
901
 
                old_lock_count += 1
902
 
            if old_lock_count == 0:
903
 
                raise AssertionError(
904
 
                    'old_repository should have been locked at least once.')
905
 
            for i in range(old_lock_count-1):
906
 
                self.repository.lock_write()
907
 
            # Fetch from the old repository into the new.
908
 
            old_repository.lock_read()
909
 
            try:
910
 
                # XXX: If you unstack a branch while it has a working tree
911
 
                # with a pending merge, the pending-merged revisions will no
912
 
                # longer be present.  You can (probably) revert and remerge.
913
 
                try:
914
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
915
 
                except errors.TagsNotSupported:
916
 
                    tags_to_fetch = set()
917
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
918
 
                    old_repository, required_ids=[self.last_revision()],
919
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
920
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
921
 
            finally:
922
 
                old_repository.unlock()
923
 
        finally:
924
 
            pb.finished()
925
628
 
926
629
    def _set_tags_bytes(self, bytes):
927
630
        """Mirror method for _get_tags_bytes.
928
631
 
929
632
        :seealso: Branch._get_tags_bytes.
930
633
        """
931
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
932
 
        op.add_cleanup(self.lock_write().unlock)
933
 
        return op.run_simple(bytes)
934
 
 
935
 
    def _set_tags_bytes_locked(self, bytes):
936
 
        self._tags_bytes = bytes
937
 
        return self._transport.put_bytes('tags', bytes)
 
634
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
635
            'tags', bytes)
938
636
 
939
637
    def _cache_revision_history(self, rev_history):
940
638
        """Set the cached revision history to rev_history.
967
665
        self._revision_history_cache = None
968
666
        self._revision_id_to_revno_cache = None
969
667
        self._last_revision_info_cache = None
970
 
        self._master_branch_cache = None
971
668
        self._merge_sorted_revisions_cache = None
972
 
        self._partial_revision_history_cache = []
973
 
        self._partial_revision_id_to_revno_cache = {}
974
 
        self._tags_bytes = None
975
669
 
976
670
    def _gen_revision_history(self):
977
671
        """Return sequence of revision hashes on to this branch.
1014
708
 
1015
709
    def unbind(self):
1016
710
        """Older format branches cannot bind or unbind."""
1017
 
        raise errors.UpgradeRequired(self.user_url)
 
711
        raise errors.UpgradeRequired(self.base)
 
712
 
 
713
    def set_append_revisions_only(self, enabled):
 
714
        """Older format branches are never restricted to append-only"""
 
715
        raise errors.UpgradeRequired(self.base)
1018
716
 
1019
717
    def last_revision(self):
1020
718
        """Return last revision id, or NULL_REVISION."""
1027
725
        :return: A tuple (revno, revision_id).
1028
726
        """
1029
727
        if self._last_revision_info_cache is None:
1030
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
728
            self._last_revision_info_cache = self._last_revision_info()
1031
729
        return self._last_revision_info_cache
1032
730
 
1033
 
    def _read_last_revision_info(self):
1034
 
        raise NotImplementedError(self._read_last_revision_info)
1035
 
 
1036
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
731
    def _last_revision_info(self):
 
732
        rh = self.revision_history()
 
733
        revno = len(rh)
 
734
        if revno:
 
735
            return (revno, rh[-1])
 
736
        else:
 
737
            return (0, _mod_revision.NULL_REVISION)
 
738
 
 
739
    @deprecated_method(deprecated_in((1, 6, 0)))
 
740
    def missing_revisions(self, other, stop_revision=None):
 
741
        """Return a list of new revisions that would perfectly fit.
 
742
 
 
743
        If self and other have not diverged, return a list of the revisions
 
744
        present in other, but missing from self.
 
745
        """
 
746
        self_history = self.revision_history()
 
747
        self_len = len(self_history)
 
748
        other_history = other.revision_history()
 
749
        other_len = len(other_history)
 
750
        common_index = min(self_len, other_len) -1
 
751
        if common_index >= 0 and \
 
752
            self_history[common_index] != other_history[common_index]:
 
753
            raise errors.DivergedBranches(self, other)
 
754
 
 
755
        if stop_revision is None:
 
756
            stop_revision = other_len
 
757
        else:
 
758
            if stop_revision > other_len:
 
759
                raise errors.NoSuchRevision(self, stop_revision)
 
760
        return other_history[self_len:stop_revision]
 
761
 
 
762
    @needs_write_lock
 
763
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
764
                         graph=None):
 
765
        """Pull in new perfect-fit revisions.
 
766
 
 
767
        :param other: Another Branch to pull from
 
768
        :param stop_revision: Updated until the given revision
 
769
        :param overwrite: Always set the branch pointer, rather than checking
 
770
            to see if it is a proper descendant.
 
771
        :param graph: A Graph object that can be used to query history
 
772
            information. This can be None.
 
773
        :return: None
 
774
        """
 
775
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
776
            overwrite, graph)
 
777
 
1037
778
    def import_last_revision_info(self, source_repo, revno, revid):
1038
779
        """Set the last revision info, importing from another repo if necessary.
1039
780
 
 
781
        This is used by the bound branch code to upload a revision to
 
782
        the master branch first before updating the tip of the local branch.
 
783
 
1040
784
        :param source_repo: Source repository to optionally fetch from
1041
785
        :param revno: Revision number of the new tip
1042
786
        :param revid: Revision id of the new tip
1045
789
            self.repository.fetch(source_repo, revision_id=revid)
1046
790
        self.set_last_revision_info(revno, revid)
1047
791
 
1048
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1049
 
                                           lossy=False):
1050
 
        """Set the last revision info, importing from another repo if necessary.
1051
 
 
1052
 
        This is used by the bound branch code to upload a revision to
1053
 
        the master branch first before updating the tip of the local branch.
1054
 
        Revisions referenced by source's tags are also transferred.
1055
 
 
1056
 
        :param source: Source branch to optionally fetch from
1057
 
        :param revno: Revision number of the new tip
1058
 
        :param revid: Revision id of the new tip
1059
 
        :param lossy: Whether to discard metadata that can not be
1060
 
            natively represented
1061
 
        :return: Tuple with the new revision number and revision id
1062
 
            (should only be different from the arguments when lossy=True)
1063
 
        """
1064
 
        if not self.repository.has_same_location(source.repository):
1065
 
            self.fetch(source, revid)
1066
 
        self.set_last_revision_info(revno, revid)
1067
 
        return (revno, revid)
1068
 
 
1069
792
    def revision_id_to_revno(self, revision_id):
1070
793
        """Given a revision id, return its revno"""
1071
794
        if _mod_revision.is_null(revision_id):
1076
799
        except ValueError:
1077
800
            raise errors.NoSuchRevision(self, revision_id)
1078
801
 
1079
 
    @needs_read_lock
1080
802
    def get_rev_id(self, revno, history=None):
1081
803
        """Find the revision id of the specified revno."""
1082
804
        if revno == 0:
1083
805
            return _mod_revision.NULL_REVISION
1084
 
        last_revno, last_revid = self.last_revision_info()
1085
 
        if revno == last_revno:
1086
 
            return last_revid
1087
 
        if revno <= 0 or revno > last_revno:
 
806
        if history is None:
 
807
            history = self.revision_history()
 
808
        if revno <= 0 or revno > len(history):
1088
809
            raise errors.NoSuchRevision(self, revno)
1089
 
        distance_from_last = last_revno - revno
1090
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1091
 
            self._extend_partial_history(distance_from_last)
1092
 
        return self._partial_revision_history_cache[distance_from_last]
 
810
        return history[revno - 1]
1093
811
 
1094
812
    def pull(self, source, overwrite=False, stop_revision=None,
1095
 
             possible_transports=None, *args, **kwargs):
 
813
             possible_transports=None, _override_hook_target=None):
1096
814
        """Mirror source into this branch.
1097
815
 
1098
816
        This branch is considered to be 'local', having low latency.
1099
817
 
1100
818
        :returns: PullResult instance
1101
819
        """
1102
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1103
 
            stop_revision=stop_revision,
1104
 
            possible_transports=possible_transports, *args, **kwargs)
 
820
        raise NotImplementedError(self.pull)
1105
821
 
1106
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1107
 
            *args, **kwargs):
 
822
    def push(self, target, overwrite=False, stop_revision=None):
1108
823
        """Mirror this branch into target.
1109
824
 
1110
825
        This branch is considered to be 'local', having low latency.
1111
826
        """
1112
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1113
 
            lossy, *args, **kwargs)
 
827
        raise NotImplementedError(self.push)
1114
828
 
1115
829
    def basis_tree(self):
1116
830
        """Return `Tree` object for last revision."""
1133
847
        try:
1134
848
            return urlutils.join(self.base[:-1], parent)
1135
849
        except errors.InvalidURLJoin, e:
1136
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
850
            raise errors.InaccessibleParent(parent, self.base)
1137
851
 
1138
852
    def _get_parent_location(self):
1139
853
        raise NotImplementedError(self._get_parent_location)
1156
870
            location = None
1157
871
        return location
1158
872
 
1159
 
    def get_child_submit_format(self):
1160
 
        """Return the preferred format of submissions to this branch."""
1161
 
        return self.get_config().get_user_option("child_submit_format")
1162
 
 
1163
873
    def get_submit_branch(self):
1164
874
        """Return the submit location of the branch.
1165
875
 
1224
934
        params = ChangeBranchTipParams(
1225
935
            self, old_revno, new_revno, old_revid, new_revid)
1226
936
        for hook in hooks:
1227
 
            hook(params)
 
937
            try:
 
938
                hook(params)
 
939
            except errors.TipChangeRejected:
 
940
                raise
 
941
            except Exception:
 
942
                exc_info = sys.exc_info()
 
943
                hook_name = Branch.hooks.get_hook_name(hook)
 
944
                raise errors.HookFailed(
 
945
                    'pre_change_branch_tip', hook_name, exc_info)
 
946
 
 
947
    def set_parent(self, url):
 
948
        raise NotImplementedError(self.set_parent)
1228
949
 
1229
950
    @needs_write_lock
1230
951
    def update(self):
1261
982
                     be truncated to end with revision_id.
1262
983
        """
1263
984
        result = to_bzrdir.create_branch()
1264
 
        result.lock_write()
1265
 
        try:
1266
 
            if repository_policy is not None:
1267
 
                repository_policy.configure_branch(result)
1268
 
            self.copy_content_into(result, revision_id=revision_id)
1269
 
        finally:
1270
 
            result.unlock()
1271
 
        return result
 
985
        if repository_policy is not None:
 
986
            repository_policy.configure_branch(result)
 
987
        self.copy_content_into(result, revision_id=revision_id)
 
988
        return  result
1272
989
 
1273
990
    @needs_read_lock
1274
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1275
 
            repository=None):
 
991
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1276
992
        """Create a new line of development from the branch, into to_bzrdir.
1277
993
 
1278
994
        to_bzrdir controls the branch format.
1280
996
        revision_id: if not None, the revision history in the new branch will
1281
997
                     be truncated to end with revision_id.
1282
998
        """
1283
 
        if (repository_policy is not None and
1284
 
            repository_policy.requires_stacking()):
1285
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1286
 
        result = to_bzrdir.create_branch(repository=repository)
1287
 
        result.lock_write()
1288
 
        try:
1289
 
            if repository_policy is not None:
1290
 
                repository_policy.configure_branch(result)
1291
 
            self.copy_content_into(result, revision_id=revision_id)
1292
 
            master_url = self.get_bound_location()
1293
 
            if master_url is None:
1294
 
                result.set_parent(self.bzrdir.root_transport.base)
1295
 
            else:
1296
 
                result.set_parent(master_url)
1297
 
        finally:
1298
 
            result.unlock()
 
999
        result = to_bzrdir.create_branch()
 
1000
        if repository_policy is not None:
 
1001
            repository_policy.configure_branch(result)
 
1002
        self.copy_content_into(result, revision_id=revision_id)
 
1003
        result.set_parent(self.bzrdir.root_transport.base)
1299
1004
        return result
1300
1005
 
1301
1006
    def _synchronize_history(self, destination, revision_id):
1313
1018
        source_revno, source_revision_id = self.last_revision_info()
1314
1019
        if revision_id is None:
1315
1020
            revno, revision_id = source_revno, source_revision_id
 
1021
        elif source_revision_id == revision_id:
 
1022
            # we know the revno without needing to walk all of history
 
1023
            revno = source_revno
1316
1024
        else:
1317
 
            graph = self.repository.get_graph()
1318
 
            try:
1319
 
                revno = graph.find_distance_to_null(revision_id, 
1320
 
                    [(source_revision_id, source_revno)])
1321
 
            except errors.GhostRevisionsHaveNoRevno:
1322
 
                # Default to 1, if we can't find anything else
1323
 
                revno = 1
 
1025
            # To figure out the revno for a random revision, we need to build
 
1026
            # the revision history, and count its length.
 
1027
            # We don't care about the order, just how long it is.
 
1028
            # Alternatively, we could start at the current location, and count
 
1029
            # backwards. But there is no guarantee that we will find it since
 
1030
            # it may be a merged revision.
 
1031
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1032
                                                                revision_id)))
1324
1033
        destination.set_last_revision_info(revno, revision_id)
1325
1034
 
 
1035
    @needs_read_lock
1326
1036
    def copy_content_into(self, destination, revision_id=None):
1327
1037
        """Copy the content of self into destination.
1328
1038
 
1329
1039
        revision_id: if not None, the revision history in the new branch will
1330
1040
                     be truncated to end with revision_id.
1331
1041
        """
1332
 
        return InterBranch.get(self, destination).copy_content_into(
1333
 
            revision_id=revision_id)
1334
 
 
1335
 
    def update_references(self, target):
1336
 
        if not getattr(self._format, 'supports_reference_locations', False):
1337
 
            return
1338
 
        reference_dict = self._get_all_reference_info()
1339
 
        if len(reference_dict) == 0:
1340
 
            return
1341
 
        old_base = self.base
1342
 
        new_base = target.base
1343
 
        target_reference_dict = target._get_all_reference_info()
1344
 
        for file_id, (tree_path, branch_location) in (
1345
 
            reference_dict.items()):
1346
 
            branch_location = urlutils.rebase_url(branch_location,
1347
 
                                                  old_base, new_base)
1348
 
            target_reference_dict.setdefault(
1349
 
                file_id, (tree_path, branch_location))
1350
 
        target._set_all_reference_info(target_reference_dict)
 
1042
        self._synchronize_history(destination, revision_id)
 
1043
        try:
 
1044
            parent = self.get_parent()
 
1045
        except errors.InaccessibleParent, e:
 
1046
            mutter('parent was not accessible to copy: %s', e)
 
1047
        else:
 
1048
            if parent:
 
1049
                destination.set_parent(parent)
 
1050
        if self._push_should_merge_tags():
 
1051
            self.tags.merge_to(destination.tags)
1351
1052
 
1352
1053
    @needs_read_lock
1353
 
    def check(self, refs):
 
1054
    def check(self):
1354
1055
        """Check consistency of the branch.
1355
1056
 
1356
1057
        In particular this checks that revisions given in the revision-history
1359
1060
 
1360
1061
        Callers will typically also want to check the repository.
1361
1062
 
1362
 
        :param refs: Calculated refs for this branch as specified by
1363
 
            branch._get_check_refs()
1364
1063
        :return: A BranchCheckResult.
1365
1064
        """
1366
 
        result = BranchCheckResult(self)
 
1065
        mainline_parent_id = None
1367
1066
        last_revno, last_revision_id = self.last_revision_info()
1368
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1369
 
        if actual_revno != last_revno:
1370
 
            result.errors.append(errors.BzrCheckError(
1371
 
                'revno does not match len(mainline) %s != %s' % (
1372
 
                last_revno, actual_revno)))
1373
 
        # TODO: We should probably also check that self.revision_history
1374
 
        # matches the repository for older branch formats.
1375
 
        # If looking for the code that cross-checks repository parents against
1376
 
        # the iter_reverse_revision_history output, that is now a repository
1377
 
        # specific check.
1378
 
        return result
 
1067
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1068
                                last_revision_id))
 
1069
        real_rev_history.reverse()
 
1070
        if len(real_rev_history) != last_revno:
 
1071
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1072
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1073
        # TODO: We should probably also check that real_rev_history actually
 
1074
        #       matches self.revision_history()
 
1075
        for revision_id in real_rev_history:
 
1076
            try:
 
1077
                revision = self.repository.get_revision(revision_id)
 
1078
            except errors.NoSuchRevision, e:
 
1079
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1080
                            % revision_id)
 
1081
            # In general the first entry on the revision history has no parents.
 
1082
            # But it's not illegal for it to have parents listed; this can happen
 
1083
            # in imports from Arch when the parents weren't reachable.
 
1084
            if mainline_parent_id is not None:
 
1085
                if mainline_parent_id not in revision.parent_ids:
 
1086
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1087
                                        "parents of {%s}"
 
1088
                                        % (mainline_parent_id, revision_id))
 
1089
            mainline_parent_id = revision_id
 
1090
        return BranchCheckResult(self)
1379
1091
 
1380
1092
    def _get_checkout_format(self):
1381
1093
        """Return the most suitable metadir for a checkout of this branch.
1382
1094
        Weaves are used if this branch's repository uses weaves.
1383
1095
        """
1384
 
        format = self.repository.bzrdir.checkout_metadir()
1385
 
        format.set_branch_format(self._format)
 
1096
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1097
            from bzrlib.repofmt import weaverepo
 
1098
            format = bzrdir.BzrDirMetaFormat1()
 
1099
            format.repository_format = weaverepo.RepositoryFormat7()
 
1100
        else:
 
1101
            format = self.repository.bzrdir.checkout_metadir()
 
1102
            format.set_branch_format(self._format)
1386
1103
        return format
1387
1104
 
1388
1105
    def create_clone_on_transport(self, to_transport, revision_id=None,
1389
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1390
 
        no_tree=None):
 
1106
        stacked_on=None):
1391
1107
        """Create a clone of this branch and its bzrdir.
1392
1108
 
1393
1109
        :param to_transport: The transport to clone onto.
1394
1110
        :param revision_id: The revision id to use as tip in the new branch.
1395
1111
            If None the tip is obtained from this branch.
1396
1112
        :param stacked_on: An optional URL to stack the clone on.
1397
 
        :param create_prefix: Create any missing directories leading up to
1398
 
            to_transport.
1399
 
        :param use_existing_dir: Use an existing directory if one exists.
1400
1113
        """
1401
1114
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1402
1115
        # clone call. Or something. 20090224 RBC/spiv.
1403
 
        # XXX: Should this perhaps clone colocated branches as well, 
1404
 
        # rather than just the default branch? 20100319 JRV
1405
 
        if revision_id is None:
1406
 
            revision_id = self.last_revision()
1407
1116
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1408
 
            revision_id=revision_id, stacked_on=stacked_on,
1409
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1410
 
            no_tree=no_tree)
 
1117
            revision_id=revision_id, stacked_on=stacked_on)
1411
1118
        return dir_to.open_branch()
1412
1119
 
1413
1120
    def create_checkout(self, to_location, revision_id=None,
1418
1125
        :param to_location: The url to produce the checkout at
1419
1126
        :param revision_id: The revision to check out
1420
1127
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1421
 
            produce a bound branch (heavyweight checkout)
 
1128
        produce a bound branch (heavyweight checkout)
1422
1129
        :param accelerator_tree: A tree which can be used for retrieving file
1423
1130
            contents more quickly than the revision tree, i.e. a workingtree.
1424
1131
            The revision tree will be used for cases where accelerator_tree's
1432
1139
        if lightweight:
1433
1140
            format = self._get_checkout_format()
1434
1141
            checkout = format.initialize_on_transport(t)
1435
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1436
 
                target_branch=self)
 
1142
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1437
1143
        else:
1438
1144
            format = self._get_checkout_format()
1439
1145
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1468
1174
        reconciler.reconcile()
1469
1175
        return reconciler
1470
1176
 
1471
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1177
    def reference_parent(self, file_id, path):
1472
1178
        """Return the parent branch for a tree-reference file_id
1473
 
 
1474
1179
        :param file_id: The file_id of the tree reference
1475
1180
        :param path: The path of the file_id in the tree
1476
1181
        :return: A branch associated with the file_id
1477
1182
        """
1478
1183
        # FIXME should provide multiple branches, based on config
1479
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1480
 
                           possible_transports=possible_transports)
 
1184
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1481
1185
 
1482
1186
    def supports_tags(self):
1483
1187
        return self._format.supports_tags()
1484
1188
 
1485
 
    def automatic_tag_name(self, revision_id):
1486
 
        """Try to automatically find the tag name for a revision.
1487
 
 
1488
 
        :param revision_id: Revision id of the revision.
1489
 
        :return: A tag name or None if no tag name could be determined.
1490
 
        """
1491
 
        for hook in Branch.hooks['automatic_tag_name']:
1492
 
            ret = hook(self, revision_id)
1493
 
            if ret is not None:
1494
 
                return ret
1495
 
        return None
1496
 
 
1497
1189
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1498
1190
                                         other_branch):
1499
1191
        """Ensure that revision_b is a descendant of revision_a.
1529
1221
        else:
1530
1222
            raise AssertionError("invalid heads: %r" % (heads,))
1531
1223
 
1532
 
    def heads_to_fetch(self):
1533
 
        """Return the heads that must and that should be fetched to copy this
1534
 
        branch into another repo.
1535
 
 
1536
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1537
 
            set of heads that must be fetched.  if_present_fetch is a set of
1538
 
            heads that must be fetched if present, but no error is necessary if
1539
 
            they are not present.
1540
 
        """
1541
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1542
 
        # are the tags.
1543
 
        must_fetch = set([self.last_revision()])
1544
 
        if_present_fetch = set()
1545
 
        c = self.get_config()
1546
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1547
 
                                                 default=False)
1548
 
        if include_tags:
1549
 
            try:
1550
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1551
 
            except errors.TagsNotSupported:
1552
 
                pass
1553
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1554
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1555
 
        return must_fetch, if_present_fetch
1556
 
 
1557
 
 
1558
 
class BranchFormat(controldir.ControlComponentFormat):
 
1224
 
 
1225
class BranchFormat(object):
1559
1226
    """An encapsulation of the initialization and open routines for a format.
1560
1227
 
1561
1228
    Formats provide three things:
1564
1231
     * an open routine.
1565
1232
 
1566
1233
    Formats are placed in an dict by their format string for reference
1567
 
    during branch opening. It's not required that these be instances, they
 
1234
    during branch opening. Its not required that these be instances, they
1568
1235
    can be classes themselves with class methods - it simply depends on
1569
1236
    whether state is needed for a given format or not.
1570
1237
 
1573
1240
    object will be created every time regardless.
1574
1241
    """
1575
1242
 
1576
 
    can_set_append_revisions_only = True
 
1243
    _default_format = None
 
1244
    """The default format used for new branches."""
 
1245
 
 
1246
    _formats = {}
 
1247
    """The known formats."""
1577
1248
 
1578
1249
    def __eq__(self, other):
1579
1250
        return self.__class__ is other.__class__
1582
1253
        return not (self == other)
1583
1254
 
1584
1255
    @classmethod
1585
 
    def find_format(klass, a_bzrdir, name=None):
 
1256
    def find_format(klass, a_bzrdir):
1586
1257
        """Return the format for the branch object in a_bzrdir."""
1587
1258
        try:
1588
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1589
 
            format_string = transport.get_bytes("format")
1590
 
            return format_registry.get(format_string)
 
1259
            transport = a_bzrdir.get_branch_transport(None)
 
1260
            format_string = transport.get("format").read()
 
1261
            return klass._formats[format_string]
1591
1262
        except errors.NoSuchFile:
1592
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1263
            raise errors.NotBranchError(path=transport.base)
1593
1264
        except KeyError:
1594
1265
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1595
1266
 
1596
1267
    @classmethod
1597
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1598
1268
    def get_default_format(klass):
1599
1269
        """Return the current default format."""
1600
 
        return format_registry.get_default()
1601
 
 
1602
 
    @classmethod
1603
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1604
 
    def get_formats(klass):
1605
 
        """Get all the known formats.
1606
 
 
1607
 
        Warning: This triggers a load of all lazy registered formats: do not
1608
 
        use except when that is desireed.
1609
 
        """
1610
 
        return format_registry._get_all()
1611
 
 
1612
 
    def get_reference(self, a_bzrdir, name=None):
 
1270
        return klass._default_format
 
1271
 
 
1272
    def get_reference(self, a_bzrdir):
1613
1273
        """Get the target reference of the branch in a_bzrdir.
1614
1274
 
1615
1275
        format probing must have been completed before calling
1617
1277
        in a_bzrdir is correct.
1618
1278
 
1619
1279
        :param a_bzrdir: The bzrdir to get the branch data from.
1620
 
        :param name: Name of the colocated branch to fetch
1621
1280
        :return: None if the branch is not a reference branch.
1622
1281
        """
1623
1282
        return None
1624
1283
 
1625
1284
    @classmethod
1626
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1285
    def set_reference(self, a_bzrdir, to_branch):
1627
1286
        """Set the target reference of the branch in a_bzrdir.
1628
1287
 
1629
1288
        format probing must have been completed before calling
1631
1290
        in a_bzrdir is correct.
1632
1291
 
1633
1292
        :param a_bzrdir: The bzrdir to set the branch reference for.
1634
 
        :param name: Name of colocated branch to set, None for default
1635
1293
        :param to_branch: branch that the checkout is to reference
1636
1294
        """
1637
1295
        raise NotImplementedError(self.set_reference)
1644
1302
        """Return the short format description for this format."""
1645
1303
        raise NotImplementedError(self.get_format_description)
1646
1304
 
1647
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1648
 
        hooks = Branch.hooks['post_branch_init']
1649
 
        if not hooks:
1650
 
            return
1651
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1652
 
        for hook in hooks:
1653
 
            hook(params)
 
1305
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1306
                           set_format=True):
 
1307
        """Initialize a branch in a bzrdir, with specified files
1654
1308
 
1655
 
    def initialize(self, a_bzrdir, name=None, repository=None):
1656
 
        """Create a branch of this format in a_bzrdir.
1657
 
        
1658
 
        :param name: Name of the colocated branch to create.
 
1309
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1310
        :param utf8_files: The files to create as a list of
 
1311
            (filename, content) tuples
 
1312
        :param set_format: If True, set the format with
 
1313
            self.get_format_string.  (BzrBranch4 has its format set
 
1314
            elsewhere)
 
1315
        :return: a branch in this format
1659
1316
        """
 
1317
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1318
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1319
        lock_map = {
 
1320
            'metadir': ('lock', lockdir.LockDir),
 
1321
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1322
        }
 
1323
        lock_name, lock_class = lock_map[lock_type]
 
1324
        control_files = lockable_files.LockableFiles(branch_transport,
 
1325
            lock_name, lock_class)
 
1326
        control_files.create_lock()
 
1327
        control_files.lock_write()
 
1328
        if set_format:
 
1329
            utf8_files += [('format', self.get_format_string())]
 
1330
        try:
 
1331
            for (filename, content) in utf8_files:
 
1332
                branch_transport.put_bytes(
 
1333
                    filename, content,
 
1334
                    mode=a_bzrdir._get_file_mode())
 
1335
        finally:
 
1336
            control_files.unlock()
 
1337
        return self.open(a_bzrdir, _found=True)
 
1338
 
 
1339
    def initialize(self, a_bzrdir):
 
1340
        """Create a branch of this format in a_bzrdir."""
1660
1341
        raise NotImplementedError(self.initialize)
1661
1342
 
1662
1343
    def is_supported(self):
1692
1373
        """
1693
1374
        raise NotImplementedError(self.network_name)
1694
1375
 
1695
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1696
 
            found_repository=None):
 
1376
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1697
1377
        """Return the branch object for a_bzrdir
1698
1378
 
1699
1379
        :param a_bzrdir: A BzrDir that contains a branch.
1700
 
        :param name: Name of colocated branch to open
1701
1380
        :param _found: a private parameter, do not use it. It is used to
1702
1381
            indicate if format probing has already be done.
1703
1382
        :param ignore_fallbacks: when set, no fallback branches will be opened
1706
1385
        raise NotImplementedError(self.open)
1707
1386
 
1708
1387
    @classmethod
1709
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1710
1388
    def register_format(klass, format):
1711
 
        """Register a metadir format.
1712
 
 
1713
 
        See MetaDirBranchFormatFactory for the ability to register a format
1714
 
        without loading the code the format needs until it is actually used.
1715
 
        """
1716
 
        format_registry.register(format)
 
1389
        """Register a metadir format."""
 
1390
        klass._formats[format.get_format_string()] = format
 
1391
        # Metadir formats have a network name of their format string, and get
 
1392
        # registered as class factories.
 
1393
        network_format_registry.register(format.get_format_string(), format.__class__)
1717
1394
 
1718
1395
    @classmethod
1719
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1720
1396
    def set_default_format(klass, format):
1721
 
        format_registry.set_default(format)
1722
 
 
1723
 
    def supports_set_append_revisions_only(self):
1724
 
        """True if this format supports set_append_revisions_only."""
1725
 
        return False
 
1397
        klass._default_format = format
1726
1398
 
1727
1399
    def supports_stacking(self):
1728
1400
        """True if this format records a stacked-on branch."""
1729
1401
        return False
1730
1402
 
1731
 
    def supports_leaving_lock(self):
1732
 
        """True if this format supports leaving locks in place."""
1733
 
        return False # by default
1734
 
 
1735
1403
    @classmethod
1736
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1737
1404
    def unregister_format(klass, format):
1738
 
        format_registry.remove(format)
 
1405
        del klass._formats[format.get_format_string()]
1739
1406
 
1740
1407
    def __str__(self):
1741
1408
        return self.get_format_description().rstrip()
1745
1412
        return False  # by default
1746
1413
 
1747
1414
 
1748
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1749
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1750
 
    
1751
 
    While none of the built in BranchFormats are lazy registered yet,
1752
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1753
 
    use it, and the bzr-loom plugin uses it as well (see
1754
 
    bzrlib.plugins.loom.formats).
1755
 
    """
1756
 
 
1757
 
    def __init__(self, format_string, module_name, member_name):
1758
 
        """Create a MetaDirBranchFormatFactory.
1759
 
 
1760
 
        :param format_string: The format string the format has.
1761
 
        :param module_name: Module to load the format class from.
1762
 
        :param member_name: Attribute name within the module for the format class.
1763
 
        """
1764
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1765
 
        self._format_string = format_string
1766
 
        
1767
 
    def get_format_string(self):
1768
 
        """See BranchFormat.get_format_string."""
1769
 
        return self._format_string
1770
 
 
1771
 
    def __call__(self):
1772
 
        """Used for network_format_registry support."""
1773
 
        return self.get_obj()()
1774
 
 
1775
 
 
1776
1415
class BranchHooks(Hooks):
1777
1416
    """A dictionary mapping hook name to a list of callables for branch hooks.
1778
1417
 
1786
1425
        These are all empty initially, because by default nothing should get
1787
1426
        notified.
1788
1427
        """
1789
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1790
 
        self.add_hook('set_rh',
 
1428
        Hooks.__init__(self)
 
1429
        self.create_hook(HookPoint('set_rh',
1791
1430
            "Invoked whenever the revision history has been set via "
1792
1431
            "set_revision_history. The api signature is (branch, "
1793
1432
            "revision_history), and the branch will be write-locked. "
1794
1433
            "The set_rh hook can be expensive for bzr to trigger, a better "
1795
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1796
 
        self.add_hook('open',
 
1434
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1435
        self.create_hook(HookPoint('open',
1797
1436
            "Called with the Branch object that has been opened after a "
1798
 
            "branch is opened.", (1, 8))
1799
 
        self.add_hook('post_push',
 
1437
            "branch is opened.", (1, 8), None))
 
1438
        self.create_hook(HookPoint('post_push',
1800
1439
            "Called after a push operation completes. post_push is called "
1801
1440
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1802
 
            "bzr client.", (0, 15))
1803
 
        self.add_hook('post_pull',
 
1441
            "bzr client.", (0, 15), None))
 
1442
        self.create_hook(HookPoint('post_pull',
1804
1443
            "Called after a pull operation completes. post_pull is called "
1805
1444
            "with a bzrlib.branch.PullResult object and only runs in the "
1806
 
            "bzr client.", (0, 15))
1807
 
        self.add_hook('pre_commit',
1808
 
            "Called after a commit is calculated but before it is "
 
1445
            "bzr client.", (0, 15), None))
 
1446
        self.create_hook(HookPoint('pre_commit',
 
1447
            "Called after a commit is calculated but before it is is "
1809
1448
            "completed. pre_commit is called with (local, master, old_revno, "
1810
1449
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1811
1450
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1813
1452
            "basis revision. hooks MUST NOT modify this delta. "
1814
1453
            " future_tree is an in-memory tree obtained from "
1815
1454
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1816
 
            "tree.", (0,91))
1817
 
        self.add_hook('post_commit',
 
1455
            "tree.", (0,91), None))
 
1456
        self.create_hook(HookPoint('post_commit',
1818
1457
            "Called in the bzr client after a commit has completed. "
1819
1458
            "post_commit is called with (local, master, old_revno, old_revid, "
1820
1459
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1821
 
            "commit to a branch.", (0, 15))
1822
 
        self.add_hook('post_uncommit',
 
1460
            "commit to a branch.", (0, 15), None))
 
1461
        self.create_hook(HookPoint('post_uncommit',
1823
1462
            "Called in the bzr client after an uncommit completes. "
1824
1463
            "post_uncommit is called with (local, master, old_revno, "
1825
1464
            "old_revid, new_revno, new_revid) where local is the local branch "
1826
1465
            "or None, master is the target branch, and an empty branch "
1827
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1828
 
        self.add_hook('pre_change_branch_tip',
 
1466
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1467
        self.create_hook(HookPoint('pre_change_branch_tip',
1829
1468
            "Called in bzr client and server before a change to the tip of a "
1830
1469
            "branch is made. pre_change_branch_tip is called with a "
1831
1470
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1832
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1833
 
        self.add_hook('post_change_branch_tip',
 
1471
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1472
        self.create_hook(HookPoint('post_change_branch_tip',
1834
1473
            "Called in bzr client and server after a change to the tip of a "
1835
1474
            "branch is made. post_change_branch_tip is called with a "
1836
1475
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1837
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1838
 
        self.add_hook('transform_fallback_location',
 
1476
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1477
        self.create_hook(HookPoint('transform_fallback_location',
1839
1478
            "Called when a stacked branch is activating its fallback "
1840
1479
            "locations. transform_fallback_location is called with (branch, "
1841
1480
            "url), and should return a new url. Returning the same url "
1846
1485
            "fallback locations have not been activated. When there are "
1847
1486
            "multiple hooks installed for transform_fallback_location, "
1848
1487
            "all are called with the url returned from the previous hook."
1849
 
            "The order is however undefined.", (1, 9))
1850
 
        self.add_hook('automatic_tag_name',
1851
 
            "Called to determine an automatic tag name for a revision. "
1852
 
            "automatic_tag_name is called with (branch, revision_id) and "
1853
 
            "should return a tag name or None if no tag name could be "
1854
 
            "determined. The first non-None tag name returned will be used.",
1855
 
            (2, 2))
1856
 
        self.add_hook('post_branch_init',
1857
 
            "Called after new branch initialization completes. "
1858
 
            "post_branch_init is called with a "
1859
 
            "bzrlib.branch.BranchInitHookParams. "
1860
 
            "Note that init, branch and checkout (both heavyweight and "
1861
 
            "lightweight) will all trigger this hook.", (2, 2))
1862
 
        self.add_hook('post_switch',
1863
 
            "Called after a checkout switches branch. "
1864
 
            "post_switch is called with a "
1865
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1866
 
 
 
1488
            "The order is however undefined.", (1, 9), None))
1867
1489
 
1868
1490
 
1869
1491
# install the default hooks into the Branch class.
1871
1493
 
1872
1494
 
1873
1495
class ChangeBranchTipParams(object):
1874
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1496
    """Object holding parameters passed to *_change_branch_tip hooks.
1875
1497
 
1876
1498
    There are 5 fields that hooks may wish to access:
1877
1499
 
1908
1530
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1909
1531
 
1910
1532
 
1911
 
class BranchInitHookParams(object):
1912
 
    """Object holding parameters passed to `*_branch_init` hooks.
1913
 
 
1914
 
    There are 4 fields that hooks may wish to access:
1915
 
 
1916
 
    :ivar format: the branch format
1917
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1918
 
    :ivar name: name of colocated branch, if any (or None)
1919
 
    :ivar branch: the branch created
1920
 
 
1921
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1922
 
    the checkout, hence they are different from the corresponding fields in
1923
 
    branch, which refer to the original branch.
1924
 
    """
1925
 
 
1926
 
    def __init__(self, format, a_bzrdir, name, branch):
1927
 
        """Create a group of BranchInitHook parameters.
1928
 
 
1929
 
        :param format: the branch format
1930
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1931
 
            initialized
1932
 
        :param name: name of colocated branch, if any (or None)
1933
 
        :param branch: the branch created
1934
 
 
1935
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1936
 
        to the checkout, hence they are different from the corresponding fields
1937
 
        in branch, which refer to the original branch.
1938
 
        """
1939
 
        self.format = format
1940
 
        self.bzrdir = a_bzrdir
1941
 
        self.name = name
1942
 
        self.branch = branch
1943
 
 
1944
 
    def __eq__(self, other):
1945
 
        return self.__dict__ == other.__dict__
1946
 
 
1947
 
    def __repr__(self):
1948
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1949
 
 
1950
 
 
1951
 
class SwitchHookParams(object):
1952
 
    """Object holding parameters passed to `*_switch` hooks.
1953
 
 
1954
 
    There are 4 fields that hooks may wish to access:
1955
 
 
1956
 
    :ivar control_dir: BzrDir of the checkout to change
1957
 
    :ivar to_branch: branch that the checkout is to reference
1958
 
    :ivar force: skip the check for local commits in a heavy checkout
1959
 
    :ivar revision_id: revision ID to switch to (or None)
1960
 
    """
1961
 
 
1962
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1963
 
        """Create a group of SwitchHook parameters.
1964
 
 
1965
 
        :param control_dir: BzrDir of the checkout to change
1966
 
        :param to_branch: branch that the checkout is to reference
1967
 
        :param force: skip the check for local commits in a heavy checkout
1968
 
        :param revision_id: revision ID to switch to (or None)
1969
 
        """
1970
 
        self.control_dir = control_dir
1971
 
        self.to_branch = to_branch
1972
 
        self.force = force
1973
 
        self.revision_id = revision_id
1974
 
 
1975
 
    def __eq__(self, other):
1976
 
        return self.__dict__ == other.__dict__
1977
 
 
1978
 
    def __repr__(self):
1979
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1980
 
            self.control_dir, self.to_branch,
1981
 
            self.revision_id)
 
1533
class BzrBranchFormat4(BranchFormat):
 
1534
    """Bzr branch format 4.
 
1535
 
 
1536
    This format has:
 
1537
     - a revision-history file.
 
1538
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1539
    """
 
1540
 
 
1541
    def get_format_description(self):
 
1542
        """See BranchFormat.get_format_description()."""
 
1543
        return "Branch format 4"
 
1544
 
 
1545
    def initialize(self, a_bzrdir):
 
1546
        """Create a branch of this format in a_bzrdir."""
 
1547
        utf8_files = [('revision-history', ''),
 
1548
                      ('branch-name', ''),
 
1549
                      ]
 
1550
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1551
                                       lock_type='branch4', set_format=False)
 
1552
 
 
1553
    def __init__(self):
 
1554
        super(BzrBranchFormat4, self).__init__()
 
1555
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1556
 
 
1557
    def network_name(self):
 
1558
        """The network name for this format is the control dirs disk label."""
 
1559
        return self._matchingbzrdir.get_format_string()
 
1560
 
 
1561
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1562
        """See BranchFormat.open()."""
 
1563
        if not _found:
 
1564
            # we are being called directly and must probe.
 
1565
            raise NotImplementedError
 
1566
        return BzrBranch(_format=self,
 
1567
                         _control_files=a_bzrdir._control_files,
 
1568
                         a_bzrdir=a_bzrdir,
 
1569
                         _repository=a_bzrdir.open_repository())
 
1570
 
 
1571
    def __str__(self):
 
1572
        return "Bazaar-NG branch format 4"
1982
1573
 
1983
1574
 
1984
1575
class BranchFormatMetadir(BranchFormat):
1988
1579
        """What class to instantiate on open calls."""
1989
1580
        raise NotImplementedError(self._branch_class)
1990
1581
 
1991
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1992
 
                           repository=None):
1993
 
        """Initialize a branch in a bzrdir, with specified files
1994
 
 
1995
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1996
 
        :param utf8_files: The files to create as a list of
1997
 
            (filename, content) tuples
1998
 
        :param name: Name of colocated branch to create, if any
1999
 
        :return: a branch in this format
2000
 
        """
2001
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2002
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2003
 
        control_files = lockable_files.LockableFiles(branch_transport,
2004
 
            'lock', lockdir.LockDir)
2005
 
        control_files.create_lock()
2006
 
        control_files.lock_write()
2007
 
        try:
2008
 
            utf8_files += [('format', self.get_format_string())]
2009
 
            for (filename, content) in utf8_files:
2010
 
                branch_transport.put_bytes(
2011
 
                    filename, content,
2012
 
                    mode=a_bzrdir._get_file_mode())
2013
 
        finally:
2014
 
            control_files.unlock()
2015
 
        branch = self.open(a_bzrdir, name, _found=True,
2016
 
                found_repository=repository)
2017
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2018
 
        return branch
2019
 
 
2020
1582
    def network_name(self):
2021
1583
        """A simple byte string uniquely identifying this format for RPC calls.
2022
1584
 
2024
1586
        """
2025
1587
        return self.get_format_string()
2026
1588
 
2027
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2028
 
            found_repository=None):
 
1589
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2029
1590
        """See BranchFormat.open()."""
2030
1591
        if not _found:
2031
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1592
            format = BranchFormat.find_format(a_bzrdir)
2032
1593
            if format.__class__ != self.__class__:
2033
1594
                raise AssertionError("wrong format %r found for %r" %
2034
1595
                    (format, self))
2035
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2036
1596
        try:
 
1597
            transport = a_bzrdir.get_branch_transport(None)
2037
1598
            control_files = lockable_files.LockableFiles(transport, 'lock',
2038
1599
                                                         lockdir.LockDir)
2039
 
            if found_repository is None:
2040
 
                found_repository = a_bzrdir.find_repository()
2041
1600
            return self._branch_class()(_format=self,
2042
1601
                              _control_files=control_files,
2043
 
                              name=name,
2044
1602
                              a_bzrdir=a_bzrdir,
2045
 
                              _repository=found_repository,
 
1603
                              _repository=a_bzrdir.find_repository(),
2046
1604
                              ignore_fallbacks=ignore_fallbacks)
2047
1605
        except errors.NoSuchFile:
2048
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1606
            raise errors.NotBranchError(path=transport.base)
2049
1607
 
2050
1608
    def __init__(self):
2051
1609
        super(BranchFormatMetadir, self).__init__()
2055
1613
    def supports_tags(self):
2056
1614
        return True
2057
1615
 
2058
 
    def supports_leaving_lock(self):
2059
 
        return True
2060
 
 
2061
1616
 
2062
1617
class BzrBranchFormat5(BranchFormatMetadir):
2063
1618
    """Bzr branch format 5.
2083
1638
        """See BranchFormat.get_format_description()."""
2084
1639
        return "Branch format 5"
2085
1640
 
2086
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1641
    def initialize(self, a_bzrdir):
2087
1642
        """Create a branch of this format in a_bzrdir."""
2088
1643
        utf8_files = [('revision-history', ''),
2089
1644
                      ('branch-name', ''),
2090
1645
                      ]
2091
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1646
        return self._initialize_helper(a_bzrdir, utf8_files)
2092
1647
 
2093
1648
    def supports_tags(self):
2094
1649
        return False
2116
1671
        """See BranchFormat.get_format_description()."""
2117
1672
        return "Branch format 6"
2118
1673
 
2119
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2120
 
        """Create a branch of this format in a_bzrdir."""
2121
 
        utf8_files = [('last-revision', '0 null:\n'),
2122
 
                      ('branch.conf', ''),
2123
 
                      ('tags', ''),
2124
 
                      ]
2125
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2126
 
 
2127
 
    def make_tags(self, branch):
2128
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2129
 
        return BasicTags(branch)
2130
 
 
2131
 
    def supports_set_append_revisions_only(self):
2132
 
        return True
2133
 
 
2134
 
 
2135
 
class BzrBranchFormat8(BranchFormatMetadir):
2136
 
    """Metadir format supporting storing locations of subtree branches."""
2137
 
 
2138
 
    def _branch_class(self):
2139
 
        return BzrBranch8
2140
 
 
2141
 
    def get_format_string(self):
2142
 
        """See BranchFormat.get_format_string()."""
2143
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2144
 
 
2145
 
    def get_format_description(self):
2146
 
        """See BranchFormat.get_format_description()."""
2147
 
        return "Branch format 8"
2148
 
 
2149
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2150
 
        """Create a branch of this format in a_bzrdir."""
2151
 
        utf8_files = [('last-revision', '0 null:\n'),
2152
 
                      ('branch.conf', ''),
2153
 
                      ('tags', ''),
2154
 
                      ('references', '')
2155
 
                      ]
2156
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2157
 
 
2158
 
    def make_tags(self, branch):
2159
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2160
 
        return BasicTags(branch)
2161
 
 
2162
 
    def supports_set_append_revisions_only(self):
2163
 
        return True
2164
 
 
2165
 
    def supports_stacking(self):
2166
 
        return True
2167
 
 
2168
 
    supports_reference_locations = True
 
1674
    def initialize(self, a_bzrdir):
 
1675
        """Create a branch of this format in a_bzrdir."""
 
1676
        utf8_files = [('last-revision', '0 null:\n'),
 
1677
                      ('branch.conf', ''),
 
1678
                      ('tags', ''),
 
1679
                      ]
 
1680
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1681
 
 
1682
    def make_tags(self, branch):
 
1683
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1684
        return BasicTags(branch)
 
1685
 
2169
1686
 
2170
1687
 
2171
1688
class BzrBranchFormat7(BranchFormatMetadir):
2177
1694
    This format was introduced in bzr 1.6.
2178
1695
    """
2179
1696
 
2180
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2181
 
        """Create a branch of this format in a_bzrdir."""
2182
 
        utf8_files = [('last-revision', '0 null:\n'),
2183
 
                      ('branch.conf', ''),
2184
 
                      ('tags', ''),
2185
 
                      ]
2186
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2187
 
 
2188
1697
    def _branch_class(self):
2189
1698
        return BzrBranch7
2190
1699
 
2196
1705
        """See BranchFormat.get_format_description()."""
2197
1706
        return "Branch format 7"
2198
1707
 
2199
 
    def supports_set_append_revisions_only(self):
2200
 
        return True
 
1708
    def initialize(self, a_bzrdir):
 
1709
        """Create a branch of this format in a_bzrdir."""
 
1710
        utf8_files = [('last-revision', '0 null:\n'),
 
1711
                      ('branch.conf', ''),
 
1712
                      ('tags', ''),
 
1713
                      ]
 
1714
        return self._initialize_helper(a_bzrdir, utf8_files)
2201
1715
 
2202
 
    def supports_stacking(self):
2203
 
        return True
 
1716
    def __init__(self):
 
1717
        super(BzrBranchFormat7, self).__init__()
 
1718
        self._matchingbzrdir.repository_format = \
 
1719
            RepositoryFormatKnitPack5RichRoot()
2204
1720
 
2205
1721
    def make_tags(self, branch):
2206
1722
        """See bzrlib.branch.BranchFormat.make_tags()."""
2207
1723
        return BasicTags(branch)
2208
1724
 
2209
 
    supports_reference_locations = False
 
1725
    def supports_stacking(self):
 
1726
        return True
2210
1727
 
2211
1728
 
2212
1729
class BranchReferenceFormat(BranchFormat):
2228
1745
        """See BranchFormat.get_format_description()."""
2229
1746
        return "Checkout reference format 1"
2230
1747
 
2231
 
    def get_reference(self, a_bzrdir, name=None):
 
1748
    def get_reference(self, a_bzrdir):
2232
1749
        """See BranchFormat.get_reference()."""
2233
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2234
 
        return transport.get_bytes('location')
 
1750
        transport = a_bzrdir.get_branch_transport(None)
 
1751
        return transport.get('location').read()
2235
1752
 
2236
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1753
    def set_reference(self, a_bzrdir, to_branch):
2237
1754
        """See BranchFormat.set_reference()."""
2238
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1755
        transport = a_bzrdir.get_branch_transport(None)
2239
1756
        location = transport.put_bytes('location', to_branch.base)
2240
1757
 
2241
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2242
 
            repository=None):
 
1758
    def initialize(self, a_bzrdir, target_branch=None):
2243
1759
        """Create a branch of this format in a_bzrdir."""
2244
1760
        if target_branch is None:
2245
1761
            # this format does not implement branch itself, thus the implicit
2246
1762
            # creation contract must see it as uninitializable
2247
1763
            raise errors.UninitializableFormat(self)
2248
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2249
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1764
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1765
        branch_transport = a_bzrdir.get_branch_transport(self)
2250
1766
        branch_transport.put_bytes('location',
2251
 
            target_branch.bzrdir.user_url)
 
1767
            target_branch.bzrdir.root_transport.base)
2252
1768
        branch_transport.put_bytes('format', self.get_format_string())
2253
 
        branch = self.open(
2254
 
            a_bzrdir, name, _found=True,
 
1769
        return self.open(
 
1770
            a_bzrdir, _found=True,
2255
1771
            possible_transports=[target_branch.bzrdir.root_transport])
2256
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2257
 
        return branch
2258
1772
 
2259
1773
    def __init__(self):
2260
1774
        super(BranchReferenceFormat, self).__init__()
2266
1780
        def clone(to_bzrdir, revision_id=None,
2267
1781
            repository_policy=None):
2268
1782
            """See Branch.clone()."""
2269
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1783
            return format.initialize(to_bzrdir, a_branch)
2270
1784
            # cannot obey revision_id limits when cloning a reference ...
2271
1785
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2272
1786
            # emit some sort of warning/error to the caller ?!
2273
1787
        return clone
2274
1788
 
2275
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2276
 
             possible_transports=None, ignore_fallbacks=False,
2277
 
             found_repository=None):
 
1789
    def open(self, a_bzrdir, _found=False, location=None,
 
1790
             possible_transports=None, ignore_fallbacks=False):
2278
1791
        """Return the branch that the branch reference in a_bzrdir points at.
2279
1792
 
2280
1793
        :param a_bzrdir: A BzrDir that contains a branch.
2281
 
        :param name: Name of colocated branch to open, if any
2282
1794
        :param _found: a private parameter, do not use it. It is used to
2283
1795
            indicate if format probing has already be done.
2284
1796
        :param ignore_fallbacks: when set, no fallback branches will be opened
2289
1801
        :param possible_transports: An optional reusable transports list.
2290
1802
        """
2291
1803
        if not _found:
2292
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1804
            format = BranchFormat.find_format(a_bzrdir)
2293
1805
            if format.__class__ != self.__class__:
2294
1806
                raise AssertionError("wrong format %r found for %r" %
2295
1807
                    (format, self))
2296
1808
        if location is None:
2297
 
            location = self.get_reference(a_bzrdir, name)
 
1809
            location = self.get_reference(a_bzrdir)
2298
1810
        real_bzrdir = bzrdir.BzrDir.open(
2299
1811
            location, possible_transports=possible_transports)
2300
 
        result = real_bzrdir.open_branch(name=name, 
2301
 
            ignore_fallbacks=ignore_fallbacks)
 
1812
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2302
1813
        # this changes the behaviour of result.clone to create a new reference
2303
1814
        # rather than a copy of the content of the branch.
2304
1815
        # I did not use a proxy object because that needs much more extensive
2311
1822
        return result
2312
1823
 
2313
1824
 
2314
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2315
 
    """Branch format registry."""
2316
 
 
2317
 
    def __init__(self, other_registry=None):
2318
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2319
 
        self._default_format = None
2320
 
 
2321
 
    def set_default(self, format):
2322
 
        self._default_format = format
2323
 
 
2324
 
    def get_default(self):
2325
 
        return self._default_format
2326
 
 
2327
 
 
2328
1825
network_format_registry = registry.FormatRegistry()
2329
1826
"""Registry of formats indexed by their network name.
2330
1827
 
2333
1830
BranchFormat.network_name() for more detail.
2334
1831
"""
2335
1832
 
2336
 
format_registry = BranchFormatRegistry(network_format_registry)
2337
 
 
2338
1833
 
2339
1834
# formats which have no format string are not discoverable
2340
1835
# and not independently creatable, so are not registered.
2341
1836
__format5 = BzrBranchFormat5()
2342
1837
__format6 = BzrBranchFormat6()
2343
1838
__format7 = BzrBranchFormat7()
2344
 
__format8 = BzrBranchFormat8()
2345
 
format_registry.register(__format5)
2346
 
format_registry.register(BranchReferenceFormat())
2347
 
format_registry.register(__format6)
2348
 
format_registry.register(__format7)
2349
 
format_registry.register(__format8)
2350
 
format_registry.set_default(__format7)
2351
 
 
2352
 
 
2353
 
class BranchWriteLockResult(LogicalLockResult):
2354
 
    """The result of write locking a branch.
2355
 
 
2356
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2357
 
        None.
2358
 
    :ivar unlock: A callable which will unlock the lock.
2359
 
    """
2360
 
 
2361
 
    def __init__(self, unlock, branch_token):
2362
 
        LogicalLockResult.__init__(self, unlock)
2363
 
        self.branch_token = branch_token
2364
 
 
2365
 
    def __repr__(self):
2366
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2367
 
            self.unlock)
2368
 
 
2369
 
 
2370
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1839
BranchFormat.register_format(__format5)
 
1840
BranchFormat.register_format(BranchReferenceFormat())
 
1841
BranchFormat.register_format(__format6)
 
1842
BranchFormat.register_format(__format7)
 
1843
BranchFormat.set_default_format(__format6)
 
1844
_legacy_formats = [BzrBranchFormat4(),
 
1845
    ]
 
1846
network_format_registry.register(
 
1847
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
1848
 
 
1849
 
 
1850
class BzrBranch(Branch):
2371
1851
    """A branch stored in the actual filesystem.
2372
1852
 
2373
1853
    Note that it's "local" in the context of the filesystem; it doesn't
2379
1859
    :ivar repository: Repository for this branch.
2380
1860
    :ivar base: The url of the base directory for this branch; the one
2381
1861
        containing the .bzr directory.
2382
 
    :ivar name: Optional colocated branch name as it exists in the control
2383
 
        directory.
2384
1862
    """
2385
1863
 
2386
1864
    def __init__(self, _format=None,
2387
 
                 _control_files=None, a_bzrdir=None, name=None,
2388
 
                 _repository=None, ignore_fallbacks=False):
 
1865
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1866
                 ignore_fallbacks=False):
2389
1867
        """Create new branch object at a particular location."""
2390
1868
        if a_bzrdir is None:
2391
1869
            raise ValueError('a_bzrdir must be supplied')
2392
1870
        else:
2393
1871
            self.bzrdir = a_bzrdir
2394
1872
        self._base = self.bzrdir.transport.clone('..').base
2395
 
        self.name = name
2396
1873
        # XXX: We should be able to just do
2397
1874
        #   self.base = self.bzrdir.root_transport.base
2398
1875
        # but this does not quite work yet -- mbp 20080522
2405
1882
        Branch.__init__(self)
2406
1883
 
2407
1884
    def __str__(self):
2408
 
        if self.name is None:
2409
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2410
 
        else:
2411
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2412
 
                self.name)
 
1885
        return '%s(%r)' % (self.__class__.__name__, self.base)
2413
1886
 
2414
1887
    __repr__ = __str__
2415
1888
 
2426
1899
        return self.control_files.is_locked()
2427
1900
 
2428
1901
    def lock_write(self, token=None):
2429
 
        """Lock the branch for write operations.
2430
 
 
2431
 
        :param token: A token to permit reacquiring a previously held and
2432
 
            preserved lock.
2433
 
        :return: A BranchWriteLockResult.
2434
 
        """
2435
 
        if not self.is_locked():
2436
 
            self._note_lock('w')
2437
 
        # All-in-one needs to always unlock/lock.
2438
 
        repo_control = getattr(self.repository, 'control_files', None)
2439
 
        if self.control_files == repo_control or not self.is_locked():
2440
 
            self.repository._warn_if_deprecated(self)
2441
 
            self.repository.lock_write()
2442
 
            took_lock = True
2443
 
        else:
2444
 
            took_lock = False
 
1902
        repo_token = self.repository.lock_write()
2445
1903
        try:
2446
 
            return BranchWriteLockResult(self.unlock,
2447
 
                self.control_files.lock_write(token=token))
 
1904
            token = self.control_files.lock_write(token=token)
2448
1905
        except:
2449
 
            if took_lock:
2450
 
                self.repository.unlock()
 
1906
            self.repository.unlock()
2451
1907
            raise
 
1908
        return token
2452
1909
 
2453
1910
    def lock_read(self):
2454
 
        """Lock the branch for read operations.
2455
 
 
2456
 
        :return: A bzrlib.lock.LogicalLockResult.
2457
 
        """
2458
 
        if not self.is_locked():
2459
 
            self._note_lock('r')
2460
 
        # All-in-one needs to always unlock/lock.
2461
 
        repo_control = getattr(self.repository, 'control_files', None)
2462
 
        if self.control_files == repo_control or not self.is_locked():
2463
 
            self.repository._warn_if_deprecated(self)
2464
 
            self.repository.lock_read()
2465
 
            took_lock = True
2466
 
        else:
2467
 
            took_lock = False
 
1911
        self.repository.lock_read()
2468
1912
        try:
2469
1913
            self.control_files.lock_read()
2470
 
            return LogicalLockResult(self.unlock)
2471
1914
        except:
2472
 
            if took_lock:
2473
 
                self.repository.unlock()
 
1915
            self.repository.unlock()
2474
1916
            raise
2475
1917
 
2476
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2477
1918
    def unlock(self):
 
1919
        # TODO: test for failed two phase locks. This is known broken.
2478
1920
        try:
2479
1921
            self.control_files.unlock()
2480
1922
        finally:
2481
 
            # All-in-one needs to always unlock/lock.
2482
 
            repo_control = getattr(self.repository, 'control_files', None)
2483
 
            if (self.control_files == repo_control or
2484
 
                not self.control_files.is_locked()):
2485
 
                self.repository.unlock()
2486
 
            if not self.control_files.is_locked():
2487
 
                # we just released the lock
2488
 
                self._clear_cached_state()
 
1923
            self.repository.unlock()
 
1924
        if not self.control_files.is_locked():
 
1925
            # we just released the lock
 
1926
            self._clear_cached_state()
2489
1927
 
2490
1928
    def peek_lock_mode(self):
2491
1929
        if self.control_files._lock_count == 0:
2501
1939
        """See Branch.print_file."""
2502
1940
        return self.repository.print_file(file, revision_id)
2503
1941
 
 
1942
    def _write_revision_history(self, history):
 
1943
        """Factored out of set_revision_history.
 
1944
 
 
1945
        This performs the actual writing to disk.
 
1946
        It is intended to be called by BzrBranch5.set_revision_history."""
 
1947
        self._transport.put_bytes(
 
1948
            'revision-history', '\n'.join(history),
 
1949
            mode=self.bzrdir._get_file_mode())
 
1950
 
 
1951
    @needs_write_lock
 
1952
    def set_revision_history(self, rev_history):
 
1953
        """See Branch.set_revision_history."""
 
1954
        if 'evil' in debug.debug_flags:
 
1955
            mutter_callsite(3, "set_revision_history scales with history.")
 
1956
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
1957
        for rev_id in rev_history:
 
1958
            check_not_reserved_id(rev_id)
 
1959
        if Branch.hooks['post_change_branch_tip']:
 
1960
            # Don't calculate the last_revision_info() if there are no hooks
 
1961
            # that will use it.
 
1962
            old_revno, old_revid = self.last_revision_info()
 
1963
        if len(rev_history) == 0:
 
1964
            revid = _mod_revision.NULL_REVISION
 
1965
        else:
 
1966
            revid = rev_history[-1]
 
1967
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
1968
        self._write_revision_history(rev_history)
 
1969
        self._clear_cached_state()
 
1970
        self._cache_revision_history(rev_history)
 
1971
        for hook in Branch.hooks['set_rh']:
 
1972
            hook(self, rev_history)
 
1973
        if Branch.hooks['post_change_branch_tip']:
 
1974
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
1975
 
 
1976
    def _synchronize_history(self, destination, revision_id):
 
1977
        """Synchronize last revision and revision history between branches.
 
1978
 
 
1979
        This version is most efficient when the destination is also a
 
1980
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
1981
        history is the true lefthand parent history, and all of the revisions
 
1982
        are in the destination's repository.  If not, set_revision_history
 
1983
        will fail.
 
1984
 
 
1985
        :param destination: The branch to copy the history into
 
1986
        :param revision_id: The revision-id to truncate history at.  May
 
1987
          be None to copy complete history.
 
1988
        """
 
1989
        if not isinstance(destination._format, BzrBranchFormat5):
 
1990
            super(BzrBranch, self)._synchronize_history(
 
1991
                destination, revision_id)
 
1992
            return
 
1993
        if revision_id == _mod_revision.NULL_REVISION:
 
1994
            new_history = []
 
1995
        else:
 
1996
            new_history = self.revision_history()
 
1997
        if revision_id is not None and new_history != []:
 
1998
            try:
 
1999
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2000
            except ValueError:
 
2001
                rev = self.repository.get_revision(revision_id)
 
2002
                new_history = rev.get_history(self.repository)[1:]
 
2003
        destination.set_revision_history(new_history)
 
2004
 
2504
2005
    @needs_write_lock
2505
2006
    def set_last_revision_info(self, revno, revision_id):
2506
 
        if not revision_id or not isinstance(revision_id, basestring):
2507
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2007
        """Set the last revision of this branch.
 
2008
 
 
2009
        The caller is responsible for checking that the revno is correct
 
2010
        for this revision id.
 
2011
 
 
2012
        It may be possible to set the branch last revision to an id not
 
2013
        present in the repository.  However, branches can also be
 
2014
        configured to check constraints on history, in which case this may not
 
2015
        be permitted.
 
2016
        """
2508
2017
        revision_id = _mod_revision.ensure_null(revision_id)
2509
 
        old_revno, old_revid = self.last_revision_info()
2510
 
        if self._get_append_revisions_only():
2511
 
            self._check_history_violation(revision_id)
2512
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2513
 
        self._write_last_revision_info(revno, revision_id)
2514
 
        self._clear_cached_state()
2515
 
        self._last_revision_info_cache = revno, revision_id
2516
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2018
        # this old format stores the full history, but this api doesn't
 
2019
        # provide it, so we must generate, and might as well check it's
 
2020
        # correct
 
2021
        history = self._lefthand_history(revision_id)
 
2022
        if len(history) != revno:
 
2023
            raise AssertionError('%d != %d' % (len(history), revno))
 
2024
        self.set_revision_history(history)
 
2025
 
 
2026
    def _gen_revision_history(self):
 
2027
        history = self._transport.get_bytes('revision-history').split('\n')
 
2028
        if history[-1:] == ['']:
 
2029
            # There shouldn't be a trailing newline, but just in case.
 
2030
            history.pop()
 
2031
        return history
 
2032
 
 
2033
    @needs_write_lock
 
2034
    def generate_revision_history(self, revision_id, last_rev=None,
 
2035
        other_branch=None):
 
2036
        """Create a new revision history that will finish with revision_id.
 
2037
 
 
2038
        :param revision_id: the new tip to use.
 
2039
        :param last_rev: The previous last_revision. If not None, then this
 
2040
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2041
        :param other_branch: The other branch that DivergedBranches should
 
2042
            raise with respect to.
 
2043
        """
 
2044
        self.set_revision_history(self._lefthand_history(revision_id,
 
2045
            last_rev, other_branch))
2517
2046
 
2518
2047
    def basis_tree(self):
2519
2048
        """See Branch.basis_tree."""
2520
2049
        return self.repository.revision_tree(self.last_revision())
2521
2050
 
 
2051
    @needs_write_lock
 
2052
    def pull(self, source, overwrite=False, stop_revision=None,
 
2053
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2054
             _override_hook_target=None):
 
2055
        """See Branch.pull.
 
2056
 
 
2057
        :param _hook_master: Private parameter - set the branch to
 
2058
            be supplied as the master to pull hooks.
 
2059
        :param run_hooks: Private parameter - if false, this branch
 
2060
            is being called because it's the master of the primary branch,
 
2061
            so it should not run its hooks.
 
2062
        :param _override_hook_target: Private parameter - set the branch to be
 
2063
            supplied as the target_branch to pull hooks.
 
2064
        """
 
2065
        result = PullResult()
 
2066
        result.source_branch = source
 
2067
        if _override_hook_target is None:
 
2068
            result.target_branch = self
 
2069
        else:
 
2070
            result.target_branch = _override_hook_target
 
2071
        source.lock_read()
 
2072
        try:
 
2073
            # We assume that during 'pull' the local repository is closer than
 
2074
            # the remote one.
 
2075
            graph = self.repository.get_graph(source.repository)
 
2076
            result.old_revno, result.old_revid = self.last_revision_info()
 
2077
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2078
                                  graph=graph)
 
2079
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2080
            result.new_revno, result.new_revid = self.last_revision_info()
 
2081
            if _hook_master:
 
2082
                result.master_branch = _hook_master
 
2083
                result.local_branch = result.target_branch
 
2084
            else:
 
2085
                result.master_branch = result.target_branch
 
2086
                result.local_branch = None
 
2087
            if run_hooks:
 
2088
                for hook in Branch.hooks['post_pull']:
 
2089
                    hook(result)
 
2090
        finally:
 
2091
            source.unlock()
 
2092
        return result
 
2093
 
2522
2094
    def _get_parent_location(self):
2523
2095
        _locs = ['parent', 'pull', 'x-pull']
2524
2096
        for l in _locs:
2528
2100
                pass
2529
2101
        return None
2530
2102
 
 
2103
    @needs_read_lock
 
2104
    def push(self, target, overwrite=False, stop_revision=None,
 
2105
             _override_hook_source_branch=None):
 
2106
        """See Branch.push.
 
2107
 
 
2108
        This is the basic concrete implementation of push()
 
2109
 
 
2110
        :param _override_hook_source_branch: If specified, run
 
2111
        the hooks passing this Branch as the source, rather than self.
 
2112
        This is for use of RemoteBranch, where push is delegated to the
 
2113
        underlying vfs-based Branch.
 
2114
        """
 
2115
        # TODO: Public option to disable running hooks - should be trivial but
 
2116
        # needs tests.
 
2117
        return _run_with_write_locked_target(
 
2118
            target, self._push_with_bound_branches, target, overwrite,
 
2119
            stop_revision,
 
2120
            _override_hook_source_branch=_override_hook_source_branch)
 
2121
 
 
2122
    def _push_with_bound_branches(self, target, overwrite,
 
2123
            stop_revision,
 
2124
            _override_hook_source_branch=None):
 
2125
        """Push from self into target, and into target's master if any.
 
2126
 
 
2127
        This is on the base BzrBranch class even though it doesn't support
 
2128
        bound branches because the *target* might be bound.
 
2129
        """
 
2130
        def _run_hooks():
 
2131
            if _override_hook_source_branch:
 
2132
                result.source_branch = _override_hook_source_branch
 
2133
            for hook in Branch.hooks['post_push']:
 
2134
                hook(result)
 
2135
 
 
2136
        bound_location = target.get_bound_location()
 
2137
        if bound_location and target.base != bound_location:
 
2138
            # there is a master branch.
 
2139
            #
 
2140
            # XXX: Why the second check?  Is it even supported for a branch to
 
2141
            # be bound to itself? -- mbp 20070507
 
2142
            master_branch = target.get_master_branch()
 
2143
            master_branch.lock_write()
 
2144
            try:
 
2145
                # push into the master from this branch.
 
2146
                self._basic_push(master_branch, overwrite, stop_revision)
 
2147
                # and push into the target branch from this. Note that we push from
 
2148
                # this branch again, because its considered the highest bandwidth
 
2149
                # repository.
 
2150
                result = self._basic_push(target, overwrite, stop_revision)
 
2151
                result.master_branch = master_branch
 
2152
                result.local_branch = target
 
2153
                _run_hooks()
 
2154
                return result
 
2155
            finally:
 
2156
                master_branch.unlock()
 
2157
        else:
 
2158
            # no master branch
 
2159
            result = self._basic_push(target, overwrite, stop_revision)
 
2160
            # TODO: Why set master_branch and local_branch if there's no
 
2161
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2162
            # 20070504
 
2163
            result.master_branch = target
 
2164
            result.local_branch = None
 
2165
            _run_hooks()
 
2166
            return result
 
2167
 
 
2168
    def _basic_push(self, target, overwrite, stop_revision):
 
2169
        """Basic implementation of push without bound branches or hooks.
 
2170
 
 
2171
        Must be called with self read locked and target write locked.
 
2172
        """
 
2173
        result = BranchPushResult()
 
2174
        result.source_branch = self
 
2175
        result.target_branch = target
 
2176
        result.old_revno, result.old_revid = target.last_revision_info()
 
2177
        if result.old_revid != self.last_revision():
 
2178
            # We assume that during 'push' this repository is closer than
 
2179
            # the target.
 
2180
            graph = self.repository.get_graph(target.repository)
 
2181
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2182
                                    graph=graph)
 
2183
        if self._push_should_merge_tags():
 
2184
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2185
        result.new_revno, result.new_revid = target.last_revision_info()
 
2186
        return result
 
2187
 
2531
2188
    def get_stacked_on_url(self):
2532
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2189
        raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2190
 
2534
2191
    def set_push_location(self, location):
2535
2192
        """See Branch.set_push_location."""
2537
2194
            'push_location', location,
2538
2195
            store=_mod_config.STORE_LOCATION_NORECURSE)
2539
2196
 
 
2197
    @needs_write_lock
 
2198
    def set_parent(self, url):
 
2199
        """See Branch.set_parent."""
 
2200
        # TODO: Maybe delete old location files?
 
2201
        # URLs should never be unicode, even on the local fs,
 
2202
        # FIXUP this and get_parent in a future branch format bump:
 
2203
        # read and rewrite the file. RBC 20060125
 
2204
        if url is not None:
 
2205
            if isinstance(url, unicode):
 
2206
                try:
 
2207
                    url = url.encode('ascii')
 
2208
                except UnicodeEncodeError:
 
2209
                    raise errors.InvalidURL(url,
 
2210
                        "Urls must be 7-bit ascii, "
 
2211
                        "use bzrlib.urlutils.escape")
 
2212
            url = urlutils.relative_url(self.base, url)
 
2213
        self._set_parent_location(url)
 
2214
 
2540
2215
    def _set_parent_location(self, url):
2541
2216
        if url is None:
2542
2217
            self._transport.delete('parent')
2544
2219
            self._transport.put_bytes('parent', url + '\n',
2545
2220
                mode=self.bzrdir._get_file_mode())
2546
2221
 
2547
 
    @needs_write_lock
2548
 
    def unbind(self):
2549
 
        """If bound, unbind"""
2550
 
        return self.set_bound_location(None)
 
2222
 
 
2223
class BzrBranch5(BzrBranch):
 
2224
    """A format 5 branch. This supports new features over plain branches.
 
2225
 
 
2226
    It has support for a master_branch which is the data for bound branches.
 
2227
    """
 
2228
 
 
2229
    @needs_write_lock
 
2230
    def pull(self, source, overwrite=False, stop_revision=None,
 
2231
             run_hooks=True, possible_transports=None,
 
2232
             _override_hook_target=None):
 
2233
        """Pull from source into self, updating my master if any.
 
2234
 
 
2235
        :param run_hooks: Private parameter - if false, this branch
 
2236
            is being called because it's the master of the primary branch,
 
2237
            so it should not run its hooks.
 
2238
        """
 
2239
        bound_location = self.get_bound_location()
 
2240
        master_branch = None
 
2241
        if bound_location and source.base != bound_location:
 
2242
            # not pulling from master, so we need to update master.
 
2243
            master_branch = self.get_master_branch(possible_transports)
 
2244
            master_branch.lock_write()
 
2245
        try:
 
2246
            if master_branch:
 
2247
                # pull from source into master.
 
2248
                master_branch.pull(source, overwrite, stop_revision,
 
2249
                    run_hooks=False)
 
2250
            return super(BzrBranch5, self).pull(source, overwrite,
 
2251
                stop_revision, _hook_master=master_branch,
 
2252
                run_hooks=run_hooks,
 
2253
                _override_hook_target=_override_hook_target)
 
2254
        finally:
 
2255
            if master_branch:
 
2256
                master_branch.unlock()
 
2257
 
 
2258
    def get_bound_location(self):
 
2259
        try:
 
2260
            return self._transport.get_bytes('bound')[:-1]
 
2261
        except errors.NoSuchFile:
 
2262
            return None
 
2263
 
 
2264
    @needs_read_lock
 
2265
    def get_master_branch(self, possible_transports=None):
 
2266
        """Return the branch we are bound to.
 
2267
 
 
2268
        :return: Either a Branch, or None
 
2269
 
 
2270
        This could memoise the branch, but if thats done
 
2271
        it must be revalidated on each new lock.
 
2272
        So for now we just don't memoise it.
 
2273
        # RBC 20060304 review this decision.
 
2274
        """
 
2275
        bound_loc = self.get_bound_location()
 
2276
        if not bound_loc:
 
2277
            return None
 
2278
        try:
 
2279
            return Branch.open(bound_loc,
 
2280
                               possible_transports=possible_transports)
 
2281
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2282
            raise errors.BoundBranchConnectionFailure(
 
2283
                    self, bound_loc, e)
 
2284
 
 
2285
    @needs_write_lock
 
2286
    def set_bound_location(self, location):
 
2287
        """Set the target where this branch is bound to.
 
2288
 
 
2289
        :param location: URL to the target branch
 
2290
        """
 
2291
        if location:
 
2292
            self._transport.put_bytes('bound', location+'\n',
 
2293
                mode=self.bzrdir._get_file_mode())
 
2294
        else:
 
2295
            try:
 
2296
                self._transport.delete('bound')
 
2297
            except errors.NoSuchFile:
 
2298
                return False
 
2299
            return True
2551
2300
 
2552
2301
    @needs_write_lock
2553
2302
    def bind(self, other):
2575
2324
        # history around
2576
2325
        self.set_bound_location(other.base)
2577
2326
 
2578
 
    def get_bound_location(self):
2579
 
        try:
2580
 
            return self._transport.get_bytes('bound')[:-1]
2581
 
        except errors.NoSuchFile:
2582
 
            return None
2583
 
 
2584
 
    @needs_read_lock
2585
 
    def get_master_branch(self, possible_transports=None):
2586
 
        """Return the branch we are bound to.
2587
 
 
2588
 
        :return: Either a Branch, or None
2589
 
        """
2590
 
        if self._master_branch_cache is None:
2591
 
            self._master_branch_cache = self._get_master_branch(
2592
 
                possible_transports)
2593
 
        return self._master_branch_cache
2594
 
 
2595
 
    def _get_master_branch(self, possible_transports):
2596
 
        bound_loc = self.get_bound_location()
2597
 
        if not bound_loc:
2598
 
            return None
2599
 
        try:
2600
 
            return Branch.open(bound_loc,
2601
 
                               possible_transports=possible_transports)
2602
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2603
 
            raise errors.BoundBranchConnectionFailure(
2604
 
                    self, bound_loc, e)
2605
 
 
2606
2327
    @needs_write_lock
2607
 
    def set_bound_location(self, location):
2608
 
        """Set the target where this branch is bound to.
2609
 
 
2610
 
        :param location: URL to the target branch
2611
 
        """
2612
 
        self._master_branch_cache = None
2613
 
        if location:
2614
 
            self._transport.put_bytes('bound', location+'\n',
2615
 
                mode=self.bzrdir._get_file_mode())
2616
 
        else:
2617
 
            try:
2618
 
                self._transport.delete('bound')
2619
 
            except errors.NoSuchFile:
2620
 
                return False
2621
 
            return True
 
2328
    def unbind(self):
 
2329
        """If bound, unbind"""
 
2330
        return self.set_bound_location(None)
2622
2331
 
2623
2332
    @needs_write_lock
2624
2333
    def update(self, possible_transports=None):
2637
2346
            return old_tip
2638
2347
        return None
2639
2348
 
2640
 
    def _read_last_revision_info(self):
2641
 
        revision_string = self._transport.get_bytes('last-revision')
2642
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2643
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2644
 
        revno = int(revno)
2645
 
        return revno, revision_id
2646
 
 
2647
 
    def _write_last_revision_info(self, revno, revision_id):
2648
 
        """Simply write out the revision id, with no checks.
2649
 
 
2650
 
        Use set_last_revision_info to perform this safely.
2651
 
 
2652
 
        Does not update the revision_history cache.
2653
 
        """
2654
 
        revision_id = _mod_revision.ensure_null(revision_id)
2655
 
        out_string = '%d %s\n' % (revno, revision_id)
2656
 
        self._transport.put_bytes('last-revision', out_string,
2657
 
            mode=self.bzrdir._get_file_mode())
2658
 
 
2659
 
 
2660
 
class FullHistoryBzrBranch(BzrBranch):
2661
 
    """Bzr branch which contains the full revision history."""
2662
 
 
2663
 
    @needs_write_lock
2664
 
    def set_last_revision_info(self, revno, revision_id):
2665
 
        if not revision_id or not isinstance(revision_id, basestring):
2666
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2667
 
        revision_id = _mod_revision.ensure_null(revision_id)
2668
 
        # this old format stores the full history, but this api doesn't
2669
 
        # provide it, so we must generate, and might as well check it's
2670
 
        # correct
2671
 
        history = self._lefthand_history(revision_id)
2672
 
        if len(history) != revno:
2673
 
            raise AssertionError('%d != %d' % (len(history), revno))
2674
 
        self._set_revision_history(history)
2675
 
 
2676
 
    def _read_last_revision_info(self):
2677
 
        rh = self.revision_history()
2678
 
        revno = len(rh)
2679
 
        if revno:
2680
 
            return (revno, rh[-1])
2681
 
        else:
2682
 
            return (0, _mod_revision.NULL_REVISION)
2683
 
 
2684
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2685
 
    @needs_write_lock
2686
 
    def set_revision_history(self, rev_history):
2687
 
        """See Branch.set_revision_history."""
2688
 
        self._set_revision_history(rev_history)
2689
 
 
2690
 
    def _set_revision_history(self, rev_history):
2691
 
        if 'evil' in debug.debug_flags:
2692
 
            mutter_callsite(3, "set_revision_history scales with history.")
2693
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2694
 
        for rev_id in rev_history:
2695
 
            check_not_reserved_id(rev_id)
2696
 
        if Branch.hooks['post_change_branch_tip']:
2697
 
            # Don't calculate the last_revision_info() if there are no hooks
2698
 
            # that will use it.
2699
 
            old_revno, old_revid = self.last_revision_info()
2700
 
        if len(rev_history) == 0:
2701
 
            revid = _mod_revision.NULL_REVISION
2702
 
        else:
2703
 
            revid = rev_history[-1]
2704
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2705
 
        self._write_revision_history(rev_history)
2706
 
        self._clear_cached_state()
2707
 
        self._cache_revision_history(rev_history)
2708
 
        for hook in Branch.hooks['set_rh']:
2709
 
            hook(self, rev_history)
2710
 
        if Branch.hooks['post_change_branch_tip']:
2711
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2712
 
 
2713
 
    def _write_revision_history(self, history):
2714
 
        """Factored out of set_revision_history.
2715
 
 
2716
 
        This performs the actual writing to disk.
2717
 
        It is intended to be called by set_revision_history."""
2718
 
        self._transport.put_bytes(
2719
 
            'revision-history', '\n'.join(history),
2720
 
            mode=self.bzrdir._get_file_mode())
2721
 
 
2722
 
    def _gen_revision_history(self):
2723
 
        history = self._transport.get_bytes('revision-history').split('\n')
2724
 
        if history[-1:] == ['']:
2725
 
            # There shouldn't be a trailing newline, but just in case.
2726
 
            history.pop()
2727
 
        return history
2728
 
 
2729
 
    def _synchronize_history(self, destination, revision_id):
2730
 
        if not isinstance(destination, FullHistoryBzrBranch):
2731
 
            super(BzrBranch, self)._synchronize_history(
2732
 
                destination, revision_id)
2733
 
            return
2734
 
        if revision_id == _mod_revision.NULL_REVISION:
2735
 
            new_history = []
2736
 
        else:
2737
 
            new_history = self.revision_history()
2738
 
        if revision_id is not None and new_history != []:
2739
 
            try:
2740
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2741
 
            except ValueError:
2742
 
                rev = self.repository.get_revision(revision_id)
2743
 
                new_history = rev.get_history(self.repository)[1:]
2744
 
        destination._set_revision_history(new_history)
2745
 
 
2746
 
    @needs_write_lock
2747
 
    def generate_revision_history(self, revision_id, last_rev=None,
2748
 
        other_branch=None):
2749
 
        """Create a new revision history that will finish with revision_id.
2750
 
 
2751
 
        :param revision_id: the new tip to use.
2752
 
        :param last_rev: The previous last_revision. If not None, then this
2753
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2754
 
        :param other_branch: The other branch that DivergedBranches should
2755
 
            raise with respect to.
2756
 
        """
2757
 
        self._set_revision_history(self._lefthand_history(revision_id,
2758
 
            last_rev, other_branch))
2759
 
 
2760
 
 
2761
 
class BzrBranch5(FullHistoryBzrBranch):
2762
 
    """A format 5 branch. This supports new features over plain branches.
2763
 
 
2764
 
    It has support for a master_branch which is the data for bound branches.
2765
 
    """
2766
 
 
2767
 
 
2768
 
class BzrBranch8(BzrBranch):
2769
 
    """A branch that stores tree-reference locations."""
 
2349
 
 
2350
class BzrBranch7(BzrBranch5):
 
2351
    """A branch with support for a fallback repository."""
2770
2352
 
2771
2353
    def _open_hook(self):
2772
2354
        if self._ignore_fallbacks:
2788
2370
 
2789
2371
    def __init__(self, *args, **kwargs):
2790
2372
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2791
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2373
        super(BzrBranch7, self).__init__(*args, **kwargs)
2792
2374
        self._last_revision_info_cache = None
2793
 
        self._reference_info = None
 
2375
        self._partial_revision_history_cache = []
2794
2376
 
2795
2377
    def _clear_cached_state(self):
2796
 
        super(BzrBranch8, self)._clear_cached_state()
 
2378
        super(BzrBranch7, self)._clear_cached_state()
2797
2379
        self._last_revision_info_cache = None
2798
 
        self._reference_info = None
 
2380
        self._partial_revision_history_cache = []
 
2381
 
 
2382
    def _last_revision_info(self):
 
2383
        revision_string = self._transport.get_bytes('last-revision')
 
2384
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2385
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2386
        revno = int(revno)
 
2387
        return revno, revision_id
 
2388
 
 
2389
    def _write_last_revision_info(self, revno, revision_id):
 
2390
        """Simply write out the revision id, with no checks.
 
2391
 
 
2392
        Use set_last_revision_info to perform this safely.
 
2393
 
 
2394
        Does not update the revision_history cache.
 
2395
        Intended to be called by set_last_revision_info and
 
2396
        _write_revision_history.
 
2397
        """
 
2398
        revision_id = _mod_revision.ensure_null(revision_id)
 
2399
        out_string = '%d %s\n' % (revno, revision_id)
 
2400
        self._transport.put_bytes('last-revision', out_string,
 
2401
            mode=self.bzrdir._get_file_mode())
 
2402
 
 
2403
    @needs_write_lock
 
2404
    def set_last_revision_info(self, revno, revision_id):
 
2405
        revision_id = _mod_revision.ensure_null(revision_id)
 
2406
        old_revno, old_revid = self.last_revision_info()
 
2407
        if self._get_append_revisions_only():
 
2408
            self._check_history_violation(revision_id)
 
2409
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2410
        self._write_last_revision_info(revno, revision_id)
 
2411
        self._clear_cached_state()
 
2412
        self._last_revision_info_cache = revno, revision_id
 
2413
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2414
 
 
2415
    def _synchronize_history(self, destination, revision_id):
 
2416
        """Synchronize last revision and revision history between branches.
 
2417
 
 
2418
        :see: Branch._synchronize_history
 
2419
        """
 
2420
        # XXX: The base Branch has a fast implementation of this method based
 
2421
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2422
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2423
        # but wants the fast implementation, so it calls
 
2424
        # Branch._synchronize_history directly.
 
2425
        Branch._synchronize_history(self, destination, revision_id)
2799
2426
 
2800
2427
    def _check_history_violation(self, revision_id):
2801
 
        current_revid = self.last_revision()
2802
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2428
        last_revision = _mod_revision.ensure_null(self.last_revision())
2803
2429
        if _mod_revision.is_null(last_revision):
2804
2430
            return
2805
 
        graph = self.repository.get_graph()
2806
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2807
 
            if lh_ancestor == current_revid:
2808
 
                return
2809
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2431
        if last_revision not in self._lefthand_history(revision_id):
 
2432
            raise errors.AppendRevisionsOnlyViolation(self.base)
2810
2433
 
2811
2434
    def _gen_revision_history(self):
2812
2435
        """Generate the revision history from last revision
2815
2438
        self._extend_partial_history(stop_index=last_revno-1)
2816
2439
        return list(reversed(self._partial_revision_history_cache))
2817
2440
 
 
2441
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2442
        """Extend the partial history to include a given index
 
2443
 
 
2444
        If a stop_index is supplied, stop when that index has been reached.
 
2445
        If a stop_revision is supplied, stop when that revision is
 
2446
        encountered.  Otherwise, stop when the beginning of history is
 
2447
        reached.
 
2448
 
 
2449
        :param stop_index: The index which should be present.  When it is
 
2450
            present, history extension will stop.
 
2451
        :param revision_id: The revision id which should be present.  When
 
2452
            it is encountered, history extension will stop.
 
2453
        """
 
2454
        repo = self.repository
 
2455
        if len(self._partial_revision_history_cache) == 0:
 
2456
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2457
        else:
 
2458
            start_revision = self._partial_revision_history_cache[-1]
 
2459
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2460
            #skip the last revision in the list
 
2461
            next_revision = iterator.next()
 
2462
        for revision_id in iterator:
 
2463
            self._partial_revision_history_cache.append(revision_id)
 
2464
            if (stop_index is not None and
 
2465
                len(self._partial_revision_history_cache) > stop_index):
 
2466
                break
 
2467
            if revision_id == stop_revision:
 
2468
                break
 
2469
 
 
2470
    def _write_revision_history(self, history):
 
2471
        """Factored out of set_revision_history.
 
2472
 
 
2473
        This performs the actual writing to disk, with format-specific checks.
 
2474
        It is intended to be called by BzrBranch5.set_revision_history.
 
2475
        """
 
2476
        if len(history) == 0:
 
2477
            last_revision = 'null:'
 
2478
        else:
 
2479
            if history != self._lefthand_history(history[-1]):
 
2480
                raise errors.NotLefthandHistory(history)
 
2481
            last_revision = history[-1]
 
2482
        if self._get_append_revisions_only():
 
2483
            self._check_history_violation(last_revision)
 
2484
        self._write_last_revision_info(len(history), last_revision)
 
2485
 
2818
2486
    @needs_write_lock
2819
2487
    def _set_parent_location(self, url):
2820
2488
        """Set the parent branch"""
2825
2493
        """Set the parent branch"""
2826
2494
        return self._get_config_location('parent_location')
2827
2495
 
2828
 
    @needs_write_lock
2829
 
    def _set_all_reference_info(self, info_dict):
2830
 
        """Replace all reference info stored in a branch.
2831
 
 
2832
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2833
 
        """
2834
 
        s = StringIO()
2835
 
        writer = rio.RioWriter(s)
2836
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2837
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2838
 
                                branch_location=branch_location)
2839
 
            writer.write_stanza(stanza)
2840
 
        self._transport.put_bytes('references', s.getvalue())
2841
 
        self._reference_info = info_dict
2842
 
 
2843
 
    @needs_read_lock
2844
 
    def _get_all_reference_info(self):
2845
 
        """Return all the reference info stored in a branch.
2846
 
 
2847
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2848
 
        """
2849
 
        if self._reference_info is not None:
2850
 
            return self._reference_info
2851
 
        rio_file = self._transport.get('references')
2852
 
        try:
2853
 
            stanzas = rio.read_stanzas(rio_file)
2854
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2855
 
                             s['branch_location'])) for s in stanzas)
2856
 
        finally:
2857
 
            rio_file.close()
2858
 
        self._reference_info = info_dict
2859
 
        return info_dict
2860
 
 
2861
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2862
 
        """Set the branch location to use for a tree reference.
2863
 
 
2864
 
        :param file_id: The file-id of the tree reference.
2865
 
        :param tree_path: The path of the tree reference in the tree.
2866
 
        :param branch_location: The location of the branch to retrieve tree
2867
 
            references from.
2868
 
        """
2869
 
        info_dict = self._get_all_reference_info()
2870
 
        info_dict[file_id] = (tree_path, branch_location)
2871
 
        if None in (tree_path, branch_location):
2872
 
            if tree_path is not None:
2873
 
                raise ValueError('tree_path must be None when branch_location'
2874
 
                                 ' is None.')
2875
 
            if branch_location is not None:
2876
 
                raise ValueError('branch_location must be None when tree_path'
2877
 
                                 ' is None.')
2878
 
            del info_dict[file_id]
2879
 
        self._set_all_reference_info(info_dict)
2880
 
 
2881
 
    def get_reference_info(self, file_id):
2882
 
        """Get the tree_path and branch_location for a tree reference.
2883
 
 
2884
 
        :return: a tuple of (tree_path, branch_location)
2885
 
        """
2886
 
        return self._get_all_reference_info().get(file_id, (None, None))
2887
 
 
2888
 
    def reference_parent(self, file_id, path, possible_transports=None):
2889
 
        """Return the parent branch for a tree-reference file_id.
2890
 
 
2891
 
        :param file_id: The file_id of the tree reference
2892
 
        :param path: The path of the file_id in the tree
2893
 
        :return: A branch associated with the file_id
2894
 
        """
2895
 
        branch_location = self.get_reference_info(file_id)[1]
2896
 
        if branch_location is None:
2897
 
            return Branch.reference_parent(self, file_id, path,
2898
 
                                           possible_transports)
2899
 
        branch_location = urlutils.join(self.user_url, branch_location)
2900
 
        return Branch.open(branch_location,
2901
 
                           possible_transports=possible_transports)
2902
 
 
2903
2496
    def set_push_location(self, location):
2904
2497
        """See Branch.set_push_location."""
2905
2498
        self._set_config_location('push_location', location)
2906
2499
 
2907
2500
    def set_bound_location(self, location):
2908
2501
        """See Branch.set_push_location."""
2909
 
        self._master_branch_cache = None
2910
2502
        result = None
2911
2503
        config = self.get_config()
2912
2504
        if location is None:
2943
2535
        # you can always ask for the URL; but you might not be able to use it
2944
2536
        # if the repo can't support stacking.
2945
2537
        ## self._check_stackable_repo()
2946
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2947
 
        # waste effort reading the whole stack of config files.
2948
 
        config = self.get_config()._get_branch_data_config()
2949
 
        stacked_url = self._get_config_location('stacked_on_location',
2950
 
            config=config)
 
2538
        stacked_url = self._get_config_location('stacked_on_location')
2951
2539
        if stacked_url is None:
2952
2540
            raise errors.NotStacked(self)
2953
2541
        return stacked_url
2954
2542
 
 
2543
    def set_append_revisions_only(self, enabled):
 
2544
        if enabled:
 
2545
            value = 'True'
 
2546
        else:
 
2547
            value = 'False'
 
2548
        self.get_config().set_user_option('append_revisions_only', value,
 
2549
            warn_masked=True)
 
2550
 
2955
2551
    def _get_append_revisions_only(self):
2956
 
        return self.get_config(
2957
 
            ).get_user_option_as_bool('append_revisions_only')
 
2552
        value = self.get_config().get_user_option('append_revisions_only')
 
2553
        return value == 'True'
 
2554
 
 
2555
    @needs_write_lock
 
2556
    def generate_revision_history(self, revision_id, last_rev=None,
 
2557
                                  other_branch=None):
 
2558
        """See BzrBranch5.generate_revision_history"""
 
2559
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2560
        revno = len(history)
 
2561
        self.set_last_revision_info(revno, revision_id)
2958
2562
 
2959
2563
    @needs_read_lock
2960
2564
    def get_rev_id(self, revno, history=None):
2985
2589
        try:
2986
2590
            index = self._partial_revision_history_cache.index(revision_id)
2987
2591
        except ValueError:
2988
 
            try:
2989
 
                self._extend_partial_history(stop_revision=revision_id)
2990
 
            except errors.RevisionNotPresent, e:
2991
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2592
            self._extend_partial_history(stop_revision=revision_id)
2992
2593
            index = len(self._partial_revision_history_cache) - 1
2993
2594
            if self._partial_revision_history_cache[index] != revision_id:
2994
2595
                raise errors.NoSuchRevision(self, revision_id)
2995
2596
        return self.revno() - index
2996
2597
 
2997
2598
 
2998
 
class BzrBranch7(BzrBranch8):
2999
 
    """A branch with support for a fallback repository."""
3000
 
 
3001
 
    def set_reference_info(self, file_id, tree_path, branch_location):
3002
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
3003
 
 
3004
 
    def get_reference_info(self, file_id):
3005
 
        Branch.get_reference_info(self, file_id)
3006
 
 
3007
 
    def reference_parent(self, file_id, path, possible_transports=None):
3008
 
        return Branch.reference_parent(self, file_id, path,
3009
 
                                       possible_transports)
3010
 
 
3011
 
 
3012
2599
class BzrBranch6(BzrBranch7):
3013
2600
    """See BzrBranchFormat6 for the capabilities of this branch.
3014
2601
 
3017
2604
    """
3018
2605
 
3019
2606
    def get_stacked_on_url(self):
3020
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2607
        raise errors.UnstackableBranchFormat(self._format, self.base)
3021
2608
 
3022
2609
 
3023
2610
######################################################################
3049
2636
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3050
2637
    """
3051
2638
 
3052
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3053
2639
    def __int__(self):
3054
 
        """Return the relative change in revno.
3055
 
 
3056
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3057
 
        """
 
2640
        # DEPRECATED: pull used to return the change in revno
3058
2641
        return self.new_revno - self.old_revno
3059
2642
 
3060
2643
    def report(self, to_file):
3085
2668
        target, otherwise it will be None.
3086
2669
    """
3087
2670
 
3088
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3089
2671
    def __int__(self):
3090
 
        """Return the relative change in revno.
3091
 
 
3092
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3093
 
        """
 
2672
        # DEPRECATED: push used to return the change in revno
3094
2673
        return self.new_revno - self.old_revno
3095
2674
 
3096
2675
    def report(self, to_file):
3110
2689
 
3111
2690
    def __init__(self, branch):
3112
2691
        self.branch = branch
3113
 
        self.errors = []
3114
2692
 
3115
2693
    def report_results(self, verbose):
3116
2694
        """Report the check results via trace.note.
3118
2696
        :param verbose: Requests more detailed display of what was checked,
3119
2697
            if any.
3120
2698
        """
3121
 
        note('checked branch %s format %s', self.branch.user_url,
3122
 
            self.branch._format)
3123
 
        for error in self.errors:
3124
 
            note('found error:%s', error)
 
2699
        note('checked branch %s format %s',
 
2700
             self.branch.base,
 
2701
             self.branch._format)
3125
2702
 
3126
2703
 
3127
2704
class Converter5to6(object):
3165
2742
        branch._transport.put_bytes('format', format.get_format_string())
3166
2743
 
3167
2744
 
3168
 
class Converter7to8(object):
3169
 
    """Perform an in-place upgrade of format 7 to format 8"""
3170
 
 
3171
 
    def convert(self, branch):
3172
 
        format = BzrBranchFormat8()
3173
 
        branch._transport.put_bytes('references', '')
3174
 
        # update target format
3175
 
        branch._transport.put_bytes('format', format.get_format_string())
 
2745
 
 
2746
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2747
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2748
    duration.
 
2749
 
 
2750
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2751
 
 
2752
    If an exception is raised by callable, then that exception *will* be
 
2753
    propagated, even if the unlock attempt raises its own error.  Thus
 
2754
    _run_with_write_locked_target should be preferred to simply doing::
 
2755
 
 
2756
        target.lock_write()
 
2757
        try:
 
2758
            return callable(*args, **kwargs)
 
2759
        finally:
 
2760
            target.unlock()
 
2761
 
 
2762
    """
 
2763
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2764
    # should share code?
 
2765
    target.lock_write()
 
2766
    try:
 
2767
        result = callable(*args, **kwargs)
 
2768
    except:
 
2769
        exc_info = sys.exc_info()
 
2770
        try:
 
2771
            target.unlock()
 
2772
        finally:
 
2773
            raise exc_info[0], exc_info[1], exc_info[2]
 
2774
    else:
 
2775
        target.unlock()
 
2776
        return result
3176
2777
 
3177
2778
 
3178
2779
class InterBranch(InterObject):
3186
2787
    _optimisers = []
3187
2788
    """The available optimised InterBranch types."""
3188
2789
 
3189
 
    @classmethod
3190
 
    def _get_branch_formats_to_test(klass):
3191
 
        """Return an iterable of format tuples for testing.
3192
 
        
3193
 
        :return: An iterable of (from_format, to_format) to use when testing
3194
 
            this InterBranch class. Each InterBranch class should define this
3195
 
            method itself.
3196
 
        """
3197
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
3198
 
 
3199
 
    @needs_write_lock
3200
 
    def pull(self, overwrite=False, stop_revision=None,
3201
 
             possible_transports=None, local=False):
3202
 
        """Mirror source into target branch.
3203
 
 
3204
 
        The target branch is considered to be 'local', having low latency.
3205
 
 
3206
 
        :returns: PullResult instance
3207
 
        """
3208
 
        raise NotImplementedError(self.pull)
3209
 
 
3210
 
    @needs_write_lock
3211
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3212
 
             _override_hook_source_branch=None):
3213
 
        """Mirror the source branch into the target branch.
3214
 
 
3215
 
        The source branch is considered to be 'local', having low latency.
3216
 
        """
3217
 
        raise NotImplementedError(self.push)
3218
 
 
3219
 
    @needs_write_lock
3220
 
    def copy_content_into(self, revision_id=None):
3221
 
        """Copy the content of source into target
3222
 
 
3223
 
        revision_id: if not None, the revision history in the new branch will
3224
 
                     be truncated to end with revision_id.
3225
 
        """
3226
 
        raise NotImplementedError(self.copy_content_into)
3227
 
 
3228
 
    @needs_write_lock
3229
 
    def fetch(self, stop_revision=None, limit=None):
3230
 
        """Fetch revisions.
3231
 
 
3232
 
        :param stop_revision: Last revision to fetch
3233
 
        :param limit: Optional rough limit of revisions to fetch
3234
 
        """
3235
 
        raise NotImplementedError(self.fetch)
 
2790
    @staticmethod
 
2791
    def _get_branch_formats_to_test():
 
2792
        """Return a tuple with the Branch formats to use when testing."""
 
2793
        raise NotImplementedError(self._get_branch_formats_to_test)
 
2794
 
 
2795
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2796
                         graph=None):
 
2797
        """Pull in new perfect-fit revisions.
 
2798
 
 
2799
        :param stop_revision: Updated until the given revision
 
2800
        :param overwrite: Always set the branch pointer, rather than checking
 
2801
            to see if it is a proper descendant.
 
2802
        :param graph: A Graph object that can be used to query history
 
2803
            information. This can be None.
 
2804
        :return: None
 
2805
        """
 
2806
        raise NotImplementedError(self.update_revisions)
3236
2807
 
3237
2808
 
3238
2809
class GenericInterBranch(InterBranch):
3239
 
    """InterBranch implementation that uses public Branch functions."""
 
2810
    """InterBranch implementation that uses public Branch functions.
 
2811
    """
 
2812
 
 
2813
    @staticmethod
 
2814
    def _get_branch_formats_to_test():
 
2815
        return BranchFormat._default_format, BranchFormat._default_format
 
2816
 
 
2817
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2818
        graph=None):
 
2819
        """See InterBranch.update_revisions()."""
 
2820
        self.source.lock_read()
 
2821
        try:
 
2822
            other_revno, other_last_revision = self.source.last_revision_info()
 
2823
            stop_revno = None # unknown
 
2824
            if stop_revision is None:
 
2825
                stop_revision = other_last_revision
 
2826
                if _mod_revision.is_null(stop_revision):
 
2827
                    # if there are no commits, we're done.
 
2828
                    return
 
2829
                stop_revno = other_revno
 
2830
 
 
2831
            # what's the current last revision, before we fetch [and change it
 
2832
            # possibly]
 
2833
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2834
            # we fetch here so that we don't process data twice in the common
 
2835
            # case of having something to pull, and so that the check for
 
2836
            # already merged can operate on the just fetched graph, which will
 
2837
            # be cached in memory.
 
2838
            self.target.fetch(self.source, stop_revision)
 
2839
            # Check to see if one is an ancestor of the other
 
2840
            if not overwrite:
 
2841
                if graph is None:
 
2842
                    graph = self.target.repository.get_graph()
 
2843
                if self.target._check_if_descendant_or_diverged(
 
2844
                        stop_revision, last_rev, graph, self.source):
 
2845
                    # stop_revision is a descendant of last_rev, but we aren't
 
2846
                    # overwriting, so we're done.
 
2847
                    return
 
2848
            if stop_revno is None:
 
2849
                if graph is None:
 
2850
                    graph = self.target.repository.get_graph()
 
2851
                this_revno, this_last_revision = \
 
2852
                        self.target.last_revision_info()
 
2853
                stop_revno = graph.find_distance_to_null(stop_revision,
 
2854
                                [(other_last_revision, other_revno),
 
2855
                                 (this_last_revision, this_revno)])
 
2856
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
2857
        finally:
 
2858
            self.source.unlock()
3240
2859
 
3241
2860
    @classmethod
3242
 
    def is_compatible(klass, source, target):
 
2861
    def is_compatible(self, source, target):
3243
2862
        # GenericBranch uses the public API, so always compatible
3244
2863
        return True
3245
2864
 
3246
 
    @classmethod
3247
 
    def _get_branch_formats_to_test(klass):
3248
 
        return [(format_registry.get_default(), format_registry.get_default())]
3249
 
 
3250
 
    @classmethod
3251
 
    def unwrap_format(klass, format):
3252
 
        if isinstance(format, remote.RemoteBranchFormat):
3253
 
            format._ensure_real()
3254
 
            return format._custom_format
3255
 
        return format
3256
 
 
3257
 
    @needs_write_lock
3258
 
    def copy_content_into(self, revision_id=None):
3259
 
        """Copy the content of source into target
3260
 
 
3261
 
        revision_id: if not None, the revision history in the new branch will
3262
 
                     be truncated to end with revision_id.
3263
 
        """
3264
 
        self.source.update_references(self.target)
3265
 
        self.source._synchronize_history(self.target, revision_id)
3266
 
        try:
3267
 
            parent = self.source.get_parent()
3268
 
        except errors.InaccessibleParent, e:
3269
 
            mutter('parent was not accessible to copy: %s', e)
3270
 
        else:
3271
 
            if parent:
3272
 
                self.target.set_parent(parent)
3273
 
        if self.source._push_should_merge_tags():
3274
 
            self.source.tags.merge_to(self.target.tags)
3275
 
 
3276
 
    @needs_write_lock
3277
 
    def fetch(self, stop_revision=None, limit=None):
3278
 
        if self.target.base == self.source.base:
3279
 
            return (0, [])
3280
 
        self.source.lock_read()
3281
 
        try:
3282
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3283
 
            fetch_spec_factory.source_branch = self.source
3284
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3285
 
            fetch_spec_factory.source_repo = self.source.repository
3286
 
            fetch_spec_factory.target_repo = self.target.repository
3287
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3288
 
            fetch_spec_factory.limit = limit
3289
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3290
 
            return self.target.repository.fetch(self.source.repository,
3291
 
                fetch_spec=fetch_spec)
3292
 
        finally:
3293
 
            self.source.unlock()
3294
 
 
3295
 
    @needs_write_lock
3296
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3297
 
            graph=None):
3298
 
        other_revno, other_last_revision = self.source.last_revision_info()
3299
 
        stop_revno = None # unknown
3300
 
        if stop_revision is None:
3301
 
            stop_revision = other_last_revision
3302
 
            if _mod_revision.is_null(stop_revision):
3303
 
                # if there are no commits, we're done.
3304
 
                return
3305
 
            stop_revno = other_revno
3306
 
 
3307
 
        # what's the current last revision, before we fetch [and change it
3308
 
        # possibly]
3309
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3310
 
        # we fetch here so that we don't process data twice in the common
3311
 
        # case of having something to pull, and so that the check for
3312
 
        # already merged can operate on the just fetched graph, which will
3313
 
        # be cached in memory.
3314
 
        self.fetch(stop_revision=stop_revision)
3315
 
        # Check to see if one is an ancestor of the other
3316
 
        if not overwrite:
3317
 
            if graph is None:
3318
 
                graph = self.target.repository.get_graph()
3319
 
            if self.target._check_if_descendant_or_diverged(
3320
 
                    stop_revision, last_rev, graph, self.source):
3321
 
                # stop_revision is a descendant of last_rev, but we aren't
3322
 
                # overwriting, so we're done.
3323
 
                return
3324
 
        if stop_revno is None:
3325
 
            if graph is None:
3326
 
                graph = self.target.repository.get_graph()
3327
 
            this_revno, this_last_revision = \
3328
 
                    self.target.last_revision_info()
3329
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3330
 
                            [(other_last_revision, other_revno),
3331
 
                             (this_last_revision, this_revno)])
3332
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3333
 
 
3334
 
    @needs_write_lock
3335
 
    def pull(self, overwrite=False, stop_revision=None,
3336
 
             possible_transports=None, run_hooks=True,
3337
 
             _override_hook_target=None, local=False):
3338
 
        """Pull from source into self, updating my master if any.
3339
 
 
3340
 
        :param run_hooks: Private parameter - if false, this branch
3341
 
            is being called because it's the master of the primary branch,
3342
 
            so it should not run its hooks.
3343
 
        """
3344
 
        bound_location = self.target.get_bound_location()
3345
 
        if local and not bound_location:
3346
 
            raise errors.LocalRequiresBoundBranch()
3347
 
        master_branch = None
3348
 
        source_is_master = False
3349
 
        if bound_location:
3350
 
            # bound_location comes from a config file, some care has to be
3351
 
            # taken to relate it to source.user_url
3352
 
            normalized = urlutils.normalize_url(bound_location)
3353
 
            try:
3354
 
                relpath = self.source.user_transport.relpath(normalized)
3355
 
                source_is_master = (relpath == '')
3356
 
            except (errors.PathNotChild, errors.InvalidURL):
3357
 
                source_is_master = False
3358
 
        if not local and bound_location and not source_is_master:
3359
 
            # not pulling from master, so we need to update master.
3360
 
            master_branch = self.target.get_master_branch(possible_transports)
3361
 
            master_branch.lock_write()
3362
 
        try:
3363
 
            if master_branch:
3364
 
                # pull from source into master.
3365
 
                master_branch.pull(self.source, overwrite, stop_revision,
3366
 
                    run_hooks=False)
3367
 
            return self._pull(overwrite,
3368
 
                stop_revision, _hook_master=master_branch,
3369
 
                run_hooks=run_hooks,
3370
 
                _override_hook_target=_override_hook_target,
3371
 
                merge_tags_to_master=not source_is_master)
3372
 
        finally:
3373
 
            if master_branch:
3374
 
                master_branch.unlock()
3375
 
 
3376
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3377
 
             _override_hook_source_branch=None):
3378
 
        """See InterBranch.push.
3379
 
 
3380
 
        This is the basic concrete implementation of push()
3381
 
 
3382
 
        :param _override_hook_source_branch: If specified, run the hooks
3383
 
            passing this Branch as the source, rather than self.  This is for
3384
 
            use of RemoteBranch, where push is delegated to the underlying
3385
 
            vfs-based Branch.
3386
 
        """
3387
 
        if lossy:
3388
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3389
 
        # TODO: Public option to disable running hooks - should be trivial but
3390
 
        # needs tests.
3391
 
 
3392
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3393
 
        op.add_cleanup(self.source.lock_read().unlock)
3394
 
        op.add_cleanup(self.target.lock_write().unlock)
3395
 
        return op.run(overwrite, stop_revision,
3396
 
            _override_hook_source_branch=_override_hook_source_branch)
3397
 
 
3398
 
    def _basic_push(self, overwrite, stop_revision):
3399
 
        """Basic implementation of push without bound branches or hooks.
3400
 
 
3401
 
        Must be called with source read locked and target write locked.
3402
 
        """
3403
 
        result = BranchPushResult()
3404
 
        result.source_branch = self.source
3405
 
        result.target_branch = self.target
3406
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3407
 
        self.source.update_references(self.target)
3408
 
        if result.old_revid != stop_revision:
3409
 
            # We assume that during 'push' this repository is closer than
3410
 
            # the target.
3411
 
            graph = self.source.repository.get_graph(self.target.repository)
3412
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3413
 
                    graph=graph)
3414
 
        if self.source._push_should_merge_tags():
3415
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3416
 
                overwrite)
3417
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3418
 
        return result
3419
 
 
3420
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3421
 
            _override_hook_source_branch=None):
3422
 
        """Push from source into target, and into target's master if any.
3423
 
        """
3424
 
        def _run_hooks():
3425
 
            if _override_hook_source_branch:
3426
 
                result.source_branch = _override_hook_source_branch
3427
 
            for hook in Branch.hooks['post_push']:
3428
 
                hook(result)
3429
 
 
3430
 
        bound_location = self.target.get_bound_location()
3431
 
        if bound_location and self.target.base != bound_location:
3432
 
            # there is a master branch.
3433
 
            #
3434
 
            # XXX: Why the second check?  Is it even supported for a branch to
3435
 
            # be bound to itself? -- mbp 20070507
3436
 
            master_branch = self.target.get_master_branch()
3437
 
            master_branch.lock_write()
3438
 
            operation.add_cleanup(master_branch.unlock)
3439
 
            # push into the master from the source branch.
3440
 
            master_inter = InterBranch.get(self.source, master_branch)
3441
 
            master_inter._basic_push(overwrite, stop_revision)
3442
 
            # and push into the target branch from the source. Note that
3443
 
            # we push from the source branch again, because it's considered
3444
 
            # the highest bandwidth repository.
3445
 
            result = self._basic_push(overwrite, stop_revision)
3446
 
            result.master_branch = master_branch
3447
 
            result.local_branch = self.target
3448
 
        else:
3449
 
            master_branch = None
3450
 
            # no master branch
3451
 
            result = self._basic_push(overwrite, stop_revision)
3452
 
            # TODO: Why set master_branch and local_branch if there's no
3453
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3454
 
            # 20070504
3455
 
            result.master_branch = self.target
3456
 
            result.local_branch = None
3457
 
        _run_hooks()
3458
 
        return result
3459
 
 
3460
 
    def _pull(self, overwrite=False, stop_revision=None,
3461
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3462
 
             _override_hook_target=None, local=False,
3463
 
             merge_tags_to_master=True):
3464
 
        """See Branch.pull.
3465
 
 
3466
 
        This function is the core worker, used by GenericInterBranch.pull to
3467
 
        avoid duplication when pulling source->master and source->local.
3468
 
 
3469
 
        :param _hook_master: Private parameter - set the branch to
3470
 
            be supplied as the master to pull hooks.
3471
 
        :param run_hooks: Private parameter - if false, this branch
3472
 
            is being called because it's the master of the primary branch,
3473
 
            so it should not run its hooks.
3474
 
            is being called because it's the master of the primary branch,
3475
 
            so it should not run its hooks.
3476
 
        :param _override_hook_target: Private parameter - set the branch to be
3477
 
            supplied as the target_branch to pull hooks.
3478
 
        :param local: Only update the local branch, and not the bound branch.
3479
 
        """
3480
 
        # This type of branch can't be bound.
3481
 
        if local:
3482
 
            raise errors.LocalRequiresBoundBranch()
3483
 
        result = PullResult()
3484
 
        result.source_branch = self.source
3485
 
        if _override_hook_target is None:
3486
 
            result.target_branch = self.target
3487
 
        else:
3488
 
            result.target_branch = _override_hook_target
3489
 
        self.source.lock_read()
3490
 
        try:
3491
 
            # We assume that during 'pull' the target repository is closer than
3492
 
            # the source one.
3493
 
            self.source.update_references(self.target)
3494
 
            graph = self.target.repository.get_graph(self.source.repository)
3495
 
            # TODO: Branch formats should have a flag that indicates 
3496
 
            # that revno's are expensive, and pull() should honor that flag.
3497
 
            # -- JRV20090506
3498
 
            result.old_revno, result.old_revid = \
3499
 
                self.target.last_revision_info()
3500
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3501
 
                graph=graph)
3502
 
            # TODO: The old revid should be specified when merging tags, 
3503
 
            # so a tags implementation that versions tags can only 
3504
 
            # pull in the most recent changes. -- JRV20090506
3505
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3506
 
                overwrite, ignore_master=not merge_tags_to_master)
3507
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3508
 
            if _hook_master:
3509
 
                result.master_branch = _hook_master
3510
 
                result.local_branch = result.target_branch
3511
 
            else:
3512
 
                result.master_branch = result.target_branch
3513
 
                result.local_branch = None
3514
 
            if run_hooks:
3515
 
                for hook in Branch.hooks['post_pull']:
3516
 
                    hook(result)
3517
 
        finally:
3518
 
            self.source.unlock()
3519
 
        return result
3520
 
 
3521
2865
 
3522
2866
InterBranch.register_optimiser(GenericInterBranch)