~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-10 15:46:03 UTC
  • mfrom: (4985.3.21 update)
  • mto: This revision was merged to the branch mainline in revision 5021.
  • Revision ID: v.ladeuil+lp@free.fr-20100210154603-k4no1gvfuqpzrw7p
Update performs two merges in a more logical order but stop on conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
from cStringIO import StringIO
18
19
import sys
19
20
 
20
21
from bzrlib.lazy_import import lazy_import
30
31
        lockable_files,
31
32
        repository,
32
33
        revision as _mod_revision,
 
34
        rio,
 
35
        symbol_versioning,
33
36
        transport,
34
37
        tsort,
35
38
        ui,
36
39
        urlutils,
37
40
        )
38
 
from bzrlib.config import BranchConfig
 
41
from bzrlib.config import BranchConfig, TransportConfig
39
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
43
from bzrlib.tag import (
41
44
    BasicTags,
43
46
    )
44
47
""")
45
48
 
46
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
 
from bzrlib.hooks import Hooks
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.hooks import HookPoint, Hooks
 
51
from bzrlib.inter import InterObject
 
52
from bzrlib.lock import _RelockDebugMixin
 
53
from bzrlib import registry
48
54
from bzrlib.symbol_versioning import (
49
55
    deprecated_in,
50
56
    deprecated_method,
81
87
    # - RBC 20060112
82
88
    base = None
83
89
 
84
 
    # override this to set the strategy for storing tags
85
 
    def _make_tags(self):
86
 
        return DisabledTags(self)
87
 
 
88
90
    def __init__(self, *ignored, **ignored_too):
89
 
        self.tags = self._make_tags()
 
91
        self.tags = self._format.make_tags(self)
90
92
        self._revision_history_cache = None
91
93
        self._revision_id_to_revno_cache = None
92
94
        self._partial_revision_id_to_revno_cache = {}
 
95
        self._partial_revision_history_cache = []
93
96
        self._last_revision_info_cache = None
94
97
        self._merge_sorted_revisions_cache = None
95
98
        self._open_hook()
100
103
    def _open_hook(self):
101
104
        """Called by init to allow simpler extension of the base class."""
102
105
 
 
106
    def _activate_fallback_location(self, url):
 
107
        """Activate the branch/repository from url as a fallback repository."""
 
108
        repo = self._get_fallback_repository(url)
 
109
        if repo.has_same_location(self.repository):
 
110
            raise errors.UnstackableLocationError(self.base, url)
 
111
        self.repository.add_fallback_repository(repo)
 
112
 
103
113
    def break_lock(self):
104
114
        """Break a lock if one is present from another instance.
105
115
 
114
124
        if master is not None:
115
125
            master.break_lock()
116
126
 
 
127
    def _check_stackable_repo(self):
 
128
        if not self.repository._format.supports_external_lookups:
 
129
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
130
                self.repository.base)
 
131
 
 
132
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
133
        """Extend the partial history to include a given index
 
134
 
 
135
        If a stop_index is supplied, stop when that index has been reached.
 
136
        If a stop_revision is supplied, stop when that revision is
 
137
        encountered.  Otherwise, stop when the beginning of history is
 
138
        reached.
 
139
 
 
140
        :param stop_index: The index which should be present.  When it is
 
141
            present, history extension will stop.
 
142
        :param stop_revision: The revision id which should be present.  When
 
143
            it is encountered, history extension will stop.
 
144
        """
 
145
        if len(self._partial_revision_history_cache) == 0:
 
146
            self._partial_revision_history_cache = [self.last_revision()]
 
147
        repository._iter_for_revno(
 
148
            self.repository, self._partial_revision_history_cache,
 
149
            stop_index=stop_index, stop_revision=stop_revision)
 
150
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
151
            self._partial_revision_history_cache.pop()
 
152
 
 
153
    def _get_check_refs(self):
 
154
        """Get the references needed for check().
 
155
 
 
156
        See bzrlib.check.
 
157
        """
 
158
        revid = self.last_revision()
 
159
        return [('revision-existence', revid), ('lefthand-distance', revid)]
 
160
 
117
161
    @staticmethod
118
162
    def open(base, _unsupported=False, possible_transports=None):
119
163
        """Open the branch rooted at base.
134
178
    @staticmethod
135
179
    def open_containing(url, possible_transports=None):
136
180
        """Open an existing branch which contains url.
137
 
        
 
181
 
138
182
        This probes for a branch at url, and searches upwards from there.
139
183
 
140
184
        Basically we keep looking up until we find the control directory or
141
185
        run into the root.  If there isn't one, raises NotBranchError.
142
 
        If there is one and it is either an unrecognised format or an unsupported 
 
186
        If there is one and it is either an unrecognised format or an unsupported
143
187
        format, UnknownFormatError or UnsupportedFormatError are raised.
144
188
        If there is one, it is returned, along with the unused portion of url.
145
189
        """
147
191
                                                         possible_transports)
148
192
        return control.open_branch(), relpath
149
193
 
 
194
    def _push_should_merge_tags(self):
 
195
        """Should _basic_push merge this branch's tags into the target?
 
196
 
 
197
        The default implementation returns False if this branch has no tags,
 
198
        and True the rest of the time.  Subclasses may override this.
 
199
        """
 
200
        return self.supports_tags() and self.tags.get_tag_dict()
 
201
 
150
202
    def get_config(self):
151
203
        return BranchConfig(self)
152
204
 
 
205
    def _get_config(self):
 
206
        """Get the concrete config for just the config in this branch.
 
207
 
 
208
        This is not intended for client use; see Branch.get_config for the
 
209
        public API.
 
210
 
 
211
        Added in 1.14.
 
212
 
 
213
        :return: An object supporting get_option and set_option.
 
214
        """
 
215
        raise NotImplementedError(self._get_config)
 
216
 
 
217
    def _get_fallback_repository(self, url):
 
218
        """Get the repository we fallback to at url."""
 
219
        url = urlutils.join(self.base, url)
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
 
221
            possible_transports=[self.bzrdir.root_transport])
 
222
        return a_bzrdir.open_branch().repository
 
223
 
 
224
    def _get_tags_bytes(self):
 
225
        """Get the bytes of a serialised tags dict.
 
226
 
 
227
        Note that not all branches support tags, nor do all use the same tags
 
228
        logic: this method is specific to BasicTags. Other tag implementations
 
229
        may use the same method name and behave differently, safely, because
 
230
        of the double-dispatch via
 
231
        format.make_tags->tags_instance->get_tags_dict.
 
232
 
 
233
        :return: The bytes of the tags file.
 
234
        :seealso: Branch._set_tags_bytes.
 
235
        """
 
236
        return self._transport.get_bytes('tags')
 
237
 
153
238
    def _get_nick(self, local=False, possible_transports=None):
154
239
        config = self.get_config()
155
240
        # explicit overrides master, but don't look for master if local is True
174
259
    def is_locked(self):
175
260
        raise NotImplementedError(self.is_locked)
176
261
 
 
262
    def _lefthand_history(self, revision_id, last_rev=None,
 
263
                          other_branch=None):
 
264
        if 'evil' in debug.debug_flags:
 
265
            mutter_callsite(4, "_lefthand_history scales with history.")
 
266
        # stop_revision must be a descendant of last_revision
 
267
        graph = self.repository.get_graph()
 
268
        if last_rev is not None:
 
269
            if not graph.is_ancestor(last_rev, revision_id):
 
270
                # our previous tip is not merged into stop_revision
 
271
                raise errors.DivergedBranches(self, other_branch)
 
272
        # make a new revision history from the graph
 
273
        parents_map = graph.get_parent_map([revision_id])
 
274
        if revision_id not in parents_map:
 
275
            raise errors.NoSuchRevision(self, revision_id)
 
276
        current_rev_id = revision_id
 
277
        new_history = []
 
278
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
279
        # Do not include ghosts or graph origin in revision_history
 
280
        while (current_rev_id in parents_map and
 
281
               len(parents_map[current_rev_id]) > 0):
 
282
            check_not_reserved_id(current_rev_id)
 
283
            new_history.append(current_rev_id)
 
284
            current_rev_id = parents_map[current_rev_id][0]
 
285
            parents_map = graph.get_parent_map([current_rev_id])
 
286
        new_history.reverse()
 
287
        return new_history
 
288
 
177
289
    def lock_write(self):
178
290
        raise NotImplementedError(self.lock_write)
179
291
 
228
340
    @needs_read_lock
229
341
    def revision_id_to_dotted_revno(self, revision_id):
230
342
        """Given a revision id, return its dotted revno.
231
 
        
 
343
 
232
344
        :return: a tuple like (1,) or (400,1,3).
233
345
        """
234
346
        return self._do_revision_id_to_dotted_revno(revision_id)
335
447
        # start_revision_id.
336
448
        if self._merge_sorted_revisions_cache is None:
337
449
            last_revision = self.last_revision()
338
 
            graph = self.repository.get_graph()
339
 
            parent_map = dict(((key, value) for key, value in
340
 
                     graph.iter_ancestry([last_revision]) if value is not None))
341
 
            revision_graph = repository._strip_NULL_ghosts(parent_map)
342
 
            revs = tsort.merge_sort(revision_graph, last_revision, None,
343
 
                generate_revno=True)
344
 
            # Drop the sequence # before caching
345
 
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
346
 
 
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
 
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
454
                last_key)
347
455
        filtered = self._filter_merge_sorted_revisions(
348
456
            self._merge_sorted_revisions_cache, start_revision_id,
349
457
            stop_revision_id, stop_rule)
359
467
        """Iterate over an inclusive range of sorted revisions."""
360
468
        rev_iter = iter(merge_sorted_revisions)
361
469
        if start_revision_id is not None:
362
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
470
            for node in rev_iter:
 
471
                rev_id = node.key[-1]
363
472
                if rev_id != start_revision_id:
364
473
                    continue
365
474
                else:
366
475
                    # The decision to include the start or not
367
476
                    # depends on the stop_rule if a stop is provided
368
 
                    rev_iter = chain(
369
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
370
 
                        rev_iter)
 
477
                    # so pop this node back into the iterator
 
478
                    rev_iter = chain(iter([node]), rev_iter)
371
479
                    break
372
480
        if stop_revision_id is None:
373
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
374
 
                yield rev_id, depth, revno, end_of_merge
 
481
            # Yield everything
 
482
            for node in rev_iter:
 
483
                rev_id = node.key[-1]
 
484
                yield (rev_id, node.merge_depth, node.revno,
 
485
                       node.end_of_merge)
375
486
        elif stop_rule == 'exclude':
376
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
487
            for node in rev_iter:
 
488
                rev_id = node.key[-1]
377
489
                if rev_id == stop_revision_id:
378
490
                    return
379
 
                yield rev_id, depth, revno, end_of_merge
 
491
                yield (rev_id, node.merge_depth, node.revno,
 
492
                       node.end_of_merge)
380
493
        elif stop_rule == 'include':
381
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
382
 
                yield rev_id, depth, revno, end_of_merge
 
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)
383
498
                if rev_id == stop_revision_id:
384
499
                    return
385
500
        elif stop_rule == 'with-merges':
388
503
                left_parent = stop_rev.parent_ids[0]
389
504
            else:
390
505
                left_parent = _mod_revision.NULL_REVISION
391
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
506
            # left_parent is the actual revision we want to stop logging at,
 
507
            # since we want to show the merged revisions after the stop_rev too
 
508
            reached_stop_revision_id = False
 
509
            revision_id_whitelist = []
 
510
            for node in rev_iter:
 
511
                rev_id = node.key[-1]
392
512
                if rev_id == left_parent:
 
513
                    # reached the left parent after the stop_revision
393
514
                    return
394
 
                yield rev_id, depth, revno, end_of_merge
 
515
                if (not reached_stop_revision_id or
 
516
                        rev_id in revision_id_whitelist):
 
517
                    yield (rev_id, node.merge_depth, node.revno,
 
518
                       node.end_of_merge)
 
519
                    if reached_stop_revision_id or rev_id == stop_revision_id:
 
520
                        # only do the merged revs of rev_id from now on
 
521
                        rev = self.repository.get_revision(rev_id)
 
522
                        if rev.parent_ids:
 
523
                            reached_stop_revision_id = True
 
524
                            revision_id_whitelist.extend(rev.parent_ids)
395
525
        else:
396
526
            raise ValueError('invalid stop_rule %r' % stop_rule)
397
527
 
398
528
    def leave_lock_in_place(self):
399
529
        """Tell this branch object not to release the physical lock when this
400
530
        object is unlocked.
401
 
        
 
531
 
402
532
        If lock_write doesn't return a token, then this method is not supported.
403
533
        """
404
534
        self.control_files.leave_in_place()
419
549
        """
420
550
        raise errors.UpgradeRequired(self.base)
421
551
 
 
552
    def set_append_revisions_only(self, enabled):
 
553
        if not self._format.supports_set_append_revisions_only():
 
554
            raise errors.UpgradeRequired(self.base)
 
555
        if enabled:
 
556
            value = 'True'
 
557
        else:
 
558
            value = 'False'
 
559
        self.get_config().set_user_option('append_revisions_only', value,
 
560
            warn_masked=True)
 
561
 
 
562
    def set_reference_info(self, file_id, tree_path, branch_location):
 
563
        """Set the branch location to use for a tree reference."""
 
564
        raise errors.UnsupportedOperation(self.set_reference_info, self)
 
565
 
 
566
    def get_reference_info(self, file_id):
 
567
        """Get the tree_path and branch_location for a tree reference."""
 
568
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
569
 
422
570
    @needs_write_lock
423
571
    def fetch(self, from_branch, last_revision=None, pb=None):
424
572
        """Copy revisions from from_branch into this branch.
427
575
        :param last_revision: What revision to stop at (None for at the end
428
576
                              of the branch.
429
577
        :param pb: An optional progress bar to use.
430
 
 
431
 
        Returns the copied revision count and the failed revisions in a tuple:
432
 
        (copied, failures).
 
578
        :return: None
433
579
        """
434
580
        if self.base == from_branch.base:
435
581
            return (0, [])
436
 
        if pb is None:
437
 
            nested_pb = ui.ui_factory.nested_progress_bar()
438
 
            pb = nested_pb
439
 
        else:
440
 
            nested_pb = None
441
 
 
 
582
        if pb is not None:
 
583
            symbol_versioning.warn(
 
584
                symbol_versioning.deprecated_in((1, 14, 0))
 
585
                % "pb parameter to fetch()")
442
586
        from_branch.lock_read()
443
587
        try:
444
588
            if last_revision is None:
445
 
                pb.update('get source history')
446
589
                last_revision = from_branch.last_revision()
447
590
                last_revision = _mod_revision.ensure_null(last_revision)
448
591
            return self.repository.fetch(from_branch.repository,
449
592
                                         revision_id=last_revision,
450
 
                                         pb=nested_pb)
 
593
                                         pb=pb)
451
594
        finally:
452
 
            if nested_pb is not None:
453
 
                nested_pb.finished()
454
595
            from_branch.unlock()
455
596
 
456
597
    def get_bound_location(self):
460
601
        branch.
461
602
        """
462
603
        return None
463
 
    
 
604
 
464
605
    def get_old_bound_location(self):
465
606
        """Return the URL of the branch we used to be bound to
466
607
        """
467
608
        raise errors.UpgradeRequired(self.base)
468
609
 
469
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
470
 
                           timezone=None, committer=None, revprops=None, 
 
610
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
611
                           timezone=None, committer=None, revprops=None,
471
612
                           revision_id=None):
472
613
        """Obtain a CommitBuilder for this branch.
473
 
        
 
614
 
474
615
        :param parents: Revision ids of the parents of the new revision.
475
616
        :param config: Optional configuration to use.
476
617
        :param timestamp: Optional timestamp recorded for commit.
482
623
 
483
624
        if config is None:
484
625
            config = self.get_config()
485
 
        
 
626
 
486
627
        return self.repository.get_commit_builder(self, parents, config,
487
628
            timestamp, timezone, committer, revprops, revision_id)
488
629
 
489
630
    def get_master_branch(self, possible_transports=None):
490
631
        """Return the branch we are bound to.
491
 
        
 
632
 
492
633
        :return: Either a Branch, or None
493
634
        """
494
635
        return None
520
661
    def set_revision_history(self, rev_history):
521
662
        raise NotImplementedError(self.set_revision_history)
522
663
 
 
664
    @needs_write_lock
 
665
    def set_parent(self, url):
 
666
        """See Branch.set_parent."""
 
667
        # TODO: Maybe delete old location files?
 
668
        # URLs should never be unicode, even on the local fs,
 
669
        # FIXUP this and get_parent in a future branch format bump:
 
670
        # read and rewrite the file. RBC 20060125
 
671
        if url is not None:
 
672
            if isinstance(url, unicode):
 
673
                try:
 
674
                    url = url.encode('ascii')
 
675
                except UnicodeEncodeError:
 
676
                    raise errors.InvalidURL(url,
 
677
                        "Urls must be 7-bit ascii, "
 
678
                        "use bzrlib.urlutils.escape")
 
679
            url = urlutils.relative_url(self.base, url)
 
680
        self._set_parent_location(url)
 
681
 
 
682
    @needs_write_lock
523
683
    def set_stacked_on_url(self, url):
524
684
        """Set the URL this branch is stacked against.
525
685
 
528
688
        :raises UnstackableRepositoryFormat: If the repository does not support
529
689
            stacking.
530
690
        """
531
 
        raise NotImplementedError(self.set_stacked_on_url)
 
691
        if not self._format.supports_stacking():
 
692
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
693
        # XXX: Changing from one fallback repository to another does not check
 
694
        # that all the data you need is present in the new fallback.
 
695
        # Possibly it should.
 
696
        self._check_stackable_repo()
 
697
        if not url:
 
698
            try:
 
699
                old_url = self.get_stacked_on_url()
 
700
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
701
                errors.UnstackableRepositoryFormat):
 
702
                return
 
703
            self._unstack()
 
704
        else:
 
705
            self._activate_fallback_location(url)
 
706
        # write this out after the repository is stacked to avoid setting a
 
707
        # stacked config that doesn't work.
 
708
        self._set_config_location('stacked_on_location', url)
 
709
 
 
710
    def _unstack(self):
 
711
        """Change a branch to be unstacked, copying data as needed.
 
712
        
 
713
        Don't call this directly, use set_stacked_on_url(None).
 
714
        """
 
715
        pb = ui.ui_factory.nested_progress_bar()
 
716
        try:
 
717
            pb.update("Unstacking")
 
718
            # The basic approach here is to fetch the tip of the branch,
 
719
            # including all available ghosts, from the existing stacked
 
720
            # repository into a new repository object without the fallbacks. 
 
721
            #
 
722
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
723
            # correct for CHKMap repostiories
 
724
            old_repository = self.repository
 
725
            if len(old_repository._fallback_repositories) != 1:
 
726
                raise AssertionError("can't cope with fallback repositories "
 
727
                    "of %r" % (self.repository,))
 
728
            # unlock it, including unlocking the fallback
 
729
            old_repository.unlock()
 
730
            old_repository.lock_read()
 
731
            try:
 
732
                # Repositories don't offer an interface to remove fallback
 
733
                # repositories today; take the conceptually simpler option and just
 
734
                # reopen it.  We reopen it starting from the URL so that we
 
735
                # get a separate connection for RemoteRepositories and can
 
736
                # stream from one of them to the other.  This does mean doing
 
737
                # separate SSH connection setup, but unstacking is not a
 
738
                # common operation so it's tolerable.
 
739
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
740
                new_repository = new_bzrdir.find_repository()
 
741
                self.repository = new_repository
 
742
                if self.repository._fallback_repositories:
 
743
                    raise AssertionError("didn't expect %r to have "
 
744
                        "fallback_repositories"
 
745
                        % (self.repository,))
 
746
                # this is not paired with an unlock because it's just restoring
 
747
                # the previous state; the lock's released when set_stacked_on_url
 
748
                # returns
 
749
                self.repository.lock_write()
 
750
                # XXX: If you unstack a branch while it has a working tree
 
751
                # with a pending merge, the pending-merged revisions will no
 
752
                # longer be present.  You can (probably) revert and remerge.
 
753
                #
 
754
                # XXX: This only fetches up to the tip of the repository; it
 
755
                # doesn't bring across any tags.  That's fairly consistent
 
756
                # with how branch works, but perhaps not ideal.
 
757
                self.repository.fetch(old_repository,
 
758
                    revision_id=self.last_revision(),
 
759
                    find_ghosts=True)
 
760
            finally:
 
761
                old_repository.unlock()
 
762
        finally:
 
763
            pb.finished()
 
764
 
 
765
    def _set_tags_bytes(self, bytes):
 
766
        """Mirror method for _get_tags_bytes.
 
767
 
 
768
        :seealso: Branch._get_tags_bytes.
 
769
        """
 
770
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
771
            'tags', bytes)
532
772
 
533
773
    def _cache_revision_history(self, rev_history):
534
774
        """Set the cached revision history to rev_history.
562
802
        self._revision_id_to_revno_cache = None
563
803
        self._last_revision_info_cache = None
564
804
        self._merge_sorted_revisions_cache = None
 
805
        self._partial_revision_history_cache = []
 
806
        self._partial_revision_id_to_revno_cache = {}
565
807
 
566
808
    def _gen_revision_history(self):
567
809
        """Return sequence of revision hashes on to this branch.
568
 
        
 
810
 
569
811
        Unlike revision_history, this method always regenerates or rereads the
570
812
        revision history, i.e. it does not cache the result, so repeated calls
571
813
        may be expensive.
572
814
 
573
815
        Concrete subclasses should override this instead of revision_history so
574
816
        that subclasses do not need to deal with caching logic.
575
 
        
 
817
 
576
818
        This API is semi-public; it only for use by subclasses, all other code
577
819
        should consider it to be private.
578
820
        """
581
823
    @needs_read_lock
582
824
    def revision_history(self):
583
825
        """Return sequence of revision ids on this branch.
584
 
        
 
826
 
585
827
        This method will cache the revision history for as long as it is safe to
586
828
        do so.
587
829
        """
606
848
        """Older format branches cannot bind or unbind."""
607
849
        raise errors.UpgradeRequired(self.base)
608
850
 
609
 
    def set_append_revisions_only(self, enabled):
610
 
        """Older format branches are never restricted to append-only"""
611
 
        raise errors.UpgradeRequired(self.base)
612
 
 
613
851
    def last_revision(self):
614
852
        """Return last revision id, or NULL_REVISION."""
615
853
        return self.last_revision_info()[1]
635
873
    @deprecated_method(deprecated_in((1, 6, 0)))
636
874
    def missing_revisions(self, other, stop_revision=None):
637
875
        """Return a list of new revisions that would perfectly fit.
638
 
        
 
876
 
639
877
        If self and other have not diverged, return a list of the revisions
640
878
        present in other, but missing from self.
641
879
        """
668
906
            information. This can be None.
669
907
        :return: None
670
908
        """
671
 
        other.lock_read()
672
 
        try:
673
 
            other_revno, other_last_revision = other.last_revision_info()
674
 
            stop_revno = None # unknown
675
 
            if stop_revision is None:
676
 
                stop_revision = other_last_revision
677
 
                if _mod_revision.is_null(stop_revision):
678
 
                    # if there are no commits, we're done.
679
 
                    return
680
 
                stop_revno = other_revno
681
 
 
682
 
            # what's the current last revision, before we fetch [and change it
683
 
            # possibly]
684
 
            last_rev = _mod_revision.ensure_null(self.last_revision())
685
 
            # we fetch here so that we don't process data twice in the common
686
 
            # case of having something to pull, and so that the check for 
687
 
            # already merged can operate on the just fetched graph, which will
688
 
            # be cached in memory.
689
 
            self.fetch(other, stop_revision)
690
 
            # Check to see if one is an ancestor of the other
691
 
            if not overwrite:
692
 
                if graph is None:
693
 
                    graph = self.repository.get_graph()
694
 
                if self._check_if_descendant_or_diverged(
695
 
                        stop_revision, last_rev, graph, other):
696
 
                    # stop_revision is a descendant of last_rev, but we aren't
697
 
                    # overwriting, so we're done.
698
 
                    return
699
 
            if stop_revno is None:
700
 
                if graph is None:
701
 
                    graph = self.repository.get_graph()
702
 
                this_revno, this_last_revision = self.last_revision_info()
703
 
                stop_revno = graph.find_distance_to_null(stop_revision,
704
 
                                [(other_last_revision, other_revno),
705
 
                                 (this_last_revision, this_revno)])
706
 
            self.set_last_revision_info(stop_revno, stop_revision)
707
 
        finally:
708
 
            other.unlock()
 
909
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
910
            overwrite, graph)
 
911
 
 
912
    def import_last_revision_info(self, source_repo, revno, revid):
 
913
        """Set the last revision info, importing from another repo if necessary.
 
914
 
 
915
        This is used by the bound branch code to upload a revision to
 
916
        the master branch first before updating the tip of the local branch.
 
917
 
 
918
        :param source_repo: Source repository to optionally fetch from
 
919
        :param revno: Revision number of the new tip
 
920
        :param revid: Revision id of the new tip
 
921
        """
 
922
        if not self.repository.has_same_location(source_repo):
 
923
            self.repository.fetch(source_repo, revision_id=revid)
 
924
        self.set_last_revision_info(revno, revid)
709
925
 
710
926
    def revision_id_to_revno(self, revision_id):
711
927
        """Given a revision id, return its revno"""
717
933
        except ValueError:
718
934
            raise errors.NoSuchRevision(self, revision_id)
719
935
 
 
936
    @needs_read_lock
720
937
    def get_rev_id(self, revno, history=None):
721
938
        """Find the revision id of the specified revno."""
722
939
        if revno == 0:
723
940
            return _mod_revision.NULL_REVISION
724
 
        if history is None:
725
 
            history = self.revision_history()
726
 
        if revno <= 0 or revno > len(history):
 
941
        last_revno, last_revid = self.last_revision_info()
 
942
        if revno == last_revno:
 
943
            return last_revid
 
944
        if revno <= 0 or revno > last_revno:
727
945
            raise errors.NoSuchRevision(self, revno)
728
 
        return history[revno - 1]
 
946
        distance_from_last = last_revno - revno
 
947
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
948
            self._extend_partial_history(distance_from_last)
 
949
        return self._partial_revision_history_cache[distance_from_last]
729
950
 
 
951
    @needs_write_lock
730
952
    def pull(self, source, overwrite=False, stop_revision=None,
731
 
             possible_transports=None, _override_hook_target=None):
 
953
             possible_transports=None, *args, **kwargs):
732
954
        """Mirror source into this branch.
733
955
 
734
956
        This branch is considered to be 'local', having low latency.
735
957
 
736
958
        :returns: PullResult instance
737
959
        """
738
 
        raise NotImplementedError(self.pull)
 
960
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
961
            stop_revision=stop_revision,
 
962
            possible_transports=possible_transports, *args, **kwargs)
739
963
 
740
 
    def push(self, target, overwrite=False, stop_revision=None):
 
964
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
965
        **kwargs):
741
966
        """Mirror this branch into target.
742
967
 
743
968
        This branch is considered to be 'local', having low latency.
744
969
        """
745
 
        raise NotImplementedError(self.push)
 
970
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
971
            *args, **kwargs)
 
972
 
 
973
    def lossy_push(self, target, stop_revision=None):
 
974
        """Push deltas into another branch.
 
975
 
 
976
        :note: This does not, like push, retain the revision ids from 
 
977
            the source branch and will, rather than adding bzr-specific 
 
978
            metadata, push only those semantics of the revision that can be 
 
979
            natively represented by this branch' VCS.
 
980
 
 
981
        :param target: Target branch
 
982
        :param stop_revision: Revision to push, defaults to last revision.
 
983
        :return: BranchPushResult with an extra member revidmap: 
 
984
            A dictionary mapping revision ids from the target branch 
 
985
            to new revision ids in the target branch, for each 
 
986
            revision that was pushed.
 
987
        """
 
988
        inter = InterBranch.get(self, target)
 
989
        lossy_push = getattr(inter, "lossy_push", None)
 
990
        if lossy_push is None:
 
991
            raise errors.LossyPushToSameVCS(self, target)
 
992
        return lossy_push(stop_revision)
746
993
 
747
994
    def basis_tree(self):
748
995
        """Return `Tree` object for last revision."""
751
998
    def get_parent(self):
752
999
        """Return the parent location of the branch.
753
1000
 
754
 
        This is the default location for push/pull/missing.  The usual
 
1001
        This is the default location for pull/missing.  The usual
755
1002
        pattern is that the user can override it by specifying a
756
1003
        location.
757
1004
        """
758
 
        raise NotImplementedError(self.get_parent)
 
1005
        parent = self._get_parent_location()
 
1006
        if parent is None:
 
1007
            return parent
 
1008
        # This is an old-format absolute path to a local branch
 
1009
        # turn it into a url
 
1010
        if parent.startswith('/'):
 
1011
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
 
1012
        try:
 
1013
            return urlutils.join(self.base[:-1], parent)
 
1014
        except errors.InvalidURLJoin, e:
 
1015
            raise errors.InaccessibleParent(parent, self.base)
 
1016
 
 
1017
    def _get_parent_location(self):
 
1018
        raise NotImplementedError(self._get_parent_location)
759
1019
 
760
1020
    def _set_config_location(self, name, url, config=None,
761
1021
                             make_relative=False):
775
1035
            location = None
776
1036
        return location
777
1037
 
 
1038
    def get_child_submit_format(self):
 
1039
        """Return the preferred format of submissions to this branch."""
 
1040
        return self.get_config().get_user_option("child_submit_format")
 
1041
 
778
1042
    def get_submit_branch(self):
779
1043
        """Return the submit location of the branch.
780
1044
 
797
1061
    def get_public_branch(self):
798
1062
        """Return the public location of the branch.
799
1063
 
800
 
        This is is used by merge directives.
 
1064
        This is used by merge directives.
801
1065
        """
802
1066
        return self._get_config_location('public_branch')
803
1067
 
819
1083
        """Set a new push location for this branch."""
820
1084
        raise NotImplementedError(self.set_push_location)
821
1085
 
822
 
    def set_parent(self, url):
823
 
        raise NotImplementedError(self.set_parent)
 
1086
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
 
1087
        """Run the post_change_branch_tip hooks."""
 
1088
        hooks = Branch.hooks['post_change_branch_tip']
 
1089
        if not hooks:
 
1090
            return
 
1091
        new_revno, new_revid = self.last_revision_info()
 
1092
        params = ChangeBranchTipParams(
 
1093
            self, old_revno, new_revno, old_revid, new_revid)
 
1094
        for hook in hooks:
 
1095
            hook(params)
 
1096
 
 
1097
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
 
1098
        """Run the pre_change_branch_tip hooks."""
 
1099
        hooks = Branch.hooks['pre_change_branch_tip']
 
1100
        if not hooks:
 
1101
            return
 
1102
        old_revno, old_revid = self.last_revision_info()
 
1103
        params = ChangeBranchTipParams(
 
1104
            self, old_revno, new_revno, old_revid, new_revid)
 
1105
        for hook in hooks:
 
1106
            hook(params)
824
1107
 
825
1108
    @needs_write_lock
826
1109
    def update(self):
827
 
        """Synchronise this branch with the master branch if any. 
 
1110
        """Synchronise this branch with the master branch if any.
828
1111
 
829
1112
        :return: None or the last_revision pivoted out during the update.
830
1113
        """
837
1120
        """
838
1121
        if revno != 0:
839
1122
            self.check_real_revno(revno)
840
 
            
 
1123
 
841
1124
    def check_real_revno(self, revno):
842
1125
        """\
843
1126
        Check whether a revno corresponds to a real revision.
847
1130
            raise errors.InvalidRevisionNumber(revno)
848
1131
 
849
1132
    @needs_read_lock
850
 
    def clone(self, to_bzrdir, revision_id=None):
 
1133
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
851
1134
        """Clone this branch into to_bzrdir preserving all semantic values.
852
 
        
 
1135
 
 
1136
        Most API users will want 'create_clone_on_transport', which creates a
 
1137
        new bzrdir and branch on the fly.
 
1138
 
853
1139
        revision_id: if not None, the revision history in the new branch will
854
1140
                     be truncated to end with revision_id.
855
1141
        """
856
1142
        result = to_bzrdir.create_branch()
857
 
        self.copy_content_into(result, revision_id=revision_id)
858
 
        return  result
 
1143
        result.lock_write()
 
1144
        try:
 
1145
            if repository_policy is not None:
 
1146
                repository_policy.configure_branch(result)
 
1147
            self.copy_content_into(result, revision_id=revision_id)
 
1148
        finally:
 
1149
            result.unlock()
 
1150
        return result
859
1151
 
860
1152
    @needs_read_lock
861
 
    def sprout(self, to_bzrdir, revision_id=None):
 
1153
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
862
1154
        """Create a new line of development from the branch, into to_bzrdir.
863
1155
 
864
1156
        to_bzrdir controls the branch format.
866
1158
        revision_id: if not None, the revision history in the new branch will
867
1159
                     be truncated to end with revision_id.
868
1160
        """
 
1161
        if (repository_policy is not None and
 
1162
            repository_policy.requires_stacking()):
 
1163
            to_bzrdir._format.require_stacking(_skip_repo=True)
869
1164
        result = to_bzrdir.create_branch()
870
 
        self.copy_content_into(result, revision_id=revision_id)
871
 
        result.set_parent(self.bzrdir.root_transport.base)
 
1165
        result.lock_write()
 
1166
        try:
 
1167
            if repository_policy is not None:
 
1168
                repository_policy.configure_branch(result)
 
1169
            self.copy_content_into(result, revision_id=revision_id)
 
1170
            result.set_parent(self.bzrdir.root_transport.base)
 
1171
        finally:
 
1172
            result.unlock()
872
1173
        return result
873
1174
 
874
1175
    def _synchronize_history(self, destination, revision_id):
886
1187
        source_revno, source_revision_id = self.last_revision_info()
887
1188
        if revision_id is None:
888
1189
            revno, revision_id = source_revno, source_revision_id
889
 
        elif source_revision_id == revision_id:
890
 
            # we know the revno without needing to walk all of history
891
 
            revno = source_revno
892
1190
        else:
893
 
            # To figure out the revno for a random revision, we need to build
894
 
            # the revision history, and count its length.
895
 
            # We don't care about the order, just how long it is.
896
 
            # Alternatively, we could start at the current location, and count
897
 
            # backwards. But there is no guarantee that we will find it since
898
 
            # it may be a merged revision.
899
 
            revno = len(list(self.repository.iter_reverse_revision_history(
900
 
                                                                revision_id)))
 
1191
            graph = self.repository.get_graph()
 
1192
            try:
 
1193
                revno = graph.find_distance_to_null(revision_id, 
 
1194
                    [(source_revision_id, source_revno)])
 
1195
            except errors.GhostRevisionsHaveNoRevno:
 
1196
                # Default to 1, if we can't find anything else
 
1197
                revno = 1
901
1198
        destination.set_last_revision_info(revno, revision_id)
902
 
    
 
1199
 
903
1200
    @needs_read_lock
904
1201
    def copy_content_into(self, destination, revision_id=None):
905
1202
        """Copy the content of self into destination.
907
1204
        revision_id: if not None, the revision history in the new branch will
908
1205
                     be truncated to end with revision_id.
909
1206
        """
 
1207
        self.update_references(destination)
910
1208
        self._synchronize_history(destination, revision_id)
911
1209
        try:
912
1210
            parent = self.get_parent()
915
1213
        else:
916
1214
            if parent:
917
1215
                destination.set_parent(parent)
918
 
        self.tags.merge_to(destination.tags)
 
1216
        if self._push_should_merge_tags():
 
1217
            self.tags.merge_to(destination.tags)
 
1218
 
 
1219
    def update_references(self, target):
 
1220
        if not getattr(self._format, 'supports_reference_locations', False):
 
1221
            return
 
1222
        reference_dict = self._get_all_reference_info()
 
1223
        if len(reference_dict) == 0:
 
1224
            return
 
1225
        old_base = self.base
 
1226
        new_base = target.base
 
1227
        target_reference_dict = target._get_all_reference_info()
 
1228
        for file_id, (tree_path, branch_location) in (
 
1229
            reference_dict.items()):
 
1230
            branch_location = urlutils.rebase_url(branch_location,
 
1231
                                                  old_base, new_base)
 
1232
            target_reference_dict.setdefault(
 
1233
                file_id, (tree_path, branch_location))
 
1234
        target._set_all_reference_info(target_reference_dict)
919
1235
 
920
1236
    @needs_read_lock
921
 
    def check(self):
 
1237
    def check(self, refs):
922
1238
        """Check consistency of the branch.
923
1239
 
924
1240
        In particular this checks that revisions given in the revision-history
925
 
        do actually match up in the revision graph, and that they're all 
 
1241
        do actually match up in the revision graph, and that they're all
926
1242
        present in the repository.
927
 
        
 
1243
 
928
1244
        Callers will typically also want to check the repository.
929
1245
 
 
1246
        :param refs: Calculated refs for this branch as specified by
 
1247
            branch._get_check_refs()
930
1248
        :return: A BranchCheckResult.
931
1249
        """
932
 
        mainline_parent_id = None
 
1250
        result = BranchCheckResult(self)
933
1251
        last_revno, last_revision_id = self.last_revision_info()
934
 
        real_rev_history = list(self.repository.iter_reverse_revision_history(
935
 
                                last_revision_id))
936
 
        real_rev_history.reverse()
937
 
        if len(real_rev_history) != last_revno:
938
 
            raise errors.BzrCheckError('revno does not match len(mainline)'
939
 
                ' %s != %s' % (last_revno, len(real_rev_history)))
940
 
        # TODO: We should probably also check that real_rev_history actually
941
 
        #       matches self.revision_history()
942
 
        for revision_id in real_rev_history:
943
 
            try:
944
 
                revision = self.repository.get_revision(revision_id)
945
 
            except errors.NoSuchRevision, e:
946
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
947
 
                            % revision_id)
948
 
            # In general the first entry on the revision history has no parents.
949
 
            # But it's not illegal for it to have parents listed; this can happen
950
 
            # in imports from Arch when the parents weren't reachable.
951
 
            if mainline_parent_id is not None:
952
 
                if mainline_parent_id not in revision.parent_ids:
953
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
954
 
                                        "parents of {%s}"
955
 
                                        % (mainline_parent_id, revision_id))
956
 
            mainline_parent_id = revision_id
957
 
        return BranchCheckResult(self)
 
1252
        actual_revno = refs[('lefthand-distance', last_revision_id)]
 
1253
        if actual_revno != last_revno:
 
1254
            result.errors.append(errors.BzrCheckError(
 
1255
                'revno does not match len(mainline) %s != %s' % (
 
1256
                last_revno, actual_revno)))
 
1257
        # TODO: We should probably also check that self.revision_history
 
1258
        # matches the repository for older branch formats.
 
1259
        # If looking for the code that cross-checks repository parents against
 
1260
        # the iter_reverse_revision_history output, that is now a repository
 
1261
        # specific check.
 
1262
        return result
958
1263
 
959
1264
    def _get_checkout_format(self):
960
1265
        """Return the most suitable metadir for a checkout of this branch.
969
1274
            format.set_branch_format(self._format)
970
1275
        return format
971
1276
 
 
1277
    def create_clone_on_transport(self, to_transport, revision_id=None,
 
1278
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1279
        """Create a clone of this branch and its bzrdir.
 
1280
 
 
1281
        :param to_transport: The transport to clone onto.
 
1282
        :param revision_id: The revision id to use as tip in the new branch.
 
1283
            If None the tip is obtained from this branch.
 
1284
        :param stacked_on: An optional URL to stack the clone on.
 
1285
        :param create_prefix: Create any missing directories leading up to
 
1286
            to_transport.
 
1287
        :param use_existing_dir: Use an existing directory if one exists.
 
1288
        """
 
1289
        # XXX: Fix the bzrdir API to allow getting the branch back from the
 
1290
        # clone call. Or something. 20090224 RBC/spiv.
 
1291
        if revision_id is None:
 
1292
            revision_id = self.last_revision()
 
1293
        dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1294
            revision_id=revision_id, stacked_on=stacked_on,
 
1295
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1296
        return dir_to.open_branch()
 
1297
 
972
1298
    def create_checkout(self, to_location, revision_id=None,
973
1299
                        lightweight=False, accelerator_tree=None,
974
1300
                        hardlink=False):
975
1301
        """Create a checkout of a branch.
976
 
        
 
1302
 
977
1303
        :param to_location: The url to produce the checkout at
978
1304
        :param revision_id: The revision to check out
979
1305
        :param lightweight: If True, produce a lightweight checkout, otherwise,
998
1324
                to_location, force_new_tree=False, format=format)
999
1325
            checkout = checkout_branch.bzrdir
1000
1326
            checkout_branch.bind(self)
1001
 
            # pull up to the specified revision_id to set the initial 
 
1327
            # pull up to the specified revision_id to set the initial
1002
1328
            # branch tip correctly, and seed it with history.
1003
1329
            checkout_branch.pull(self, stop_revision=revision_id)
1004
1330
            from_branch=None
1026
1352
        reconciler.reconcile()
1027
1353
        return reconciler
1028
1354
 
1029
 
    def reference_parent(self, file_id, path):
 
1355
    def reference_parent(self, file_id, path, possible_transports=None):
1030
1356
        """Return the parent branch for a tree-reference file_id
1031
1357
        :param file_id: The file_id of the tree reference
1032
1358
        :param path: The path of the file_id in the tree
1033
1359
        :return: A branch associated with the file_id
1034
1360
        """
1035
1361
        # FIXME should provide multiple branches, based on config
1036
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
 
1362
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1363
                           possible_transports=possible_transports)
1037
1364
 
1038
1365
    def supports_tags(self):
1039
1366
        return self._format.supports_tags()
1043
1370
        """Ensure that revision_b is a descendant of revision_a.
1044
1371
 
1045
1372
        This is a helper function for update_revisions.
1046
 
        
 
1373
 
1047
1374
        :raises: DivergedBranches if revision_b has diverged from revision_a.
1048
1375
        :returns: True if revision_b is a descendant of revision_a.
1049
1376
        """
1059
1386
 
1060
1387
    def _revision_relations(self, revision_a, revision_b, graph):
1061
1388
        """Determine the relationship between two revisions.
1062
 
        
 
1389
 
1063
1390
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1064
1391
        """
1065
1392
        heads = graph.heads([revision_a, revision_b])
1082
1409
     * a format string,
1083
1410
     * an open routine.
1084
1411
 
1085
 
    Formats are placed in an dict by their format string for reference 
 
1412
    Formats are placed in an dict by their format string for reference
1086
1413
    during branch opening. Its not required that these be instances, they
1087
 
    can be classes themselves with class methods - it simply depends on 
 
1414
    can be classes themselves with class methods - it simply depends on
1088
1415
    whether state is needed for a given format or not.
1089
1416
 
1090
1417
    Once a format is deprecated, just deprecate the initialize and open
1091
 
    methods on the format class. Do not deprecate the object, as the 
 
1418
    methods on the format class. Do not deprecate the object, as the
1092
1419
    object will be created every time regardless.
1093
1420
    """
1094
1421
 
1098
1425
    _formats = {}
1099
1426
    """The known formats."""
1100
1427
 
 
1428
    can_set_append_revisions_only = True
 
1429
 
1101
1430
    def __eq__(self, other):
1102
1431
        return self.__class__ is other.__class__
1103
1432
 
1109
1438
        """Return the format for the branch object in a_bzrdir."""
1110
1439
        try:
1111
1440
            transport = a_bzrdir.get_branch_transport(None)
1112
 
            format_string = transport.get("format").read()
 
1441
            format_string = transport.get_bytes("format")
1113
1442
            return klass._formats[format_string]
1114
1443
        except errors.NoSuchFile:
1115
 
            raise errors.NotBranchError(path=transport.base)
 
1444
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1116
1445
        except KeyError:
1117
1446
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1118
1447
 
1176
1505
        control_files = lockable_files.LockableFiles(branch_transport,
1177
1506
            lock_name, lock_class)
1178
1507
        control_files.create_lock()
1179
 
        control_files.lock_write()
 
1508
        try:
 
1509
            control_files.lock_write()
 
1510
        except errors.LockContention:
 
1511
            if lock_type != 'branch4':
 
1512
                raise
 
1513
            lock_taken = False
 
1514
        else:
 
1515
            lock_taken = True
1180
1516
        if set_format:
1181
1517
            utf8_files += [('format', self.get_format_string())]
1182
1518
        try:
1185
1521
                    filename, content,
1186
1522
                    mode=a_bzrdir._get_file_mode())
1187
1523
        finally:
1188
 
            control_files.unlock()
 
1524
            if lock_taken:
 
1525
                control_files.unlock()
1189
1526
        return self.open(a_bzrdir, _found=True)
1190
1527
 
1191
1528
    def initialize(self, a_bzrdir):
1196
1533
        """Is this format supported?
1197
1534
 
1198
1535
        Supported formats can be initialized and opened.
1199
 
        Unsupported formats may not support initialization or committing or 
 
1536
        Unsupported formats may not support initialization or committing or
1200
1537
        some other features depending on the reason for not being supported.
1201
1538
        """
1202
1539
        return True
1203
1540
 
1204
 
    def open(self, a_bzrdir, _found=False):
 
1541
    def make_tags(self, branch):
 
1542
        """Create a tags object for branch.
 
1543
 
 
1544
        This method is on BranchFormat, because BranchFormats are reflected
 
1545
        over the wire via network_name(), whereas full Branch instances require
 
1546
        multiple VFS method calls to operate at all.
 
1547
 
 
1548
        The default implementation returns a disabled-tags instance.
 
1549
 
 
1550
        Note that it is normal for branch to be a RemoteBranch when using tags
 
1551
        on a RemoteBranch.
 
1552
        """
 
1553
        return DisabledTags(branch)
 
1554
 
 
1555
    def network_name(self):
 
1556
        """A simple byte string uniquely identifying this format for RPC calls.
 
1557
 
 
1558
        MetaDir branch formats use their disk format string to identify the
 
1559
        repository over the wire. All in one formats such as bzr < 0.8, and
 
1560
        foreign formats like svn/git and hg should use some marker which is
 
1561
        unique and immutable.
 
1562
        """
 
1563
        raise NotImplementedError(self.network_name)
 
1564
 
 
1565
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1205
1566
        """Return the branch object for a_bzrdir
1206
1567
 
1207
 
        _found is a private parameter, do not use it. It is used to indicate
1208
 
               if format probing has already be done.
 
1568
        :param a_bzrdir: A BzrDir that contains a branch.
 
1569
        :param _found: a private parameter, do not use it. It is used to
 
1570
            indicate if format probing has already be done.
 
1571
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
1572
            (if there are any).  Default is to open fallbacks.
1209
1573
        """
1210
1574
        raise NotImplementedError(self.open)
1211
1575
 
1212
1576
    @classmethod
1213
1577
    def register_format(klass, format):
 
1578
        """Register a metadir format."""
1214
1579
        klass._formats[format.get_format_string()] = format
 
1580
        # Metadir formats have a network name of their format string, and get
 
1581
        # registered as class factories.
 
1582
        network_format_registry.register(format.get_format_string(), format.__class__)
1215
1583
 
1216
1584
    @classmethod
1217
1585
    def set_default_format(klass, format):
1218
1586
        klass._default_format = format
1219
1587
 
 
1588
    def supports_set_append_revisions_only(self):
 
1589
        """True if this format supports set_append_revisions_only."""
 
1590
        return False
 
1591
 
1220
1592
    def supports_stacking(self):
1221
1593
        """True if this format records a stacked-on branch."""
1222
1594
        return False
1226
1598
        del klass._formats[format.get_format_string()]
1227
1599
 
1228
1600
    def __str__(self):
1229
 
        return self.get_format_string().rstrip()
 
1601
        return self.get_format_description().rstrip()
1230
1602
 
1231
1603
    def supports_tags(self):
1232
1604
        """True if this format supports tags stored in the branch"""
1235
1607
 
1236
1608
class BranchHooks(Hooks):
1237
1609
    """A dictionary mapping hook name to a list of callables for branch hooks.
1238
 
    
 
1610
 
1239
1611
    e.g. ['set_rh'] Is the list of items to be called when the
1240
1612
    set_revision_history function is invoked.
1241
1613
    """
1247
1619
        notified.
1248
1620
        """
1249
1621
        Hooks.__init__(self)
1250
 
        # Introduced in 0.15:
1251
 
        # invoked whenever the revision history has been set
1252
 
        # with set_revision_history. The api signature is
1253
 
        # (branch, revision_history), and the branch will
1254
 
        # be write-locked.
1255
 
        self['set_rh'] = []
1256
 
        # Invoked after a branch is opened. The api signature is (branch).
1257
 
        self['open'] = []
1258
 
        # invoked after a push operation completes.
1259
 
        # the api signature is
1260
 
        # (push_result)
1261
 
        # containing the members
1262
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1263
 
        # where local is the local target branch or None, master is the target 
1264
 
        # master branch, and the rest should be self explanatory. The source
1265
 
        # is read locked and the target branches write locked. Source will
1266
 
        # be the local low-latency branch.
1267
 
        self['post_push'] = []
1268
 
        # invoked after a pull operation completes.
1269
 
        # the api signature is
1270
 
        # (pull_result)
1271
 
        # containing the members
1272
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1273
 
        # where local is the local branch or None, master is the target 
1274
 
        # master branch, and the rest should be self explanatory. The source
1275
 
        # is read locked and the target branches write locked. The local
1276
 
        # branch is the low-latency branch.
1277
 
        self['post_pull'] = []
1278
 
        # invoked before a commit operation takes place.
1279
 
        # the api signature is
1280
 
        # (local, master, old_revno, old_revid, future_revno, future_revid,
1281
 
        #  tree_delta, future_tree).
1282
 
        # old_revid is NULL_REVISION for the first commit to a branch
1283
 
        # tree_delta is a TreeDelta object describing changes from the basis
1284
 
        # revision, hooks MUST NOT modify this delta
1285
 
        # future_tree is an in-memory tree obtained from
1286
 
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1287
 
        self['pre_commit'] = []
1288
 
        # invoked after a commit operation completes.
1289
 
        # the api signature is 
1290
 
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1291
 
        # old_revid is NULL_REVISION for the first commit to a branch.
1292
 
        self['post_commit'] = []
1293
 
        # invoked after a uncommit operation completes.
1294
 
        # the api signature is
1295
 
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1296
 
        # local is the local branch or None, master is the target branch,
1297
 
        # and an empty branch recieves new_revno of 0, new_revid of None.
1298
 
        self['post_uncommit'] = []
1299
 
        # Introduced in 1.6
1300
 
        # Invoked before the tip of a branch changes.
1301
 
        # the api signature is
1302
 
        # (params) where params is a ChangeBranchTipParams with the members
1303
 
        # (branch, old_revno, new_revno, old_revid, new_revid)
1304
 
        self['pre_change_branch_tip'] = []
1305
 
        # Introduced in 1.4
1306
 
        # Invoked after the tip of a branch changes.
1307
 
        # the api signature is
1308
 
        # (params) where params is a ChangeBranchTipParams with the members
1309
 
        # (branch, old_revno, new_revno, old_revid, new_revid)
1310
 
        self['post_change_branch_tip'] = []
1311
 
        # Introduced in 1.9
1312
 
        # Invoked when a stacked branch activates its fallback locations and
1313
 
        # allows the transformation of the url of said location.
1314
 
        # the api signature is
1315
 
        # (branch, url) where branch is the branch having its fallback
1316
 
        # location activated and url is the url for the fallback location.
1317
 
        # The hook should return a url.
1318
 
        self['transform_fallback_location'] = []
 
1622
        self.create_hook(HookPoint('set_rh',
 
1623
            "Invoked whenever the revision history has been set via "
 
1624
            "set_revision_history. The api signature is (branch, "
 
1625
            "revision_history), and the branch will be write-locked. "
 
1626
            "The set_rh hook can be expensive for bzr to trigger, a better "
 
1627
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1628
        self.create_hook(HookPoint('open',
 
1629
            "Called with the Branch object that has been opened after a "
 
1630
            "branch is opened.", (1, 8), None))
 
1631
        self.create_hook(HookPoint('post_push',
 
1632
            "Called after a push operation completes. post_push is called "
 
1633
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
 
1634
            "bzr client.", (0, 15), None))
 
1635
        self.create_hook(HookPoint('post_pull',
 
1636
            "Called after a pull operation completes. post_pull is called "
 
1637
            "with a bzrlib.branch.PullResult object and only runs in the "
 
1638
            "bzr client.", (0, 15), None))
 
1639
        self.create_hook(HookPoint('pre_commit',
 
1640
            "Called after a commit is calculated but before it is is "
 
1641
            "completed. pre_commit is called with (local, master, old_revno, "
 
1642
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
 
1643
            "). old_revid is NULL_REVISION for the first commit to a branch, "
 
1644
            "tree_delta is a TreeDelta object describing changes from the "
 
1645
            "basis revision. hooks MUST NOT modify this delta. "
 
1646
            " future_tree is an in-memory tree obtained from "
 
1647
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
 
1648
            "tree.", (0,91), None))
 
1649
        self.create_hook(HookPoint('post_commit',
 
1650
            "Called in the bzr client after a commit has completed. "
 
1651
            "post_commit is called with (local, master, old_revno, old_revid, "
 
1652
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
 
1653
            "commit to a branch.", (0, 15), None))
 
1654
        self.create_hook(HookPoint('post_uncommit',
 
1655
            "Called in the bzr client after an uncommit completes. "
 
1656
            "post_uncommit is called with (local, master, old_revno, "
 
1657
            "old_revid, new_revno, new_revid) where local is the local branch "
 
1658
            "or None, master is the target branch, and an empty branch "
 
1659
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1660
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1661
            "Called in bzr client and server before a change to the tip of a "
 
1662
            "branch is made. pre_change_branch_tip is called with a "
 
1663
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1664
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1665
        self.create_hook(HookPoint('post_change_branch_tip',
 
1666
            "Called in bzr client and server after a change to the tip of a "
 
1667
            "branch is made. post_change_branch_tip is called with a "
 
1668
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
 
1669
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1670
        self.create_hook(HookPoint('transform_fallback_location',
 
1671
            "Called when a stacked branch is activating its fallback "
 
1672
            "locations. transform_fallback_location is called with (branch, "
 
1673
            "url), and should return a new url. Returning the same url "
 
1674
            "allows it to be used as-is, returning a different one can be "
 
1675
            "used to cause the branch to stack on a closer copy of that "
 
1676
            "fallback_location. Note that the branch cannot have history "
 
1677
            "accessing methods called on it during this hook because the "
 
1678
            "fallback locations have not been activated. When there are "
 
1679
            "multiple hooks installed for transform_fallback_location, "
 
1680
            "all are called with the url returned from the previous hook."
 
1681
            "The order is however undefined.", (1, 9), None))
1319
1682
 
1320
1683
 
1321
1684
# install the default hooks into the Branch class.
1353
1716
 
1354
1717
    def __eq__(self, other):
1355
1718
        return self.__dict__ == other.__dict__
1356
 
    
 
1719
 
1357
1720
    def __repr__(self):
1358
1721
        return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1359
 
            self.__class__.__name__, self.branch, 
 
1722
            self.__class__.__name__, self.branch,
1360
1723
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1361
1724
 
1362
1725
 
1384
1747
        super(BzrBranchFormat4, self).__init__()
1385
1748
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1386
1749
 
1387
 
    def open(self, a_bzrdir, _found=False):
1388
 
        """Return the branch object for a_bzrdir
 
1750
    def network_name(self):
 
1751
        """The network name for this format is the control dirs disk label."""
 
1752
        return self._matchingbzrdir.get_format_string()
1389
1753
 
1390
 
        _found is a private parameter, do not use it. It is used to indicate
1391
 
               if format probing has already be done.
1392
 
        """
 
1754
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1755
        """See BranchFormat.open()."""
1393
1756
        if not _found:
1394
1757
            # we are being called directly and must probe.
1395
1758
            raise NotImplementedError
1409
1772
        """What class to instantiate on open calls."""
1410
1773
        raise NotImplementedError(self._branch_class)
1411
1774
 
1412
 
    def open(self, a_bzrdir, _found=False):
1413
 
        """Return the branch object for a_bzrdir.
 
1775
    def network_name(self):
 
1776
        """A simple byte string uniquely identifying this format for RPC calls.
1414
1777
 
1415
 
        _found is a private parameter, do not use it. It is used to indicate
1416
 
               if format probing has already be done.
 
1778
        Metadir branch formats use their format string.
1417
1779
        """
 
1780
        return self.get_format_string()
 
1781
 
 
1782
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1783
        """See BranchFormat.open()."""
1418
1784
        if not _found:
1419
1785
            format = BranchFormat.find_format(a_bzrdir)
1420
1786
            if format.__class__ != self.__class__:
1427
1793
            return self._branch_class()(_format=self,
1428
1794
                              _control_files=control_files,
1429
1795
                              a_bzrdir=a_bzrdir,
1430
 
                              _repository=a_bzrdir.find_repository())
 
1796
                              _repository=a_bzrdir.find_repository(),
 
1797
                              ignore_fallbacks=ignore_fallbacks)
1431
1798
        except errors.NoSuchFile:
1432
 
            raise errors.NotBranchError(path=transport.base)
 
1799
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1433
1800
 
1434
1801
    def __init__(self):
1435
1802
        super(BranchFormatMetadir, self).__init__()
1463
1830
    def get_format_description(self):
1464
1831
        """See BranchFormat.get_format_description()."""
1465
1832
        return "Branch format 5"
1466
 
        
 
1833
 
1467
1834
    def initialize(self, a_bzrdir):
1468
1835
        """Create a branch of this format in a_bzrdir."""
1469
1836
        utf8_files = [('revision-history', ''),
1505
1872
                      ]
1506
1873
        return self._initialize_helper(a_bzrdir, utf8_files)
1507
1874
 
1508
 
 
1509
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1875
    def make_tags(self, branch):
 
1876
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1877
        return BasicTags(branch)
 
1878
 
 
1879
    def supports_set_append_revisions_only(self):
 
1880
        return True
 
1881
 
 
1882
 
 
1883
class BzrBranchFormat8(BranchFormatMetadir):
 
1884
    """Metadir format supporting storing locations of subtree branches."""
 
1885
 
 
1886
    def _branch_class(self):
 
1887
        return BzrBranch8
 
1888
 
 
1889
    def get_format_string(self):
 
1890
        """See BranchFormat.get_format_string()."""
 
1891
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
 
1892
 
 
1893
    def get_format_description(self):
 
1894
        """See BranchFormat.get_format_description()."""
 
1895
        return "Branch format 8"
 
1896
 
 
1897
    def initialize(self, a_bzrdir):
 
1898
        """Create a branch of this format in a_bzrdir."""
 
1899
        utf8_files = [('last-revision', '0 null:\n'),
 
1900
                      ('branch.conf', ''),
 
1901
                      ('tags', ''),
 
1902
                      ('references', '')
 
1903
                      ]
 
1904
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1905
 
 
1906
    def __init__(self):
 
1907
        super(BzrBranchFormat8, self).__init__()
 
1908
        self._matchingbzrdir.repository_format = \
 
1909
            RepositoryFormatKnitPack5RichRoot()
 
1910
 
 
1911
    def make_tags(self, branch):
 
1912
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1913
        return BasicTags(branch)
 
1914
 
 
1915
    def supports_set_append_revisions_only(self):
 
1916
        return True
 
1917
 
 
1918
    def supports_stacking(self):
 
1919
        return True
 
1920
 
 
1921
    supports_reference_locations = True
 
1922
 
 
1923
 
 
1924
class BzrBranchFormat7(BzrBranchFormat8):
1510
1925
    """Branch format with last-revision, tags, and a stacked location pointer.
1511
1926
 
1512
1927
    The stacked location pointer is passed down to the repository and requires
1515
1930
    This format was introduced in bzr 1.6.
1516
1931
    """
1517
1932
 
 
1933
    def initialize(self, a_bzrdir):
 
1934
        """Create a branch of this format in a_bzrdir."""
 
1935
        utf8_files = [('last-revision', '0 null:\n'),
 
1936
                      ('branch.conf', ''),
 
1937
                      ('tags', ''),
 
1938
                      ]
 
1939
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1940
 
1518
1941
    def _branch_class(self):
1519
1942
        return BzrBranch7
1520
1943
 
1526
1949
        """See BranchFormat.get_format_description()."""
1527
1950
        return "Branch format 7"
1528
1951
 
1529
 
    def initialize(self, a_bzrdir):
1530
 
        """Create a branch of this format in a_bzrdir."""
1531
 
        utf8_files = [('last-revision', '0 null:\n'),
1532
 
                      ('branch.conf', ''),
1533
 
                      ('tags', ''),
1534
 
                      ]
1535
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1536
 
 
1537
 
    def __init__(self):
1538
 
        super(BzrBranchFormat7, self).__init__()
1539
 
        self._matchingbzrdir.repository_format = \
1540
 
            RepositoryFormatKnitPack5RichRoot()
1541
 
 
1542
 
    def supports_stacking(self):
 
1952
    def supports_set_append_revisions_only(self):
1543
1953
        return True
1544
1954
 
 
1955
    supports_reference_locations = False
 
1956
 
1545
1957
 
1546
1958
class BranchReferenceFormat(BranchFormat):
1547
1959
    """Bzr branch reference format.
1565
1977
    def get_reference(self, a_bzrdir):
1566
1978
        """See BranchFormat.get_reference()."""
1567
1979
        transport = a_bzrdir.get_branch_transport(None)
1568
 
        return transport.get('location').read()
 
1980
        return transport.get_bytes('location')
1569
1981
 
1570
1982
    def set_reference(self, a_bzrdir, to_branch):
1571
1983
        """See BranchFormat.set_reference()."""
1594
2006
 
1595
2007
    def _make_reference_clone_function(format, a_branch):
1596
2008
        """Create a clone() routine for a branch dynamically."""
1597
 
        def clone(to_bzrdir, revision_id=None):
 
2009
        def clone(to_bzrdir, revision_id=None,
 
2010
            repository_policy=None):
1598
2011
            """See Branch.clone()."""
1599
2012
            return format.initialize(to_bzrdir, a_branch)
1600
2013
            # cannot obey revision_id limits when cloning a reference ...
1603
2016
        return clone
1604
2017
 
1605
2018
    def open(self, a_bzrdir, _found=False, location=None,
1606
 
             possible_transports=None):
 
2019
             possible_transports=None, ignore_fallbacks=False):
1607
2020
        """Return the branch that the branch reference in a_bzrdir points at.
1608
2021
 
1609
 
        _found is a private parameter, do not use it. It is used to indicate
1610
 
               if format probing has already be done.
 
2022
        :param a_bzrdir: A BzrDir that contains a branch.
 
2023
        :param _found: a private parameter, do not use it. It is used to
 
2024
            indicate if format probing has already be done.
 
2025
        :param ignore_fallbacks: when set, no fallback branches will be opened
 
2026
            (if there are any).  Default is to open fallbacks.
 
2027
        :param location: The location of the referenced branch.  If
 
2028
            unspecified, this will be determined from the branch reference in
 
2029
            a_bzrdir.
 
2030
        :param possible_transports: An optional reusable transports list.
1611
2031
        """
1612
2032
        if not _found:
1613
2033
            format = BranchFormat.find_format(a_bzrdir)
1618
2038
            location = self.get_reference(a_bzrdir)
1619
2039
        real_bzrdir = bzrdir.BzrDir.open(
1620
2040
            location, possible_transports=possible_transports)
1621
 
        result = real_bzrdir.open_branch()
 
2041
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1622
2042
        # this changes the behaviour of result.clone to create a new reference
1623
2043
        # rather than a copy of the content of the branch.
1624
2044
        # I did not use a proxy object because that needs much more extensive
1631
2051
        return result
1632
2052
 
1633
2053
 
 
2054
network_format_registry = registry.FormatRegistry()
 
2055
"""Registry of formats indexed by their network name.
 
2056
 
 
2057
The network name for a branch format is an identifier that can be used when
 
2058
referring to formats with smart server operations. See
 
2059
BranchFormat.network_name() for more detail.
 
2060
"""
 
2061
 
 
2062
 
1634
2063
# formats which have no format string are not discoverable
1635
2064
# and not independently creatable, so are not registered.
1636
2065
__format5 = BzrBranchFormat5()
1637
2066
__format6 = BzrBranchFormat6()
1638
2067
__format7 = BzrBranchFormat7()
 
2068
__format8 = BzrBranchFormat8()
1639
2069
BranchFormat.register_format(__format5)
1640
2070
BranchFormat.register_format(BranchReferenceFormat())
1641
2071
BranchFormat.register_format(__format6)
1642
2072
BranchFormat.register_format(__format7)
1643
 
BranchFormat.set_default_format(__format6)
 
2073
BranchFormat.register_format(__format8)
 
2074
BranchFormat.set_default_format(__format7)
1644
2075
_legacy_formats = [BzrBranchFormat4(),
1645
 
                   ]
1646
 
 
1647
 
class BzrBranch(Branch):
 
2076
    ]
 
2077
network_format_registry.register(
 
2078
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2079
 
 
2080
 
 
2081
class BzrBranch(Branch, _RelockDebugMixin):
1648
2082
    """A branch stored in the actual filesystem.
1649
2083
 
1650
2084
    Note that it's "local" in the context of the filesystem; it doesn't
1651
2085
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1652
2086
    it's writable, and can be accessed via the normal filesystem API.
1653
2087
 
1654
 
    :ivar _transport: Transport for file operations on this branch's 
 
2088
    :ivar _transport: Transport for file operations on this branch's
1655
2089
        control files, typically pointing to the .bzr/branch directory.
1656
2090
    :ivar repository: Repository for this branch.
1657
 
    :ivar base: The url of the base directory for this branch; the one 
 
2091
    :ivar base: The url of the base directory for this branch; the one
1658
2092
        containing the .bzr directory.
1659
2093
    """
1660
 
    
 
2094
 
1661
2095
    def __init__(self, _format=None,
1662
 
                 _control_files=None, a_bzrdir=None, _repository=None):
 
2096
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2097
                 ignore_fallbacks=False):
1663
2098
        """Create new branch object at a particular location."""
1664
2099
        if a_bzrdir is None:
1665
2100
            raise ValueError('a_bzrdir must be supplied')
1688
2123
 
1689
2124
    base = property(_get_base, doc="The URL for the root of this branch.")
1690
2125
 
 
2126
    def _get_config(self):
 
2127
        return TransportConfig(self._transport, 'branch.conf')
 
2128
 
1691
2129
    def is_locked(self):
1692
2130
        return self.control_files.is_locked()
1693
2131
 
1694
2132
    def lock_write(self, token=None):
1695
 
        repo_token = self.repository.lock_write()
 
2133
        if not self.is_locked():
 
2134
            self._note_lock('w')
 
2135
        # All-in-one needs to always unlock/lock.
 
2136
        repo_control = getattr(self.repository, 'control_files', None)
 
2137
        if self.control_files == repo_control or not self.is_locked():
 
2138
            self.repository._warn_if_deprecated(self)
 
2139
            self.repository.lock_write()
 
2140
            took_lock = True
 
2141
        else:
 
2142
            took_lock = False
1696
2143
        try:
1697
 
            token = self.control_files.lock_write(token=token)
 
2144
            return self.control_files.lock_write(token=token)
1698
2145
        except:
1699
 
            self.repository.unlock()
 
2146
            if took_lock:
 
2147
                self.repository.unlock()
1700
2148
            raise
1701
 
        return token
1702
2149
 
1703
2150
    def lock_read(self):
1704
 
        self.repository.lock_read()
 
2151
        if not self.is_locked():
 
2152
            self._note_lock('r')
 
2153
        # All-in-one needs to always unlock/lock.
 
2154
        repo_control = getattr(self.repository, 'control_files', None)
 
2155
        if self.control_files == repo_control or not self.is_locked():
 
2156
            self.repository._warn_if_deprecated(self)
 
2157
            self.repository.lock_read()
 
2158
            took_lock = True
 
2159
        else:
 
2160
            took_lock = False
1705
2161
        try:
1706
2162
            self.control_files.lock_read()
1707
2163
        except:
1708
 
            self.repository.unlock()
 
2164
            if took_lock:
 
2165
                self.repository.unlock()
1709
2166
            raise
1710
2167
 
 
2168
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1711
2169
    def unlock(self):
1712
 
        # TODO: test for failed two phase locks. This is known broken.
1713
2170
        try:
1714
2171
            self.control_files.unlock()
1715
2172
        finally:
1716
 
            self.repository.unlock()
1717
 
        if not self.control_files.is_locked():
1718
 
            # we just released the lock
1719
 
            self._clear_cached_state()
1720
 
        
 
2173
            # All-in-one needs to always unlock/lock.
 
2174
            repo_control = getattr(self.repository, 'control_files', None)
 
2175
            if (self.control_files == repo_control or
 
2176
                not self.control_files.is_locked()):
 
2177
                self.repository.unlock()
 
2178
            if not self.control_files.is_locked():
 
2179
                # we just released the lock
 
2180
                self._clear_cached_state()
 
2181
 
1721
2182
    def peek_lock_mode(self):
1722
2183
        if self.control_files._lock_count == 0:
1723
2184
            return None
1795
2256
                new_history = rev.get_history(self.repository)[1:]
1796
2257
        destination.set_revision_history(new_history)
1797
2258
 
1798
 
    def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1799
 
        """Run the pre_change_branch_tip hooks."""
1800
 
        hooks = Branch.hooks['pre_change_branch_tip']
1801
 
        if not hooks:
1802
 
            return
1803
 
        old_revno, old_revid = self.last_revision_info()
1804
 
        params = ChangeBranchTipParams(
1805
 
            self, old_revno, new_revno, old_revid, new_revid)
1806
 
        for hook in hooks:
1807
 
            try:
1808
 
                hook(params)
1809
 
            except errors.TipChangeRejected:
1810
 
                raise
1811
 
            except Exception:
1812
 
                exc_info = sys.exc_info()
1813
 
                hook_name = Branch.hooks.get_hook_name(hook)
1814
 
                raise errors.HookFailed(
1815
 
                    'pre_change_branch_tip', hook_name, exc_info)
1816
 
 
1817
 
    def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1818
 
        """Run the post_change_branch_tip hooks."""
1819
 
        hooks = Branch.hooks['post_change_branch_tip']
1820
 
        if not hooks:
1821
 
            return
1822
 
        new_revno, new_revid = self.last_revision_info()
1823
 
        params = ChangeBranchTipParams(
1824
 
            self, old_revno, new_revno, old_revid, new_revid)
1825
 
        for hook in hooks:
1826
 
            hook(params)
1827
 
 
1828
2259
    @needs_write_lock
1829
2260
    def set_last_revision_info(self, revno, revision_id):
1830
2261
        """Set the last revision of this branch.
1833
2264
        for this revision id.
1834
2265
 
1835
2266
        It may be possible to set the branch last revision to an id not
1836
 
        present in the repository.  However, branches can also be 
 
2267
        present in the repository.  However, branches can also be
1837
2268
        configured to check constraints on history, in which case this may not
1838
2269
        be permitted.
1839
2270
        """
1853
2284
            history.pop()
1854
2285
        return history
1855
2286
 
1856
 
    def _lefthand_history(self, revision_id, last_rev=None,
1857
 
                          other_branch=None):
1858
 
        if 'evil' in debug.debug_flags:
1859
 
            mutter_callsite(4, "_lefthand_history scales with history.")
1860
 
        # stop_revision must be a descendant of last_revision
1861
 
        graph = self.repository.get_graph()
1862
 
        if last_rev is not None:
1863
 
            if not graph.is_ancestor(last_rev, revision_id):
1864
 
                # our previous tip is not merged into stop_revision
1865
 
                raise errors.DivergedBranches(self, other_branch)
1866
 
        # make a new revision history from the graph
1867
 
        parents_map = graph.get_parent_map([revision_id])
1868
 
        if revision_id not in parents_map:
1869
 
            raise errors.NoSuchRevision(self, revision_id)
1870
 
        current_rev_id = revision_id
1871
 
        new_history = []
1872
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
1873
 
        # Do not include ghosts or graph origin in revision_history
1874
 
        while (current_rev_id in parents_map and
1875
 
               len(parents_map[current_rev_id]) > 0):
1876
 
            check_not_reserved_id(current_rev_id)
1877
 
            new_history.append(current_rev_id)
1878
 
            current_rev_id = parents_map[current_rev_id][0]
1879
 
            parents_map = graph.get_parent_map([current_rev_id])
1880
 
        new_history.reverse()
1881
 
        return new_history
1882
 
 
1883
2287
    @needs_write_lock
1884
2288
    def generate_revision_history(self, revision_id, last_rev=None,
1885
2289
        other_branch=None):
1898
2302
        """See Branch.basis_tree."""
1899
2303
        return self.repository.revision_tree(self.last_revision())
1900
2304
 
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
 
 
1944
2305
    def _get_parent_location(self):
1945
2306
        _locs = ['parent', 'pull', 'x-pull']
1946
2307
        for l in _locs:
1950
2311
                pass
1951
2312
        return None
1952
2313
 
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
 
 
2018
2314
    def _basic_push(self, target, overwrite, stop_revision):
2019
2315
        """Basic implementation of push without bound branches or hooks.
2020
2316
 
2021
 
        Must be called with self read locked and target write locked.
 
2317
        Must be called with source read locked and target write locked.
2022
2318
        """
2023
 
        result = PushResult()
 
2319
        result = BranchPushResult()
2024
2320
        result.source_branch = self
2025
2321
        result.target_branch = target
2026
2322
        result.old_revno, result.old_revid = target.last_revision_info()
 
2323
        self.update_references(target)
2027
2324
        if result.old_revid != self.last_revision():
2028
2325
            # We assume that during 'push' this repository is closer than
2029
2326
            # the target.
2030
2327
            graph = self.repository.get_graph(target.repository)
2031
 
            target.update_revisions(self, stop_revision, overwrite=overwrite,
2032
 
                                    graph=graph)
 
2328
            target.update_revisions(self, stop_revision,
 
2329
                overwrite=overwrite, graph=graph)
2033
2330
        if self._push_should_merge_tags():
2034
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2331
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2332
                overwrite)
2035
2333
        result.new_revno, result.new_revid = target.last_revision_info()
2036
2334
        return result
2037
2335
 
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
 
 
2060
2336
    def get_stacked_on_url(self):
2061
2337
        raise errors.UnstackableBranchFormat(self._format, self.base)
2062
2338
 
2066
2342
            'push_location', location,
2067
2343
            store=_mod_config.STORE_LOCATION_NORECURSE)
2068
2344
 
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
 
 
2087
2345
    def _set_parent_location(self, url):
2088
2346
        if url is None:
2089
2347
            self._transport.delete('parent')
2091
2349
            self._transport.put_bytes('parent', url + '\n',
2092
2350
                mode=self.bzrdir._get_file_mode())
2093
2351
 
2094
 
    def set_stacked_on_url(self, url):
2095
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2096
 
 
2097
2352
 
2098
2353
class BzrBranch5(BzrBranch):
2099
2354
    """A format 5 branch. This supports new features over plain branches.
2101
2356
    It has support for a master_branch which is the data for bound branches.
2102
2357
    """
2103
2358
 
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
 
 
2133
2359
    def get_bound_location(self):
2134
2360
        try:
2135
2361
            return self._transport.get_bytes('bound')[:-1]
2139
2365
    @needs_read_lock
2140
2366
    def get_master_branch(self, possible_transports=None):
2141
2367
        """Return the branch we are bound to.
2142
 
        
 
2368
 
2143
2369
        :return: Either a Branch, or None
2144
2370
 
2145
2371
        This could memoise the branch, but if thats done
2181
2407
        check for divergence to raise an error when the branches are not
2182
2408
        either the same, or one a prefix of the other. That behaviour may not
2183
2409
        be useful, so that check may be removed in future.
2184
 
        
 
2410
 
2185
2411
        :param other: The branch to bind to
2186
2412
        :type other: Branch
2187
2413
        """
2206
2432
 
2207
2433
    @needs_write_lock
2208
2434
    def update(self, possible_transports=None):
2209
 
        """Synchronise this branch with the master branch if any. 
 
2435
        """Synchronise this branch with the master branch if any.
2210
2436
 
2211
2437
        :return: None or the last_revision that was pivoted out during the
2212
2438
                 update.
2222
2448
        return None
2223
2449
 
2224
2450
 
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))
 
2451
class BzrBranch8(BzrBranch5):
 
2452
    """A branch that stores tree-reference locations."""
2239
2453
 
2240
2454
    def _open_hook(self):
 
2455
        if self._ignore_fallbacks:
 
2456
            return
2241
2457
        try:
2242
2458
            url = self.get_stacked_on_url()
2243
2459
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2253
2469
                        "None, not a URL." % hook_name)
2254
2470
            self._activate_fallback_location(url)
2255
2471
 
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
 
 
2261
2472
    def __init__(self, *args, **kwargs):
2262
 
        super(BzrBranch7, self).__init__(*args, **kwargs)
 
2473
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
 
2474
        super(BzrBranch8, self).__init__(*args, **kwargs)
2263
2475
        self._last_revision_info_cache = None
2264
 
        self._partial_revision_history_cache = []
 
2476
        self._reference_info = None
2265
2477
 
2266
2478
    def _clear_cached_state(self):
2267
 
        super(BzrBranch7, self)._clear_cached_state()
 
2479
        super(BzrBranch8, self)._clear_cached_state()
2268
2480
        self._last_revision_info_cache = None
2269
 
        self._partial_revision_history_cache = []
 
2481
        self._reference_info = None
2270
2482
 
2271
2483
    def _last_revision_info(self):
2272
2484
        revision_string = self._transport.get_bytes('last-revision')
2303
2515
 
2304
2516
    def _synchronize_history(self, destination, revision_id):
2305
2517
        """Synchronize last revision and revision history between branches.
2306
 
        
 
2518
 
2307
2519
        :see: Branch._synchronize_history
2308
2520
        """
2309
2521
        # XXX: The base Branch has a fast implementation of this method based
2327
2539
        self._extend_partial_history(stop_index=last_revno-1)
2328
2540
        return list(reversed(self._partial_revision_history_cache))
2329
2541
 
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
 
 
2359
2542
    def _write_revision_history(self, history):
2360
2543
        """Factored out of set_revision_history.
2361
2544
 
2382
2565
        """Set the parent branch"""
2383
2566
        return self._get_config_location('parent_location')
2384
2567
 
 
2568
    @needs_write_lock
 
2569
    def _set_all_reference_info(self, info_dict):
 
2570
        """Replace all reference info stored in a branch.
 
2571
 
 
2572
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
 
2573
        """
 
2574
        s = StringIO()
 
2575
        writer = rio.RioWriter(s)
 
2576
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2577
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2578
                                branch_location=branch_location)
 
2579
            writer.write_stanza(stanza)
 
2580
        self._transport.put_bytes('references', s.getvalue())
 
2581
        self._reference_info = info_dict
 
2582
 
 
2583
    @needs_read_lock
 
2584
    def _get_all_reference_info(self):
 
2585
        """Return all the reference info stored in a branch.
 
2586
 
 
2587
        :return: A dict of {file_id: (tree_path, branch_location)}
 
2588
        """
 
2589
        if self._reference_info is not None:
 
2590
            return self._reference_info
 
2591
        rio_file = self._transport.get('references')
 
2592
        try:
 
2593
            stanzas = rio.read_stanzas(rio_file)
 
2594
            info_dict = dict((s['file_id'], (s['tree_path'],
 
2595
                             s['branch_location'])) for s in stanzas)
 
2596
        finally:
 
2597
            rio_file.close()
 
2598
        self._reference_info = info_dict
 
2599
        return info_dict
 
2600
 
 
2601
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2602
        """Set the branch location to use for a tree reference.
 
2603
 
 
2604
        :param file_id: The file-id of the tree reference.
 
2605
        :param tree_path: The path of the tree reference in the tree.
 
2606
        :param branch_location: The location of the branch to retrieve tree
 
2607
            references from.
 
2608
        """
 
2609
        info_dict = self._get_all_reference_info()
 
2610
        info_dict[file_id] = (tree_path, branch_location)
 
2611
        if None in (tree_path, branch_location):
 
2612
            if tree_path is not None:
 
2613
                raise ValueError('tree_path must be None when branch_location'
 
2614
                                 ' is None.')
 
2615
            if branch_location is not None:
 
2616
                raise ValueError('branch_location must be None when tree_path'
 
2617
                                 ' is None.')
 
2618
            del info_dict[file_id]
 
2619
        self._set_all_reference_info(info_dict)
 
2620
 
 
2621
    def get_reference_info(self, file_id):
 
2622
        """Get the tree_path and branch_location for a tree reference.
 
2623
 
 
2624
        :return: a tuple of (tree_path, branch_location)
 
2625
        """
 
2626
        return self._get_all_reference_info().get(file_id, (None, None))
 
2627
 
 
2628
    def reference_parent(self, file_id, path, possible_transports=None):
 
2629
        """Return the parent branch for a tree-reference file_id.
 
2630
 
 
2631
        :param file_id: The file_id of the tree reference
 
2632
        :param path: The path of the file_id in the tree
 
2633
        :return: A branch associated with the file_id
 
2634
        """
 
2635
        branch_location = self.get_reference_info(file_id)[1]
 
2636
        if branch_location is None:
 
2637
            return Branch.reference_parent(self, file_id, path,
 
2638
                                           possible_transports)
 
2639
        branch_location = urlutils.join(self.base, branch_location)
 
2640
        return Branch.open(branch_location,
 
2641
                           possible_transports=possible_transports)
 
2642
 
2385
2643
    def set_push_location(self, location):
2386
2644
        """See Branch.set_push_location."""
2387
2645
        self._set_config_location('push_location', location)
2429
2687
            raise errors.NotStacked(self)
2430
2688
        return stacked_url
2431
2689
 
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
 
 
2466
2690
    def _get_append_revisions_only(self):
2467
2691
        value = self.get_config().get_user_option('append_revisions_only')
2468
2692
        return value == 'True'
2469
2693
 
2470
 
    def _make_tags(self):
2471
 
        return BasicTags(self)
2472
 
 
2473
2694
    @needs_write_lock
2474
2695
    def generate_revision_history(self, revision_id, last_rev=None,
2475
2696
                                  other_branch=None):
2514
2735
        return self.revno() - index
2515
2736
 
2516
2737
 
 
2738
class BzrBranch7(BzrBranch8):
 
2739
    """A branch with support for a fallback repository."""
 
2740
 
 
2741
    def set_reference_info(self, file_id, tree_path, branch_location):
 
2742
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
 
2743
 
 
2744
    def get_reference_info(self, file_id):
 
2745
        Branch.get_reference_info(self, file_id)
 
2746
 
 
2747
    def reference_parent(self, file_id, path, possible_transports=None):
 
2748
        return Branch.reference_parent(self, file_id, path,
 
2749
                                       possible_transports)
 
2750
 
 
2751
 
2517
2752
class BzrBranch6(BzrBranch7):
2518
2753
    """See BzrBranchFormat6 for the capabilities of this branch.
2519
2754
 
2524
2759
    def get_stacked_on_url(self):
2525
2760
        raise errors.UnstackableBranchFormat(self._format, self.base)
2526
2761
 
2527
 
    def set_stacked_on_url(self, url):
2528
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
2529
 
 
2530
2762
 
2531
2763
######################################################################
2532
2764
# results of operations
2549
2781
    :ivar new_revno: Revision number after pull.
2550
2782
    :ivar old_revid: Tip revision id before pull.
2551
2783
    :ivar new_revid: Tip revision id after pull.
2552
 
    :ivar source_branch: Source (local) branch object.
 
2784
    :ivar source_branch: Source (local) branch object. (read locked)
2553
2785
    :ivar master_branch: Master branch of the target, or the target if no
2554
2786
        Master
2555
2787
    :ivar local_branch: target branch if there is a Master, else None
2556
 
    :ivar target_branch: Target/destination branch object.
 
2788
    :ivar target_branch: Target/destination branch object. (write locked)
2557
2789
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2558
2790
    """
2559
2791
 
2570
2802
        self._show_tag_conficts(to_file)
2571
2803
 
2572
2804
 
2573
 
class PushResult(_Result):
 
2805
class BranchPushResult(_Result):
2574
2806
    """Result of a Branch.push operation.
2575
2807
 
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.
 
2808
    :ivar old_revno: Revision number (eg 10) of the target before push.
 
2809
    :ivar new_revno: Revision number (eg 12) of the target after push.
 
2810
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
 
2811
        before the push.
 
2812
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
 
2813
        after the push.
 
2814
    :ivar source_branch: Source branch object that the push was from. This is
 
2815
        read locked, and generally is a local (and thus low latency) branch.
 
2816
    :ivar master_branch: If target is a bound branch, the master branch of
 
2817
        target, or target itself. Always write locked.
 
2818
    :ivar target_branch: The direct Branch where data is being sent (write
 
2819
        locked).
 
2820
    :ivar local_branch: If the target is a bound branch this will be the
 
2821
        target, otherwise it will be None.
2583
2822
    """
2584
2823
 
2585
2824
    def __int__(self):
2589
2828
    def report(self, to_file):
2590
2829
        """Write a human-readable description of the result."""
2591
2830
        if self.old_revid == self.new_revid:
2592
 
            to_file.write('No new revisions to push.\n')
 
2831
            note('No new revisions to push.')
2593
2832
        else:
2594
 
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
 
2833
            note('Pushed up to revision %d.' % self.new_revno)
2595
2834
        self._show_tag_conficts(to_file)
2596
2835
 
2597
2836
 
2603
2842
 
2604
2843
    def __init__(self, branch):
2605
2844
        self.branch = branch
 
2845
        self.errors = []
2606
2846
 
2607
2847
    def report_results(self, verbose):
2608
2848
        """Report the check results via trace.note.
2609
 
        
 
2849
 
2610
2850
        :param verbose: Requests more detailed display of what was checked,
2611
2851
            if any.
2612
2852
        """
2613
 
        note('checked branch %s format %s',
2614
 
             self.branch.base,
2615
 
             self.branch._format)
 
2853
        note('checked branch %s format %s', self.branch.base,
 
2854
            self.branch._format)
 
2855
        for error in self.errors:
 
2856
            note('found error:%s', error)
2616
2857
 
2617
2858
 
2618
2859
class Converter5to6(object):
2656
2897
        branch._transport.put_bytes('format', format.get_format_string())
2657
2898
 
2658
2899
 
 
2900
class Converter7to8(object):
 
2901
    """Perform an in-place upgrade of format 6 to format 7"""
 
2902
 
 
2903
    def convert(self, branch):
 
2904
        format = BzrBranchFormat8()
 
2905
        branch._transport.put_bytes('references', '')
 
2906
        # update target format
 
2907
        branch._transport.put_bytes('format', format.get_format_string())
 
2908
 
2659
2909
 
2660
2910
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2661
2911
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2672
2922
            return callable(*args, **kwargs)
2673
2923
        finally:
2674
2924
            target.unlock()
2675
 
    
 
2925
 
2676
2926
    """
2677
2927
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2678
2928
    # should share code?
2688
2938
    else:
2689
2939
        target.unlock()
2690
2940
        return result
 
2941
 
 
2942
 
 
2943
class InterBranch(InterObject):
 
2944
    """This class represents operations taking place between two branches.
 
2945
 
 
2946
    Its instances have methods like pull() and push() and contain
 
2947
    references to the source and target repositories these operations
 
2948
    can be carried out on.
 
2949
    """
 
2950
 
 
2951
    _optimisers = []
 
2952
    """The available optimised InterBranch types."""
 
2953
 
 
2954
    @staticmethod
 
2955
    def _get_branch_formats_to_test():
 
2956
        """Return a tuple with the Branch formats to use when testing."""
 
2957
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2958
 
 
2959
    def pull(self, overwrite=False, stop_revision=None,
 
2960
             possible_transports=None, local=False):
 
2961
        """Mirror source into target branch.
 
2962
 
 
2963
        The target branch is considered to be 'local', having low latency.
 
2964
 
 
2965
        :returns: PullResult instance
 
2966
        """
 
2967
        raise NotImplementedError(self.pull)
 
2968
 
 
2969
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2970
                         graph=None):
 
2971
        """Pull in new perfect-fit revisions.
 
2972
 
 
2973
        :param stop_revision: Updated until the given revision
 
2974
        :param overwrite: Always set the branch pointer, rather than checking
 
2975
            to see if it is a proper descendant.
 
2976
        :param graph: A Graph object that can be used to query history
 
2977
            information. This can be None.
 
2978
        :return: None
 
2979
        """
 
2980
        raise NotImplementedError(self.update_revisions)
 
2981
 
 
2982
    def push(self, overwrite=False, stop_revision=None,
 
2983
             _override_hook_source_branch=None):
 
2984
        """Mirror the source branch into the target branch.
 
2985
 
 
2986
        The source branch is considered to be 'local', having low latency.
 
2987
        """
 
2988
        raise NotImplementedError(self.push)
 
2989
 
 
2990
 
 
2991
class GenericInterBranch(InterBranch):
 
2992
    """InterBranch implementation that uses public Branch functions.
 
2993
    """
 
2994
 
 
2995
    @staticmethod
 
2996
    def _get_branch_formats_to_test():
 
2997
        return BranchFormat._default_format, BranchFormat._default_format
 
2998
 
 
2999
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3000
        graph=None):
 
3001
        """See InterBranch.update_revisions()."""
 
3002
        self.source.lock_read()
 
3003
        try:
 
3004
            other_revno, other_last_revision = self.source.last_revision_info()
 
3005
            stop_revno = None # unknown
 
3006
            if stop_revision is None:
 
3007
                stop_revision = other_last_revision
 
3008
                if _mod_revision.is_null(stop_revision):
 
3009
                    # if there are no commits, we're done.
 
3010
                    return
 
3011
                stop_revno = other_revno
 
3012
 
 
3013
            # what's the current last revision, before we fetch [and change it
 
3014
            # possibly]
 
3015
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3016
            # we fetch here so that we don't process data twice in the common
 
3017
            # case of having something to pull, and so that the check for
 
3018
            # already merged can operate on the just fetched graph, which will
 
3019
            # be cached in memory.
 
3020
            self.target.fetch(self.source, stop_revision)
 
3021
            # Check to see if one is an ancestor of the other
 
3022
            if not overwrite:
 
3023
                if graph is None:
 
3024
                    graph = self.target.repository.get_graph()
 
3025
                if self.target._check_if_descendant_or_diverged(
 
3026
                        stop_revision, last_rev, graph, self.source):
 
3027
                    # stop_revision is a descendant of last_rev, but we aren't
 
3028
                    # overwriting, so we're done.
 
3029
                    return
 
3030
            if stop_revno is None:
 
3031
                if graph is None:
 
3032
                    graph = self.target.repository.get_graph()
 
3033
                this_revno, this_last_revision = \
 
3034
                        self.target.last_revision_info()
 
3035
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3036
                                [(other_last_revision, other_revno),
 
3037
                                 (this_last_revision, this_revno)])
 
3038
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3039
        finally:
 
3040
            self.source.unlock()
 
3041
 
 
3042
    def pull(self, overwrite=False, stop_revision=None,
 
3043
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3044
             _override_hook_target=None, local=False):
 
3045
        """See Branch.pull.
 
3046
 
 
3047
        :param _hook_master: Private parameter - set the branch to
 
3048
            be supplied as the master to pull hooks.
 
3049
        :param run_hooks: Private parameter - if false, this branch
 
3050
            is being called because it's the master of the primary branch,
 
3051
            so it should not run its hooks.
 
3052
        :param _override_hook_target: Private parameter - set the branch to be
 
3053
            supplied as the target_branch to pull hooks.
 
3054
        :param local: Only update the local branch, and not the bound branch.
 
3055
        """
 
3056
        # This type of branch can't be bound.
 
3057
        if local:
 
3058
            raise errors.LocalRequiresBoundBranch()
 
3059
        result = PullResult()
 
3060
        result.source_branch = self.source
 
3061
        if _override_hook_target is None:
 
3062
            result.target_branch = self.target
 
3063
        else:
 
3064
            result.target_branch = _override_hook_target
 
3065
        self.source.lock_read()
 
3066
        try:
 
3067
            # We assume that during 'pull' the target repository is closer than
 
3068
            # the source one.
 
3069
            self.source.update_references(self.target)
 
3070
            graph = self.target.repository.get_graph(self.source.repository)
 
3071
            # TODO: Branch formats should have a flag that indicates 
 
3072
            # that revno's are expensive, and pull() should honor that flag.
 
3073
            # -- JRV20090506
 
3074
            result.old_revno, result.old_revid = \
 
3075
                self.target.last_revision_info()
 
3076
            self.target.update_revisions(self.source, stop_revision,
 
3077
                overwrite=overwrite, graph=graph)
 
3078
            # TODO: The old revid should be specified when merging tags, 
 
3079
            # so a tags implementation that versions tags can only 
 
3080
            # pull in the most recent changes. -- JRV20090506
 
3081
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3082
                overwrite)
 
3083
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3084
            if _hook_master:
 
3085
                result.master_branch = _hook_master
 
3086
                result.local_branch = result.target_branch
 
3087
            else:
 
3088
                result.master_branch = result.target_branch
 
3089
                result.local_branch = None
 
3090
            if run_hooks:
 
3091
                for hook in Branch.hooks['post_pull']:
 
3092
                    hook(result)
 
3093
        finally:
 
3094
            self.source.unlock()
 
3095
        return result
 
3096
 
 
3097
    def push(self, overwrite=False, stop_revision=None,
 
3098
             _override_hook_source_branch=None):
 
3099
        """See InterBranch.push.
 
3100
 
 
3101
        This is the basic concrete implementation of push()
 
3102
 
 
3103
        :param _override_hook_source_branch: If specified, run
 
3104
        the hooks passing this Branch as the source, rather than self.
 
3105
        This is for use of RemoteBranch, where push is delegated to the
 
3106
        underlying vfs-based Branch.
 
3107
        """
 
3108
        # TODO: Public option to disable running hooks - should be trivial but
 
3109
        # needs tests.
 
3110
        self.source.lock_read()
 
3111
        try:
 
3112
            return _run_with_write_locked_target(
 
3113
                self.target, self._push_with_bound_branches, overwrite,
 
3114
                stop_revision,
 
3115
                _override_hook_source_branch=_override_hook_source_branch)
 
3116
        finally:
 
3117
            self.source.unlock()
 
3118
 
 
3119
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3120
            _override_hook_source_branch=None):
 
3121
        """Push from source into target, and into target's master if any.
 
3122
        """
 
3123
        def _run_hooks():
 
3124
            if _override_hook_source_branch:
 
3125
                result.source_branch = _override_hook_source_branch
 
3126
            for hook in Branch.hooks['post_push']:
 
3127
                hook(result)
 
3128
 
 
3129
        bound_location = self.target.get_bound_location()
 
3130
        if bound_location and self.target.base != bound_location:
 
3131
            # there is a master branch.
 
3132
            #
 
3133
            # XXX: Why the second check?  Is it even supported for a branch to
 
3134
            # be bound to itself? -- mbp 20070507
 
3135
            master_branch = self.target.get_master_branch()
 
3136
            master_branch.lock_write()
 
3137
            try:
 
3138
                # push into the master from the source branch.
 
3139
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3140
                # and push into the target branch from the source. Note that we
 
3141
                # push from the source branch again, because its considered the
 
3142
                # highest bandwidth repository.
 
3143
                result = self.source._basic_push(self.target, overwrite,
 
3144
                    stop_revision)
 
3145
                result.master_branch = master_branch
 
3146
                result.local_branch = self.target
 
3147
                _run_hooks()
 
3148
                return result
 
3149
            finally:
 
3150
                master_branch.unlock()
 
3151
        else:
 
3152
            # no master branch
 
3153
            result = self.source._basic_push(self.target, overwrite,
 
3154
                stop_revision)
 
3155
            # TODO: Why set master_branch and local_branch if there's no
 
3156
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3157
            # 20070504
 
3158
            result.master_branch = self.target
 
3159
            result.local_branch = None
 
3160
            _run_hooks()
 
3161
            return result
 
3162
 
 
3163
    @classmethod
 
3164
    def is_compatible(self, source, target):
 
3165
        # GenericBranch uses the public API, so always compatible
 
3166
        return True
 
3167
 
 
3168
 
 
3169
class InterToBranch5(GenericInterBranch):
 
3170
 
 
3171
    @staticmethod
 
3172
    def _get_branch_formats_to_test():
 
3173
        return BranchFormat._default_format, BzrBranchFormat5()
 
3174
 
 
3175
    def pull(self, overwrite=False, stop_revision=None,
 
3176
             possible_transports=None, run_hooks=True,
 
3177
             _override_hook_target=None, local=False):
 
3178
        """Pull from source into self, updating my master if any.
 
3179
 
 
3180
        :param run_hooks: Private parameter - if false, this branch
 
3181
            is being called because it's the master of the primary branch,
 
3182
            so it should not run its hooks.
 
3183
        """
 
3184
        bound_location = self.target.get_bound_location()
 
3185
        if local and not bound_location:
 
3186
            raise errors.LocalRequiresBoundBranch()
 
3187
        master_branch = None
 
3188
        if not local and bound_location and self.source.base != bound_location:
 
3189
            # not pulling from master, so we need to update master.
 
3190
            master_branch = self.target.get_master_branch(possible_transports)
 
3191
            master_branch.lock_write()
 
3192
        try:
 
3193
            if master_branch:
 
3194
                # pull from source into master.
 
3195
                master_branch.pull(self.source, overwrite, stop_revision,
 
3196
                    run_hooks=False)
 
3197
            return super(InterToBranch5, self).pull(overwrite,
 
3198
                stop_revision, _hook_master=master_branch,
 
3199
                run_hooks=run_hooks,
 
3200
                _override_hook_target=_override_hook_target)
 
3201
        finally:
 
3202
            if master_branch:
 
3203
                master_branch.unlock()
 
3204
 
 
3205
 
 
3206
InterBranch.register_optimiser(GenericInterBranch)
 
3207
InterBranch.register_optimiser(InterToBranch5)