← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2009-10-26 06:44:40 UTC
  • mfrom: (4634.77.9 2.0)
  • mto: This revision was merged to the branch mainline in revision 4770.
  • Revision ID: andrew.bennetts@canonical.com-20091026064440-06u7tpg7l6sjkh8h
Merge lp:bzr/2.0 into lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
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
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
64
 
65
65
 
66
 
class Branch(bzrdir.ControlComponent):
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
67
79
    """Branch holding a history of revisions.
68
80
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
81
    base
 
82
        Base directory/url of the branch.
72
83
 
73
84
    hooks: An instance of BranchHooks.
74
85
    """
76
87
    # - RBC 20060112
77
88
    base = None
78
89
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
90
    def __init__(self, *ignored, **ignored_too):
88
91
        self.tags = self._format.make_tags(self)
89
92
        self._revision_history_cache = None
104
107
        """Activate the branch/repository from url as a fallback repository."""
105
108
        repo = self._get_fallback_repository(url)
106
109
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
164
167
        """
165
168
        control = bzrdir.BzrDir.open(base, _unsupported,
166
169
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
170
        return control.open_branch(_unsupported)
168
171
 
169
172
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
173
    def open_from_transport(transport, _unsupported=False):
171
174
        """Open the branch rooted at transport"""
172
175
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
176
        return control.open_branch(_unsupported)
174
177
 
175
178
    @staticmethod
176
179
    def open_containing(url, possible_transports=None):
214
217
    def _get_fallback_repository(self, url):
215
218
        """Get the repository we fallback to at url."""
216
219
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
220
        a_bzrdir = bzrdir.BzrDir.open(url,
218
221
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
222
        return a_bzrdir.open_branch().repository
220
223
 
221
224
    def _get_tags_bytes(self):
222
225
        """Get the bytes of a serialised tags dict.
283
286
        new_history.reverse()
284
287
        return new_history
285
288
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
289
    def lock_write(self):
293
290
        raise NotImplementedError(self.lock_write)
294
291
 
295
292
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
293
        raise NotImplementedError(self.lock_read)
302
294
 
303
295
    def unlock(self):
428
420
            * 'include' - the stop revision is the last item in the result
429
421
            * 'with-merges' - include the stop revision and all of its
430
422
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
423
        :param direction: either 'reverse' or 'forward':
434
424
            * reverse means return the start_revision_id first, i.e.
435
425
              start at the most recent revision and go backwards in history
457
447
        # start_revision_id.
458
448
        if self._merge_sorted_revisions_cache is None:
459
449
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
462
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
454
                last_key)
464
455
        filtered = self._filter_merge_sorted_revisions(
465
456
            self._merge_sorted_revisions_cache, start_revision_id,
466
457
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
458
        if direction == 'reverse':
471
459
            return filtered
472
460
        if direction == 'forward':
509
497
                       node.end_of_merge)
510
498
                if rev_id == stop_revision_id:
511
499
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
500
        elif stop_rule == 'with-merges':
525
501
            stop_rev = self.repository.get_revision(stop_revision_id)
526
502
            if stop_rev.parent_ids:
527
503
                left_parent = stop_rev.parent_ids[0]
528
504
            else:
529
505
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
506
            for node in rev_iter:
535
507
                rev_id = node.key[-1]
536
508
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
509
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
 
510
                yield (rev_id, node.merge_depth, node.revno,
542
511
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
549
512
        else:
550
513
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
514
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
515
    def leave_lock_in_place(self):
598
516
        """Tell this branch object not to release the physical lock when this
599
517
        object is unlocked.
616
534
        :param other: The branch to bind to
617
535
        :type other: Branch
618
536
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
537
        raise errors.UpgradeRequired(self.base)
620
538
 
621
539
    def set_append_revisions_only(self, enabled):
622
540
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
541
            raise errors.UpgradeRequired(self.base)
624
542
        if enabled:
625
543
            value = 'True'
626
544
        else:
674
592
    def get_old_bound_location(self):
675
593
        """Return the URL of the branch we used to be bound to
676
594
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
595
        raise errors.UpgradeRequired(self.base)
678
596
 
679
597
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
598
                           timezone=None, committer=None, revprops=None,
758
676
            stacking.
759
677
        """
760
678
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
679
            raise errors.UnstackableBranchFormat(self._format, self.base)
762
680
        # XXX: Changing from one fallback repository to another does not check
763
681
        # that all the data you need is present in the new fallback.
764
682
        # Possibly it should.
915
833
 
916
834
    def unbind(self):
917
835
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
836
        raise errors.UpgradeRequired(self.base)
919
837
 
920
838
    def last_revision(self):
921
839
        """Return last revision id, or NULL_REVISION."""
1081
999
        try:
1082
1000
            return urlutils.join(self.base[:-1], parent)
1083
1001
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1002
            raise errors.InaccessibleParent(parent, self.base)
1085
1003
 
1086
1004
    def _get_parent_location(self):
1087
1005
        raise NotImplementedError(self._get_parent_location)
1172
1090
        params = ChangeBranchTipParams(
1173
1091
            self, old_revno, new_revno, old_revid, new_revid)
1174
1092
        for hook in hooks:
1175
 
            hook(params)
 
1093
            try:
 
1094
                hook(params)
 
1095
            except errors.TipChangeRejected:
 
1096
                raise
 
1097
            except Exception:
 
1098
                exc_info = sys.exc_info()
 
1099
                hook_name = Branch.hooks.get_hook_name(hook)
 
1100
                raise errors.HookFailed(
 
1101
                    'pre_change_branch_tip', hook_name, exc_info)
1176
1102
 
1177
1103
    @needs_write_lock
1178
1104
    def update(self):
1359
1285
        # clone call. Or something. 20090224 RBC/spiv.
1360
1286
        if revision_id is None:
1361
1287
            revision_id = self.last_revision()
1362
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1288
        try:
 
1289
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1290
                revision_id=revision_id, stacked_on=stacked_on,
 
1291
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1292
        except errors.FileExists:
 
1293
            if not use_existing_dir:
 
1294
                raise
 
1295
        except errors.NoSuchFile:
 
1296
            if not create_prefix:
 
1297
                raise
1365
1298
        return dir_to.open_branch()
1366
1299
 
1367
1300
    def create_checkout(self, to_location, revision_id=None,
1386
1319
        if lightweight:
1387
1320
            format = self._get_checkout_format()
1388
1321
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1322
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1323
        else:
1392
1324
            format = self._get_checkout_format()
1393
1325
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1367
    def supports_tags(self):
1436
1368
        return self._format.supports_tags()
1437
1369
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1370
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1371
                                         other_branch):
1452
1372
        """Ensure that revision_b is a descendant of revision_a.
1516
1436
        return not (self == other)
1517
1437
 
1518
1438
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1439
    def find_format(klass, a_bzrdir):
1520
1440
        """Return the format for the branch object in a_bzrdir."""
1521
1441
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1442
            transport = a_bzrdir.get_branch_transport(None)
 
1443
            format_string = transport.get("format").read()
1524
1444
            return klass._formats[format_string]
1525
1445
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1446
            raise errors.NotBranchError(path=transport.base)
1527
1447
        except KeyError:
1528
1448
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1449
 
1565
1485
        """Return the short format description for this format."""
1566
1486
        raise NotImplementedError(self.get_format_description)
1567
1487
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1488
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1489
                           set_format=True):
1578
1490
        """Initialize a branch in a bzrdir, with specified files
1579
1491
 
1580
1492
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1493
        :param utf8_files: The files to create as a list of
1582
1494
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1495
        :param set_format: If True, set the format with
1585
1496
            self.get_format_string.  (BzrBranch4 has its format set
1586
1497
            elsewhere)
1587
1498
        :return: a branch in this format
1588
1499
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1500
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1501
        branch_transport = a_bzrdir.get_branch_transport(self)
1591
1502
        lock_map = {
1592
1503
            'metadir': ('lock', lockdir.LockDir),
1593
1504
            'branch4': ('branch-lock', lockable_files.TransportLock),
1614
1525
        finally:
1615
1526
            if lock_taken:
1616
1527
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1528
        return self.open(a_bzrdir, _found=True)
1620
1529
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1530
    def initialize(self, a_bzrdir):
 
1531
        """Create a branch of this format in a_bzrdir."""
1626
1532
        raise NotImplementedError(self.initialize)
1627
1533
 
1628
1534
    def is_supported(self):
1658
1564
        """
1659
1565
        raise NotImplementedError(self.network_name)
1660
1566
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1567
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1568
        """Return the branch object for a_bzrdir
1663
1569
 
1664
1570
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1571
        :param _found: a private parameter, do not use it. It is used to
1667
1572
            indicate if format probing has already be done.
1668
1573
        :param ignore_fallbacks: when set, no fallback branches will be opened
1776
1681
            "multiple hooks installed for transform_fallback_location, "
1777
1682
            "all are called with the url returned from the previous hook."
1778
1683
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1684
 
1797
1685
 
1798
1686
# install the default hooks into the Branch class.
1837
1725
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1726
 
1839
1727
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1728
class BzrBranchFormat4(BranchFormat):
1919
1729
    """Bzr branch format 4.
1920
1730
 
1927
1737
        """See BranchFormat.get_format_description()."""
1928
1738
        return "Branch format 4"
1929
1739
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1740
    def initialize(self, a_bzrdir):
1931
1741
        """Create a branch of this format in a_bzrdir."""
1932
1742
        utf8_files = [('revision-history', ''),
1933
1743
                      ('branch-name', ''),
1934
1744
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1745
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1746
                                       lock_type='branch4', set_format=False)
1937
1747
 
1938
1748
    def __init__(self):
1943
1753
        """The network name for this format is the control dirs disk label."""
1944
1754
        return self._matchingbzrdir.get_format_string()
1945
1755
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1756
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1757
        """See BranchFormat.open()."""
1948
1758
        if not _found:
1949
1759
            # we are being called directly and must probe.
1951
1761
        return BzrBranch(_format=self,
1952
1762
                         _control_files=a_bzrdir._control_files,
1953
1763
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1764
                         _repository=a_bzrdir.open_repository())
1956
1765
 
1957
1766
    def __str__(self):
1972
1781
        """
1973
1782
        return self.get_format_string()
1974
1783
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1784
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1785
        """See BranchFormat.open()."""
1977
1786
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1787
            format = BranchFormat.find_format(a_bzrdir)
1979
1788
            if format.__class__ != self.__class__:
1980
1789
                raise AssertionError("wrong format %r found for %r" %
1981
1790
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1791
        try:
 
1792
            transport = a_bzrdir.get_branch_transport(None)
1984
1793
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1794
                                                         lockdir.LockDir)
1986
1795
            return self._branch_class()(_format=self,
1987
1796
                              _control_files=control_files,
1988
 
                              name=name,
1989
1797
                              a_bzrdir=a_bzrdir,
1990
1798
                              _repository=a_bzrdir.find_repository(),
1991
1799
                              ignore_fallbacks=ignore_fallbacks)
1992
1800
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1801
            raise errors.NotBranchError(path=transport.base)
1994
1802
 
1995
1803
    def __init__(self):
1996
1804
        super(BranchFormatMetadir, self).__init__()
2025
1833
        """See BranchFormat.get_format_description()."""
2026
1834
        return "Branch format 5"
2027
1835
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1836
    def initialize(self, a_bzrdir):
2029
1837
        """Create a branch of this format in a_bzrdir."""
2030
1838
        utf8_files = [('revision-history', ''),
2031
1839
                      ('branch-name', ''),
2032
1840
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1841
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1842
 
2035
1843
    def supports_tags(self):
2036
1844
        return False
2058
1866
        """See BranchFormat.get_format_description()."""
2059
1867
        return "Branch format 6"
2060
1868
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1869
    def initialize(self, a_bzrdir):
2062
1870
        """Create a branch of this format in a_bzrdir."""
2063
1871
        utf8_files = [('last-revision', '0 null:\n'),
2064
1872
                      ('branch.conf', ''),
2065
1873
                      ('tags', ''),
2066
1874
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1875
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1876
 
2069
1877
    def make_tags(self, branch):
2070
1878
        """See bzrlib.branch.BranchFormat.make_tags()."""
2088
1896
        """See BranchFormat.get_format_description()."""
2089
1897
        return "Branch format 8"
2090
1898
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1899
    def initialize(self, a_bzrdir):
2092
1900
        """Create a branch of this format in a_bzrdir."""
2093
1901
        utf8_files = [('last-revision', '0 null:\n'),
2094
1902
                      ('branch.conf', ''),
2095
1903
                      ('tags', ''),
2096
1904
                      ('references', '')
2097
1905
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1906
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1907
 
2100
1908
    def __init__(self):
2101
1909
        super(BzrBranchFormat8, self).__init__()
2124
1932
    This format was introduced in bzr 1.6.
2125
1933
    """
2126
1934
 
2127
 
    def initialize(self, a_bzrdir, name=None):
 
1935
    def initialize(self, a_bzrdir):
2128
1936
        """Create a branch of this format in a_bzrdir."""
2129
1937
        utf8_files = [('last-revision', '0 null:\n'),
2130
1938
                      ('branch.conf', ''),
2131
1939
                      ('tags', ''),
2132
1940
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1941
        return self._initialize_helper(a_bzrdir, utf8_files)
2134
1942
 
2135
1943
    def _branch_class(self):
2136
1944
        return BzrBranch7
2171
1979
    def get_reference(self, a_bzrdir):
2172
1980
        """See BranchFormat.get_reference()."""
2173
1981
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1982
        return transport.get('location').read()
2175
1983
 
2176
1984
    def set_reference(self, a_bzrdir, to_branch):
2177
1985
        """See BranchFormat.set_reference()."""
2178
1986
        transport = a_bzrdir.get_branch_transport(None)
2179
1987
        location = transport.put_bytes('location', to_branch.base)
2180
1988
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1989
    def initialize(self, a_bzrdir, target_branch=None):
2182
1990
        """Create a branch of this format in a_bzrdir."""
2183
1991
        if target_branch is None:
2184
1992
            # this format does not implement branch itself, thus the implicit
2185
1993
            # creation contract must see it as uninitializable
2186
1994
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1995
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1996
        branch_transport = a_bzrdir.get_branch_transport(self)
2189
1997
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1998
            target_branch.bzrdir.root_transport.base)
2191
1999
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
2000
        return self.open(
 
2001
            a_bzrdir, _found=True,
2194
2002
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
2003
 
2198
2004
    def __init__(self):
2199
2005
        super(BranchReferenceFormat, self).__init__()
2205
2011
        def clone(to_bzrdir, revision_id=None,
2206
2012
            repository_policy=None):
2207
2013
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2014
            return format.initialize(to_bzrdir, a_branch)
2209
2015
            # cannot obey revision_id limits when cloning a reference ...
2210
2016
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
2017
            # emit some sort of warning/error to the caller ?!
2212
2018
        return clone
2213
2019
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2020
    def open(self, a_bzrdir, _found=False, location=None,
2215
2021
             possible_transports=None, ignore_fallbacks=False):
2216
2022
        """Return the branch that the branch reference in a_bzrdir points at.
2217
2023
 
2218
2024
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
2025
        :param _found: a private parameter, do not use it. It is used to
2221
2026
            indicate if format probing has already be done.
2222
2027
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
2032
        :param possible_transports: An optional reusable transports list.
2228
2033
        """
2229
2034
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2035
            format = BranchFormat.find_format(a_bzrdir)
2231
2036
            if format.__class__ != self.__class__:
2232
2037
                raise AssertionError("wrong format %r found for %r" %
2233
2038
                    (format, self))
2235
2040
            location = self.get_reference(a_bzrdir)
2236
2041
        real_bzrdir = bzrdir.BzrDir.open(
2237
2042
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
2043
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2044
        # this changes the behaviour of result.clone to create a new reference
2241
2045
        # rather than a copy of the content of the branch.
2242
2046
        # I did not use a proxy object because that needs much more extensive
2276
2080
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2081
 
2278
2082
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
    def __str__(self):
2292
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
 
            self.unlock)
2294
 
 
2295
 
 
2296
2083
class BzrBranch(Branch, _RelockDebugMixin):
2297
2084
    """A branch stored in the actual filesystem.
2298
2085
 
2305
2092
    :ivar repository: Repository for this branch.
2306
2093
    :ivar base: The url of the base directory for this branch; the one
2307
2094
        containing the .bzr directory.
2308
 
    :ivar name: Optional colocated branch name as it exists in the control
2309
 
        directory.
2310
2095
    """
2311
2096
 
2312
2097
    def __init__(self, _format=None,
2313
 
                 _control_files=None, a_bzrdir=None, name=None,
2314
 
                 _repository=None, ignore_fallbacks=False):
 
2098
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2099
                 ignore_fallbacks=False):
2315
2100
        """Create new branch object at a particular location."""
2316
2101
        if a_bzrdir is None:
2317
2102
            raise ValueError('a_bzrdir must be supplied')
2318
2103
        else:
2319
2104
            self.bzrdir = a_bzrdir
2320
2105
        self._base = self.bzrdir.transport.clone('..').base
2321
 
        self.name = name
2322
2106
        # XXX: We should be able to just do
2323
2107
        #   self.base = self.bzrdir.root_transport.base
2324
2108
        # but this does not quite work yet -- mbp 20080522
2331
2115
        Branch.__init__(self)
2332
2116
 
2333
2117
    def __str__(self):
2334
 
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2336
 
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
2118
        return '%s(%r)' % (self.__class__.__name__, self.base)
2339
2119
 
2340
2120
    __repr__ = __str__
2341
2121
 
2352
2132
        return self.control_files.is_locked()
2353
2133
 
2354
2134
    def lock_write(self, token=None):
2355
 
        """Lock the branch for write operations.
2356
 
 
2357
 
        :param token: A token to permit reacquiring a previously held and
2358
 
            preserved lock.
2359
 
        :return: A BranchWriteLockResult.
2360
 
        """
2361
2135
        if not self.is_locked():
2362
2136
            self._note_lock('w')
2363
2137
        # All-in-one needs to always unlock/lock.
2364
2138
        repo_control = getattr(self.repository, 'control_files', None)
2365
2139
        if self.control_files == repo_control or not self.is_locked():
2366
 
            self.repository._warn_if_deprecated(self)
2367
2140
            self.repository.lock_write()
2368
2141
            took_lock = True
2369
2142
        else:
2370
2143
            took_lock = False
2371
2144
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
2145
            return self.control_files.lock_write(token=token)
2374
2146
        except:
2375
2147
            if took_lock:
2376
2148
                self.repository.unlock()
2377
2149
            raise
2378
2150
 
2379
2151
    def lock_read(self):
2380
 
        """Lock the branch for read operations.
2381
 
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
2384
 
        """
2385
2152
        if not self.is_locked():
2386
2153
            self._note_lock('r')
2387
2154
        # All-in-one needs to always unlock/lock.
2388
2155
        repo_control = getattr(self.repository, 'control_files', None)
2389
2156
        if self.control_files == repo_control or not self.is_locked():
2390
 
            self.repository._warn_if_deprecated(self)
2391
2157
            self.repository.lock_read()
2392
2158
            took_lock = True
2393
2159
        else:
2394
2160
            took_lock = False
2395
2161
        try:
2396
2162
            self.control_files.lock_read()
2397
 
            return self
2398
2163
        except:
2399
2164
            if took_lock:
2400
2165
                self.repository.unlock()
2569
2334
        return result
2570
2335
 
2571
2336
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2337
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2338
 
2574
2339
    def set_push_location(self, location):
2575
2340
        """See Branch.set_push_location."""
2765
2530
        if _mod_revision.is_null(last_revision):
2766
2531
            return
2767
2532
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2533
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2534
 
2770
2535
    def _gen_revision_history(self):
2771
2536
        """Generate the revision history from last revision
2871
2636
        if branch_location is None:
2872
2637
            return Branch.reference_parent(self, file_id, path,
2873
2638
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2639
        branch_location = urlutils.join(self.base, branch_location)
2875
2640
        return Branch.open(branch_location,
2876
2641
                           possible_transports=possible_transports)
2877
2642
 
2923
2688
        return stacked_url
2924
2689
 
2925
2690
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2691
        value = self.get_config().get_user_option('append_revisions_only')
 
2692
        return value == 'True'
2928
2693
 
2929
2694
    @needs_write_lock
2930
2695
    def generate_revision_history(self, revision_id, last_rev=None,
2992
2757
    """
2993
2758
 
2994
2759
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2760
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2761
 
2997
2762
 
2998
2763
######################################################################
3085
2850
        :param verbose: Requests more detailed display of what was checked,
3086
2851
            if any.
3087
2852
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
 
2853
        note('checked branch %s format %s', self.branch.base,
3089
2854
            self.branch._format)
3090
2855
        for error in self.errors:
3091
2856
            note('found error:%s', error)
3420
3185
        if local and not bound_location:
3421
3186
            raise errors.LocalRequiresBoundBranch()
3422
3187
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3188
        if not local and bound_location and self.source.base != bound_location:
3424
3189
            # not pulling from master, so we need to update master.
3425
3190
            master_branch = self.target.get_master_branch(possible_transports)
3426
3191
            master_branch.lock_write()