/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-21 07:52:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5176.
  • Revision ID: andrew.bennetts@canonical.com-20100421075231-2n8pfxbhlhqxic6w
https://launchpad.net/bugs/532435
Add example merge_file_content hook based on my answer to <https://answers.edge.launchpad.net/bzr/+question/103163>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
49
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
53
53
from bzrlib import registry
54
54
from bzrlib.symbol_versioning import (
55
55
    deprecated_in,
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):
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: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
293
        raise NotImplementedError(self.lock_read)
301
294
 
302
295
    def unlock(self):
427
420
            * 'include' - the stop revision is the last item in the result
428
421
            * 'with-merges' - include the stop revision and all of its
429
422
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
423
        :param direction: either 'reverse' or 'forward':
433
424
            * reverse means return the start_revision_id first, i.e.
434
425
              start at the most recent revision and go backwards in history
465
456
            stop_revision_id, stop_rule)
466
457
        # Make sure we don't return revisions that are not part of the
467
458
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
 
459
        filtered = self._filter_non_ancestors(filtered)
469
460
        if direction == 'reverse':
470
461
            return filtered
471
462
        if direction == 'forward':
508
499
                       node.end_of_merge)
509
500
                if rev_id == stop_revision_id:
510
501
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
502
        elif stop_rule == 'with-merges':
524
503
            stop_rev = self.repository.get_revision(stop_revision_id)
525
504
            if stop_rev.parent_ids:
548
527
        else:
549
528
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
529
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
 
530
    def _filter_non_ancestors(self, rev_iter):
552
531
        # If we started from a dotted revno, we want to consider it as a tip
553
532
        # and don't want to yield revisions that are not part of its
554
533
        # ancestry. Given the order guaranteed by the merge sort, we will see
615
594
        :param other: The branch to bind to
616
595
        :type other: Branch
617
596
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
 
597
        raise errors.UpgradeRequired(self.base)
619
598
 
620
599
    def set_append_revisions_only(self, enabled):
621
600
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
 
601
            raise errors.UpgradeRequired(self.base)
623
602
        if enabled:
624
603
            value = 'True'
625
604
        else:
673
652
    def get_old_bound_location(self):
674
653
        """Return the URL of the branch we used to be bound to
675
654
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
655
        raise errors.UpgradeRequired(self.base)
677
656
 
678
657
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
658
                           timezone=None, committer=None, revprops=None,
757
736
            stacking.
758
737
        """
759
738
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
739
            raise errors.UnstackableBranchFormat(self._format, self.base)
761
740
        # XXX: Changing from one fallback repository to another does not check
762
741
        # that all the data you need is present in the new fallback.
763
742
        # Possibly it should.
914
893
 
915
894
    def unbind(self):
916
895
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
896
        raise errors.UpgradeRequired(self.base)
918
897
 
919
898
    def last_revision(self):
920
899
        """Return last revision id, or NULL_REVISION."""
1080
1059
        try:
1081
1060
            return urlutils.join(self.base[:-1], parent)
1082
1061
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1062
            raise errors.InaccessibleParent(parent, self.base)
1084
1063
 
1085
1064
    def _get_parent_location(self):
1086
1065
        raise NotImplementedError(self._get_parent_location)
1356
1335
        """
1357
1336
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1337
        # clone call. Or something. 20090224 RBC/spiv.
1359
 
        # XXX: Should this perhaps clone colocated branches as well, 
1360
 
        # rather than just the default branch? 20100319 JRV
1361
1338
        if revision_id is None:
1362
1339
            revision_id = self.last_revision()
1363
1340
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1533
1510
        """Return the current default format."""
1534
1511
        return klass._default_format
1535
1512
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
 
1513
    def get_reference(self, a_bzrdir):
1537
1514
        """Get the target reference of the branch in a_bzrdir.
1538
1515
 
1539
1516
        format probing must have been completed before calling
1541
1518
        in a_bzrdir is correct.
1542
1519
 
1543
1520
        :param a_bzrdir: The bzrdir to get the branch data from.
1544
 
        :param name: Name of the colocated branch to fetch
1545
1521
        :return: None if the branch is not a reference branch.
1546
1522
        """
1547
1523
        return None
1548
1524
 
1549
1525
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1526
    def set_reference(self, a_bzrdir, to_branch):
1551
1527
        """Set the target reference of the branch in a_bzrdir.
1552
1528
 
1553
1529
        format probing must have been completed before calling
1555
1531
        in a_bzrdir is correct.
1556
1532
 
1557
1533
        :param a_bzrdir: The bzrdir to set the branch reference for.
1558
 
        :param name: Name of colocated branch to set, None for default
1559
1534
        :param to_branch: branch that the checkout is to reference
1560
1535
        """
1561
1536
        raise NotImplementedError(self.set_reference)
1568
1543
        """Return the short format description for this format."""
1569
1544
        raise NotImplementedError(self.get_format_description)
1570
1545
 
1571
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
 
        hooks = Branch.hooks['post_branch_init']
1573
 
        if not hooks:
1574
 
            return
1575
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
 
        for hook in hooks:
1577
 
            hook(params)
1578
 
 
1579
1546
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
1547
                           lock_type='metadir', set_format=True):
1581
1548
        """Initialize a branch in a bzrdir, with specified files
1589
1556
            elsewhere)
1590
1557
        :return: a branch in this format
1591
1558
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1559
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1593
1560
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1594
1561
        lock_map = {
1595
1562
            'metadir': ('lock', lockdir.LockDir),
1617
1584
        finally:
1618
1585
            if lock_taken:
1619
1586
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
 
1587
        return self.open(a_bzrdir, name, _found=True)
1623
1588
 
1624
1589
    def initialize(self, a_bzrdir, name=None):
1625
1590
        """Create a branch of this format in a_bzrdir.
1785
1750
            "should return a tag name or None if no tag name could be "
1786
1751
            "determined. The first non-None tag name returned will be used.",
1787
1752
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
1789
 
            "Called after new branch initialization completes. "
1790
 
            "post_branch_init is called with a "
1791
 
            "bzrlib.branch.BranchInitHookParams. "
1792
 
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
1795
 
            "Called after a checkout switches branch. "
1796
 
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
1753
 
1799
1754
 
1800
1755
 
1840
1795
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1841
1796
 
1842
1797
 
1843
 
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
1845
 
 
1846
 
    There are 4 fields that hooks may wish to access:
1847
 
 
1848
 
    :ivar format: the branch format
1849
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
 
    :ivar name: name of colocated branch, if any (or None)
1851
 
    :ivar branch: the branch created
1852
 
 
1853
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
 
    the checkout, hence they are different from the corresponding fields in
1855
 
    branch, which refer to the original branch.
1856
 
    """
1857
 
 
1858
 
    def __init__(self, format, a_bzrdir, name, branch):
1859
 
        """Create a group of BranchInitHook parameters.
1860
 
 
1861
 
        :param format: the branch format
1862
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1863
 
            initialized
1864
 
        :param name: name of colocated branch, if any (or None)
1865
 
        :param branch: the branch created
1866
 
 
1867
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1868
 
        to the checkout, hence they are different from the corresponding fields
1869
 
        in branch, which refer to the original branch.
1870
 
        """
1871
 
        self.format = format
1872
 
        self.bzrdir = a_bzrdir
1873
 
        self.name = name
1874
 
        self.branch = branch
1875
 
 
1876
 
    def __eq__(self, other):
1877
 
        return self.__dict__ == other.__dict__
1878
 
 
1879
 
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
1886
 
 
1887
 
 
1888
 
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
1890
 
 
1891
 
    There are 4 fields that hooks may wish to access:
1892
 
 
1893
 
    :ivar control_dir: BzrDir of the checkout to change
1894
 
    :ivar to_branch: branch that the checkout is to reference
1895
 
    :ivar force: skip the check for local commits in a heavy checkout
1896
 
    :ivar revision_id: revision ID to switch to (or None)
1897
 
    """
1898
 
 
1899
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1900
 
        """Create a group of SwitchHook parameters.
1901
 
 
1902
 
        :param control_dir: BzrDir of the checkout to change
1903
 
        :param to_branch: branch that the checkout is to reference
1904
 
        :param force: skip the check for local commits in a heavy checkout
1905
 
        :param revision_id: revision ID to switch to (or None)
1906
 
        """
1907
 
        self.control_dir = control_dir
1908
 
        self.to_branch = to_branch
1909
 
        self.force = force
1910
 
        self.revision_id = revision_id
1911
 
 
1912
 
    def __eq__(self, other):
1913
 
        return self.__dict__ == other.__dict__
1914
 
 
1915
 
    def __repr__(self):
1916
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
 
            self.control_dir, self.to_branch,
1918
 
            self.revision_id)
1919
 
 
1920
 
 
1921
1798
class BzrBranchFormat4(BranchFormat):
1922
1799
    """Bzr branch format 4.
1923
1800
 
1982
1859
            if format.__class__ != self.__class__:
1983
1860
                raise AssertionError("wrong format %r found for %r" %
1984
1861
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
1862
        try:
 
1863
            transport = a_bzrdir.get_branch_transport(None, name=name)
1987
1864
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1865
                                                         lockdir.LockDir)
1989
1866
            return self._branch_class()(_format=self,
2171
2048
        """See BranchFormat.get_format_description()."""
2172
2049
        return "Checkout reference format 1"
2173
2050
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
 
2051
    def get_reference(self, a_bzrdir):
2175
2052
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2053
        transport = a_bzrdir.get_branch_transport(None)
2177
2054
        return transport.get_bytes('location')
2178
2055
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
2056
    def set_reference(self, a_bzrdir, to_branch):
2180
2057
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2058
        transport = a_bzrdir.get_branch_transport(None)
2182
2059
        location = transport.put_bytes('location', to_branch.base)
2183
2060
 
2184
2061
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2187
2064
            # this format does not implement branch itself, thus the implicit
2188
2065
            # creation contract must see it as uninitializable
2189
2066
            raise errors.UninitializableFormat(self)
2190
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2067
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
2191
2068
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2192
2069
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
 
2070
            target_branch.bzrdir.root_transport.base)
2194
2071
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
 
2072
        return self.open(
2196
2073
            a_bzrdir, name, _found=True,
2197
2074
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
2075
 
2201
2076
    def __init__(self):
2202
2077
        super(BranchReferenceFormat, self).__init__()
2235
2110
                raise AssertionError("wrong format %r found for %r" %
2236
2111
                    (format, self))
2237
2112
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
 
2113
            location = self.get_reference(a_bzrdir)
2239
2114
        real_bzrdir = bzrdir.BzrDir.open(
2240
2115
            location, possible_transports=possible_transports)
2241
2116
        result = real_bzrdir.open_branch(name=name, 
2279
2154
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2280
2155
 
2281
2156
 
2282
 
class BranchWriteLockResult(LogicalLockResult):
2283
 
    """The result of write locking a branch.
2284
 
 
2285
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2286
 
        None.
2287
 
    :ivar unlock: A callable which will unlock the lock.
2288
 
    """
2289
 
 
2290
 
    def __init__(self, unlock, branch_token):
2291
 
        LogicalLockResult.__init__(self, unlock)
2292
 
        self.branch_token = branch_token
2293
 
 
2294
 
    def __repr__(self):
2295
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
 
            self.unlock)
2297
 
 
2298
 
 
2299
2157
class BzrBranch(Branch, _RelockDebugMixin):
2300
2158
    """A branch stored in the actual filesystem.
2301
2159
 
2335
2193
 
2336
2194
    def __str__(self):
2337
2195
        if self.name is None:
2338
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2196
            return '%s(%r)' % (self.__class__.__name__, self.base)
2339
2197
        else:
2340
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2341
 
                self.name)
 
2198
            return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2342
2199
 
2343
2200
    __repr__ = __str__
2344
2201
 
2355
2212
        return self.control_files.is_locked()
2356
2213
 
2357
2214
    def lock_write(self, token=None):
2358
 
        """Lock the branch for write operations.
2359
 
 
2360
 
        :param token: A token to permit reacquiring a previously held and
2361
 
            preserved lock.
2362
 
        :return: A BranchWriteLockResult.
2363
 
        """
2364
2215
        if not self.is_locked():
2365
2216
            self._note_lock('w')
2366
2217
        # All-in-one needs to always unlock/lock.
2372
2223
        else:
2373
2224
            took_lock = False
2374
2225
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
 
2226
            return self.control_files.lock_write(token=token)
2377
2227
        except:
2378
2228
            if took_lock:
2379
2229
                self.repository.unlock()
2380
2230
            raise
2381
2231
 
2382
2232
    def lock_read(self):
2383
 
        """Lock the branch for read operations.
2384
 
 
2385
 
        :return: A bzrlib.lock.LogicalLockResult.
2386
 
        """
2387
2233
        if not self.is_locked():
2388
2234
            self._note_lock('r')
2389
2235
        # All-in-one needs to always unlock/lock.
2396
2242
            took_lock = False
2397
2243
        try:
2398
2244
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
2245
        except:
2401
2246
            if took_lock:
2402
2247
                self.repository.unlock()
2571
2416
        return result
2572
2417
 
2573
2418
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2419
        raise errors.UnstackableBranchFormat(self._format, self.base)
2575
2420
 
2576
2421
    def set_push_location(self, location):
2577
2422
        """See Branch.set_push_location."""
2767
2612
        if _mod_revision.is_null(last_revision):
2768
2613
            return
2769
2614
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2615
            raise errors.AppendRevisionsOnlyViolation(self.base)
2771
2616
 
2772
2617
    def _gen_revision_history(self):
2773
2618
        """Generate the revision history from last revision
2873
2718
        if branch_location is None:
2874
2719
            return Branch.reference_parent(self, file_id, path,
2875
2720
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2721
        branch_location = urlutils.join(self.base, branch_location)
2877
2722
        return Branch.open(branch_location,
2878
2723
                           possible_transports=possible_transports)
2879
2724
 
2925
2770
        return stacked_url
2926
2771
 
2927
2772
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
 
2773
        value = self.get_config().get_user_option('append_revisions_only')
 
2774
        return value == 'True'
2930
2775
 
2931
2776
    @needs_write_lock
2932
2777
    def generate_revision_history(self, revision_id, last_rev=None,
2994
2839
    """
2995
2840
 
2996
2841
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2842
        raise errors.UnstackableBranchFormat(self._format, self.base)
2998
2843
 
2999
2844
 
3000
2845
######################################################################
3087
2932
        :param verbose: Requests more detailed display of what was checked,
3088
2933
            if any.
3089
2934
        """
3090
 
        note('checked branch %s format %s', self.branch.user_url,
 
2935
        note('checked branch %s format %s', self.branch.base,
3091
2936
            self.branch._format)
3092
2937
        for error in self.errors:
3093
2938
            note('found error:%s', error)
3422
3267
        if local and not bound_location:
3423
3268
            raise errors.LocalRequiresBoundBranch()
3424
3269
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3270
        if not local and bound_location and self.source.base != bound_location:
3426
3271
            # not pulling from master, so we need to update master.
3427
3272
            master_branch = self.target.get_master_branch(possible_transports)
3428
3273
            master_branch.lock_write()