/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: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

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
456
447
        # start_revision_id.
457
448
        if self._merge_sorted_revisions_cache is None:
458
449
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
461
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                last_revision)
 
454
                last_key)
463
455
        filtered = self._filter_merge_sorted_revisions(
464
456
            self._merge_sorted_revisions_cache, start_revision_id,
465
457
            stop_revision_id, stop_rule)
466
458
        # Make sure we don't return revisions that are not part of the
467
459
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
 
460
        filtered = self._filter_non_ancestors(filtered)
469
461
        if direction == 'reverse':
470
462
            return filtered
471
463
        if direction == 'forward':
508
500
                       node.end_of_merge)
509
501
                if rev_id == stop_revision_id:
510
502
                    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
503
        elif stop_rule == 'with-merges':
524
504
            stop_rev = self.repository.get_revision(stop_revision_id)
525
505
            if stop_rev.parent_ids:
548
528
        else:
549
529
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
530
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
 
531
    def _filter_non_ancestors(self, rev_iter):
552
532
        # If we started from a dotted revno, we want to consider it as a tip
553
533
        # and don't want to yield revisions that are not part of its
554
534
        # ancestry. Given the order guaranteed by the merge sort, we will see
615
595
        :param other: The branch to bind to
616
596
        :type other: Branch
617
597
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
 
598
        raise errors.UpgradeRequired(self.base)
619
599
 
620
600
    def set_append_revisions_only(self, enabled):
621
601
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
 
602
            raise errors.UpgradeRequired(self.base)
623
603
        if enabled:
624
604
            value = 'True'
625
605
        else:
673
653
    def get_old_bound_location(self):
674
654
        """Return the URL of the branch we used to be bound to
675
655
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
656
        raise errors.UpgradeRequired(self.base)
677
657
 
678
658
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
659
                           timezone=None, committer=None, revprops=None,
757
737
            stacking.
758
738
        """
759
739
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
740
            raise errors.UnstackableBranchFormat(self._format, self.base)
761
741
        # XXX: Changing from one fallback repository to another does not check
762
742
        # that all the data you need is present in the new fallback.
763
743
        # Possibly it should.
914
894
 
915
895
    def unbind(self):
916
896
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
897
        raise errors.UpgradeRequired(self.base)
918
898
 
919
899
    def last_revision(self):
920
900
        """Return last revision id, or NULL_REVISION."""
1080
1060
        try:
1081
1061
            return urlutils.join(self.base[:-1], parent)
1082
1062
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1063
            raise errors.InaccessibleParent(parent, self.base)
1084
1064
 
1085
1065
    def _get_parent_location(self):
1086
1066
        raise NotImplementedError(self._get_parent_location)
1564
1544
        """Return the short format description for this format."""
1565
1545
        raise NotImplementedError(self.get_format_description)
1566
1546
 
1567
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
 
        hooks = Branch.hooks['post_branch_init']
1569
 
        if not hooks:
1570
 
            return
1571
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1572
 
        for hook in hooks:
1573
 
            hook(params)
1574
 
 
1575
1547
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
1548
                           lock_type='metadir', set_format=True):
1577
1549
        """Initialize a branch in a bzrdir, with specified files
1585
1557
            elsewhere)
1586
1558
        :return: a branch in this format
1587
1559
        """
1588
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1560
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1589
1561
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1590
1562
        lock_map = {
1591
1563
            'metadir': ('lock', lockdir.LockDir),
1613
1585
        finally:
1614
1586
            if lock_taken:
1615
1587
                control_files.unlock()
1616
 
        branch = self.open(a_bzrdir, name, _found=True)
1617
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1618
 
        return branch
 
1588
        return self.open(a_bzrdir, name, _found=True)
1619
1589
 
1620
1590
    def initialize(self, a_bzrdir, name=None):
1621
1591
        """Create a branch of this format in a_bzrdir.
1781
1751
            "should return a tag name or None if no tag name could be "
1782
1752
            "determined. The first non-None tag name returned will be used.",
1783
1753
            (2, 2), None))
1784
 
        self.create_hook(HookPoint('post_branch_init',
1785
 
            "Called after new branch initialization completes. "
1786
 
            "post_branch_init is called with a "
1787
 
            "bzrlib.branch.BranchInitHookParams. "
1788
 
            "Note that init, branch and checkout (both heavyweight and "
1789
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1790
 
        self.create_hook(HookPoint('post_switch',
1791
 
            "Called after a checkout switches branch. "
1792
 
            "post_switch is called with a "
1793
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1794
1754
 
1795
1755
 
1796
1756
 
1836
1796
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1837
1797
 
1838
1798
 
1839
 
class BranchInitHookParams(object):
1840
 
    """Object holding parameters passed to *_branch_init hooks.
1841
 
 
1842
 
    There are 4 fields that hooks may wish to access:
1843
 
 
1844
 
    :ivar format: the branch format
1845
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
 
    :ivar name: name of colocated branch, if any (or None)
1847
 
    :ivar branch: the branch created
1848
 
 
1849
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
 
    the checkout, hence they are different from the corresponding fields in
1851
 
    branch, which refer to the original branch.
1852
 
    """
1853
 
 
1854
 
    def __init__(self, format, a_bzrdir, name, branch):
1855
 
        """Create a group of BranchInitHook parameters.
1856
 
 
1857
 
        :param format: the branch format
1858
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1859
 
            initialized
1860
 
        :param name: name of colocated branch, if any (or None)
1861
 
        :param branch: the branch created
1862
 
 
1863
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1864
 
        to the checkout, hence they are different from the corresponding fields
1865
 
        in branch, which refer to the original branch.
1866
 
        """
1867
 
        self.format = format
1868
 
        self.bzrdir = a_bzrdir
1869
 
        self.name = name
1870
 
        self.branch = branch
1871
 
 
1872
 
    def __eq__(self, other):
1873
 
        return self.__dict__ == other.__dict__
1874
 
 
1875
 
    def __repr__(self):
1876
 
        if self.branch:
1877
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1878
 
        else:
1879
 
            return "<%s of format:%s bzrdir:%s>" % (
1880
 
                self.__class__.__name__, self.branch,
1881
 
                self.format, self.bzrdir)
1882
 
 
1883
 
 
1884
 
class SwitchHookParams(object):
1885
 
    """Object holding parameters passed to *_switch hooks.
1886
 
 
1887
 
    There are 4 fields that hooks may wish to access:
1888
 
 
1889
 
    :ivar control_dir: BzrDir of the checkout to change
1890
 
    :ivar to_branch: branch that the checkout is to reference
1891
 
    :ivar force: skip the check for local commits in a heavy checkout
1892
 
    :ivar revision_id: revision ID to switch to (or None)
1893
 
    """
1894
 
 
1895
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1896
 
        """Create a group of SwitchHook parameters.
1897
 
 
1898
 
        :param control_dir: BzrDir of the checkout to change
1899
 
        :param to_branch: branch that the checkout is to reference
1900
 
        :param force: skip the check for local commits in a heavy checkout
1901
 
        :param revision_id: revision ID to switch to (or None)
1902
 
        """
1903
 
        self.control_dir = control_dir
1904
 
        self.to_branch = to_branch
1905
 
        self.force = force
1906
 
        self.revision_id = revision_id
1907
 
 
1908
 
    def __eq__(self, other):
1909
 
        return self.__dict__ == other.__dict__
1910
 
 
1911
 
    def __repr__(self):
1912
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
 
            self.control_dir, self.to_branch,
1914
 
            self.revision_id)
1915
 
 
1916
 
 
1917
1799
class BzrBranchFormat4(BranchFormat):
1918
1800
    """Bzr branch format 4.
1919
1801
 
1978
1860
            if format.__class__ != self.__class__:
1979
1861
                raise AssertionError("wrong format %r found for %r" %
1980
1862
                    (format, self))
1981
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1982
1863
        try:
 
1864
            transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1865
            control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1866
                                                         lockdir.LockDir)
1985
1867
            return self._branch_class()(_format=self,
2183
2065
            # this format does not implement branch itself, thus the implicit
2184
2066
            # creation contract must see it as uninitializable
2185
2067
            raise errors.UninitializableFormat(self)
2186
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2068
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
2187
2069
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2188
2070
        branch_transport.put_bytes('location',
2189
 
            target_branch.bzrdir.user_url)
 
2071
            target_branch.bzrdir.root_transport.base)
2190
2072
        branch_transport.put_bytes('format', self.get_format_string())
2191
 
        branch = self.open(
 
2073
        return self.open(
2192
2074
            a_bzrdir, name, _found=True,
2193
2075
            possible_transports=[target_branch.bzrdir.root_transport])
2194
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2195
 
        return branch
2196
2076
 
2197
2077
    def __init__(self):
2198
2078
        super(BranchReferenceFormat, self).__init__()
2275
2155
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2276
2156
 
2277
2157
 
2278
 
class BranchWriteLockResult(LogicalLockResult):
2279
 
    """The result of write locking a branch.
2280
 
 
2281
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2282
 
        None.
2283
 
    :ivar unlock: A callable which will unlock the lock.
2284
 
    """
2285
 
 
2286
 
    def __init__(self, unlock, branch_token):
2287
 
        LogicalLockResult.__init__(self, unlock)
2288
 
        self.branch_token = branch_token
2289
 
 
2290
 
    def __repr__(self):
2291
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2292
 
            self.unlock)
2293
 
 
2294
 
 
2295
2158
class BzrBranch(Branch, _RelockDebugMixin):
2296
2159
    """A branch stored in the actual filesystem.
2297
2160
 
2331
2194
 
2332
2195
    def __str__(self):
2333
2196
        if self.name is None:
2334
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2197
            return '%s(%r)' % (self.__class__.__name__, self.base)
2335
2198
        else:
2336
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2337
 
                self.name)
 
2199
            return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2338
2200
 
2339
2201
    __repr__ = __str__
2340
2202
 
2351
2213
        return self.control_files.is_locked()
2352
2214
 
2353
2215
    def lock_write(self, token=None):
2354
 
        """Lock the branch for write operations.
2355
 
 
2356
 
        :param token: A token to permit reacquiring a previously held and
2357
 
            preserved lock.
2358
 
        :return: A BranchWriteLockResult.
2359
 
        """
2360
2216
        if not self.is_locked():
2361
2217
            self._note_lock('w')
2362
2218
        # All-in-one needs to always unlock/lock.
2368
2224
        else:
2369
2225
            took_lock = False
2370
2226
        try:
2371
 
            return BranchWriteLockResult(self.unlock,
2372
 
                self.control_files.lock_write(token=token))
 
2227
            return self.control_files.lock_write(token=token)
2373
2228
        except:
2374
2229
            if took_lock:
2375
2230
                self.repository.unlock()
2376
2231
            raise
2377
2232
 
2378
2233
    def lock_read(self):
2379
 
        """Lock the branch for read operations.
2380
 
 
2381
 
        :return: A bzrlib.lock.LogicalLockResult.
2382
 
        """
2383
2234
        if not self.is_locked():
2384
2235
            self._note_lock('r')
2385
2236
        # All-in-one needs to always unlock/lock.
2392
2243
            took_lock = False
2393
2244
        try:
2394
2245
            self.control_files.lock_read()
2395
 
            return LogicalLockResult(self.unlock)
2396
2246
        except:
2397
2247
            if took_lock:
2398
2248
                self.repository.unlock()
2567
2417
        return result
2568
2418
 
2569
2419
    def get_stacked_on_url(self):
2570
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2420
        raise errors.UnstackableBranchFormat(self._format, self.base)
2571
2421
 
2572
2422
    def set_push_location(self, location):
2573
2423
        """See Branch.set_push_location."""
2763
2613
        if _mod_revision.is_null(last_revision):
2764
2614
            return
2765
2615
        if last_revision not in self._lefthand_history(revision_id):
2766
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2616
            raise errors.AppendRevisionsOnlyViolation(self.base)
2767
2617
 
2768
2618
    def _gen_revision_history(self):
2769
2619
        """Generate the revision history from last revision
2869
2719
        if branch_location is None:
2870
2720
            return Branch.reference_parent(self, file_id, path,
2871
2721
                                           possible_transports)
2872
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2722
        branch_location = urlutils.join(self.base, branch_location)
2873
2723
        return Branch.open(branch_location,
2874
2724
                           possible_transports=possible_transports)
2875
2725
 
2921
2771
        return stacked_url
2922
2772
 
2923
2773
    def _get_append_revisions_only(self):
2924
 
        return self.get_config(
2925
 
            ).get_user_option_as_bool('append_revisions_only')
 
2774
        value = self.get_config().get_user_option('append_revisions_only')
 
2775
        return value == 'True'
2926
2776
 
2927
2777
    @needs_write_lock
2928
2778
    def generate_revision_history(self, revision_id, last_rev=None,
2990
2840
    """
2991
2841
 
2992
2842
    def get_stacked_on_url(self):
2993
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2843
        raise errors.UnstackableBranchFormat(self._format, self.base)
2994
2844
 
2995
2845
 
2996
2846
######################################################################
3083
2933
        :param verbose: Requests more detailed display of what was checked,
3084
2934
            if any.
3085
2935
        """
3086
 
        note('checked branch %s format %s', self.branch.user_url,
 
2936
        note('checked branch %s format %s', self.branch.base,
3087
2937
            self.branch._format)
3088
2938
        for error in self.errors:
3089
2939
            note('found error:%s', error)
3418
3268
        if local and not bound_location:
3419
3269
            raise errors.LocalRequiresBoundBranch()
3420
3270
        master_branch = None
3421
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3271
        if not local and bound_location and self.source.base != bound_location:
3422
3272
            # not pulling from master, so we need to update master.
3423
3273
            master_branch = self.target.get_master_branch(possible_transports)
3424
3274
            master_branch.lock_write()