/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Frank Aspell
  • Date: 2009-02-22 16:54:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: frankaspell@googlemail.com-20090222165402-2myrucnu7er5w4ha
Fixing various typos

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
42
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
40
from bzrlib.tag import (
44
41
    BasicTags,
46
43
    )
47
44
""")
48
45
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
51
 
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
 
from bzrlib import registry
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
54
48
from bzrlib.symbol_versioning import (
55
49
    deprecated_in,
56
50
    deprecated_method,
63
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
58
 
65
59
 
66
 
class Branch(bzrdir.ControlComponent):
 
60
# TODO: Maybe include checks for common corruption of newlines, etc?
 
61
 
 
62
# TODO: Some operations like log might retrieve the same revisions
 
63
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
64
# cache in memory to make this faster.  In general anything can be
 
65
# cached in memory between lock and unlock operations. .. nb thats
 
66
# what the transaction identity map provides
 
67
 
 
68
 
 
69
######################################################################
 
70
# branch objects
 
71
 
 
72
class Branch(object):
67
73
    """Branch holding a history of revisions.
68
74
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
75
    base
 
76
        Base directory/url of the branch.
72
77
 
73
78
    hooks: An instance of BranchHooks.
74
79
    """
76
81
    # - RBC 20060112
77
82
    base = None
78
83
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
 
84
    # override this to set the strategy for storing tags
 
85
    def _make_tags(self):
 
86
        return DisabledTags(self)
86
87
 
87
88
    def __init__(self, *ignored, **ignored_too):
88
 
        self.tags = self._format.make_tags(self)
 
89
        self.tags = self._make_tags()
89
90
        self._revision_history_cache = None
90
91
        self._revision_id_to_revno_cache = None
91
92
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
93
        self._last_revision_info_cache = None
94
94
        self._merge_sorted_revisions_cache = None
95
95
        self._open_hook()
100
100
    def _open_hook(self):
101
101
        """Called by init to allow simpler extension of the base class."""
102
102
 
103
 
    def _activate_fallback_location(self, url):
104
 
        """Activate the branch/repository from url as a fallback repository."""
105
 
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
 
        self.repository.add_fallback_repository(repo)
109
 
 
110
103
    def break_lock(self):
111
104
        """Break a lock if one is present from another instance.
112
105
 
121
114
        if master is not None:
122
115
            master.break_lock()
123
116
 
124
 
    def _check_stackable_repo(self):
125
 
        if not self.repository._format.supports_external_lookups:
126
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
 
                self.repository.base)
128
 
 
129
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
 
        """Extend the partial history to include a given index
131
 
 
132
 
        If a stop_index is supplied, stop when that index has been reached.
133
 
        If a stop_revision is supplied, stop when that revision is
134
 
        encountered.  Otherwise, stop when the beginning of history is
135
 
        reached.
136
 
 
137
 
        :param stop_index: The index which should be present.  When it is
138
 
            present, history extension will stop.
139
 
        :param stop_revision: The revision id which should be present.  When
140
 
            it is encountered, history extension will stop.
141
 
        """
142
 
        if len(self._partial_revision_history_cache) == 0:
143
 
            self._partial_revision_history_cache = [self.last_revision()]
144
 
        repository._iter_for_revno(
145
 
            self.repository, self._partial_revision_history_cache,
146
 
            stop_index=stop_index, stop_revision=stop_revision)
147
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
 
            self._partial_revision_history_cache.pop()
149
 
 
150
 
    def _get_check_refs(self):
151
 
        """Get the references needed for check().
152
 
 
153
 
        See bzrlib.check.
154
 
        """
155
 
        revid = self.last_revision()
156
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
157
 
 
158
117
    @staticmethod
159
118
    def open(base, _unsupported=False, possible_transports=None):
160
119
        """Open the branch rooted at base.
164
123
        """
165
124
        control = bzrdir.BzrDir.open(base, _unsupported,
166
125
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
126
        return control.open_branch(_unsupported)
168
127
 
169
128
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
129
    def open_from_transport(transport, _unsupported=False):
171
130
        """Open the branch rooted at transport"""
172
131
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
132
        return control.open_branch(_unsupported)
174
133
 
175
134
    @staticmethod
176
135
    def open_containing(url, possible_transports=None):
177
136
        """Open an existing branch which contains url.
178
 
 
 
137
        
179
138
        This probes for a branch at url, and searches upwards from there.
180
139
 
181
140
        Basically we keep looking up until we find the control directory or
182
141
        run into the root.  If there isn't one, raises NotBranchError.
183
 
        If there is one and it is either an unrecognised format or an unsupported
 
142
        If there is one and it is either an unrecognised format or an unsupported 
184
143
        format, UnknownFormatError or UnsupportedFormatError are raised.
185
144
        If there is one, it is returned, along with the unused portion of url.
186
145
        """
188
147
                                                         possible_transports)
189
148
        return control.open_branch(), relpath
190
149
 
191
 
    def _push_should_merge_tags(self):
192
 
        """Should _basic_push merge this branch's tags into the target?
193
 
 
194
 
        The default implementation returns False if this branch has no tags,
195
 
        and True the rest of the time.  Subclasses may override this.
196
 
        """
197
 
        return self.supports_tags() and self.tags.get_tag_dict()
198
 
 
199
150
    def get_config(self):
200
151
        return BranchConfig(self)
201
152
 
202
 
    def _get_config(self):
203
 
        """Get the concrete config for just the config in this branch.
204
 
 
205
 
        This is not intended for client use; see Branch.get_config for the
206
 
        public API.
207
 
 
208
 
        Added in 1.14.
209
 
 
210
 
        :return: An object supporting get_option and set_option.
211
 
        """
212
 
        raise NotImplementedError(self._get_config)
213
 
 
214
 
    def _get_fallback_repository(self, url):
215
 
        """Get the repository we fallback to at url."""
216
 
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
220
 
 
221
 
    def _get_tags_bytes(self):
222
 
        """Get the bytes of a serialised tags dict.
223
 
 
224
 
        Note that not all branches support tags, nor do all use the same tags
225
 
        logic: this method is specific to BasicTags. Other tag implementations
226
 
        may use the same method name and behave differently, safely, because
227
 
        of the double-dispatch via
228
 
        format.make_tags->tags_instance->get_tags_dict.
229
 
 
230
 
        :return: The bytes of the tags file.
231
 
        :seealso: Branch._set_tags_bytes.
232
 
        """
233
 
        return self._transport.get_bytes('tags')
234
 
 
235
153
    def _get_nick(self, local=False, possible_transports=None):
236
154
        config = self.get_config()
237
155
        # explicit overrides master, but don't look for master if local is True
283
201
        new_history.reverse()
284
202
        return new_history
285
203
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
204
    def lock_write(self):
293
205
        raise NotImplementedError(self.lock_write)
294
206
 
295
207
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
208
        raise NotImplementedError(self.lock_read)
302
209
 
303
210
    def unlock(self):
348
255
    @needs_read_lock
349
256
    def revision_id_to_dotted_revno(self, revision_id):
350
257
        """Given a revision id, return its dotted revno.
351
 
 
 
258
        
352
259
        :return: a tuple like (1,) or (400,1,3).
353
260
        """
354
261
        return self._do_revision_id_to_dotted_revno(revision_id)
428
335
            * 'include' - the stop revision is the last item in the result
429
336
            * 'with-merges' - include the stop revision and all of its
430
337
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
338
        :param direction: either 'reverse' or 'forward':
434
339
            * reverse means return the start_revision_id first, i.e.
435
340
              start at the most recent revision and go backwards in history
457
362
        # start_revision_id.
458
363
        if self._merge_sorted_revisions_cache is None:
459
364
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
365
            graph = self.repository.get_graph()
 
366
            parent_map = dict(((key, value) for key, value in
 
367
                     graph.iter_ancestry([last_revision]) if value is not None))
 
368
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
369
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
370
                generate_revno=True)
 
371
            # Drop the sequence # before caching
 
372
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
373
 
464
374
        filtered = self._filter_merge_sorted_revisions(
465
375
            self._merge_sorted_revisions_cache, start_revision_id,
466
376
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
377
        if direction == 'reverse':
471
378
            return filtered
472
379
        if direction == 'forward':
479
386
        """Iterate over an inclusive range of sorted revisions."""
480
387
        rev_iter = iter(merge_sorted_revisions)
481
388
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
389
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
390
                if rev_id != start_revision_id:
485
391
                    continue
486
392
                else:
487
393
                    # The decision to include the start or not
488
394
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
395
                    rev_iter = chain(
 
396
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
397
                        rev_iter)
491
398
                    break
492
399
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
400
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
401
                yield rev_id, depth, revno, end_of_merge
498
402
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
403
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
404
                if rev_id == stop_revision_id:
502
405
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
406
                yield rev_id, depth, revno, end_of_merge
505
407
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       node.end_of_merge)
 
408
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
409
                yield rev_id, depth, revno, end_of_merge
510
410
                if rev_id == stop_revision_id:
511
411
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
412
        elif stop_rule == 'with-merges':
525
413
            stop_rev = self.repository.get_revision(stop_revision_id)
526
414
            if stop_rev.parent_ids:
527
415
                left_parent = stop_rev.parent_ids[0]
528
416
            else:
529
417
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
418
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
419
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
420
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
421
                yield rev_id, depth, revno, end_of_merge
549
422
        else:
550
423
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
424
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
425
    def leave_lock_in_place(self):
598
426
        """Tell this branch object not to release the physical lock when this
599
427
        object is unlocked.
600
 
 
 
428
        
601
429
        If lock_write doesn't return a token, then this method is not supported.
602
430
        """
603
431
        self.control_files.leave_in_place()
616
444
        :param other: The branch to bind to
617
445
        :type other: Branch
618
446
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
620
 
 
621
 
    def set_append_revisions_only(self, enabled):
622
 
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
624
 
        if enabled:
625
 
            value = 'True'
626
 
        else:
627
 
            value = 'False'
628
 
        self.get_config().set_user_option('append_revisions_only', value,
629
 
            warn_masked=True)
630
 
 
631
 
    def set_reference_info(self, file_id, tree_path, branch_location):
632
 
        """Set the branch location to use for a tree reference."""
633
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
634
 
 
635
 
    def get_reference_info(self, file_id):
636
 
        """Get the tree_path and branch_location for a tree reference."""
637
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
447
        raise errors.UpgradeRequired(self.base)
638
448
 
639
449
    @needs_write_lock
640
450
    def fetch(self, from_branch, last_revision=None, pb=None):
644
454
        :param last_revision: What revision to stop at (None for at the end
645
455
                              of the branch.
646
456
        :param pb: An optional progress bar to use.
647
 
        :return: None
 
457
 
 
458
        Returns the copied revision count and the failed revisions in a tuple:
 
459
        (copied, failures).
648
460
        """
649
461
        if self.base == from_branch.base:
650
462
            return (0, [])
651
 
        if pb is not None:
652
 
            symbol_versioning.warn(
653
 
                symbol_versioning.deprecated_in((1, 14, 0))
654
 
                % "pb parameter to fetch()")
 
463
        if pb is None:
 
464
            nested_pb = ui.ui_factory.nested_progress_bar()
 
465
            pb = nested_pb
 
466
        else:
 
467
            nested_pb = None
 
468
 
655
469
        from_branch.lock_read()
656
470
        try:
657
471
            if last_revision is None:
 
472
                pb.update('get source history')
658
473
                last_revision = from_branch.last_revision()
659
474
                last_revision = _mod_revision.ensure_null(last_revision)
660
475
            return self.repository.fetch(from_branch.repository,
661
476
                                         revision_id=last_revision,
662
 
                                         pb=pb)
 
477
                                         pb=nested_pb)
663
478
        finally:
 
479
            if nested_pb is not None:
 
480
                nested_pb.finished()
664
481
            from_branch.unlock()
665
482
 
666
483
    def get_bound_location(self):
670
487
        branch.
671
488
        """
672
489
        return None
673
 
 
 
490
    
674
491
    def get_old_bound_location(self):
675
492
        """Return the URL of the branch we used to be bound to
676
493
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
494
        raise errors.UpgradeRequired(self.base)
678
495
 
679
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
 
                           timezone=None, committer=None, revprops=None,
 
496
    def get_commit_builder(self, parents, config=None, timestamp=None, 
 
497
                           timezone=None, committer=None, revprops=None, 
681
498
                           revision_id=None):
682
499
        """Obtain a CommitBuilder for this branch.
683
 
 
 
500
        
684
501
        :param parents: Revision ids of the parents of the new revision.
685
502
        :param config: Optional configuration to use.
686
503
        :param timestamp: Optional timestamp recorded for commit.
692
509
 
693
510
        if config is None:
694
511
            config = self.get_config()
695
 
 
 
512
        
696
513
        return self.repository.get_commit_builder(self, parents, config,
697
514
            timestamp, timezone, committer, revprops, revision_id)
698
515
 
699
516
    def get_master_branch(self, possible_transports=None):
700
517
        """Return the branch we are bound to.
701
 
 
 
518
        
702
519
        :return: Either a Branch, or None
703
520
        """
704
521
        return None
730
547
    def set_revision_history(self, rev_history):
731
548
        raise NotImplementedError(self.set_revision_history)
732
549
 
733
 
    @needs_write_lock
734
 
    def set_parent(self, url):
735
 
        """See Branch.set_parent."""
736
 
        # TODO: Maybe delete old location files?
737
 
        # URLs should never be unicode, even on the local fs,
738
 
        # FIXUP this and get_parent in a future branch format bump:
739
 
        # read and rewrite the file. RBC 20060125
740
 
        if url is not None:
741
 
            if isinstance(url, unicode):
742
 
                try:
743
 
                    url = url.encode('ascii')
744
 
                except UnicodeEncodeError:
745
 
                    raise errors.InvalidURL(url,
746
 
                        "Urls must be 7-bit ascii, "
747
 
                        "use bzrlib.urlutils.escape")
748
 
            url = urlutils.relative_url(self.base, url)
749
 
        self._set_parent_location(url)
750
 
 
751
 
    @needs_write_lock
752
550
    def set_stacked_on_url(self, url):
753
551
        """Set the URL this branch is stacked against.
754
552
 
757
555
        :raises UnstackableRepositoryFormat: If the repository does not support
758
556
            stacking.
759
557
        """
760
 
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
765
 
        self._check_stackable_repo()
766
 
        if not url:
767
 
            try:
768
 
                old_url = self.get_stacked_on_url()
769
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
 
                errors.UnstackableRepositoryFormat):
771
 
                return
772
 
            self._unstack()
773
 
        else:
774
 
            self._activate_fallback_location(url)
775
 
        # write this out after the repository is stacked to avoid setting a
776
 
        # stacked config that doesn't work.
777
 
        self._set_config_location('stacked_on_location', url)
778
 
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
 
 
834
 
    def _set_tags_bytes(self, bytes):
835
 
        """Mirror method for _get_tags_bytes.
836
 
 
837
 
        :seealso: Branch._get_tags_bytes.
838
 
        """
839
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
840
 
            'tags', bytes)
 
558
        raise NotImplementedError(self.set_stacked_on_url)
841
559
 
842
560
    def _cache_revision_history(self, rev_history):
843
561
        """Set the cached revision history to rev_history.
871
589
        self._revision_id_to_revno_cache = None
872
590
        self._last_revision_info_cache = None
873
591
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
592
 
877
593
    def _gen_revision_history(self):
878
594
        """Return sequence of revision hashes on to this branch.
879
 
 
 
595
        
880
596
        Unlike revision_history, this method always regenerates or rereads the
881
597
        revision history, i.e. it does not cache the result, so repeated calls
882
598
        may be expensive.
883
599
 
884
600
        Concrete subclasses should override this instead of revision_history so
885
601
        that subclasses do not need to deal with caching logic.
886
 
 
 
602
        
887
603
        This API is semi-public; it only for use by subclasses, all other code
888
604
        should consider it to be private.
889
605
        """
892
608
    @needs_read_lock
893
609
    def revision_history(self):
894
610
        """Return sequence of revision ids on this branch.
895
 
 
 
611
        
896
612
        This method will cache the revision history for as long as it is safe to
897
613
        do so.
898
614
        """
915
631
 
916
632
    def unbind(self):
917
633
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
634
        raise errors.UpgradeRequired(self.base)
 
635
 
 
636
    def set_append_revisions_only(self, enabled):
 
637
        """Older format branches are never restricted to append-only"""
 
638
        raise errors.UpgradeRequired(self.base)
919
639
 
920
640
    def last_revision(self):
921
641
        """Return last revision id, or NULL_REVISION."""
942
662
    @deprecated_method(deprecated_in((1, 6, 0)))
943
663
    def missing_revisions(self, other, stop_revision=None):
944
664
        """Return a list of new revisions that would perfectly fit.
945
 
 
 
665
        
946
666
        If self and other have not diverged, return a list of the revisions
947
667
        present in other, but missing from self.
948
668
        """
975
695
            information. This can be None.
976
696
        :return: None
977
697
        """
978
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
979
 
            overwrite, graph)
980
 
 
981
 
    def import_last_revision_info(self, source_repo, revno, revid):
982
 
        """Set the last revision info, importing from another repo if necessary.
983
 
 
984
 
        This is used by the bound branch code to upload a revision to
985
 
        the master branch first before updating the tip of the local branch.
986
 
 
987
 
        :param source_repo: Source repository to optionally fetch from
988
 
        :param revno: Revision number of the new tip
989
 
        :param revid: Revision id of the new tip
990
 
        """
991
 
        if not self.repository.has_same_location(source_repo):
992
 
            self.repository.fetch(source_repo, revision_id=revid)
993
 
        self.set_last_revision_info(revno, revid)
 
698
        other.lock_read()
 
699
        try:
 
700
            other_revno, other_last_revision = other.last_revision_info()
 
701
            stop_revno = None # unknown
 
702
            if stop_revision is None:
 
703
                stop_revision = other_last_revision
 
704
                if _mod_revision.is_null(stop_revision):
 
705
                    # if there are no commits, we're done.
 
706
                    return
 
707
                stop_revno = other_revno
 
708
 
 
709
            # what's the current last revision, before we fetch [and change it
 
710
            # possibly]
 
711
            last_rev = _mod_revision.ensure_null(self.last_revision())
 
712
            # we fetch here so that we don't process data twice in the common
 
713
            # case of having something to pull, and so that the check for 
 
714
            # already merged can operate on the just fetched graph, which will
 
715
            # be cached in memory.
 
716
            self.fetch(other, stop_revision)
 
717
            # Check to see if one is an ancestor of the other
 
718
            if not overwrite:
 
719
                if graph is None:
 
720
                    graph = self.repository.get_graph()
 
721
                if self._check_if_descendant_or_diverged(
 
722
                        stop_revision, last_rev, graph, other):
 
723
                    # stop_revision is a descendant of last_rev, but we aren't
 
724
                    # overwriting, so we're done.
 
725
                    return
 
726
            if stop_revno is None:
 
727
                if graph is None:
 
728
                    graph = self.repository.get_graph()
 
729
                this_revno, this_last_revision = self.last_revision_info()
 
730
                stop_revno = graph.find_distance_to_null(stop_revision,
 
731
                                [(other_last_revision, other_revno),
 
732
                                 (this_last_revision, this_revno)])
 
733
            self.set_last_revision_info(stop_revno, stop_revision)
 
734
        finally:
 
735
            other.unlock()
994
736
 
995
737
    def revision_id_to_revno(self, revision_id):
996
738
        """Given a revision id, return its revno"""
1002
744
        except ValueError:
1003
745
            raise errors.NoSuchRevision(self, revision_id)
1004
746
 
1005
 
    @needs_read_lock
1006
747
    def get_rev_id(self, revno, history=None):
1007
748
        """Find the revision id of the specified revno."""
1008
749
        if revno == 0:
1009
750
            return _mod_revision.NULL_REVISION
1010
 
        last_revno, last_revid = self.last_revision_info()
1011
 
        if revno == last_revno:
1012
 
            return last_revid
1013
 
        if revno <= 0 or revno > last_revno:
 
751
        if history is None:
 
752
            history = self.revision_history()
 
753
        if revno <= 0 or revno > len(history):
1014
754
            raise errors.NoSuchRevision(self, revno)
1015
 
        distance_from_last = last_revno - revno
1016
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1017
 
            self._extend_partial_history(distance_from_last)
1018
 
        return self._partial_revision_history_cache[distance_from_last]
 
755
        return history[revno - 1]
1019
756
 
1020
 
    @needs_write_lock
1021
757
    def pull(self, source, overwrite=False, stop_revision=None,
1022
 
             possible_transports=None, *args, **kwargs):
 
758
             possible_transports=None, _override_hook_target=None):
1023
759
        """Mirror source into this branch.
1024
760
 
1025
761
        This branch is considered to be 'local', having low latency.
1026
762
 
1027
763
        :returns: PullResult instance
1028
764
        """
1029
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
 
            stop_revision=stop_revision,
1031
 
            possible_transports=possible_transports, *args, **kwargs)
 
765
        raise NotImplementedError(self.pull)
1032
766
 
1033
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1034
 
        **kwargs):
 
767
    def push(self, target, overwrite=False, stop_revision=None):
1035
768
        """Mirror this branch into target.
1036
769
 
1037
770
        This branch is considered to be 'local', having low latency.
1038
771
        """
1039
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1040
 
            *args, **kwargs)
1041
 
 
1042
 
    def lossy_push(self, target, stop_revision=None):
1043
 
        """Push deltas into another branch.
1044
 
 
1045
 
        :note: This does not, like push, retain the revision ids from 
1046
 
            the source branch and will, rather than adding bzr-specific 
1047
 
            metadata, push only those semantics of the revision that can be 
1048
 
            natively represented by this branch' VCS.
1049
 
 
1050
 
        :param target: Target branch
1051
 
        :param stop_revision: Revision to push, defaults to last revision.
1052
 
        :return: BranchPushResult with an extra member revidmap: 
1053
 
            A dictionary mapping revision ids from the target branch 
1054
 
            to new revision ids in the target branch, for each 
1055
 
            revision that was pushed.
1056
 
        """
1057
 
        inter = InterBranch.get(self, target)
1058
 
        lossy_push = getattr(inter, "lossy_push", None)
1059
 
        if lossy_push is None:
1060
 
            raise errors.LossyPushToSameVCS(self, target)
1061
 
        return lossy_push(stop_revision)
 
772
        raise NotImplementedError(self.push)
1062
773
 
1063
774
    def basis_tree(self):
1064
775
        """Return `Tree` object for last revision."""
1067
778
    def get_parent(self):
1068
779
        """Return the parent location of the branch.
1069
780
 
1070
 
        This is the default location for pull/missing.  The usual
 
781
        This is the default location for push/pull/missing.  The usual
1071
782
        pattern is that the user can override it by specifying a
1072
783
        location.
1073
784
        """
1074
 
        parent = self._get_parent_location()
1075
 
        if parent is None:
1076
 
            return parent
1077
 
        # This is an old-format absolute path to a local branch
1078
 
        # turn it into a url
1079
 
        if parent.startswith('/'):
1080
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1081
 
        try:
1082
 
            return urlutils.join(self.base[:-1], parent)
1083
 
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
1085
 
 
1086
 
    def _get_parent_location(self):
1087
 
        raise NotImplementedError(self._get_parent_location)
 
785
        raise NotImplementedError(self.get_parent)
1088
786
 
1089
787
    def _set_config_location(self, name, url, config=None,
1090
788
                             make_relative=False):
1104
802
            location = None
1105
803
        return location
1106
804
 
1107
 
    def get_child_submit_format(self):
1108
 
        """Return the preferred format of submissions to this branch."""
1109
 
        return self.get_config().get_user_option("child_submit_format")
1110
 
 
1111
805
    def get_submit_branch(self):
1112
806
        """Return the submit location of the branch.
1113
807
 
1172
866
        params = ChangeBranchTipParams(
1173
867
            self, old_revno, new_revno, old_revid, new_revid)
1174
868
        for hook in hooks:
1175
 
            hook(params)
 
869
            try:
 
870
                hook(params)
 
871
            except errors.TipChangeRejected:
 
872
                raise
 
873
            except Exception:
 
874
                exc_info = sys.exc_info()
 
875
                hook_name = Branch.hooks.get_hook_name(hook)
 
876
                raise errors.HookFailed(
 
877
                    'pre_change_branch_tip', hook_name, exc_info)
 
878
 
 
879
    def set_parent(self, url):
 
880
        raise NotImplementedError(self.set_parent)
1176
881
 
1177
882
    @needs_write_lock
1178
883
    def update(self):
1179
 
        """Synchronise this branch with the master branch if any.
 
884
        """Synchronise this branch with the master branch if any. 
1180
885
 
1181
886
        :return: None or the last_revision pivoted out during the update.
1182
887
        """
1189
894
        """
1190
895
        if revno != 0:
1191
896
            self.check_real_revno(revno)
1192
 
 
 
897
            
1193
898
    def check_real_revno(self, revno):
1194
899
        """\
1195
900
        Check whether a revno corresponds to a real revision.
1199
904
            raise errors.InvalidRevisionNumber(revno)
1200
905
 
1201
906
    @needs_read_lock
1202
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
 
907
    def clone(self, to_bzrdir, revision_id=None):
1203
908
        """Clone this branch into to_bzrdir preserving all semantic values.
1204
 
 
1205
 
        Most API users will want 'create_clone_on_transport', which creates a
1206
 
        new bzrdir and branch on the fly.
1207
 
 
 
909
        
1208
910
        revision_id: if not None, the revision history in the new branch will
1209
911
                     be truncated to end with revision_id.
1210
912
        """
1211
913
        result = to_bzrdir.create_branch()
1212
 
        result.lock_write()
1213
 
        try:
1214
 
            if repository_policy is not None:
1215
 
                repository_policy.configure_branch(result)
1216
 
            self.copy_content_into(result, revision_id=revision_id)
1217
 
        finally:
1218
 
            result.unlock()
1219
 
        return result
 
914
        self.copy_content_into(result, revision_id=revision_id)
 
915
        return  result
1220
916
 
1221
917
    @needs_read_lock
1222
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
918
    def sprout(self, to_bzrdir, revision_id=None):
1223
919
        """Create a new line of development from the branch, into to_bzrdir.
1224
920
 
1225
921
        to_bzrdir controls the branch format.
1227
923
        revision_id: if not None, the revision history in the new branch will
1228
924
                     be truncated to end with revision_id.
1229
925
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
926
        result = to_bzrdir.create_branch()
1234
 
        result.lock_write()
1235
 
        try:
1236
 
            if repository_policy is not None:
1237
 
                repository_policy.configure_branch(result)
1238
 
            self.copy_content_into(result, revision_id=revision_id)
1239
 
            result.set_parent(self.bzrdir.root_transport.base)
1240
 
        finally:
1241
 
            result.unlock()
 
927
        self.copy_content_into(result, revision_id=revision_id)
 
928
        result.set_parent(self.bzrdir.root_transport.base)
1242
929
        return result
1243
930
 
1244
931
    def _synchronize_history(self, destination, revision_id):
1256
943
        source_revno, source_revision_id = self.last_revision_info()
1257
944
        if revision_id is None:
1258
945
            revno, revision_id = source_revno, source_revision_id
 
946
        elif source_revision_id == revision_id:
 
947
            # we know the revno without needing to walk all of history
 
948
            revno = source_revno
1259
949
        else:
1260
 
            graph = self.repository.get_graph()
1261
 
            try:
1262
 
                revno = graph.find_distance_to_null(revision_id, 
1263
 
                    [(source_revision_id, source_revno)])
1264
 
            except errors.GhostRevisionsHaveNoRevno:
1265
 
                # Default to 1, if we can't find anything else
1266
 
                revno = 1
 
950
            # To figure out the revno for a random revision, we need to build
 
951
            # the revision history, and count its length.
 
952
            # We don't care about the order, just how long it is.
 
953
            # Alternatively, we could start at the current location, and count
 
954
            # backwards. But there is no guarantee that we will find it since
 
955
            # it may be a merged revision.
 
956
            revno = len(list(self.repository.iter_reverse_revision_history(
 
957
                                                                revision_id)))
1267
958
        destination.set_last_revision_info(revno, revision_id)
1268
 
 
 
959
    
1269
960
    @needs_read_lock
1270
961
    def copy_content_into(self, destination, revision_id=None):
1271
962
        """Copy the content of self into destination.
1273
964
        revision_id: if not None, the revision history in the new branch will
1274
965
                     be truncated to end with revision_id.
1275
966
        """
1276
 
        self.update_references(destination)
1277
967
        self._synchronize_history(destination, revision_id)
1278
968
        try:
1279
969
            parent = self.get_parent()
1282
972
        else:
1283
973
            if parent:
1284
974
                destination.set_parent(parent)
1285
 
        if self._push_should_merge_tags():
1286
 
            self.tags.merge_to(destination.tags)
1287
 
 
1288
 
    def update_references(self, target):
1289
 
        if not getattr(self._format, 'supports_reference_locations', False):
1290
 
            return
1291
 
        reference_dict = self._get_all_reference_info()
1292
 
        if len(reference_dict) == 0:
1293
 
            return
1294
 
        old_base = self.base
1295
 
        new_base = target.base
1296
 
        target_reference_dict = target._get_all_reference_info()
1297
 
        for file_id, (tree_path, branch_location) in (
1298
 
            reference_dict.items()):
1299
 
            branch_location = urlutils.rebase_url(branch_location,
1300
 
                                                  old_base, new_base)
1301
 
            target_reference_dict.setdefault(
1302
 
                file_id, (tree_path, branch_location))
1303
 
        target._set_all_reference_info(target_reference_dict)
 
975
        self.tags.merge_to(destination.tags)
1304
976
 
1305
977
    @needs_read_lock
1306
 
    def check(self, refs):
 
978
    def check(self):
1307
979
        """Check consistency of the branch.
1308
980
 
1309
981
        In particular this checks that revisions given in the revision-history
1310
 
        do actually match up in the revision graph, and that they're all
 
982
        do actually match up in the revision graph, and that they're all 
1311
983
        present in the repository.
1312
 
 
 
984
        
1313
985
        Callers will typically also want to check the repository.
1314
986
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
987
        :return: A BranchCheckResult.
1318
988
        """
1319
 
        result = BranchCheckResult(self)
 
989
        mainline_parent_id = None
1320
990
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        return result
 
991
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
992
                                last_revision_id))
 
993
        real_rev_history.reverse()
 
994
        if len(real_rev_history) != last_revno:
 
995
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
996
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
997
        # TODO: We should probably also check that real_rev_history actually
 
998
        #       matches self.revision_history()
 
999
        for revision_id in real_rev_history:
 
1000
            try:
 
1001
                revision = self.repository.get_revision(revision_id)
 
1002
            except errors.NoSuchRevision, e:
 
1003
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1004
                            % revision_id)
 
1005
            # In general the first entry on the revision history has no parents.
 
1006
            # But it's not illegal for it to have parents listed; this can happen
 
1007
            # in imports from Arch when the parents weren't reachable.
 
1008
            if mainline_parent_id is not None:
 
1009
                if mainline_parent_id not in revision.parent_ids:
 
1010
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1011
                                        "parents of {%s}"
 
1012
                                        % (mainline_parent_id, revision_id))
 
1013
            mainline_parent_id = revision_id
 
1014
        return BranchCheckResult(self)
1332
1015
 
1333
1016
    def _get_checkout_format(self):
1334
1017
        """Return the most suitable metadir for a checkout of this branch.
1343
1026
            format.set_branch_format(self._format)
1344
1027
        return format
1345
1028
 
1346
 
    def create_clone_on_transport(self, to_transport, revision_id=None,
1347
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1348
 
        """Create a clone of this branch and its bzrdir.
1349
 
 
1350
 
        :param to_transport: The transport to clone onto.
1351
 
        :param revision_id: The revision id to use as tip in the new branch.
1352
 
            If None the tip is obtained from this branch.
1353
 
        :param stacked_on: An optional URL to stack the clone on.
1354
 
        :param create_prefix: Create any missing directories leading up to
1355
 
            to_transport.
1356
 
        :param use_existing_dir: Use an existing directory if one exists.
1357
 
        """
1358
 
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
 
        # clone call. Or something. 20090224 RBC/spiv.
1360
 
        if revision_id is None:
1361
 
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1365
 
        return dir_to.open_branch()
1366
 
 
1367
1029
    def create_checkout(self, to_location, revision_id=None,
1368
1030
                        lightweight=False, accelerator_tree=None,
1369
1031
                        hardlink=False):
1370
1032
        """Create a checkout of a branch.
1371
 
 
 
1033
        
1372
1034
        :param to_location: The url to produce the checkout at
1373
1035
        :param revision_id: The revision to check out
1374
1036
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1386
1048
        if lightweight:
1387
1049
            format = self._get_checkout_format()
1388
1050
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1051
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1052
        else:
1392
1053
            format = self._get_checkout_format()
1393
1054
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1394
1055
                to_location, force_new_tree=False, format=format)
1395
1056
            checkout = checkout_branch.bzrdir
1396
1057
            checkout_branch.bind(self)
1397
 
            # pull up to the specified revision_id to set the initial
 
1058
            # pull up to the specified revision_id to set the initial 
1398
1059
            # branch tip correctly, and seed it with history.
1399
1060
            checkout_branch.pull(self, stop_revision=revision_id)
1400
1061
            from_branch=None
1422
1083
        reconciler.reconcile()
1423
1084
        return reconciler
1424
1085
 
1425
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1086
    def reference_parent(self, file_id, path):
1426
1087
        """Return the parent branch for a tree-reference file_id
1427
1088
        :param file_id: The file_id of the tree reference
1428
1089
        :param path: The path of the file_id in the tree
1429
1090
        :return: A branch associated with the file_id
1430
1091
        """
1431
1092
        # FIXME should provide multiple branches, based on config
1432
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
 
                           possible_transports=possible_transports)
 
1093
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1434
1094
 
1435
1095
    def supports_tags(self):
1436
1096
        return self._format.supports_tags()
1437
1097
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1098
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1099
                                         other_branch):
1452
1100
        """Ensure that revision_b is a descendant of revision_a.
1453
1101
 
1454
1102
        This is a helper function for update_revisions.
1455
 
 
 
1103
        
1456
1104
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1457
1105
        :returns: True if revision_b is a descendant of revision_a.
1458
1106
        """
1468
1116
 
1469
1117
    def _revision_relations(self, revision_a, revision_b, graph):
1470
1118
        """Determine the relationship between two revisions.
1471
 
 
 
1119
        
1472
1120
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1473
1121
        """
1474
1122
        heads = graph.heads([revision_a, revision_b])
1491
1139
     * a format string,
1492
1140
     * an open routine.
1493
1141
 
1494
 
    Formats are placed in an dict by their format string for reference
 
1142
    Formats are placed in an dict by their format string for reference 
1495
1143
    during branch opening. Its not required that these be instances, they
1496
 
    can be classes themselves with class methods - it simply depends on
 
1144
    can be classes themselves with class methods - it simply depends on 
1497
1145
    whether state is needed for a given format or not.
1498
1146
 
1499
1147
    Once a format is deprecated, just deprecate the initialize and open
1500
 
    methods on the format class. Do not deprecate the object, as the
 
1148
    methods on the format class. Do not deprecate the object, as the 
1501
1149
    object will be created every time regardless.
1502
1150
    """
1503
1151
 
1507
1155
    _formats = {}
1508
1156
    """The known formats."""
1509
1157
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1158
    def __eq__(self, other):
1513
1159
        return self.__class__ is other.__class__
1514
1160
 
1516
1162
        return not (self == other)
1517
1163
 
1518
1164
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1165
    def find_format(klass, a_bzrdir):
1520
1166
        """Return the format for the branch object in a_bzrdir."""
1521
1167
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1168
            transport = a_bzrdir.get_branch_transport(None)
 
1169
            format_string = transport.get("format").read()
1524
1170
            return klass._formats[format_string]
1525
1171
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1172
            raise errors.NotBranchError(path=transport.base)
1527
1173
        except KeyError:
1528
1174
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1175
 
1565
1211
        """Return the short format description for this format."""
1566
1212
        raise NotImplementedError(self.get_format_description)
1567
1213
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1214
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1215
                           set_format=True):
1578
1216
        """Initialize a branch in a bzrdir, with specified files
1579
1217
 
1580
1218
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1219
        :param utf8_files: The files to create as a list of
1582
1220
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1221
        :param set_format: If True, set the format with
1585
1222
            self.get_format_string.  (BzrBranch4 has its format set
1586
1223
            elsewhere)
1587
1224
        :return: a branch in this format
1588
1225
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1226
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1227
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1228
        lock_map = {
1592
1229
            'metadir': ('lock', lockdir.LockDir),
1593
1230
            'branch4': ('branch-lock', lockable_files.TransportLock),
1596
1233
        control_files = lockable_files.LockableFiles(branch_transport,
1597
1234
            lock_name, lock_class)
1598
1235
        control_files.create_lock()
1599
 
        try:
1600
 
            control_files.lock_write()
1601
 
        except errors.LockContention:
1602
 
            if lock_type != 'branch4':
1603
 
                raise
1604
 
            lock_taken = False
1605
 
        else:
1606
 
            lock_taken = True
 
1236
        control_files.lock_write()
1607
1237
        if set_format:
1608
1238
            utf8_files += [('format', self.get_format_string())]
1609
1239
        try:
1612
1242
                    filename, content,
1613
1243
                    mode=a_bzrdir._get_file_mode())
1614
1244
        finally:
1615
 
            if lock_taken:
1616
 
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1245
            control_files.unlock()
 
1246
        return self.open(a_bzrdir, _found=True)
1620
1247
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1248
    def initialize(self, a_bzrdir):
 
1249
        """Create a branch of this format in a_bzrdir."""
1626
1250
        raise NotImplementedError(self.initialize)
1627
1251
 
1628
1252
    def is_supported(self):
1629
1253
        """Is this format supported?
1630
1254
 
1631
1255
        Supported formats can be initialized and opened.
1632
 
        Unsupported formats may not support initialization or committing or
 
1256
        Unsupported formats may not support initialization or committing or 
1633
1257
        some other features depending on the reason for not being supported.
1634
1258
        """
1635
1259
        return True
1636
1260
 
1637
 
    def make_tags(self, branch):
1638
 
        """Create a tags object for branch.
1639
 
 
1640
 
        This method is on BranchFormat, because BranchFormats are reflected
1641
 
        over the wire via network_name(), whereas full Branch instances require
1642
 
        multiple VFS method calls to operate at all.
1643
 
 
1644
 
        The default implementation returns a disabled-tags instance.
1645
 
 
1646
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1647
 
        on a RemoteBranch.
1648
 
        """
1649
 
        return DisabledTags(branch)
1650
 
 
1651
 
    def network_name(self):
1652
 
        """A simple byte string uniquely identifying this format for RPC calls.
1653
 
 
1654
 
        MetaDir branch formats use their disk format string to identify the
1655
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1656
 
        foreign formats like svn/git and hg should use some marker which is
1657
 
        unique and immutable.
1658
 
        """
1659
 
        raise NotImplementedError(self.network_name)
1660
 
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1261
    def open(self, a_bzrdir, _found=False):
1662
1262
        """Return the branch object for a_bzrdir
1663
1263
 
1664
 
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
 
        :param _found: a private parameter, do not use it. It is used to
1667
 
            indicate if format probing has already be done.
1668
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1669
 
            (if there are any).  Default is to open fallbacks.
 
1264
        _found is a private parameter, do not use it. It is used to indicate
 
1265
               if format probing has already be done.
1670
1266
        """
1671
1267
        raise NotImplementedError(self.open)
1672
1268
 
1673
1269
    @classmethod
1674
1270
    def register_format(klass, format):
1675
 
        """Register a metadir format."""
1676
1271
        klass._formats[format.get_format_string()] = format
1677
 
        # Metadir formats have a network name of their format string, and get
1678
 
        # registered as class factories.
1679
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1680
1272
 
1681
1273
    @classmethod
1682
1274
    def set_default_format(klass, format):
1683
1275
        klass._default_format = format
1684
1276
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1277
    def supports_stacking(self):
1690
1278
        """True if this format records a stacked-on branch."""
1691
1279
        return False
1695
1283
        del klass._formats[format.get_format_string()]
1696
1284
 
1697
1285
    def __str__(self):
1698
 
        return self.get_format_description().rstrip()
 
1286
        return self.get_format_string().rstrip()
1699
1287
 
1700
1288
    def supports_tags(self):
1701
1289
        """True if this format supports tags stored in the branch"""
1704
1292
 
1705
1293
class BranchHooks(Hooks):
1706
1294
    """A dictionary mapping hook name to a list of callables for branch hooks.
1707
 
 
 
1295
    
1708
1296
    e.g. ['set_rh'] Is the list of items to be called when the
1709
1297
    set_revision_history function is invoked.
1710
1298
    """
1716
1304
        notified.
1717
1305
        """
1718
1306
        Hooks.__init__(self)
1719
 
        self.create_hook(HookPoint('set_rh',
1720
 
            "Invoked whenever the revision history has been set via "
1721
 
            "set_revision_history. The api signature is (branch, "
1722
 
            "revision_history), and the branch will be write-locked. "
1723
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1724
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('open',
1726
 
            "Called with the Branch object that has been opened after a "
1727
 
            "branch is opened.", (1, 8), None))
1728
 
        self.create_hook(HookPoint('post_push',
1729
 
            "Called after a push operation completes. post_push is called "
1730
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
 
            "bzr client.", (0, 15), None))
1732
 
        self.create_hook(HookPoint('post_pull',
1733
 
            "Called after a pull operation completes. post_pull is called "
1734
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1735
 
            "bzr client.", (0, 15), None))
1736
 
        self.create_hook(HookPoint('pre_commit',
1737
 
            "Called after a commit is calculated but before it is is "
1738
 
            "completed. pre_commit is called with (local, master, old_revno, "
1739
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1741
 
            "tree_delta is a TreeDelta object describing changes from the "
1742
 
            "basis revision. hooks MUST NOT modify this delta. "
1743
 
            " future_tree is an in-memory tree obtained from "
1744
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
 
            "tree.", (0,91), None))
1746
 
        self.create_hook(HookPoint('post_commit',
1747
 
            "Called in the bzr client after a commit has completed. "
1748
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1749
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
 
            "commit to a branch.", (0, 15), None))
1751
 
        self.create_hook(HookPoint('post_uncommit',
1752
 
            "Called in the bzr client after an uncommit completes. "
1753
 
            "post_uncommit is called with (local, master, old_revno, "
1754
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1755
 
            "or None, master is the target branch, and an empty branch "
1756
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1758
 
            "Called in bzr client and server before a change to the tip of a "
1759
 
            "branch is made. pre_change_branch_tip is called with a "
1760
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1762
 
        self.create_hook(HookPoint('post_change_branch_tip',
1763
 
            "Called in bzr client and server after a change to the tip of a "
1764
 
            "branch is made. post_change_branch_tip is called with a "
1765
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1767
 
        self.create_hook(HookPoint('transform_fallback_location',
1768
 
            "Called when a stacked branch is activating its fallback "
1769
 
            "locations. transform_fallback_location is called with (branch, "
1770
 
            "url), and should return a new url. Returning the same url "
1771
 
            "allows it to be used as-is, returning a different one can be "
1772
 
            "used to cause the branch to stack on a closer copy of that "
1773
 
            "fallback_location. Note that the branch cannot have history "
1774
 
            "accessing methods called on it during this hook because the "
1775
 
            "fallback locations have not been activated. When there are "
1776
 
            "multiple hooks installed for transform_fallback_location, "
1777
 
            "all are called with the url returned from the previous hook."
1778
 
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
 
1307
        # Introduced in 0.15:
 
1308
        # invoked whenever the revision history has been set
 
1309
        # with set_revision_history. The api signature is
 
1310
        # (branch, revision_history), and the branch will
 
1311
        # be write-locked.
 
1312
        self['set_rh'] = []
 
1313
        # Invoked after a branch is opened. The api signature is (branch).
 
1314
        self['open'] = []
 
1315
        # invoked after a push operation completes.
 
1316
        # the api signature is
 
1317
        # (push_result)
 
1318
        # containing the members
 
1319
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1320
        # where local is the local target branch or None, master is the target 
 
1321
        # master branch, and the rest should be self explanatory. The source
 
1322
        # is read locked and the target branches write locked. Source will
 
1323
        # be the local low-latency branch.
 
1324
        self['post_push'] = []
 
1325
        # invoked after a pull operation completes.
 
1326
        # the api signature is
 
1327
        # (pull_result)
 
1328
        # containing the members
 
1329
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1330
        # where local is the local branch or None, master is the target 
 
1331
        # master branch, and the rest should be self explanatory. The source
 
1332
        # is read locked and the target branches write locked. The local
 
1333
        # branch is the low-latency branch.
 
1334
        self['post_pull'] = []
 
1335
        # invoked before a commit operation takes place.
 
1336
        # the api signature is
 
1337
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1338
        #  tree_delta, future_tree).
 
1339
        # old_revid is NULL_REVISION for the first commit to a branch
 
1340
        # tree_delta is a TreeDelta object describing changes from the basis
 
1341
        # revision, hooks MUST NOT modify this delta
 
1342
        # future_tree is an in-memory tree obtained from
 
1343
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1344
        self['pre_commit'] = []
 
1345
        # invoked after a commit operation completes.
 
1346
        # the api signature is 
 
1347
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1348
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1349
        self['post_commit'] = []
 
1350
        # invoked after a uncommit operation completes.
 
1351
        # the api signature is
 
1352
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1353
        # local is the local branch or None, master is the target branch,
 
1354
        # and an empty branch receives new_revno of 0, new_revid of None.
 
1355
        self['post_uncommit'] = []
 
1356
        # Introduced in 1.6
 
1357
        # Invoked before the tip of a branch changes.
 
1358
        # the api signature is
 
1359
        # (params) where params is a ChangeBranchTipParams with the members
 
1360
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1361
        self['pre_change_branch_tip'] = []
 
1362
        # Introduced in 1.4
 
1363
        # Invoked after the tip of a branch changes.
 
1364
        # the api signature is
 
1365
        # (params) where params is a ChangeBranchTipParams with the members
 
1366
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1367
        self['post_change_branch_tip'] = []
 
1368
        # Introduced in 1.9
 
1369
        # Invoked when a stacked branch activates its fallback locations and
 
1370
        # allows the transformation of the url of said location.
 
1371
        # the api signature is
 
1372
        # (branch, url) where branch is the branch having its fallback
 
1373
        # location activated and url is the url for the fallback location.
 
1374
        # The hook should return a url.
 
1375
        self['transform_fallback_location'] = []
1796
1376
 
1797
1377
 
1798
1378
# install the default hooks into the Branch class.
1830
1410
 
1831
1411
    def __eq__(self, other):
1832
1412
        return self.__dict__ == other.__dict__
1833
 
 
 
1413
    
1834
1414
    def __repr__(self):
1835
1415
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1836
 
            self.__class__.__name__, self.branch,
 
1416
            self.__class__.__name__, self.branch, 
1837
1417
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1418
 
1839
1419
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1420
class BzrBranchFormat4(BranchFormat):
1919
1421
    """Bzr branch format 4.
1920
1422
 
1927
1429
        """See BranchFormat.get_format_description()."""
1928
1430
        return "Branch format 4"
1929
1431
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1432
    def initialize(self, a_bzrdir):
1931
1433
        """Create a branch of this format in a_bzrdir."""
1932
1434
        utf8_files = [('revision-history', ''),
1933
1435
                      ('branch-name', ''),
1934
1436
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1437
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1438
                                       lock_type='branch4', set_format=False)
1937
1439
 
1938
1440
    def __init__(self):
1939
1441
        super(BzrBranchFormat4, self).__init__()
1940
1442
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1941
1443
 
1942
 
    def network_name(self):
1943
 
        """The network name for this format is the control dirs disk label."""
1944
 
        return self._matchingbzrdir.get_format_string()
 
1444
    def open(self, a_bzrdir, _found=False):
 
1445
        """Return the branch object for a_bzrdir
1945
1446
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
 
        """See BranchFormat.open()."""
 
1447
        _found is a private parameter, do not use it. It is used to indicate
 
1448
               if format probing has already be done.
 
1449
        """
1948
1450
        if not _found:
1949
1451
            # we are being called directly and must probe.
1950
1452
            raise NotImplementedError
1951
1453
        return BzrBranch(_format=self,
1952
1454
                         _control_files=a_bzrdir._control_files,
1953
1455
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1456
                         _repository=a_bzrdir.open_repository())
1956
1457
 
1957
1458
    def __str__(self):
1965
1466
        """What class to instantiate on open calls."""
1966
1467
        raise NotImplementedError(self._branch_class)
1967
1468
 
1968
 
    def network_name(self):
1969
 
        """A simple byte string uniquely identifying this format for RPC calls.
 
1469
    def open(self, a_bzrdir, _found=False):
 
1470
        """Return the branch object for a_bzrdir.
1970
1471
 
1971
 
        Metadir branch formats use their format string.
 
1472
        _found is a private parameter, do not use it. It is used to indicate
 
1473
               if format probing has already be done.
1972
1474
        """
1973
 
        return self.get_format_string()
1974
 
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
 
        """See BranchFormat.open()."""
1977
1475
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1476
            format = BranchFormat.find_format(a_bzrdir)
1979
1477
            if format.__class__ != self.__class__:
1980
1478
                raise AssertionError("wrong format %r found for %r" %
1981
1479
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1480
        try:
 
1481
            transport = a_bzrdir.get_branch_transport(None)
1984
1482
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1483
                                                         lockdir.LockDir)
1986
1484
            return self._branch_class()(_format=self,
1987
1485
                              _control_files=control_files,
1988
 
                              name=name,
1989
1486
                              a_bzrdir=a_bzrdir,
1990
 
                              _repository=a_bzrdir.find_repository(),
1991
 
                              ignore_fallbacks=ignore_fallbacks)
 
1487
                              _repository=a_bzrdir.find_repository())
1992
1488
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1489
            raise errors.NotBranchError(path=transport.base)
1994
1490
 
1995
1491
    def __init__(self):
1996
1492
        super(BranchFormatMetadir, self).__init__()
2024
1520
    def get_format_description(self):
2025
1521
        """See BranchFormat.get_format_description()."""
2026
1522
        return "Branch format 5"
2027
 
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1523
        
 
1524
    def initialize(self, a_bzrdir):
2029
1525
        """Create a branch of this format in a_bzrdir."""
2030
1526
        utf8_files = [('revision-history', ''),
2031
1527
                      ('branch-name', ''),
2032
1528
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1529
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1530
 
2035
1531
    def supports_tags(self):
2036
1532
        return False
2058
1554
        """See BranchFormat.get_format_description()."""
2059
1555
        return "Branch format 6"
2060
1556
 
2061
 
    def initialize(self, a_bzrdir, name=None):
2062
 
        """Create a branch of this format in a_bzrdir."""
2063
 
        utf8_files = [('last-revision', '0 null:\n'),
2064
 
                      ('branch.conf', ''),
2065
 
                      ('tags', ''),
2066
 
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2068
 
 
2069
 
    def make_tags(self, branch):
2070
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
 
        return BasicTags(branch)
2072
 
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
 
 
2076
 
 
2077
 
class BzrBranchFormat8(BranchFormatMetadir):
2078
 
    """Metadir format supporting storing locations of subtree branches."""
2079
 
 
2080
 
    def _branch_class(self):
2081
 
        return BzrBranch8
2082
 
 
2083
 
    def get_format_string(self):
2084
 
        """See BranchFormat.get_format_string()."""
2085
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2086
 
 
2087
 
    def get_format_description(self):
2088
 
        """See BranchFormat.get_format_description()."""
2089
 
        return "Branch format 8"
2090
 
 
2091
 
    def initialize(self, a_bzrdir, name=None):
2092
 
        """Create a branch of this format in a_bzrdir."""
2093
 
        utf8_files = [('last-revision', '0 null:\n'),
2094
 
                      ('branch.conf', ''),
2095
 
                      ('tags', ''),
2096
 
                      ('references', '')
2097
 
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2099
 
 
2100
 
    def __init__(self):
2101
 
        super(BzrBranchFormat8, self).__init__()
2102
 
        self._matchingbzrdir.repository_format = \
2103
 
            RepositoryFormatKnitPack5RichRoot()
2104
 
 
2105
 
    def make_tags(self, branch):
2106
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
 
        return BasicTags(branch)
2108
 
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
 
    def supports_stacking(self):
2113
 
        return True
2114
 
 
2115
 
    supports_reference_locations = True
2116
 
 
2117
 
 
2118
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1557
    def initialize(self, a_bzrdir):
 
1558
        """Create a branch of this format in a_bzrdir."""
 
1559
        utf8_files = [('last-revision', '0 null:\n'),
 
1560
                      ('branch.conf', ''),
 
1561
                      ('tags', ''),
 
1562
                      ]
 
1563
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1564
 
 
1565
 
 
1566
class BzrBranchFormat7(BranchFormatMetadir):
2119
1567
    """Branch format with last-revision, tags, and a stacked location pointer.
2120
1568
 
2121
1569
    The stacked location pointer is passed down to the repository and requires
2124
1572
    This format was introduced in bzr 1.6.
2125
1573
    """
2126
1574
 
2127
 
    def initialize(self, a_bzrdir, name=None):
2128
 
        """Create a branch of this format in a_bzrdir."""
2129
 
        utf8_files = [('last-revision', '0 null:\n'),
2130
 
                      ('branch.conf', ''),
2131
 
                      ('tags', ''),
2132
 
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2134
 
 
2135
1575
    def _branch_class(self):
2136
1576
        return BzrBranch7
2137
1577
 
2143
1583
        """See BranchFormat.get_format_description()."""
2144
1584
        return "Branch format 7"
2145
1585
 
2146
 
    def supports_set_append_revisions_only(self):
 
1586
    def initialize(self, a_bzrdir):
 
1587
        """Create a branch of this format in a_bzrdir."""
 
1588
        utf8_files = [('last-revision', '0 null:\n'),
 
1589
                      ('branch.conf', ''),
 
1590
                      ('tags', ''),
 
1591
                      ]
 
1592
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1593
 
 
1594
    def __init__(self):
 
1595
        super(BzrBranchFormat7, self).__init__()
 
1596
        self._matchingbzrdir.repository_format = \
 
1597
            RepositoryFormatKnitPack5RichRoot()
 
1598
 
 
1599
    def supports_stacking(self):
2147
1600
        return True
2148
1601
 
2149
 
    supports_reference_locations = False
2150
 
 
2151
1602
 
2152
1603
class BranchReferenceFormat(BranchFormat):
2153
1604
    """Bzr branch reference format.
2171
1622
    def get_reference(self, a_bzrdir):
2172
1623
        """See BranchFormat.get_reference()."""
2173
1624
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1625
        return transport.get('location').read()
2175
1626
 
2176
1627
    def set_reference(self, a_bzrdir, to_branch):
2177
1628
        """See BranchFormat.set_reference()."""
2178
1629
        transport = a_bzrdir.get_branch_transport(None)
2179
1630
        location = transport.put_bytes('location', to_branch.base)
2180
1631
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1632
    def initialize(self, a_bzrdir, target_branch=None):
2182
1633
        """Create a branch of this format in a_bzrdir."""
2183
1634
        if target_branch is None:
2184
1635
            # this format does not implement branch itself, thus the implicit
2185
1636
            # creation contract must see it as uninitializable
2186
1637
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1638
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1639
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1640
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1641
            target_branch.bzrdir.root_transport.base)
2191
1642
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1643
        return self.open(
 
1644
            a_bzrdir, _found=True,
2194
1645
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1646
 
2198
1647
    def __init__(self):
2199
1648
        super(BranchReferenceFormat, self).__init__()
2202
1651
 
2203
1652
    def _make_reference_clone_function(format, a_branch):
2204
1653
        """Create a clone() routine for a branch dynamically."""
2205
 
        def clone(to_bzrdir, revision_id=None,
2206
 
            repository_policy=None):
 
1654
        def clone(to_bzrdir, revision_id=None):
2207
1655
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1656
            return format.initialize(to_bzrdir, a_branch)
2209
1657
            # cannot obey revision_id limits when cloning a reference ...
2210
1658
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1659
            # emit some sort of warning/error to the caller ?!
2212
1660
        return clone
2213
1661
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
 
             possible_transports=None, ignore_fallbacks=False):
 
1662
    def open(self, a_bzrdir, _found=False, location=None,
 
1663
             possible_transports=None):
2216
1664
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1665
 
2218
 
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
 
        :param _found: a private parameter, do not use it. It is used to
2221
 
            indicate if format probing has already be done.
2222
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2223
 
            (if there are any).  Default is to open fallbacks.
2224
 
        :param location: The location of the referenced branch.  If
2225
 
            unspecified, this will be determined from the branch reference in
2226
 
            a_bzrdir.
2227
 
        :param possible_transports: An optional reusable transports list.
 
1666
        _found is a private parameter, do not use it. It is used to indicate
 
1667
               if format probing has already be done.
2228
1668
        """
2229
1669
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1670
            format = BranchFormat.find_format(a_bzrdir)
2231
1671
            if format.__class__ != self.__class__:
2232
1672
                raise AssertionError("wrong format %r found for %r" %
2233
1673
                    (format, self))
2235
1675
            location = self.get_reference(a_bzrdir)
2236
1676
        real_bzrdir = bzrdir.BzrDir.open(
2237
1677
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1678
        result = real_bzrdir.open_branch()
2240
1679
        # this changes the behaviour of result.clone to create a new reference
2241
1680
        # rather than a copy of the content of the branch.
2242
1681
        # I did not use a proxy object because that needs much more extensive
2249
1688
        return result
2250
1689
 
2251
1690
 
2252
 
network_format_registry = registry.FormatRegistry()
2253
 
"""Registry of formats indexed by their network name.
2254
 
 
2255
 
The network name for a branch format is an identifier that can be used when
2256
 
referring to formats with smart server operations. See
2257
 
BranchFormat.network_name() for more detail.
2258
 
"""
2259
 
 
2260
 
 
2261
1691
# formats which have no format string are not discoverable
2262
1692
# and not independently creatable, so are not registered.
2263
1693
__format5 = BzrBranchFormat5()
2264
1694
__format6 = BzrBranchFormat6()
2265
1695
__format7 = BzrBranchFormat7()
2266
 
__format8 = BzrBranchFormat8()
2267
1696
BranchFormat.register_format(__format5)
2268
1697
BranchFormat.register_format(BranchReferenceFormat())
2269
1698
BranchFormat.register_format(__format6)
2270
1699
BranchFormat.register_format(__format7)
2271
 
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1700
BranchFormat.set_default_format(__format6)
2273
1701
_legacy_formats = [BzrBranchFormat4(),
2274
 
    ]
2275
 
network_format_registry.register(
2276
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
 
 
2278
 
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1702
                   ]
 
1703
 
 
1704
class BzrBranch(Branch):
2293
1705
    """A branch stored in the actual filesystem.
2294
1706
 
2295
1707
    Note that it's "local" in the context of the filesystem; it doesn't
2296
1708
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2297
1709
    it's writable, and can be accessed via the normal filesystem API.
2298
1710
 
2299
 
    :ivar _transport: Transport for file operations on this branch's
 
1711
    :ivar _transport: Transport for file operations on this branch's 
2300
1712
        control files, typically pointing to the .bzr/branch directory.
2301
1713
    :ivar repository: Repository for this branch.
2302
 
    :ivar base: The url of the base directory for this branch; the one
 
1714
    :ivar base: The url of the base directory for this branch; the one 
2303
1715
        containing the .bzr directory.
2304
 
    :ivar name: Optional colocated branch name as it exists in the control
2305
 
        directory.
2306
1716
    """
2307
 
 
 
1717
    
2308
1718
    def __init__(self, _format=None,
2309
 
                 _control_files=None, a_bzrdir=None, name=None,
2310
 
                 _repository=None, ignore_fallbacks=False):
 
1719
                 _control_files=None, a_bzrdir=None, _repository=None):
2311
1720
        """Create new branch object at a particular location."""
2312
1721
        if a_bzrdir is None:
2313
1722
            raise ValueError('a_bzrdir must be supplied')
2314
1723
        else:
2315
1724
            self.bzrdir = a_bzrdir
2316
1725
        self._base = self.bzrdir.transport.clone('..').base
2317
 
        self.name = name
2318
1726
        # XXX: We should be able to just do
2319
1727
        #   self.base = self.bzrdir.root_transport.base
2320
1728
        # but this does not quite work yet -- mbp 20080522
2327
1735
        Branch.__init__(self)
2328
1736
 
2329
1737
    def __str__(self):
2330
 
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2332
 
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
1738
        return '%s(%r)' % (self.__class__.__name__, self.base)
2335
1739
 
2336
1740
    __repr__ = __str__
2337
1741
 
2341
1745
 
2342
1746
    base = property(_get_base, doc="The URL for the root of this branch.")
2343
1747
 
2344
 
    def _get_config(self):
2345
 
        return TransportConfig(self._transport, 'branch.conf')
2346
 
 
2347
1748
    def is_locked(self):
2348
1749
        return self.control_files.is_locked()
2349
1750
 
2350
1751
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
 
        if not self.is_locked():
2358
 
            self._note_lock('w')
2359
 
        # All-in-one needs to always unlock/lock.
2360
 
        repo_control = getattr(self.repository, 'control_files', None)
2361
 
        if self.control_files == repo_control or not self.is_locked():
2362
 
            self.repository._warn_if_deprecated(self)
2363
 
            self.repository.lock_write()
2364
 
            took_lock = True
2365
 
        else:
2366
 
            took_lock = False
 
1752
        repo_token = self.repository.lock_write()
2367
1753
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
1754
            token = self.control_files.lock_write(token=token)
2370
1755
        except:
2371
 
            if took_lock:
2372
 
                self.repository.unlock()
 
1756
            self.repository.unlock()
2373
1757
            raise
 
1758
        return token
2374
1759
 
2375
1760
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
 
        if not self.is_locked():
2382
 
            self._note_lock('r')
2383
 
        # All-in-one needs to always unlock/lock.
2384
 
        repo_control = getattr(self.repository, 'control_files', None)
2385
 
        if self.control_files == repo_control or not self.is_locked():
2386
 
            self.repository._warn_if_deprecated(self)
2387
 
            self.repository.lock_read()
2388
 
            took_lock = True
2389
 
        else:
2390
 
            took_lock = False
 
1761
        self.repository.lock_read()
2391
1762
        try:
2392
1763
            self.control_files.lock_read()
2393
 
            return self
2394
1764
        except:
2395
 
            if took_lock:
2396
 
                self.repository.unlock()
 
1765
            self.repository.unlock()
2397
1766
            raise
2398
1767
 
2399
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1768
    def unlock(self):
 
1769
        # TODO: test for failed two phase locks. This is known broken.
2401
1770
        try:
2402
1771
            self.control_files.unlock()
2403
1772
        finally:
2404
 
            # All-in-one needs to always unlock/lock.
2405
 
            repo_control = getattr(self.repository, 'control_files', None)
2406
 
            if (self.control_files == repo_control or
2407
 
                not self.control_files.is_locked()):
2408
 
                self.repository.unlock()
2409
 
            if not self.control_files.is_locked():
2410
 
                # we just released the lock
2411
 
                self._clear_cached_state()
2412
 
 
 
1773
            self.repository.unlock()
 
1774
        if not self.control_files.is_locked():
 
1775
            # we just released the lock
 
1776
            self._clear_cached_state()
 
1777
        
2413
1778
    def peek_lock_mode(self):
2414
1779
        if self.control_files._lock_count == 0:
2415
1780
            return None
2495
1860
        for this revision id.
2496
1861
 
2497
1862
        It may be possible to set the branch last revision to an id not
2498
 
        present in the repository.  However, branches can also be
 
1863
        present in the repository.  However, branches can also be 
2499
1864
        configured to check constraints on history, in which case this may not
2500
1865
        be permitted.
2501
1866
        """
2533
1898
        """See Branch.basis_tree."""
2534
1899
        return self.repository.revision_tree(self.last_revision())
2535
1900
 
 
1901
    @needs_write_lock
 
1902
    def pull(self, source, overwrite=False, stop_revision=None,
 
1903
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1904
             _override_hook_target=None):
 
1905
        """See Branch.pull.
 
1906
 
 
1907
        :param _hook_master: Private parameter - set the branch to 
 
1908
            be supplied as the master to pull hooks.
 
1909
        :param run_hooks: Private parameter - if false, this branch
 
1910
            is being called because it's the master of the primary branch,
 
1911
            so it should not run its hooks.
 
1912
        :param _override_hook_target: Private parameter - set the branch to be
 
1913
            supplied as the target_branch to pull hooks.
 
1914
        """
 
1915
        result = PullResult()
 
1916
        result.source_branch = source
 
1917
        if _override_hook_target is None:
 
1918
            result.target_branch = self
 
1919
        else:
 
1920
            result.target_branch = _override_hook_target
 
1921
        source.lock_read()
 
1922
        try:
 
1923
            # We assume that during 'pull' the local repository is closer than
 
1924
            # the remote one.
 
1925
            graph = self.repository.get_graph(source.repository)
 
1926
            result.old_revno, result.old_revid = self.last_revision_info()
 
1927
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1928
                                  graph=graph)
 
1929
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1930
            result.new_revno, result.new_revid = self.last_revision_info()
 
1931
            if _hook_master:
 
1932
                result.master_branch = _hook_master
 
1933
                result.local_branch = result.target_branch
 
1934
            else:
 
1935
                result.master_branch = result.target_branch
 
1936
                result.local_branch = None
 
1937
            if run_hooks:
 
1938
                for hook in Branch.hooks['post_pull']:
 
1939
                    hook(result)
 
1940
        finally:
 
1941
            source.unlock()
 
1942
        return result
 
1943
 
2536
1944
    def _get_parent_location(self):
2537
1945
        _locs = ['parent', 'pull', 'x-pull']
2538
1946
        for l in _locs:
2542
1950
                pass
2543
1951
        return None
2544
1952
 
 
1953
    @needs_read_lock
 
1954
    def push(self, target, overwrite=False, stop_revision=None,
 
1955
             _override_hook_source_branch=None):
 
1956
        """See Branch.push.
 
1957
 
 
1958
        This is the basic concrete implementation of push()
 
1959
 
 
1960
        :param _override_hook_source_branch: If specified, run
 
1961
        the hooks passing this Branch as the source, rather than self.  
 
1962
        This is for use of RemoteBranch, where push is delegated to the
 
1963
        underlying vfs-based Branch. 
 
1964
        """
 
1965
        # TODO: Public option to disable running hooks - should be trivial but
 
1966
        # needs tests.
 
1967
        return _run_with_write_locked_target(
 
1968
            target, self._push_with_bound_branches, target, overwrite,
 
1969
            stop_revision,
 
1970
            _override_hook_source_branch=_override_hook_source_branch)
 
1971
 
 
1972
    def _push_with_bound_branches(self, target, overwrite,
 
1973
            stop_revision,
 
1974
            _override_hook_source_branch=None):
 
1975
        """Push from self into target, and into target's master if any.
 
1976
        
 
1977
        This is on the base BzrBranch class even though it doesn't support 
 
1978
        bound branches because the *target* might be bound.
 
1979
        """
 
1980
        def _run_hooks():
 
1981
            if _override_hook_source_branch:
 
1982
                result.source_branch = _override_hook_source_branch
 
1983
            for hook in Branch.hooks['post_push']:
 
1984
                hook(result)
 
1985
 
 
1986
        bound_location = target.get_bound_location()
 
1987
        if bound_location and target.base != bound_location:
 
1988
            # there is a master branch.
 
1989
            #
 
1990
            # XXX: Why the second check?  Is it even supported for a branch to
 
1991
            # be bound to itself? -- mbp 20070507
 
1992
            master_branch = target.get_master_branch()
 
1993
            master_branch.lock_write()
 
1994
            try:
 
1995
                # push into the master from this branch.
 
1996
                self._basic_push(master_branch, overwrite, stop_revision)
 
1997
                # and push into the target branch from this. Note that we push from
 
1998
                # this branch again, because its considered the highest bandwidth
 
1999
                # repository.
 
2000
                result = self._basic_push(target, overwrite, stop_revision)
 
2001
                result.master_branch = master_branch
 
2002
                result.local_branch = target
 
2003
                _run_hooks()
 
2004
                return result
 
2005
            finally:
 
2006
                master_branch.unlock()
 
2007
        else:
 
2008
            # no master branch
 
2009
            result = self._basic_push(target, overwrite, stop_revision)
 
2010
            # TODO: Why set master_branch and local_branch if there's no
 
2011
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2012
            # 20070504
 
2013
            result.master_branch = target
 
2014
            result.local_branch = None
 
2015
            _run_hooks()
 
2016
            return result
 
2017
 
2545
2018
    def _basic_push(self, target, overwrite, stop_revision):
2546
2019
        """Basic implementation of push without bound branches or hooks.
2547
2020
 
2548
 
        Must be called with source read locked and target write locked.
 
2021
        Must be called with self read locked and target write locked.
2549
2022
        """
2550
 
        result = BranchPushResult()
 
2023
        result = PushResult()
2551
2024
        result.source_branch = self
2552
2025
        result.target_branch = target
2553
2026
        result.old_revno, result.old_revid = target.last_revision_info()
2554
 
        self.update_references(target)
2555
2027
        if result.old_revid != self.last_revision():
2556
2028
            # We assume that during 'push' this repository is closer than
2557
2029
            # the target.
2558
2030
            graph = self.repository.get_graph(target.repository)
2559
 
            target.update_revisions(self, stop_revision,
2560
 
                overwrite=overwrite, graph=graph)
 
2031
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2032
                                    graph=graph)
2561
2033
        if self._push_should_merge_tags():
2562
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2563
 
                overwrite)
 
2034
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
2035
        result.new_revno, result.new_revid = target.last_revision_info()
2565
2036
        return result
2566
2037
 
 
2038
    def _push_should_merge_tags(self):
 
2039
        """Should _basic_push merge this branch's tags into the target?
 
2040
        
 
2041
        The default implementation returns False if this branch has no tags,
 
2042
        and True the rest of the time.  Subclasses may override this.
 
2043
        """
 
2044
        return self.tags.supports_tags() and self.tags.get_tag_dict()
 
2045
 
 
2046
    def get_parent(self):
 
2047
        """See Branch.get_parent."""
 
2048
        parent = self._get_parent_location()
 
2049
        if parent is None:
 
2050
            return parent
 
2051
        # This is an old-format absolute path to a local branch
 
2052
        # turn it into a url
 
2053
        if parent.startswith('/'):
 
2054
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
2055
        try:
 
2056
            return urlutils.join(self.base[:-1], parent)
 
2057
        except errors.InvalidURLJoin, e:
 
2058
            raise errors.InaccessibleParent(parent, self.base)
 
2059
 
2567
2060
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2061
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2062
 
2570
2063
    def set_push_location(self, location):
2571
2064
        """See Branch.set_push_location."""
2573
2066
            'push_location', location,
2574
2067
            store=_mod_config.STORE_LOCATION_NORECURSE)
2575
2068
 
 
2069
    @needs_write_lock
 
2070
    def set_parent(self, url):
 
2071
        """See Branch.set_parent."""
 
2072
        # TODO: Maybe delete old location files?
 
2073
        # URLs should never be unicode, even on the local fs,
 
2074
        # FIXUP this and get_parent in a future branch format bump:
 
2075
        # read and rewrite the file. RBC 20060125
 
2076
        if url is not None:
 
2077
            if isinstance(url, unicode):
 
2078
                try:
 
2079
                    url = url.encode('ascii')
 
2080
                except UnicodeEncodeError:
 
2081
                    raise errors.InvalidURL(url,
 
2082
                        "Urls must be 7-bit ascii, "
 
2083
                        "use bzrlib.urlutils.escape")
 
2084
            url = urlutils.relative_url(self.base, url)
 
2085
        self._set_parent_location(url)
 
2086
 
2576
2087
    def _set_parent_location(self, url):
2577
2088
        if url is None:
2578
2089
            self._transport.delete('parent')
2580
2091
            self._transport.put_bytes('parent', url + '\n',
2581
2092
                mode=self.bzrdir._get_file_mode())
2582
2093
 
 
2094
    def set_stacked_on_url(self, url):
 
2095
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2096
 
2583
2097
 
2584
2098
class BzrBranch5(BzrBranch):
2585
2099
    """A format 5 branch. This supports new features over plain branches.
2587
2101
    It has support for a master_branch which is the data for bound branches.
2588
2102
    """
2589
2103
 
 
2104
    @needs_write_lock
 
2105
    def pull(self, source, overwrite=False, stop_revision=None,
 
2106
             run_hooks=True, possible_transports=None,
 
2107
             _override_hook_target=None):
 
2108
        """Pull from source into self, updating my master if any.
 
2109
        
 
2110
        :param run_hooks: Private parameter - if false, this branch
 
2111
            is being called because it's the master of the primary branch,
 
2112
            so it should not run its hooks.
 
2113
        """
 
2114
        bound_location = self.get_bound_location()
 
2115
        master_branch = None
 
2116
        if bound_location and source.base != bound_location:
 
2117
            # not pulling from master, so we need to update master.
 
2118
            master_branch = self.get_master_branch(possible_transports)
 
2119
            master_branch.lock_write()
 
2120
        try:
 
2121
            if master_branch:
 
2122
                # pull from source into master.
 
2123
                master_branch.pull(source, overwrite, stop_revision,
 
2124
                    run_hooks=False)
 
2125
            return super(BzrBranch5, self).pull(source, overwrite,
 
2126
                stop_revision, _hook_master=master_branch,
 
2127
                run_hooks=run_hooks,
 
2128
                _override_hook_target=_override_hook_target)
 
2129
        finally:
 
2130
            if master_branch:
 
2131
                master_branch.unlock()
 
2132
 
2590
2133
    def get_bound_location(self):
2591
2134
        try:
2592
2135
            return self._transport.get_bytes('bound')[:-1]
2596
2139
    @needs_read_lock
2597
2140
    def get_master_branch(self, possible_transports=None):
2598
2141
        """Return the branch we are bound to.
2599
 
 
 
2142
        
2600
2143
        :return: Either a Branch, or None
2601
2144
 
2602
2145
        This could memoise the branch, but if thats done
2638
2181
        check for divergence to raise an error when the branches are not
2639
2182
        either the same, or one a prefix of the other. That behaviour may not
2640
2183
        be useful, so that check may be removed in future.
2641
 
 
 
2184
        
2642
2185
        :param other: The branch to bind to
2643
2186
        :type other: Branch
2644
2187
        """
2663
2206
 
2664
2207
    @needs_write_lock
2665
2208
    def update(self, possible_transports=None):
2666
 
        """Synchronise this branch with the master branch if any.
 
2209
        """Synchronise this branch with the master branch if any. 
2667
2210
 
2668
2211
        :return: None or the last_revision that was pivoted out during the
2669
2212
                 update.
2679
2222
        return None
2680
2223
 
2681
2224
 
2682
 
class BzrBranch8(BzrBranch5):
2683
 
    """A branch that stores tree-reference locations."""
 
2225
class BzrBranch7(BzrBranch5):
 
2226
    """A branch with support for a fallback repository."""
 
2227
 
 
2228
    def _get_fallback_repository(self, url):
 
2229
        """Get the repository we fallback to at url."""
 
2230
        url = urlutils.join(self.base, url)
 
2231
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2232
                                      possible_transports=[self._transport])
 
2233
        return a_bzrdir.open_branch().repository
 
2234
 
 
2235
    def _activate_fallback_location(self, url):
 
2236
        """Activate the branch/repository from url as a fallback repository."""
 
2237
        self.repository.add_fallback_repository(
 
2238
            self._get_fallback_repository(url))
2684
2239
 
2685
2240
    def _open_hook(self):
2686
 
        if self._ignore_fallbacks:
2687
 
            return
2688
2241
        try:
2689
2242
            url = self.get_stacked_on_url()
2690
2243
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2700
2253
                        "None, not a URL." % hook_name)
2701
2254
            self._activate_fallback_location(url)
2702
2255
 
 
2256
    def _check_stackable_repo(self):
 
2257
        if not self.repository._format.supports_external_lookups:
 
2258
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2259
                self.repository.base)
 
2260
 
2703
2261
    def __init__(self, *args, **kwargs):
2704
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2262
        super(BzrBranch7, self).__init__(*args, **kwargs)
2706
2263
        self._last_revision_info_cache = None
2707
 
        self._reference_info = None
 
2264
        self._partial_revision_history_cache = []
2708
2265
 
2709
2266
    def _clear_cached_state(self):
2710
 
        super(BzrBranch8, self)._clear_cached_state()
 
2267
        super(BzrBranch7, self)._clear_cached_state()
2711
2268
        self._last_revision_info_cache = None
2712
 
        self._reference_info = None
 
2269
        self._partial_revision_history_cache = []
2713
2270
 
2714
2271
    def _last_revision_info(self):
2715
2272
        revision_string = self._transport.get_bytes('last-revision')
2746
2303
 
2747
2304
    def _synchronize_history(self, destination, revision_id):
2748
2305
        """Synchronize last revision and revision history between branches.
2749
 
 
 
2306
        
2750
2307
        :see: Branch._synchronize_history
2751
2308
        """
2752
2309
        # XXX: The base Branch has a fast implementation of this method based
2761
2318
        if _mod_revision.is_null(last_revision):
2762
2319
            return
2763
2320
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2321
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2322
 
2766
2323
    def _gen_revision_history(self):
2767
2324
        """Generate the revision history from last revision
2770
2327
        self._extend_partial_history(stop_index=last_revno-1)
2771
2328
        return list(reversed(self._partial_revision_history_cache))
2772
2329
 
 
2330
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2331
        """Extend the partial history to include a given index
 
2332
 
 
2333
        If a stop_index is supplied, stop when that index has been reached.
 
2334
        If a stop_revision is supplied, stop when that revision is
 
2335
        encountered.  Otherwise, stop when the beginning of history is
 
2336
        reached.
 
2337
 
 
2338
        :param stop_index: The index which should be present.  When it is
 
2339
            present, history extension will stop.
 
2340
        :param revision_id: The revision id which should be present.  When
 
2341
            it is encountered, history extension will stop.
 
2342
        """
 
2343
        repo = self.repository
 
2344
        if len(self._partial_revision_history_cache) == 0:
 
2345
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2346
        else:
 
2347
            start_revision = self._partial_revision_history_cache[-1]
 
2348
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2349
            #skip the last revision in the list
 
2350
            next_revision = iterator.next()
 
2351
        for revision_id in iterator:
 
2352
            self._partial_revision_history_cache.append(revision_id)
 
2353
            if (stop_index is not None and
 
2354
                len(self._partial_revision_history_cache) > stop_index):
 
2355
                break
 
2356
            if revision_id == stop_revision:
 
2357
                break
 
2358
 
2773
2359
    def _write_revision_history(self, history):
2774
2360
        """Factored out of set_revision_history.
2775
2361
 
2796
2382
        """Set the parent branch"""
2797
2383
        return self._get_config_location('parent_location')
2798
2384
 
2799
 
    @needs_write_lock
2800
 
    def _set_all_reference_info(self, info_dict):
2801
 
        """Replace all reference info stored in a branch.
2802
 
 
2803
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2804
 
        """
2805
 
        s = StringIO()
2806
 
        writer = rio.RioWriter(s)
2807
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2808
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
 
                                branch_location=branch_location)
2810
 
            writer.write_stanza(stanza)
2811
 
        self._transport.put_bytes('references', s.getvalue())
2812
 
        self._reference_info = info_dict
2813
 
 
2814
 
    @needs_read_lock
2815
 
    def _get_all_reference_info(self):
2816
 
        """Return all the reference info stored in a branch.
2817
 
 
2818
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2819
 
        """
2820
 
        if self._reference_info is not None:
2821
 
            return self._reference_info
2822
 
        rio_file = self._transport.get('references')
2823
 
        try:
2824
 
            stanzas = rio.read_stanzas(rio_file)
2825
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2826
 
                             s['branch_location'])) for s in stanzas)
2827
 
        finally:
2828
 
            rio_file.close()
2829
 
        self._reference_info = info_dict
2830
 
        return info_dict
2831
 
 
2832
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2833
 
        """Set the branch location to use for a tree reference.
2834
 
 
2835
 
        :param file_id: The file-id of the tree reference.
2836
 
        :param tree_path: The path of the tree reference in the tree.
2837
 
        :param branch_location: The location of the branch to retrieve tree
2838
 
            references from.
2839
 
        """
2840
 
        info_dict = self._get_all_reference_info()
2841
 
        info_dict[file_id] = (tree_path, branch_location)
2842
 
        if None in (tree_path, branch_location):
2843
 
            if tree_path is not None:
2844
 
                raise ValueError('tree_path must be None when branch_location'
2845
 
                                 ' is None.')
2846
 
            if branch_location is not None:
2847
 
                raise ValueError('branch_location must be None when tree_path'
2848
 
                                 ' is None.')
2849
 
            del info_dict[file_id]
2850
 
        self._set_all_reference_info(info_dict)
2851
 
 
2852
 
    def get_reference_info(self, file_id):
2853
 
        """Get the tree_path and branch_location for a tree reference.
2854
 
 
2855
 
        :return: a tuple of (tree_path, branch_location)
2856
 
        """
2857
 
        return self._get_all_reference_info().get(file_id, (None, None))
2858
 
 
2859
 
    def reference_parent(self, file_id, path, possible_transports=None):
2860
 
        """Return the parent branch for a tree-reference file_id.
2861
 
 
2862
 
        :param file_id: The file_id of the tree reference
2863
 
        :param path: The path of the file_id in the tree
2864
 
        :return: A branch associated with the file_id
2865
 
        """
2866
 
        branch_location = self.get_reference_info(file_id)[1]
2867
 
        if branch_location is None:
2868
 
            return Branch.reference_parent(self, file_id, path,
2869
 
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
2871
 
        return Branch.open(branch_location,
2872
 
                           possible_transports=possible_transports)
2873
 
 
2874
2385
    def set_push_location(self, location):
2875
2386
        """See Branch.set_push_location."""
2876
2387
        self._set_config_location('push_location', location)
2918
2429
            raise errors.NotStacked(self)
2919
2430
        return stacked_url
2920
2431
 
 
2432
    def set_append_revisions_only(self, enabled):
 
2433
        if enabled:
 
2434
            value = 'True'
 
2435
        else:
 
2436
            value = 'False'
 
2437
        self.get_config().set_user_option('append_revisions_only', value,
 
2438
            warn_masked=True)
 
2439
 
 
2440
    def set_stacked_on_url(self, url):
 
2441
        self._check_stackable_repo()
 
2442
        if not url:
 
2443
            try:
 
2444
                old_url = self.get_stacked_on_url()
 
2445
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2446
                errors.UnstackableRepositoryFormat):
 
2447
                return
 
2448
            url = ''
 
2449
            # repositories don't offer an interface to remove fallback
 
2450
            # repositories today; take the conceptually simpler option and just
 
2451
            # reopen it.
 
2452
            self.repository = self.bzrdir.find_repository()
 
2453
            # for every revision reference the branch has, ensure it is pulled
 
2454
            # in.
 
2455
            source_repository = self._get_fallback_repository(old_url)
 
2456
            for revision_id in chain([self.last_revision()],
 
2457
                self.tags.get_reverse_tag_dict()):
 
2458
                self.repository.fetch(source_repository, revision_id,
 
2459
                    find_ghosts=True)
 
2460
        else:
 
2461
            self._activate_fallback_location(url)
 
2462
        # write this out after the repository is stacked to avoid setting a
 
2463
        # stacked config that doesn't work.
 
2464
        self._set_config_location('stacked_on_location', url)
 
2465
 
2921
2466
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2467
        value = self.get_config().get_user_option('append_revisions_only')
 
2468
        return value == 'True'
 
2469
 
 
2470
    def _make_tags(self):
 
2471
        return BasicTags(self)
2924
2472
 
2925
2473
    @needs_write_lock
2926
2474
    def generate_revision_history(self, revision_id, last_rev=None,
2966
2514
        return self.revno() - index
2967
2515
 
2968
2516
 
2969
 
class BzrBranch7(BzrBranch8):
2970
 
    """A branch with support for a fallback repository."""
2971
 
 
2972
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2973
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2974
 
 
2975
 
    def get_reference_info(self, file_id):
2976
 
        Branch.get_reference_info(self, file_id)
2977
 
 
2978
 
    def reference_parent(self, file_id, path, possible_transports=None):
2979
 
        return Branch.reference_parent(self, file_id, path,
2980
 
                                       possible_transports)
2981
 
 
2982
 
 
2983
2517
class BzrBranch6(BzrBranch7):
2984
2518
    """See BzrBranchFormat6 for the capabilities of this branch.
2985
2519
 
2988
2522
    """
2989
2523
 
2990
2524
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2525
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2526
 
 
2527
    def set_stacked_on_url(self, url):
 
2528
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2529
 
2993
2530
 
2994
2531
######################################################################
3012
2549
    :ivar new_revno: Revision number after pull.
3013
2550
    :ivar old_revid: Tip revision id before pull.
3014
2551
    :ivar new_revid: Tip revision id after pull.
3015
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2552
    :ivar source_branch: Source (local) branch object.
3016
2553
    :ivar master_branch: Master branch of the target, or the target if no
3017
2554
        Master
3018
2555
    :ivar local_branch: target branch if there is a Master, else None
3019
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2556
    :ivar target_branch: Target/destination branch object.
3020
2557
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3021
2558
    """
3022
2559
 
3033
2570
        self._show_tag_conficts(to_file)
3034
2571
 
3035
2572
 
3036
 
class BranchPushResult(_Result):
 
2573
class PushResult(_Result):
3037
2574
    """Result of a Branch.push operation.
3038
2575
 
3039
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
3040
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
3041
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3042
 
        before the push.
3043
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3044
 
        after the push.
3045
 
    :ivar source_branch: Source branch object that the push was from. This is
3046
 
        read locked, and generally is a local (and thus low latency) branch.
3047
 
    :ivar master_branch: If target is a bound branch, the master branch of
3048
 
        target, or target itself. Always write locked.
3049
 
    :ivar target_branch: The direct Branch where data is being sent (write
3050
 
        locked).
3051
 
    :ivar local_branch: If the target is a bound branch this will be the
3052
 
        target, otherwise it will be None.
 
2576
    :ivar old_revno: Revision number before push.
 
2577
    :ivar new_revno: Revision number after push.
 
2578
    :ivar old_revid: Tip revision id before push.
 
2579
    :ivar new_revid: Tip revision id after push.
 
2580
    :ivar source_branch: Source branch object.
 
2581
    :ivar master_branch: Master branch of the target, or None.
 
2582
    :ivar target_branch: Target/destination branch object.
3053
2583
    """
3054
2584
 
3055
2585
    def __int__(self):
3059
2589
    def report(self, to_file):
3060
2590
        """Write a human-readable description of the result."""
3061
2591
        if self.old_revid == self.new_revid:
3062
 
            note('No new revisions to push.')
 
2592
            to_file.write('No new revisions to push.\n')
3063
2593
        else:
3064
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2594
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3065
2595
        self._show_tag_conficts(to_file)
3066
2596
 
3067
2597
 
3073
2603
 
3074
2604
    def __init__(self, branch):
3075
2605
        self.branch = branch
3076
 
        self.errors = []
3077
2606
 
3078
2607
    def report_results(self, verbose):
3079
2608
        """Report the check results via trace.note.
3080
 
 
 
2609
        
3081
2610
        :param verbose: Requests more detailed display of what was checked,
3082
2611
            if any.
3083
2612
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
3085
 
            self.branch._format)
3086
 
        for error in self.errors:
3087
 
            note('found error:%s', error)
 
2613
        note('checked branch %s format %s',
 
2614
             self.branch.base,
 
2615
             self.branch._format)
3088
2616
 
3089
2617
 
3090
2618
class Converter5to6(object):
3128
2656
        branch._transport.put_bytes('format', format.get_format_string())
3129
2657
 
3130
2658
 
3131
 
class Converter7to8(object):
3132
 
    """Perform an in-place upgrade of format 6 to format 7"""
3133
 
 
3134
 
    def convert(self, branch):
3135
 
        format = BzrBranchFormat8()
3136
 
        branch._transport.put_bytes('references', '')
3137
 
        # update target format
3138
 
        branch._transport.put_bytes('format', format.get_format_string())
3139
 
 
3140
2659
 
3141
2660
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3142
2661
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3153
2672
            return callable(*args, **kwargs)
3154
2673
        finally:
3155
2674
            target.unlock()
3156
 
 
 
2675
    
3157
2676
    """
3158
2677
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3159
2678
    # should share code?
3169
2688
    else:
3170
2689
        target.unlock()
3171
2690
        return result
3172
 
 
3173
 
 
3174
 
class InterBranch(InterObject):
3175
 
    """This class represents operations taking place between two branches.
3176
 
 
3177
 
    Its instances have methods like pull() and push() and contain
3178
 
    references to the source and target repositories these operations
3179
 
    can be carried out on.
3180
 
    """
3181
 
 
3182
 
    _optimisers = []
3183
 
    """The available optimised InterBranch types."""
3184
 
 
3185
 
    @staticmethod
3186
 
    def _get_branch_formats_to_test():
3187
 
        """Return a tuple with the Branch formats to use when testing."""
3188
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3189
 
 
3190
 
    def pull(self, overwrite=False, stop_revision=None,
3191
 
             possible_transports=None, local=False):
3192
 
        """Mirror source into target branch.
3193
 
 
3194
 
        The target branch is considered to be 'local', having low latency.
3195
 
 
3196
 
        :returns: PullResult instance
3197
 
        """
3198
 
        raise NotImplementedError(self.pull)
3199
 
 
3200
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3201
 
                         graph=None):
3202
 
        """Pull in new perfect-fit revisions.
3203
 
 
3204
 
        :param stop_revision: Updated until the given revision
3205
 
        :param overwrite: Always set the branch pointer, rather than checking
3206
 
            to see if it is a proper descendant.
3207
 
        :param graph: A Graph object that can be used to query history
3208
 
            information. This can be None.
3209
 
        :return: None
3210
 
        """
3211
 
        raise NotImplementedError(self.update_revisions)
3212
 
 
3213
 
    def push(self, overwrite=False, stop_revision=None,
3214
 
             _override_hook_source_branch=None):
3215
 
        """Mirror the source branch into the target branch.
3216
 
 
3217
 
        The source branch is considered to be 'local', having low latency.
3218
 
        """
3219
 
        raise NotImplementedError(self.push)
3220
 
 
3221
 
 
3222
 
class GenericInterBranch(InterBranch):
3223
 
    """InterBranch implementation that uses public Branch functions.
3224
 
    """
3225
 
 
3226
 
    @staticmethod
3227
 
    def _get_branch_formats_to_test():
3228
 
        return BranchFormat._default_format, BranchFormat._default_format
3229
 
 
3230
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3231
 
        graph=None):
3232
 
        """See InterBranch.update_revisions()."""
3233
 
        self.source.lock_read()
3234
 
        try:
3235
 
            other_revno, other_last_revision = self.source.last_revision_info()
3236
 
            stop_revno = None # unknown
3237
 
            if stop_revision is None:
3238
 
                stop_revision = other_last_revision
3239
 
                if _mod_revision.is_null(stop_revision):
3240
 
                    # if there are no commits, we're done.
3241
 
                    return
3242
 
                stop_revno = other_revno
3243
 
 
3244
 
            # what's the current last revision, before we fetch [and change it
3245
 
            # possibly]
3246
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3247
 
            # we fetch here so that we don't process data twice in the common
3248
 
            # case of having something to pull, and so that the check for
3249
 
            # already merged can operate on the just fetched graph, which will
3250
 
            # be cached in memory.
3251
 
            self.target.fetch(self.source, stop_revision)
3252
 
            # Check to see if one is an ancestor of the other
3253
 
            if not overwrite:
3254
 
                if graph is None:
3255
 
                    graph = self.target.repository.get_graph()
3256
 
                if self.target._check_if_descendant_or_diverged(
3257
 
                        stop_revision, last_rev, graph, self.source):
3258
 
                    # stop_revision is a descendant of last_rev, but we aren't
3259
 
                    # overwriting, so we're done.
3260
 
                    return
3261
 
            if stop_revno is None:
3262
 
                if graph is None:
3263
 
                    graph = self.target.repository.get_graph()
3264
 
                this_revno, this_last_revision = \
3265
 
                        self.target.last_revision_info()
3266
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3267
 
                                [(other_last_revision, other_revno),
3268
 
                                 (this_last_revision, this_revno)])
3269
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3270
 
        finally:
3271
 
            self.source.unlock()
3272
 
 
3273
 
    def pull(self, overwrite=False, stop_revision=None,
3274
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3275
 
             _override_hook_target=None, local=False):
3276
 
        """See Branch.pull.
3277
 
 
3278
 
        :param _hook_master: Private parameter - set the branch to
3279
 
            be supplied as the master to pull hooks.
3280
 
        :param run_hooks: Private parameter - if false, this branch
3281
 
            is being called because it's the master of the primary branch,
3282
 
            so it should not run its hooks.
3283
 
        :param _override_hook_target: Private parameter - set the branch to be
3284
 
            supplied as the target_branch to pull hooks.
3285
 
        :param local: Only update the local branch, and not the bound branch.
3286
 
        """
3287
 
        # This type of branch can't be bound.
3288
 
        if local:
3289
 
            raise errors.LocalRequiresBoundBranch()
3290
 
        result = PullResult()
3291
 
        result.source_branch = self.source
3292
 
        if _override_hook_target is None:
3293
 
            result.target_branch = self.target
3294
 
        else:
3295
 
            result.target_branch = _override_hook_target
3296
 
        self.source.lock_read()
3297
 
        try:
3298
 
            # We assume that during 'pull' the target repository is closer than
3299
 
            # the source one.
3300
 
            self.source.update_references(self.target)
3301
 
            graph = self.target.repository.get_graph(self.source.repository)
3302
 
            # TODO: Branch formats should have a flag that indicates 
3303
 
            # that revno's are expensive, and pull() should honor that flag.
3304
 
            # -- JRV20090506
3305
 
            result.old_revno, result.old_revid = \
3306
 
                self.target.last_revision_info()
3307
 
            self.target.update_revisions(self.source, stop_revision,
3308
 
                overwrite=overwrite, graph=graph)
3309
 
            # TODO: The old revid should be specified when merging tags, 
3310
 
            # so a tags implementation that versions tags can only 
3311
 
            # pull in the most recent changes. -- JRV20090506
3312
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3313
 
                overwrite)
3314
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3315
 
            if _hook_master:
3316
 
                result.master_branch = _hook_master
3317
 
                result.local_branch = result.target_branch
3318
 
            else:
3319
 
                result.master_branch = result.target_branch
3320
 
                result.local_branch = None
3321
 
            if run_hooks:
3322
 
                for hook in Branch.hooks['post_pull']:
3323
 
                    hook(result)
3324
 
        finally:
3325
 
            self.source.unlock()
3326
 
        return result
3327
 
 
3328
 
    def push(self, overwrite=False, stop_revision=None,
3329
 
             _override_hook_source_branch=None):
3330
 
        """See InterBranch.push.
3331
 
 
3332
 
        This is the basic concrete implementation of push()
3333
 
 
3334
 
        :param _override_hook_source_branch: If specified, run
3335
 
        the hooks passing this Branch as the source, rather than self.
3336
 
        This is for use of RemoteBranch, where push is delegated to the
3337
 
        underlying vfs-based Branch.
3338
 
        """
3339
 
        # TODO: Public option to disable running hooks - should be trivial but
3340
 
        # needs tests.
3341
 
        self.source.lock_read()
3342
 
        try:
3343
 
            return _run_with_write_locked_target(
3344
 
                self.target, self._push_with_bound_branches, overwrite,
3345
 
                stop_revision,
3346
 
                _override_hook_source_branch=_override_hook_source_branch)
3347
 
        finally:
3348
 
            self.source.unlock()
3349
 
 
3350
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3351
 
            _override_hook_source_branch=None):
3352
 
        """Push from source into target, and into target's master if any.
3353
 
        """
3354
 
        def _run_hooks():
3355
 
            if _override_hook_source_branch:
3356
 
                result.source_branch = _override_hook_source_branch
3357
 
            for hook in Branch.hooks['post_push']:
3358
 
                hook(result)
3359
 
 
3360
 
        bound_location = self.target.get_bound_location()
3361
 
        if bound_location and self.target.base != bound_location:
3362
 
            # there is a master branch.
3363
 
            #
3364
 
            # XXX: Why the second check?  Is it even supported for a branch to
3365
 
            # be bound to itself? -- mbp 20070507
3366
 
            master_branch = self.target.get_master_branch()
3367
 
            master_branch.lock_write()
3368
 
            try:
3369
 
                # push into the master from the source branch.
3370
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3371
 
                # and push into the target branch from the source. Note that we
3372
 
                # push from the source branch again, because its considered the
3373
 
                # highest bandwidth repository.
3374
 
                result = self.source._basic_push(self.target, overwrite,
3375
 
                    stop_revision)
3376
 
                result.master_branch = master_branch
3377
 
                result.local_branch = self.target
3378
 
                _run_hooks()
3379
 
                return result
3380
 
            finally:
3381
 
                master_branch.unlock()
3382
 
        else:
3383
 
            # no master branch
3384
 
            result = self.source._basic_push(self.target, overwrite,
3385
 
                stop_revision)
3386
 
            # TODO: Why set master_branch and local_branch if there's no
3387
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3388
 
            # 20070504
3389
 
            result.master_branch = self.target
3390
 
            result.local_branch = None
3391
 
            _run_hooks()
3392
 
            return result
3393
 
 
3394
 
    @classmethod
3395
 
    def is_compatible(self, source, target):
3396
 
        # GenericBranch uses the public API, so always compatible
3397
 
        return True
3398
 
 
3399
 
 
3400
 
class InterToBranch5(GenericInterBranch):
3401
 
 
3402
 
    @staticmethod
3403
 
    def _get_branch_formats_to_test():
3404
 
        return BranchFormat._default_format, BzrBranchFormat5()
3405
 
 
3406
 
    def pull(self, overwrite=False, stop_revision=None,
3407
 
             possible_transports=None, run_hooks=True,
3408
 
             _override_hook_target=None, local=False):
3409
 
        """Pull from source into self, updating my master if any.
3410
 
 
3411
 
        :param run_hooks: Private parameter - if false, this branch
3412
 
            is being called because it's the master of the primary branch,
3413
 
            so it should not run its hooks.
3414
 
        """
3415
 
        bound_location = self.target.get_bound_location()
3416
 
        if local and not bound_location:
3417
 
            raise errors.LocalRequiresBoundBranch()
3418
 
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
3420
 
            # not pulling from master, so we need to update master.
3421
 
            master_branch = self.target.get_master_branch(possible_transports)
3422
 
            master_branch.lock_write()
3423
 
        try:
3424
 
            if master_branch:
3425
 
                # pull from source into master.
3426
 
                master_branch.pull(self.source, overwrite, stop_revision,
3427
 
                    run_hooks=False)
3428
 
            return super(InterToBranch5, self).pull(overwrite,
3429
 
                stop_revision, _hook_master=master_branch,
3430
 
                run_hooks=run_hooks,
3431
 
                _override_hook_target=_override_hook_target)
3432
 
        finally:
3433
 
            if master_branch:
3434
 
                master_branch.unlock()
3435
 
 
3436
 
 
3437
 
InterBranch.register_optimiser(GenericInterBranch)
3438
 
InterBranch.register_optimiser(InterToBranch5)