~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2009-09-14 02:30:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4693.
  • Revision ID: mbp@sourcefrog.net-20090914023023-ros0f3ndo04j3bww
Clearer docs about bzr help.  (Thanks to Naoki)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 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
25
25
        bzrdir,
26
26
        cache_utf8,
27
27
        config as _mod_config,
28
 
        controldir,
29
28
        debug,
30
29
        errors,
31
30
        lockdir,
32
31
        lockable_files,
33
 
        remote,
34
32
        repository,
35
33
        revision as _mod_revision,
36
34
        rio,
48
46
    )
49
47
""")
50
48
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
52
50
from bzrlib.hooks import HookPoint, Hooks
53
51
from bzrlib.inter import InterObject
54
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
52
from bzrlib import registry
56
53
from bzrlib.symbol_versioning import (
57
54
    deprecated_in,
65
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
63
 
67
64
 
68
 
class Branch(controldir.ControlComponent):
 
65
# TODO: Maybe include checks for common corruption of newlines, etc?
 
66
 
 
67
# TODO: Some operations like log might retrieve the same revisions
 
68
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
69
# cache in memory to make this faster.  In general anything can be
 
70
# cached in memory between lock and unlock operations. .. nb thats
 
71
# what the transaction identity map provides
 
72
 
 
73
 
 
74
######################################################################
 
75
# branch objects
 
76
 
 
77
class Branch(object):
69
78
    """Branch holding a history of revisions.
70
79
 
71
 
    :ivar base:
72
 
        Base directory/url of the branch; using control_url and
73
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
74
82
 
75
83
    hooks: An instance of BranchHooks.
76
84
    """
78
86
    # - RBC 20060112
79
87
    base = None
80
88
 
81
 
    @property
82
 
    def control_transport(self):
83
 
        return self._transport
84
 
 
85
 
    @property
86
 
    def user_transport(self):
87
 
        return self.bzrdir.user_transport
88
 
 
89
89
    def __init__(self, *ignored, **ignored_too):
90
90
        self.tags = self._format.make_tags(self)
91
91
        self._revision_history_cache = None
106
106
        """Activate the branch/repository from url as a fallback repository."""
107
107
        repo = self._get_fallback_repository(url)
108
108
        if repo.has_same_location(self.repository):
109
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
110
110
        self.repository.add_fallback_repository(repo)
111
111
 
112
112
    def break_lock(self):
166
166
        """
167
167
        control = bzrdir.BzrDir.open(base, _unsupported,
168
168
                                     possible_transports=possible_transports)
169
 
        return control.open_branch(unsupported=_unsupported)
 
169
        return control.open_branch(_unsupported)
170
170
 
171
171
    @staticmethod
172
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
172
    def open_from_transport(transport, _unsupported=False):
173
173
        """Open the branch rooted at transport"""
174
174
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
175
        return control.open_branch(_unsupported)
176
176
 
177
177
    @staticmethod
178
178
    def open_containing(url, possible_transports=None):
199
199
        return self.supports_tags() and self.tags.get_tag_dict()
200
200
 
201
201
    def get_config(self):
202
 
        """Get a bzrlib.config.BranchConfig for this Branch.
203
 
 
204
 
        This can then be used to get and set configuration options for the
205
 
        branch.
206
 
 
207
 
        :return: A bzrlib.config.BranchConfig.
208
 
        """
209
202
        return BranchConfig(self)
210
203
 
211
204
    def _get_config(self):
223
216
    def _get_fallback_repository(self, url):
224
217
        """Get the repository we fallback to at url."""
225
218
        url = urlutils.join(self.base, url)
226
 
        a_branch = Branch.open(url,
 
219
        a_bzrdir = bzrdir.BzrDir.open(url,
227
220
            possible_transports=[self.bzrdir.root_transport])
228
 
        return a_branch.repository
 
221
        return a_bzrdir.open_branch().repository
229
222
 
230
223
    def _get_tags_bytes(self):
231
224
        """Get the bytes of a serialised tags dict.
247
240
        if not local and not config.has_explicit_nickname():
248
241
            try:
249
242
                master = self.get_master_branch(possible_transports)
250
 
                if master and self.user_url == master.user_url:
251
 
                    raise errors.RecursiveBind(self.user_url)
252
243
                if master is not None:
253
244
                    # return the master branch value
254
245
                    return master.nick
255
 
            except errors.RecursiveBind, e:
256
 
                raise e
257
246
            except errors.BzrError, e:
258
247
                # Silently fall back to local implicit nick if the master is
259
248
                # unavailable
296
285
        new_history.reverse()
297
286
        return new_history
298
287
 
299
 
    def lock_write(self, token=None):
300
 
        """Lock the branch for write operations.
301
 
 
302
 
        :param token: A token to permit reacquiring a previously held and
303
 
            preserved lock.
304
 
        :return: A BranchWriteLockResult.
305
 
        """
 
288
    def lock_write(self):
306
289
        raise NotImplementedError(self.lock_write)
307
290
 
308
291
    def lock_read(self):
309
 
        """Lock the branch for read operations.
310
 
 
311
 
        :return: A bzrlib.lock.LogicalLockResult.
312
 
        """
313
292
        raise NotImplementedError(self.lock_read)
314
293
 
315
294
    def unlock(self):
440
419
            * 'include' - the stop revision is the last item in the result
441
420
            * 'with-merges' - include the stop revision and all of its
442
421
              merged revisions in the result
443
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
444
 
              that are in both ancestries
445
422
        :param direction: either 'reverse' or 'forward':
446
423
            * reverse means return the start_revision_id first, i.e.
447
424
              start at the most recent revision and go backwards in history
469
446
        # start_revision_id.
470
447
        if self._merge_sorted_revisions_cache is None:
471
448
            last_revision = self.last_revision()
472
 
            known_graph = self.repository.get_known_graph_ancestry(
473
 
                [last_revision])
 
449
            last_key = (last_revision,)
 
450
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
451
                [last_key])
474
452
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
475
 
                last_revision)
 
453
                last_key)
476
454
        filtered = self._filter_merge_sorted_revisions(
477
455
            self._merge_sorted_revisions_cache, start_revision_id,
478
456
            stop_revision_id, stop_rule)
479
 
        # Make sure we don't return revisions that are not part of the
480
 
        # start_revision_id ancestry.
481
 
        filtered = self._filter_start_non_ancestors(filtered)
482
457
        if direction == 'reverse':
483
458
            return filtered
484
459
        if direction == 'forward':
521
496
                       node.end_of_merge)
522
497
                if rev_id == stop_revision_id:
523
498
                    return
524
 
        elif stop_rule == 'with-merges-without-common-ancestry':
525
 
            # We want to exclude all revisions that are already part of the
526
 
            # stop_revision_id ancestry.
527
 
            graph = self.repository.get_graph()
528
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
529
 
                                                    [stop_revision_id])
530
 
            for node in rev_iter:
531
 
                rev_id = node.key[-1]
532
 
                if rev_id not in ancestors:
533
 
                    continue
534
 
                yield (rev_id, node.merge_depth, node.revno,
535
 
                       node.end_of_merge)
536
499
        elif stop_rule == 'with-merges':
537
500
            stop_rev = self.repository.get_revision(stop_revision_id)
538
501
            if stop_rev.parent_ids:
539
502
                left_parent = stop_rev.parent_ids[0]
540
503
            else:
541
504
                left_parent = _mod_revision.NULL_REVISION
542
 
            # left_parent is the actual revision we want to stop logging at,
543
 
            # since we want to show the merged revisions after the stop_rev too
544
 
            reached_stop_revision_id = False
545
 
            revision_id_whitelist = []
546
505
            for node in rev_iter:
547
506
                rev_id = node.key[-1]
548
507
                if rev_id == left_parent:
549
 
                    # reached the left parent after the stop_revision
550
508
                    return
551
 
                if (not reached_stop_revision_id or
552
 
                        rev_id in revision_id_whitelist):
553
 
                    yield (rev_id, node.merge_depth, node.revno,
 
509
                yield (rev_id, node.merge_depth, node.revno,
554
510
                       node.end_of_merge)
555
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
556
 
                        # only do the merged revs of rev_id from now on
557
 
                        rev = self.repository.get_revision(rev_id)
558
 
                        if rev.parent_ids:
559
 
                            reached_stop_revision_id = True
560
 
                            revision_id_whitelist.extend(rev.parent_ids)
561
511
        else:
562
512
            raise ValueError('invalid stop_rule %r' % stop_rule)
563
513
 
564
 
    def _filter_start_non_ancestors(self, rev_iter):
565
 
        # If we started from a dotted revno, we want to consider it as a tip
566
 
        # and don't want to yield revisions that are not part of its
567
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
568
 
        # uninteresting descendants of the first parent of our tip before the
569
 
        # tip itself.
570
 
        first = rev_iter.next()
571
 
        (rev_id, merge_depth, revno, end_of_merge) = first
572
 
        yield first
573
 
        if not merge_depth:
574
 
            # We start at a mainline revision so by definition, all others
575
 
            # revisions in rev_iter are ancestors
576
 
            for node in rev_iter:
577
 
                yield node
578
 
 
579
 
        clean = False
580
 
        whitelist = set()
581
 
        pmap = self.repository.get_parent_map([rev_id])
582
 
        parents = pmap.get(rev_id, [])
583
 
        if parents:
584
 
            whitelist.update(parents)
585
 
        else:
586
 
            # If there is no parents, there is nothing of interest left
587
 
 
588
 
            # FIXME: It's hard to test this scenario here as this code is never
589
 
            # called in that case. -- vila 20100322
590
 
            return
591
 
 
592
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
593
 
            if not clean:
594
 
                if rev_id in whitelist:
595
 
                    pmap = self.repository.get_parent_map([rev_id])
596
 
                    parents = pmap.get(rev_id, [])
597
 
                    whitelist.remove(rev_id)
598
 
                    whitelist.update(parents)
599
 
                    if merge_depth == 0:
600
 
                        # We've reached the mainline, there is nothing left to
601
 
                        # filter
602
 
                        clean = True
603
 
                else:
604
 
                    # A revision that is not part of the ancestry of our
605
 
                    # starting revision.
606
 
                    continue
607
 
            yield (rev_id, merge_depth, revno, end_of_merge)
608
 
 
609
514
    def leave_lock_in_place(self):
610
515
        """Tell this branch object not to release the physical lock when this
611
516
        object is unlocked.
628
533
        :param other: The branch to bind to
629
534
        :type other: Branch
630
535
        """
631
 
        raise errors.UpgradeRequired(self.user_url)
 
536
        raise errors.UpgradeRequired(self.base)
632
537
 
633
538
    def set_append_revisions_only(self, enabled):
634
539
        if not self._format.supports_set_append_revisions_only():
635
 
            raise errors.UpgradeRequired(self.user_url)
 
540
            raise errors.UpgradeRequired(self.base)
636
541
        if enabled:
637
542
            value = 'True'
638
543
        else:
686
591
    def get_old_bound_location(self):
687
592
        """Return the URL of the branch we used to be bound to
688
593
        """
689
 
        raise errors.UpgradeRequired(self.user_url)
 
594
        raise errors.UpgradeRequired(self.base)
690
595
 
691
596
    def get_commit_builder(self, parents, config=None, timestamp=None,
692
597
                           timezone=None, committer=None, revprops=None,
770
675
            stacking.
771
676
        """
772
677
        if not self._format.supports_stacking():
773
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
678
            raise errors.UnstackableBranchFormat(self._format, self.base)
774
679
        # XXX: Changing from one fallback repository to another does not check
775
680
        # that all the data you need is present in the new fallback.
776
681
        # Possibly it should.
806
711
            if len(old_repository._fallback_repositories) != 1:
807
712
                raise AssertionError("can't cope with fallback repositories "
808
713
                    "of %r" % (self.repository,))
809
 
            # Open the new repository object.
810
 
            # Repositories don't offer an interface to remove fallback
811
 
            # repositories today; take the conceptually simpler option and just
812
 
            # reopen it.  We reopen it starting from the URL so that we
813
 
            # get a separate connection for RemoteRepositories and can
814
 
            # stream from one of them to the other.  This does mean doing
815
 
            # separate SSH connection setup, but unstacking is not a
816
 
            # common operation so it's tolerable.
817
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
818
 
            new_repository = new_bzrdir.find_repository()
819
 
            if new_repository._fallback_repositories:
820
 
                raise AssertionError("didn't expect %r to have "
821
 
                    "fallback_repositories"
822
 
                    % (self.repository,))
823
 
            # Replace self.repository with the new repository.
824
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
825
 
            # lock count) of self.repository to the new repository.
826
 
            lock_token = old_repository.lock_write().repository_token
827
 
            self.repository = new_repository
828
 
            if isinstance(self, remote.RemoteBranch):
829
 
                # Remote branches can have a second reference to the old
830
 
                # repository that need to be replaced.
831
 
                if self._real_branch is not None:
832
 
                    self._real_branch.repository = new_repository
833
 
            self.repository.lock_write(token=lock_token)
834
 
            if lock_token is not None:
835
 
                old_repository.leave_lock_in_place()
 
714
            # unlock it, including unlocking the fallback
836
715
            old_repository.unlock()
837
 
            if lock_token is not None:
838
 
                # XXX: self.repository.leave_lock_in_place() before this
839
 
                # function will not be preserved.  Fortunately that doesn't
840
 
                # affect the current default format (2a), and would be a
841
 
                # corner-case anyway.
842
 
                #  - Andrew Bennetts, 2010/06/30
843
 
                self.repository.dont_leave_lock_in_place()
844
 
            old_lock_count = 0
845
 
            while True:
846
 
                try:
847
 
                    old_repository.unlock()
848
 
                except errors.LockNotHeld:
849
 
                    break
850
 
                old_lock_count += 1
851
 
            if old_lock_count == 0:
852
 
                raise AssertionError(
853
 
                    'old_repository should have been locked at least once.')
854
 
            for i in range(old_lock_count-1):
 
716
            old_repository.lock_read()
 
717
            try:
 
718
                # Repositories don't offer an interface to remove fallback
 
719
                # repositories today; take the conceptually simpler option and just
 
720
                # reopen it.  We reopen it starting from the URL so that we
 
721
                # get a separate connection for RemoteRepositories and can
 
722
                # stream from one of them to the other.  This does mean doing
 
723
                # separate SSH connection setup, but unstacking is not a
 
724
                # common operation so it's tolerable.
 
725
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
726
                new_repository = new_bzrdir.find_repository()
 
727
                self.repository = new_repository
 
728
                if self.repository._fallback_repositories:
 
729
                    raise AssertionError("didn't expect %r to have "
 
730
                        "fallback_repositories"
 
731
                        % (self.repository,))
 
732
                # this is not paired with an unlock because it's just restoring
 
733
                # the previous state; the lock's released when set_stacked_on_url
 
734
                # returns
855
735
                self.repository.lock_write()
856
 
            # Fetch from the old repository into the new.
857
 
            old_repository.lock_read()
858
 
            try:
859
736
                # XXX: If you unstack a branch while it has a working tree
860
737
                # with a pending merge, the pending-merged revisions will no
861
738
                # longer be present.  You can (probably) revert and remerge.
955
832
 
956
833
    def unbind(self):
957
834
        """Older format branches cannot bind or unbind."""
958
 
        raise errors.UpgradeRequired(self.user_url)
 
835
        raise errors.UpgradeRequired(self.base)
959
836
 
960
837
    def last_revision(self):
961
838
        """Return last revision id, or NULL_REVISION."""
1002
879
                raise errors.NoSuchRevision(self, stop_revision)
1003
880
        return other_history[self_len:stop_revision]
1004
881
 
 
882
    @needs_write_lock
1005
883
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1006
884
                         graph=None):
1007
885
        """Pull in new perfect-fit revisions.
1056
934
            self._extend_partial_history(distance_from_last)
1057
935
        return self._partial_revision_history_cache[distance_from_last]
1058
936
 
 
937
    @needs_write_lock
1059
938
    def pull(self, source, overwrite=False, stop_revision=None,
1060
939
             possible_transports=None, *args, **kwargs):
1061
940
        """Mirror source into this branch.
1119
998
        try:
1120
999
            return urlutils.join(self.base[:-1], parent)
1121
1000
        except errors.InvalidURLJoin, e:
1122
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1001
            raise errors.InaccessibleParent(parent, self.base)
1123
1002
 
1124
1003
    def _get_parent_location(self):
1125
1004
        raise NotImplementedError(self._get_parent_location)
1210
1089
        params = ChangeBranchTipParams(
1211
1090
            self, old_revno, new_revno, old_revid, new_revid)
1212
1091
        for hook in hooks:
1213
 
            hook(params)
 
1092
            try:
 
1093
                hook(params)
 
1094
            except errors.TipChangeRejected:
 
1095
                raise
 
1096
            except Exception:
 
1097
                exc_info = sys.exc_info()
 
1098
                hook_name = Branch.hooks.get_hook_name(hook)
 
1099
                raise errors.HookFailed(
 
1100
                    'pre_change_branch_tip', hook_name, exc_info)
1214
1101
 
1215
1102
    @needs_write_lock
1216
1103
    def update(self):
1304
1191
                revno = 1
1305
1192
        destination.set_last_revision_info(revno, revision_id)
1306
1193
 
 
1194
    @needs_read_lock
1307
1195
    def copy_content_into(self, destination, revision_id=None):
1308
1196
        """Copy the content of self into destination.
1309
1197
 
1310
1198
        revision_id: if not None, the revision history in the new branch will
1311
1199
                     be truncated to end with revision_id.
1312
1200
        """
1313
 
        return InterBranch.get(self, destination).copy_content_into(
1314
 
            revision_id=revision_id)
 
1201
        self.update_references(destination)
 
1202
        self._synchronize_history(destination, revision_id)
 
1203
        try:
 
1204
            parent = self.get_parent()
 
1205
        except errors.InaccessibleParent, e:
 
1206
            mutter('parent was not accessible to copy: %s', e)
 
1207
        else:
 
1208
            if parent:
 
1209
                destination.set_parent(parent)
 
1210
        if self._push_should_merge_tags():
 
1211
            self.tags.merge_to(destination.tags)
1315
1212
 
1316
1213
    def update_references(self, target):
1317
1214
        if not getattr(self._format, 'supports_reference_locations', False):
1385
1282
        """
1386
1283
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1387
1284
        # clone call. Or something. 20090224 RBC/spiv.
1388
 
        # XXX: Should this perhaps clone colocated branches as well, 
1389
 
        # rather than just the default branch? 20100319 JRV
1390
1285
        if revision_id is None:
1391
1286
            revision_id = self.last_revision()
1392
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1393
 
            revision_id=revision_id, stacked_on=stacked_on,
1394
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1287
        try:
 
1288
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1289
                revision_id=revision_id, stacked_on=stacked_on,
 
1290
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1291
        except errors.FileExists:
 
1292
            if not use_existing_dir:
 
1293
                raise
 
1294
        except errors.NoSuchFile:
 
1295
            if not create_prefix:
 
1296
                raise
1395
1297
        return dir_to.open_branch()
1396
1298
 
1397
1299
    def create_checkout(self, to_location, revision_id=None,
1416
1318
        if lightweight:
1417
1319
            format = self._get_checkout_format()
1418
1320
            checkout = format.initialize_on_transport(t)
1419
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1420
 
                target_branch=self)
 
1321
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1421
1322
        else:
1422
1323
            format = self._get_checkout_format()
1423
1324
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1465
1366
    def supports_tags(self):
1466
1367
        return self._format.supports_tags()
1467
1368
 
1468
 
    def automatic_tag_name(self, revision_id):
1469
 
        """Try to automatically find the tag name for a revision.
1470
 
 
1471
 
        :param revision_id: Revision id of the revision.
1472
 
        :return: A tag name or None if no tag name could be determined.
1473
 
        """
1474
 
        for hook in Branch.hooks['automatic_tag_name']:
1475
 
            ret = hook(self, revision_id)
1476
 
            if ret is not None:
1477
 
                return ret
1478
 
        return None
1479
 
 
1480
1369
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1481
1370
                                         other_branch):
1482
1371
        """Ensure that revision_b is a descendant of revision_a.
1522
1411
     * an open routine.
1523
1412
 
1524
1413
    Formats are placed in an dict by their format string for reference
1525
 
    during branch opening. It's not required that these be instances, they
 
1414
    during branch opening. Its not required that these be instances, they
1526
1415
    can be classes themselves with class methods - it simply depends on
1527
1416
    whether state is needed for a given format or not.
1528
1417
 
1546
1435
        return not (self == other)
1547
1436
 
1548
1437
    @classmethod
1549
 
    def find_format(klass, a_bzrdir, name=None):
 
1438
    def find_format(klass, a_bzrdir):
1550
1439
        """Return the format for the branch object in a_bzrdir."""
1551
1440
        try:
1552
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1553
 
            format_string = transport.get_bytes("format")
1554
 
            format = klass._formats[format_string]
1555
 
            if isinstance(format, MetaDirBranchFormatFactory):
1556
 
                return format()
1557
 
            return format
 
1441
            transport = a_bzrdir.get_branch_transport(None)
 
1442
            format_string = transport.get("format").read()
 
1443
            return klass._formats[format_string]
1558
1444
        except errors.NoSuchFile:
1559
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1445
            raise errors.NotBranchError(path=transport.base)
1560
1446
        except KeyError:
1561
1447
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1562
1448
 
1565
1451
        """Return the current default format."""
1566
1452
        return klass._default_format
1567
1453
 
1568
 
    @classmethod
1569
 
    def get_formats(klass):
1570
 
        """Get all the known formats.
1571
 
 
1572
 
        Warning: This triggers a load of all lazy registered formats: do not
1573
 
        use except when that is desireed.
1574
 
        """
1575
 
        result = []
1576
 
        for fmt in klass._formats.values():
1577
 
            if isinstance(fmt, MetaDirBranchFormatFactory):
1578
 
                fmt = fmt()
1579
 
            result.append(fmt)
1580
 
        return result
1581
 
 
1582
 
    def get_reference(self, a_bzrdir, name=None):
 
1454
    def get_reference(self, a_bzrdir):
1583
1455
        """Get the target reference of the branch in a_bzrdir.
1584
1456
 
1585
1457
        format probing must have been completed before calling
1587
1459
        in a_bzrdir is correct.
1588
1460
 
1589
1461
        :param a_bzrdir: The bzrdir to get the branch data from.
1590
 
        :param name: Name of the colocated branch to fetch
1591
1462
        :return: None if the branch is not a reference branch.
1592
1463
        """
1593
1464
        return None
1594
1465
 
1595
1466
    @classmethod
1596
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1467
    def set_reference(self, a_bzrdir, to_branch):
1597
1468
        """Set the target reference of the branch in a_bzrdir.
1598
1469
 
1599
1470
        format probing must have been completed before calling
1601
1472
        in a_bzrdir is correct.
1602
1473
 
1603
1474
        :param a_bzrdir: The bzrdir to set the branch reference for.
1604
 
        :param name: Name of colocated branch to set, None for default
1605
1475
        :param to_branch: branch that the checkout is to reference
1606
1476
        """
1607
1477
        raise NotImplementedError(self.set_reference)
1614
1484
        """Return the short format description for this format."""
1615
1485
        raise NotImplementedError(self.get_format_description)
1616
1486
 
1617
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1618
 
        hooks = Branch.hooks['post_branch_init']
1619
 
        if not hooks:
1620
 
            return
1621
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1622
 
        for hook in hooks:
1623
 
            hook(params)
1624
 
 
1625
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
 
                           lock_type='metadir', set_format=True):
 
1487
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1488
                           set_format=True):
1627
1489
        """Initialize a branch in a bzrdir, with specified files
1628
1490
 
1629
1491
        :param a_bzrdir: The bzrdir to initialize the branch in
1630
1492
        :param utf8_files: The files to create as a list of
1631
1493
            (filename, content) tuples
1632
 
        :param name: Name of colocated branch to create, if any
1633
1494
        :param set_format: If True, set the format with
1634
1495
            self.get_format_string.  (BzrBranch4 has its format set
1635
1496
            elsewhere)
1636
1497
        :return: a branch in this format
1637
1498
        """
1638
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1499
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1500
        branch_transport = a_bzrdir.get_branch_transport(self)
1640
1501
        lock_map = {
1641
1502
            'metadir': ('lock', lockdir.LockDir),
1642
1503
            'branch4': ('branch-lock', lockable_files.TransportLock),
1663
1524
        finally:
1664
1525
            if lock_taken:
1665
1526
                control_files.unlock()
1666
 
        branch = self.open(a_bzrdir, name, _found=True)
1667
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1668
 
        return branch
 
1527
        return self.open(a_bzrdir, _found=True)
1669
1528
 
1670
 
    def initialize(self, a_bzrdir, name=None):
1671
 
        """Create a branch of this format in a_bzrdir.
1672
 
        
1673
 
        :param name: Name of the colocated branch to create.
1674
 
        """
 
1529
    def initialize(self, a_bzrdir):
 
1530
        """Create a branch of this format in a_bzrdir."""
1675
1531
        raise NotImplementedError(self.initialize)
1676
1532
 
1677
1533
    def is_supported(self):
1707
1563
        """
1708
1564
        raise NotImplementedError(self.network_name)
1709
1565
 
1710
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1566
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1711
1567
        """Return the branch object for a_bzrdir
1712
1568
 
1713
1569
        :param a_bzrdir: A BzrDir that contains a branch.
1714
 
        :param name: Name of colocated branch to open
1715
1570
        :param _found: a private parameter, do not use it. It is used to
1716
1571
            indicate if format probing has already be done.
1717
1572
        :param ignore_fallbacks: when set, no fallback branches will be opened
1721
1576
 
1722
1577
    @classmethod
1723
1578
    def register_format(klass, format):
1724
 
        """Register a metadir format.
1725
 
        
1726
 
        See MetaDirBranchFormatFactory for the ability to register a format
1727
 
        without loading the code the format needs until it is actually used.
1728
 
        """
 
1579
        """Register a metadir format."""
1729
1580
        klass._formats[format.get_format_string()] = format
1730
1581
        # Metadir formats have a network name of their format string, and get
1731
 
        # registered as factories.
1732
 
        if isinstance(format, MetaDirBranchFormatFactory):
1733
 
            network_format_registry.register(format.get_format_string(), format)
1734
 
        else:
1735
 
            network_format_registry.register(format.get_format_string(),
1736
 
                format.__class__)
 
1582
        # registered as class factories.
 
1583
        network_format_registry.register(format.get_format_string(), format.__class__)
1737
1584
 
1738
1585
    @classmethod
1739
1586
    def set_default_format(klass, format):
1759
1606
        return False  # by default
1760
1607
 
1761
1608
 
1762
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1764
 
    
1765
 
    While none of the built in BranchFormats are lazy registered yet,
1766
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
 
    use it, and the bzr-loom plugin uses it as well (see
1768
 
    bzrlib.plugins.loom.formats).
1769
 
    """
1770
 
 
1771
 
    def __init__(self, format_string, module_name, member_name):
1772
 
        """Create a MetaDirBranchFormatFactory.
1773
 
 
1774
 
        :param format_string: The format string the format has.
1775
 
        :param module_name: Module to load the format class from.
1776
 
        :param member_name: Attribute name within the module for the format class.
1777
 
        """
1778
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
 
        self._format_string = format_string
1780
 
        
1781
 
    def get_format_string(self):
1782
 
        """See BranchFormat.get_format_string."""
1783
 
        return self._format_string
1784
 
 
1785
 
    def __call__(self):
1786
 
        """Used for network_format_registry support."""
1787
 
        return self.get_obj()()
1788
 
 
1789
 
 
1790
1609
class BranchHooks(Hooks):
1791
1610
    """A dictionary mapping hook name to a list of callables for branch hooks.
1792
1611
 
1819
1638
            "with a bzrlib.branch.PullResult object and only runs in the "
1820
1639
            "bzr client.", (0, 15), None))
1821
1640
        self.create_hook(HookPoint('pre_commit',
1822
 
            "Called after a commit is calculated but before it is "
 
1641
            "Called after a commit is calculated but before it is is "
1823
1642
            "completed. pre_commit is called with (local, master, old_revno, "
1824
1643
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1825
1644
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1861
1680
            "multiple hooks installed for transform_fallback_location, "
1862
1681
            "all are called with the url returned from the previous hook."
1863
1682
            "The order is however undefined.", (1, 9), None))
1864
 
        self.create_hook(HookPoint('automatic_tag_name',
1865
 
            "Called to determine an automatic tag name for a revision. "
1866
 
            "automatic_tag_name is called with (branch, revision_id) and "
1867
 
            "should return a tag name or None if no tag name could be "
1868
 
            "determined. The first non-None tag name returned will be used.",
1869
 
            (2, 2), None))
1870
 
        self.create_hook(HookPoint('post_branch_init',
1871
 
            "Called after new branch initialization completes. "
1872
 
            "post_branch_init is called with a "
1873
 
            "bzrlib.branch.BranchInitHookParams. "
1874
 
            "Note that init, branch and checkout (both heavyweight and "
1875
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1876
 
        self.create_hook(HookPoint('post_switch',
1877
 
            "Called after a checkout switches branch. "
1878
 
            "post_switch is called with a "
1879
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1880
 
 
1881
1683
 
1882
1684
 
1883
1685
# install the default hooks into the Branch class.
1922
1724
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1923
1725
 
1924
1726
 
1925
 
class BranchInitHookParams(object):
1926
 
    """Object holding parameters passed to *_branch_init hooks.
1927
 
 
1928
 
    There are 4 fields that hooks may wish to access:
1929
 
 
1930
 
    :ivar format: the branch format
1931
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1932
 
    :ivar name: name of colocated branch, if any (or None)
1933
 
    :ivar branch: the branch created
1934
 
 
1935
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
 
    the checkout, hence they are different from the corresponding fields in
1937
 
    branch, which refer to the original branch.
1938
 
    """
1939
 
 
1940
 
    def __init__(self, format, a_bzrdir, name, branch):
1941
 
        """Create a group of BranchInitHook parameters.
1942
 
 
1943
 
        :param format: the branch format
1944
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1945
 
            initialized
1946
 
        :param name: name of colocated branch, if any (or None)
1947
 
        :param branch: the branch created
1948
 
 
1949
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1950
 
        to the checkout, hence they are different from the corresponding fields
1951
 
        in branch, which refer to the original branch.
1952
 
        """
1953
 
        self.format = format
1954
 
        self.bzrdir = a_bzrdir
1955
 
        self.name = name
1956
 
        self.branch = branch
1957
 
 
1958
 
    def __eq__(self, other):
1959
 
        return self.__dict__ == other.__dict__
1960
 
 
1961
 
    def __repr__(self):
1962
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
 
1964
 
 
1965
 
class SwitchHookParams(object):
1966
 
    """Object holding parameters passed to *_switch hooks.
1967
 
 
1968
 
    There are 4 fields that hooks may wish to access:
1969
 
 
1970
 
    :ivar control_dir: BzrDir of the checkout to change
1971
 
    :ivar to_branch: branch that the checkout is to reference
1972
 
    :ivar force: skip the check for local commits in a heavy checkout
1973
 
    :ivar revision_id: revision ID to switch to (or None)
1974
 
    """
1975
 
 
1976
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1977
 
        """Create a group of SwitchHook parameters.
1978
 
 
1979
 
        :param control_dir: BzrDir of the checkout to change
1980
 
        :param to_branch: branch that the checkout is to reference
1981
 
        :param force: skip the check for local commits in a heavy checkout
1982
 
        :param revision_id: revision ID to switch to (or None)
1983
 
        """
1984
 
        self.control_dir = control_dir
1985
 
        self.to_branch = to_branch
1986
 
        self.force = force
1987
 
        self.revision_id = revision_id
1988
 
 
1989
 
    def __eq__(self, other):
1990
 
        return self.__dict__ == other.__dict__
1991
 
 
1992
 
    def __repr__(self):
1993
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
 
            self.control_dir, self.to_branch,
1995
 
            self.revision_id)
1996
 
 
1997
 
 
1998
1727
class BzrBranchFormat4(BranchFormat):
1999
1728
    """Bzr branch format 4.
2000
1729
 
2007
1736
        """See BranchFormat.get_format_description()."""
2008
1737
        return "Branch format 4"
2009
1738
 
2010
 
    def initialize(self, a_bzrdir, name=None):
 
1739
    def initialize(self, a_bzrdir):
2011
1740
        """Create a branch of this format in a_bzrdir."""
2012
1741
        utf8_files = [('revision-history', ''),
2013
1742
                      ('branch-name', ''),
2014
1743
                      ]
2015
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1744
        return self._initialize_helper(a_bzrdir, utf8_files,
2016
1745
                                       lock_type='branch4', set_format=False)
2017
1746
 
2018
1747
    def __init__(self):
2023
1752
        """The network name for this format is the control dirs disk label."""
2024
1753
        return self._matchingbzrdir.get_format_string()
2025
1754
 
2026
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1755
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2027
1756
        """See BranchFormat.open()."""
2028
1757
        if not _found:
2029
1758
            # we are being called directly and must probe.
2031
1760
        return BzrBranch(_format=self,
2032
1761
                         _control_files=a_bzrdir._control_files,
2033
1762
                         a_bzrdir=a_bzrdir,
2034
 
                         name=name,
2035
1763
                         _repository=a_bzrdir.open_repository())
2036
1764
 
2037
1765
    def __str__(self):
2052
1780
        """
2053
1781
        return self.get_format_string()
2054
1782
 
2055
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1783
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2056
1784
        """See BranchFormat.open()."""
2057
1785
        if not _found:
2058
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1786
            format = BranchFormat.find_format(a_bzrdir)
2059
1787
            if format.__class__ != self.__class__:
2060
1788
                raise AssertionError("wrong format %r found for %r" %
2061
1789
                    (format, self))
2062
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2063
1790
        try:
 
1791
            transport = a_bzrdir.get_branch_transport(None)
2064
1792
            control_files = lockable_files.LockableFiles(transport, 'lock',
2065
1793
                                                         lockdir.LockDir)
2066
1794
            return self._branch_class()(_format=self,
2067
1795
                              _control_files=control_files,
2068
 
                              name=name,
2069
1796
                              a_bzrdir=a_bzrdir,
2070
1797
                              _repository=a_bzrdir.find_repository(),
2071
1798
                              ignore_fallbacks=ignore_fallbacks)
2072
1799
        except errors.NoSuchFile:
2073
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1800
            raise errors.NotBranchError(path=transport.base)
2074
1801
 
2075
1802
    def __init__(self):
2076
1803
        super(BranchFormatMetadir, self).__init__()
2105
1832
        """See BranchFormat.get_format_description()."""
2106
1833
        return "Branch format 5"
2107
1834
 
2108
 
    def initialize(self, a_bzrdir, name=None):
 
1835
    def initialize(self, a_bzrdir):
2109
1836
        """Create a branch of this format in a_bzrdir."""
2110
1837
        utf8_files = [('revision-history', ''),
2111
1838
                      ('branch-name', ''),
2112
1839
                      ]
2113
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1840
        return self._initialize_helper(a_bzrdir, utf8_files)
2114
1841
 
2115
1842
    def supports_tags(self):
2116
1843
        return False
2138
1865
        """See BranchFormat.get_format_description()."""
2139
1866
        return "Branch format 6"
2140
1867
 
2141
 
    def initialize(self, a_bzrdir, name=None):
 
1868
    def initialize(self, a_bzrdir):
2142
1869
        """Create a branch of this format in a_bzrdir."""
2143
1870
        utf8_files = [('last-revision', '0 null:\n'),
2144
1871
                      ('branch.conf', ''),
2145
1872
                      ('tags', ''),
2146
1873
                      ]
2147
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1874
        return self._initialize_helper(a_bzrdir, utf8_files)
2148
1875
 
2149
1876
    def make_tags(self, branch):
2150
1877
        """See bzrlib.branch.BranchFormat.make_tags()."""
2168
1895
        """See BranchFormat.get_format_description()."""
2169
1896
        return "Branch format 8"
2170
1897
 
2171
 
    def initialize(self, a_bzrdir, name=None):
 
1898
    def initialize(self, a_bzrdir):
2172
1899
        """Create a branch of this format in a_bzrdir."""
2173
1900
        utf8_files = [('last-revision', '0 null:\n'),
2174
1901
                      ('branch.conf', ''),
2175
1902
                      ('tags', ''),
2176
1903
                      ('references', '')
2177
1904
                      ]
2178
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1905
        return self._initialize_helper(a_bzrdir, utf8_files)
2179
1906
 
2180
1907
    def __init__(self):
2181
1908
        super(BzrBranchFormat8, self).__init__()
2204
1931
    This format was introduced in bzr 1.6.
2205
1932
    """
2206
1933
 
2207
 
    def initialize(self, a_bzrdir, name=None):
 
1934
    def initialize(self, a_bzrdir):
2208
1935
        """Create a branch of this format in a_bzrdir."""
2209
1936
        utf8_files = [('last-revision', '0 null:\n'),
2210
1937
                      ('branch.conf', ''),
2211
1938
                      ('tags', ''),
2212
1939
                      ]
2213
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1940
        return self._initialize_helper(a_bzrdir, utf8_files)
2214
1941
 
2215
1942
    def _branch_class(self):
2216
1943
        return BzrBranch7
2248
1975
        """See BranchFormat.get_format_description()."""
2249
1976
        return "Checkout reference format 1"
2250
1977
 
2251
 
    def get_reference(self, a_bzrdir, name=None):
 
1978
    def get_reference(self, a_bzrdir):
2252
1979
        """See BranchFormat.get_reference()."""
2253
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2254
 
        return transport.get_bytes('location')
 
1980
        transport = a_bzrdir.get_branch_transport(None)
 
1981
        return transport.get('location').read()
2255
1982
 
2256
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1983
    def set_reference(self, a_bzrdir, to_branch):
2257
1984
        """See BranchFormat.set_reference()."""
2258
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1985
        transport = a_bzrdir.get_branch_transport(None)
2259
1986
        location = transport.put_bytes('location', to_branch.base)
2260
1987
 
2261
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1988
    def initialize(self, a_bzrdir, target_branch=None):
2262
1989
        """Create a branch of this format in a_bzrdir."""
2263
1990
        if target_branch is None:
2264
1991
            # this format does not implement branch itself, thus the implicit
2265
1992
            # creation contract must see it as uninitializable
2266
1993
            raise errors.UninitializableFormat(self)
2267
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1994
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1995
        branch_transport = a_bzrdir.get_branch_transport(self)
2269
1996
        branch_transport.put_bytes('location',
2270
 
            target_branch.bzrdir.user_url)
 
1997
            target_branch.bzrdir.root_transport.base)
2271
1998
        branch_transport.put_bytes('format', self.get_format_string())
2272
 
        branch = self.open(
2273
 
            a_bzrdir, name, _found=True,
 
1999
        return self.open(
 
2000
            a_bzrdir, _found=True,
2274
2001
            possible_transports=[target_branch.bzrdir.root_transport])
2275
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2276
 
        return branch
2277
2002
 
2278
2003
    def __init__(self):
2279
2004
        super(BranchReferenceFormat, self).__init__()
2285
2010
        def clone(to_bzrdir, revision_id=None,
2286
2011
            repository_policy=None):
2287
2012
            """See Branch.clone()."""
2288
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2013
            return format.initialize(to_bzrdir, a_branch)
2289
2014
            # cannot obey revision_id limits when cloning a reference ...
2290
2015
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2291
2016
            # emit some sort of warning/error to the caller ?!
2292
2017
        return clone
2293
2018
 
2294
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2019
    def open(self, a_bzrdir, _found=False, location=None,
2295
2020
             possible_transports=None, ignore_fallbacks=False):
2296
2021
        """Return the branch that the branch reference in a_bzrdir points at.
2297
2022
 
2298
2023
        :param a_bzrdir: A BzrDir that contains a branch.
2299
 
        :param name: Name of colocated branch to open, if any
2300
2024
        :param _found: a private parameter, do not use it. It is used to
2301
2025
            indicate if format probing has already be done.
2302
2026
        :param ignore_fallbacks: when set, no fallback branches will be opened
2307
2031
        :param possible_transports: An optional reusable transports list.
2308
2032
        """
2309
2033
        if not _found:
2310
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2034
            format = BranchFormat.find_format(a_bzrdir)
2311
2035
            if format.__class__ != self.__class__:
2312
2036
                raise AssertionError("wrong format %r found for %r" %
2313
2037
                    (format, self))
2314
2038
        if location is None:
2315
 
            location = self.get_reference(a_bzrdir, name)
 
2039
            location = self.get_reference(a_bzrdir)
2316
2040
        real_bzrdir = bzrdir.BzrDir.open(
2317
2041
            location, possible_transports=possible_transports)
2318
 
        result = real_bzrdir.open_branch(name=name, 
2319
 
            ignore_fallbacks=ignore_fallbacks)
 
2042
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2320
2043
        # this changes the behaviour of result.clone to create a new reference
2321
2044
        # rather than a copy of the content of the branch.
2322
2045
        # I did not use a proxy object because that needs much more extensive
2356
2079
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2357
2080
 
2358
2081
 
2359
 
class BranchWriteLockResult(LogicalLockResult):
2360
 
    """The result of write locking a branch.
2361
 
 
2362
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2363
 
        None.
2364
 
    :ivar unlock: A callable which will unlock the lock.
2365
 
    """
2366
 
 
2367
 
    def __init__(self, unlock, branch_token):
2368
 
        LogicalLockResult.__init__(self, unlock)
2369
 
        self.branch_token = branch_token
2370
 
 
2371
 
    def __repr__(self):
2372
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2373
 
            self.unlock)
2374
 
 
2375
 
 
2376
 
class BzrBranch(Branch, _RelockDebugMixin):
 
2082
class BzrBranch(Branch):
2377
2083
    """A branch stored in the actual filesystem.
2378
2084
 
2379
2085
    Note that it's "local" in the context of the filesystem; it doesn't
2385
2091
    :ivar repository: Repository for this branch.
2386
2092
    :ivar base: The url of the base directory for this branch; the one
2387
2093
        containing the .bzr directory.
2388
 
    :ivar name: Optional colocated branch name as it exists in the control
2389
 
        directory.
2390
2094
    """
2391
2095
 
2392
2096
    def __init__(self, _format=None,
2393
 
                 _control_files=None, a_bzrdir=None, name=None,
2394
 
                 _repository=None, ignore_fallbacks=False):
 
2097
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2098
                 ignore_fallbacks=False):
2395
2099
        """Create new branch object at a particular location."""
2396
2100
        if a_bzrdir is None:
2397
2101
            raise ValueError('a_bzrdir must be supplied')
2398
2102
        else:
2399
2103
            self.bzrdir = a_bzrdir
2400
2104
        self._base = self.bzrdir.transport.clone('..').base
2401
 
        self.name = name
2402
2105
        # XXX: We should be able to just do
2403
2106
        #   self.base = self.bzrdir.root_transport.base
2404
2107
        # but this does not quite work yet -- mbp 20080522
2411
2114
        Branch.__init__(self)
2412
2115
 
2413
2116
    def __str__(self):
2414
 
        if self.name is None:
2415
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2416
 
        else:
2417
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2418
 
                self.name)
 
2117
        return '%s(%r)' % (self.__class__.__name__, self.base)
2419
2118
 
2420
2119
    __repr__ = __str__
2421
2120
 
2432
2131
        return self.control_files.is_locked()
2433
2132
 
2434
2133
    def lock_write(self, token=None):
2435
 
        """Lock the branch for write operations.
2436
 
 
2437
 
        :param token: A token to permit reacquiring a previously held and
2438
 
            preserved lock.
2439
 
        :return: A BranchWriteLockResult.
2440
 
        """
2441
 
        if not self.is_locked():
2442
 
            self._note_lock('w')
2443
2134
        # All-in-one needs to always unlock/lock.
2444
2135
        repo_control = getattr(self.repository, 'control_files', None)
2445
2136
        if self.control_files == repo_control or not self.is_locked():
2446
 
            self.repository._warn_if_deprecated(self)
2447
2137
            self.repository.lock_write()
2448
2138
            took_lock = True
2449
2139
        else:
2450
2140
            took_lock = False
2451
2141
        try:
2452
 
            return BranchWriteLockResult(self.unlock,
2453
 
                self.control_files.lock_write(token=token))
 
2142
            return self.control_files.lock_write(token=token)
2454
2143
        except:
2455
2144
            if took_lock:
2456
2145
                self.repository.unlock()
2457
2146
            raise
2458
2147
 
2459
2148
    def lock_read(self):
2460
 
        """Lock the branch for read operations.
2461
 
 
2462
 
        :return: A bzrlib.lock.LogicalLockResult.
2463
 
        """
2464
 
        if not self.is_locked():
2465
 
            self._note_lock('r')
2466
2149
        # All-in-one needs to always unlock/lock.
2467
2150
        repo_control = getattr(self.repository, 'control_files', None)
2468
2151
        if self.control_files == repo_control or not self.is_locked():
2469
 
            self.repository._warn_if_deprecated(self)
2470
2152
            self.repository.lock_read()
2471
2153
            took_lock = True
2472
2154
        else:
2473
2155
            took_lock = False
2474
2156
        try:
2475
2157
            self.control_files.lock_read()
2476
 
            return LogicalLockResult(self.unlock)
2477
2158
        except:
2478
2159
            if took_lock:
2479
2160
                self.repository.unlock()
2480
2161
            raise
2481
2162
 
2482
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2483
2163
    def unlock(self):
2484
2164
        try:
2485
2165
            self.control_files.unlock()
2648
2328
        return result
2649
2329
 
2650
2330
    def get_stacked_on_url(self):
2651
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2331
        raise errors.UnstackableBranchFormat(self._format, self.base)
2652
2332
 
2653
2333
    def set_push_location(self, location):
2654
2334
        """See Branch.set_push_location."""
2844
2524
        if _mod_revision.is_null(last_revision):
2845
2525
            return
2846
2526
        if last_revision not in self._lefthand_history(revision_id):
2847
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2527
            raise errors.AppendRevisionsOnlyViolation(self.base)
2848
2528
 
2849
2529
    def _gen_revision_history(self):
2850
2530
        """Generate the revision history from last revision
2950
2630
        if branch_location is None:
2951
2631
            return Branch.reference_parent(self, file_id, path,
2952
2632
                                           possible_transports)
2953
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2633
        branch_location = urlutils.join(self.base, branch_location)
2954
2634
        return Branch.open(branch_location,
2955
2635
                           possible_transports=possible_transports)
2956
2636
 
3002
2682
        return stacked_url
3003
2683
 
3004
2684
    def _get_append_revisions_only(self):
3005
 
        return self.get_config(
3006
 
            ).get_user_option_as_bool('append_revisions_only')
 
2685
        value = self.get_config().get_user_option('append_revisions_only')
 
2686
        return value == 'True'
3007
2687
 
3008
2688
    @needs_write_lock
3009
2689
    def generate_revision_history(self, revision_id, last_rev=None,
3071
2751
    """
3072
2752
 
3073
2753
    def get_stacked_on_url(self):
3074
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2754
        raise errors.UnstackableBranchFormat(self._format, self.base)
3075
2755
 
3076
2756
 
3077
2757
######################################################################
3103
2783
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3104
2784
    """
3105
2785
 
3106
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3107
2786
    def __int__(self):
3108
 
        """Return the relative change in revno.
3109
 
 
3110
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3111
 
        """
 
2787
        # DEPRECATED: pull used to return the change in revno
3112
2788
        return self.new_revno - self.old_revno
3113
2789
 
3114
2790
    def report(self, to_file):
3139
2815
        target, otherwise it will be None.
3140
2816
    """
3141
2817
 
3142
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3143
2818
    def __int__(self):
3144
 
        """Return the relative change in revno.
3145
 
 
3146
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3147
 
        """
 
2819
        # DEPRECATED: push used to return the change in revno
3148
2820
        return self.new_revno - self.old_revno
3149
2821
 
3150
2822
    def report(self, to_file):
3172
2844
        :param verbose: Requests more detailed display of what was checked,
3173
2845
            if any.
3174
2846
        """
3175
 
        note('checked branch %s format %s', self.branch.user_url,
 
2847
        note('checked branch %s format %s', self.branch.base,
3176
2848
            self.branch._format)
3177
2849
        for error in self.errors:
3178
2850
            note('found error:%s', error)
3273
2945
    _optimisers = []
3274
2946
    """The available optimised InterBranch types."""
3275
2947
 
3276
 
    @classmethod
3277
 
    def _get_branch_formats_to_test(klass):
3278
 
        """Return an iterable of format tuples for testing.
3279
 
        
3280
 
        :return: An iterable of (from_format, to_format) to use when testing
3281
 
            this InterBranch class. Each InterBranch class should define this
3282
 
            method itself.
3283
 
        """
3284
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
2948
    @staticmethod
 
2949
    def _get_branch_formats_to_test():
 
2950
        """Return a tuple with the Branch formats to use when testing."""
 
2951
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3285
2952
 
3286
 
    @needs_write_lock
3287
2953
    def pull(self, overwrite=False, stop_revision=None,
3288
2954
             possible_transports=None, local=False):
3289
2955
        """Mirror source into target branch.
3294
2960
        """
3295
2961
        raise NotImplementedError(self.pull)
3296
2962
 
3297
 
    @needs_write_lock
3298
2963
    def update_revisions(self, stop_revision=None, overwrite=False,
3299
2964
                         graph=None):
3300
2965
        """Pull in new perfect-fit revisions.
3308
2973
        """
3309
2974
        raise NotImplementedError(self.update_revisions)
3310
2975
 
3311
 
    @needs_write_lock
3312
2976
    def push(self, overwrite=False, stop_revision=None,
3313
2977
             _override_hook_source_branch=None):
3314
2978
        """Mirror the source branch into the target branch.
3317
2981
        """
3318
2982
        raise NotImplementedError(self.push)
3319
2983
 
3320
 
    @needs_write_lock
3321
 
    def copy_content_into(self, revision_id=None):
3322
 
        """Copy the content of source into target
3323
 
 
3324
 
        revision_id: if not None, the revision history in the new branch will
3325
 
                     be truncated to end with revision_id.
3326
 
        """
3327
 
        raise NotImplementedError(self.copy_content_into)
3328
 
 
3329
2984
 
3330
2985
class GenericInterBranch(InterBranch):
3331
 
    """InterBranch implementation that uses public Branch functions."""
3332
 
 
3333
 
    @classmethod
3334
 
    def is_compatible(klass, source, target):
3335
 
        # GenericBranch uses the public API, so always compatible
3336
 
        return True
3337
 
 
3338
 
    @classmethod
3339
 
    def _get_branch_formats_to_test(klass):
3340
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3341
 
 
3342
 
    @classmethod
3343
 
    def unwrap_format(klass, format):
3344
 
        if isinstance(format, remote.RemoteBranchFormat):
3345
 
            format._ensure_real()
3346
 
            return format._custom_format
3347
 
        return format                                                                                                  
3348
 
 
3349
 
    @needs_write_lock
3350
 
    def copy_content_into(self, revision_id=None):
3351
 
        """Copy the content of source into target
3352
 
 
3353
 
        revision_id: if not None, the revision history in the new branch will
3354
 
                     be truncated to end with revision_id.
3355
 
        """
3356
 
        self.source.update_references(self.target)
3357
 
        self.source._synchronize_history(self.target, revision_id)
3358
 
        try:
3359
 
            parent = self.source.get_parent()
3360
 
        except errors.InaccessibleParent, e:
3361
 
            mutter('parent was not accessible to copy: %s', e)
3362
 
        else:
3363
 
            if parent:
3364
 
                self.target.set_parent(parent)
3365
 
        if self.source._push_should_merge_tags():
3366
 
            self.source.tags.merge_to(self.target.tags)
3367
 
 
3368
 
    @needs_write_lock
 
2986
    """InterBranch implementation that uses public Branch functions.
 
2987
    """
 
2988
 
 
2989
    @staticmethod
 
2990
    def _get_branch_formats_to_test():
 
2991
        return BranchFormat._default_format, BranchFormat._default_format
 
2992
 
3369
2993
    def update_revisions(self, stop_revision=None, overwrite=False,
3370
2994
        graph=None):
3371
2995
        """See InterBranch.update_revisions()."""
3372
 
        other_revno, other_last_revision = self.source.last_revision_info()
3373
 
        stop_revno = None # unknown
3374
 
        if stop_revision is None:
3375
 
            stop_revision = other_last_revision
3376
 
            if _mod_revision.is_null(stop_revision):
3377
 
                # if there are no commits, we're done.
3378
 
                return
3379
 
            stop_revno = other_revno
3380
 
 
3381
 
        # what's the current last revision, before we fetch [and change it
3382
 
        # possibly]
3383
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3384
 
        # we fetch here so that we don't process data twice in the common
3385
 
        # case of having something to pull, and so that the check for
3386
 
        # already merged can operate on the just fetched graph, which will
3387
 
        # be cached in memory.
3388
 
        self.target.fetch(self.source, stop_revision)
3389
 
        # Check to see if one is an ancestor of the other
3390
 
        if not overwrite:
3391
 
            if graph is None:
3392
 
                graph = self.target.repository.get_graph()
3393
 
            if self.target._check_if_descendant_or_diverged(
3394
 
                    stop_revision, last_rev, graph, self.source):
3395
 
                # stop_revision is a descendant of last_rev, but we aren't
3396
 
                # overwriting, so we're done.
3397
 
                return
3398
 
        if stop_revno is None:
3399
 
            if graph is None:
3400
 
                graph = self.target.repository.get_graph()
3401
 
            this_revno, this_last_revision = \
3402
 
                    self.target.last_revision_info()
3403
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3404
 
                            [(other_last_revision, other_revno),
3405
 
                             (this_last_revision, this_revno)])
3406
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3407
 
 
3408
 
    @needs_write_lock
 
2996
        self.source.lock_read()
 
2997
        try:
 
2998
            other_revno, other_last_revision = self.source.last_revision_info()
 
2999
            stop_revno = None # unknown
 
3000
            if stop_revision is None:
 
3001
                stop_revision = other_last_revision
 
3002
                if _mod_revision.is_null(stop_revision):
 
3003
                    # if there are no commits, we're done.
 
3004
                    return
 
3005
                stop_revno = other_revno
 
3006
 
 
3007
            # what's the current last revision, before we fetch [and change it
 
3008
            # possibly]
 
3009
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3010
            # we fetch here so that we don't process data twice in the common
 
3011
            # case of having something to pull, and so that the check for
 
3012
            # already merged can operate on the just fetched graph, which will
 
3013
            # be cached in memory.
 
3014
            self.target.fetch(self.source, stop_revision)
 
3015
            # Check to see if one is an ancestor of the other
 
3016
            if not overwrite:
 
3017
                if graph is None:
 
3018
                    graph = self.target.repository.get_graph()
 
3019
                if self.target._check_if_descendant_or_diverged(
 
3020
                        stop_revision, last_rev, graph, self.source):
 
3021
                    # stop_revision is a descendant of last_rev, but we aren't
 
3022
                    # overwriting, so we're done.
 
3023
                    return
 
3024
            if stop_revno is None:
 
3025
                if graph is None:
 
3026
                    graph = self.target.repository.get_graph()
 
3027
                this_revno, this_last_revision = \
 
3028
                        self.target.last_revision_info()
 
3029
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3030
                                [(other_last_revision, other_revno),
 
3031
                                 (this_last_revision, this_revno)])
 
3032
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3033
        finally:
 
3034
            self.source.unlock()
 
3035
 
3409
3036
    def pull(self, overwrite=False, stop_revision=None,
3410
 
             possible_transports=None, run_hooks=True,
 
3037
             possible_transports=None, _hook_master=None, run_hooks=True,
3411
3038
             _override_hook_target=None, local=False):
3412
 
        """Pull from source into self, updating my master if any.
 
3039
        """See Branch.pull.
3413
3040
 
 
3041
        :param _hook_master: Private parameter - set the branch to
 
3042
            be supplied as the master to pull hooks.
3414
3043
        :param run_hooks: Private parameter - if false, this branch
3415
3044
            is being called because it's the master of the primary branch,
3416
3045
            so it should not run its hooks.
 
3046
        :param _override_hook_target: Private parameter - set the branch to be
 
3047
            supplied as the target_branch to pull hooks.
 
3048
        :param local: Only update the local branch, and not the bound branch.
3417
3049
        """
3418
 
        bound_location = self.target.get_bound_location()
3419
 
        if local and not bound_location:
 
3050
        # This type of branch can't be bound.
 
3051
        if local:
3420
3052
            raise errors.LocalRequiresBoundBranch()
3421
 
        master_branch = None
3422
 
        if not local and bound_location and self.source.user_url != bound_location:
3423
 
            # not pulling from master, so we need to update master.
3424
 
            master_branch = self.target.get_master_branch(possible_transports)
3425
 
            master_branch.lock_write()
 
3053
        result = PullResult()
 
3054
        result.source_branch = self.source
 
3055
        if _override_hook_target is None:
 
3056
            result.target_branch = self.target
 
3057
        else:
 
3058
            result.target_branch = _override_hook_target
 
3059
        self.source.lock_read()
3426
3060
        try:
3427
 
            if master_branch:
3428
 
                # pull from source into master.
3429
 
                master_branch.pull(self.source, overwrite, stop_revision,
3430
 
                    run_hooks=False)
3431
 
            return self._pull(overwrite,
3432
 
                stop_revision, _hook_master=master_branch,
3433
 
                run_hooks=run_hooks,
3434
 
                _override_hook_target=_override_hook_target)
 
3061
            # We assume that during 'pull' the target repository is closer than
 
3062
            # the source one.
 
3063
            self.source.update_references(self.target)
 
3064
            graph = self.target.repository.get_graph(self.source.repository)
 
3065
            # TODO: Branch formats should have a flag that indicates 
 
3066
            # that revno's are expensive, and pull() should honor that flag.
 
3067
            # -- JRV20090506
 
3068
            result.old_revno, result.old_revid = \
 
3069
                self.target.last_revision_info()
 
3070
            self.target.update_revisions(self.source, stop_revision,
 
3071
                overwrite=overwrite, graph=graph)
 
3072
            # TODO: The old revid should be specified when merging tags, 
 
3073
            # so a tags implementation that versions tags can only 
 
3074
            # pull in the most recent changes. -- JRV20090506
 
3075
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3076
                overwrite)
 
3077
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3078
            if _hook_master:
 
3079
                result.master_branch = _hook_master
 
3080
                result.local_branch = result.target_branch
 
3081
            else:
 
3082
                result.master_branch = result.target_branch
 
3083
                result.local_branch = None
 
3084
            if run_hooks:
 
3085
                for hook in Branch.hooks['post_pull']:
 
3086
                    hook(result)
3435
3087
        finally:
3436
 
            if master_branch:
3437
 
                master_branch.unlock()
 
3088
            self.source.unlock()
 
3089
        return result
3438
3090
 
3439
3091
    def push(self, overwrite=False, stop_revision=None,
3440
3092
             _override_hook_source_branch=None):
3480
3132
                # push into the master from the source branch.
3481
3133
                self.source._basic_push(master_branch, overwrite, stop_revision)
3482
3134
                # and push into the target branch from the source. Note that we
3483
 
                # push from the source branch again, because it's considered the
 
3135
                # push from the source branch again, because its considered the
3484
3136
                # highest bandwidth repository.
3485
3137
                result = self.source._basic_push(self.target, overwrite,
3486
3138
                    stop_revision)
3502
3154
            _run_hooks()
3503
3155
            return result
3504
3156
 
3505
 
    def _pull(self, overwrite=False, stop_revision=None,
3506
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3157
    @classmethod
 
3158
    def is_compatible(self, source, target):
 
3159
        # GenericBranch uses the public API, so always compatible
 
3160
        return True
 
3161
 
 
3162
 
 
3163
class InterToBranch5(GenericInterBranch):
 
3164
 
 
3165
    @staticmethod
 
3166
    def _get_branch_formats_to_test():
 
3167
        return BranchFormat._default_format, BzrBranchFormat5()
 
3168
 
 
3169
    def pull(self, overwrite=False, stop_revision=None,
 
3170
             possible_transports=None, run_hooks=True,
3507
3171
             _override_hook_target=None, local=False):
3508
 
        """See Branch.pull.
3509
 
 
3510
 
        This function is the core worker, used by GenericInterBranch.pull to
3511
 
        avoid duplication when pulling source->master and source->local.
3512
 
 
3513
 
        :param _hook_master: Private parameter - set the branch to
3514
 
            be supplied as the master to pull hooks.
 
3172
        """Pull from source into self, updating my master if any.
 
3173
 
3515
3174
        :param run_hooks: Private parameter - if false, this branch
3516
3175
            is being called because it's the master of the primary branch,
3517
3176
            so it should not run its hooks.
3518
 
        :param _override_hook_target: Private parameter - set the branch to be
3519
 
            supplied as the target_branch to pull hooks.
3520
 
        :param local: Only update the local branch, and not the bound branch.
3521
3177
        """
3522
 
        # This type of branch can't be bound.
3523
 
        if local:
 
3178
        bound_location = self.target.get_bound_location()
 
3179
        if local and not bound_location:
3524
3180
            raise errors.LocalRequiresBoundBranch()
3525
 
        result = PullResult()
3526
 
        result.source_branch = self.source
3527
 
        if _override_hook_target is None:
3528
 
            result.target_branch = self.target
3529
 
        else:
3530
 
            result.target_branch = _override_hook_target
3531
 
        self.source.lock_read()
 
3181
        master_branch = None
 
3182
        if not local and bound_location and self.source.base != bound_location:
 
3183
            # not pulling from master, so we need to update master.
 
3184
            master_branch = self.target.get_master_branch(possible_transports)
 
3185
            master_branch.lock_write()
3532
3186
        try:
3533
 
            # We assume that during 'pull' the target repository is closer than
3534
 
            # the source one.
3535
 
            self.source.update_references(self.target)
3536
 
            graph = self.target.repository.get_graph(self.source.repository)
3537
 
            # TODO: Branch formats should have a flag that indicates 
3538
 
            # that revno's are expensive, and pull() should honor that flag.
3539
 
            # -- JRV20090506
3540
 
            result.old_revno, result.old_revid = \
3541
 
                self.target.last_revision_info()
3542
 
            self.target.update_revisions(self.source, stop_revision,
3543
 
                overwrite=overwrite, graph=graph)
3544
 
            # TODO: The old revid should be specified when merging tags, 
3545
 
            # so a tags implementation that versions tags can only 
3546
 
            # pull in the most recent changes. -- JRV20090506
3547
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3548
 
                overwrite)
3549
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3550
 
            if _hook_master:
3551
 
                result.master_branch = _hook_master
3552
 
                result.local_branch = result.target_branch
3553
 
            else:
3554
 
                result.master_branch = result.target_branch
3555
 
                result.local_branch = None
3556
 
            if run_hooks:
3557
 
                for hook in Branch.hooks['post_pull']:
3558
 
                    hook(result)
 
3187
            if master_branch:
 
3188
                # pull from source into master.
 
3189
                master_branch.pull(self.source, overwrite, stop_revision,
 
3190
                    run_hooks=False)
 
3191
            return super(InterToBranch5, self).pull(overwrite,
 
3192
                stop_revision, _hook_master=master_branch,
 
3193
                run_hooks=run_hooks,
 
3194
                _override_hook_target=_override_hook_target)
3559
3195
        finally:
3560
 
            self.source.unlock()
3561
 
        return result
 
3196
            if master_branch:
 
3197
                master_branch.unlock()
3562
3198
 
3563
3199
 
3564
3200
InterBranch.register_optimiser(GenericInterBranch)
 
3201
InterBranch.register_optimiser(InterToBranch5)