← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-15 15:03:15 UTC
  • mfrom: (4797.42.3 2.1-integration)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: v.ladeuil+lp@free.fr-20100415150315-y2bbh2tzvshyzet0
Merge 2.1 into bzr.dev including fixes for #262450, #373898, #498409

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
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: 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
466
456
            stop_revision_id, stop_rule)
467
457
        # Make sure we don't return revisions that are not part of the
468
458
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
 
459
        filtered = self._filter_non_ancestors(filtered)
470
460
        if direction == 'reverse':
471
461
            return filtered
472
462
        if direction == 'forward':
509
499
                       node.end_of_merge)
510
500
                if rev_id == stop_revision_id:
511
501
                    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
502
        elif stop_rule == 'with-merges':
525
503
            stop_rev = self.repository.get_revision(stop_revision_id)
526
504
            if stop_rev.parent_ids:
549
527
        else:
550
528
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
529
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
 
530
    def _filter_non_ancestors(self, rev_iter):
553
531
        # If we started from a dotted revno, we want to consider it as a tip
554
532
        # and don't want to yield revisions that are not part of its
555
533
        # ancestry. Given the order guaranteed by the merge sort, we will see
616
594
        :param other: The branch to bind to
617
595
        :type other: Branch
618
596
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
597
        raise errors.UpgradeRequired(self.base)
620
598
 
621
599
    def set_append_revisions_only(self, enabled):
622
600
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
601
            raise errors.UpgradeRequired(self.base)
624
602
        if enabled:
625
603
            value = 'True'
626
604
        else:
674
652
    def get_old_bound_location(self):
675
653
        """Return the URL of the branch we used to be bound to
676
654
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
655
        raise errors.UpgradeRequired(self.base)
678
656
 
679
657
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
658
                           timezone=None, committer=None, revprops=None,
758
736
            stacking.
759
737
        """
760
738
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
739
            raise errors.UnstackableBranchFormat(self._format, self.base)
762
740
        # XXX: Changing from one fallback repository to another does not check
763
741
        # that all the data you need is present in the new fallback.
764
742
        # Possibly it should.
915
893
 
916
894
    def unbind(self):
917
895
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
896
        raise errors.UpgradeRequired(self.base)
919
897
 
920
898
    def last_revision(self):
921
899
        """Return last revision id, or NULL_REVISION."""
1081
1059
        try:
1082
1060
            return urlutils.join(self.base[:-1], parent)
1083
1061
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1062
            raise errors.InaccessibleParent(parent, self.base)
1085
1063
 
1086
1064
    def _get_parent_location(self):
1087
1065
        raise NotImplementedError(self._get_parent_location)
1565
1543
        """Return the short format description for this format."""
1566
1544
        raise NotImplementedError(self.get_format_description)
1567
1545
 
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
1546
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
1547
                           lock_type='metadir', set_format=True):
1578
1548
        """Initialize a branch in a bzrdir, with specified files
1586
1556
            elsewhere)
1587
1557
        :return: a branch in this format
1588
1558
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1559
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1590
1560
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1591
1561
        lock_map = {
1592
1562
            'metadir': ('lock', lockdir.LockDir),
1614
1584
        finally:
1615
1585
            if lock_taken:
1616
1586
                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
 
1587
        return self.open(a_bzrdir, name, _found=True)
1620
1588
 
1621
1589
    def initialize(self, a_bzrdir, name=None):
1622
1590
        """Create a branch of this format in a_bzrdir.
1782
1750
            "should return a tag name or None if no tag name could be "
1783
1751
            "determined. The first non-None tag name returned will be used.",
1784
1752
            (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
1753
 
1796
1754
 
1797
1755
 
1837
1795
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1796
 
1839
1797
 
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
1798
class BzrBranchFormat4(BranchFormat):
1919
1799
    """Bzr branch format 4.
1920
1800
 
1979
1859
            if format.__class__ != self.__class__:
1980
1860
                raise AssertionError("wrong format %r found for %r" %
1981
1861
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1862
        try:
 
1863
            transport = a_bzrdir.get_branch_transport(None, name=name)
1984
1864
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1865
                                                         lockdir.LockDir)
1986
1866
            return self._branch_class()(_format=self,
2184
2064
            # this format does not implement branch itself, thus the implicit
2185
2065
            # creation contract must see it as uninitializable
2186
2066
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2067
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
2188
2068
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2189
2069
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
2070
            target_branch.bzrdir.root_transport.base)
2191
2071
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
 
2072
        return self.open(
2193
2073
            a_bzrdir, name, _found=True,
2194
2074
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
2075
 
2198
2076
    def __init__(self):
2199
2077
        super(BranchReferenceFormat, self).__init__()
2276
2154
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2155
 
2278
2156
 
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
2157
class BzrBranch(Branch, _RelockDebugMixin):
2297
2158
    """A branch stored in the actual filesystem.
2298
2159
 
2332
2193
 
2333
2194
    def __str__(self):
2334
2195
        if self.name is None:
2335
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2196
            return '%s(%r)' % (self.__class__.__name__, self.base)
2336
2197
        else:
2337
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
 
                self.name)
 
2198
            return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2339
2199
 
2340
2200
    __repr__ = __str__
2341
2201
 
2352
2212
        return self.control_files.is_locked()
2353
2213
 
2354
2214
    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
2215
        if not self.is_locked():
2362
2216
            self._note_lock('w')
2363
2217
        # All-in-one needs to always unlock/lock.
2369
2223
        else:
2370
2224
            took_lock = False
2371
2225
        try:
2372
 
            return BranchWriteLockResult(self.unlock,
2373
 
                self.control_files.lock_write(token=token))
 
2226
            return self.control_files.lock_write(token=token)
2374
2227
        except:
2375
2228
            if took_lock:
2376
2229
                self.repository.unlock()
2377
2230
            raise
2378
2231
 
2379
2232
    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
2233
        if not self.is_locked():
2386
2234
            self._note_lock('r')
2387
2235
        # All-in-one needs to always unlock/lock.
2394
2242
            took_lock = False
2395
2243
        try:
2396
2244
            self.control_files.lock_read()
2397
 
            return self
2398
2245
        except:
2399
2246
            if took_lock:
2400
2247
                self.repository.unlock()
2569
2416
        return result
2570
2417
 
2571
2418
    def get_stacked_on_url(self):
2572
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2419
        raise errors.UnstackableBranchFormat(self._format, self.base)
2573
2420
 
2574
2421
    def set_push_location(self, location):
2575
2422
        """See Branch.set_push_location."""
2765
2612
        if _mod_revision.is_null(last_revision):
2766
2613
            return
2767
2614
        if last_revision not in self._lefthand_history(revision_id):
2768
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2615
            raise errors.AppendRevisionsOnlyViolation(self.base)
2769
2616
 
2770
2617
    def _gen_revision_history(self):
2771
2618
        """Generate the revision history from last revision
2871
2718
        if branch_location is None:
2872
2719
            return Branch.reference_parent(self, file_id, path,
2873
2720
                                           possible_transports)
2874
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2721
        branch_location = urlutils.join(self.base, branch_location)
2875
2722
        return Branch.open(branch_location,
2876
2723
                           possible_transports=possible_transports)
2877
2724
 
2923
2770
        return stacked_url
2924
2771
 
2925
2772
    def _get_append_revisions_only(self):
2926
 
        return self.get_config(
2927
 
            ).get_user_option_as_bool('append_revisions_only')
 
2773
        value = self.get_config().get_user_option('append_revisions_only')
 
2774
        return value == 'True'
2928
2775
 
2929
2776
    @needs_write_lock
2930
2777
    def generate_revision_history(self, revision_id, last_rev=None,
2992
2839
    """
2993
2840
 
2994
2841
    def get_stacked_on_url(self):
2995
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2842
        raise errors.UnstackableBranchFormat(self._format, self.base)
2996
2843
 
2997
2844
 
2998
2845
######################################################################
3085
2932
        :param verbose: Requests more detailed display of what was checked,
3086
2933
            if any.
3087
2934
        """
3088
 
        note('checked branch %s format %s', self.branch.user_url,
 
2935
        note('checked branch %s format %s', self.branch.base,
3089
2936
            self.branch._format)
3090
2937
        for error in self.errors:
3091
2938
            note('found error:%s', error)
3420
3267
        if local and not bound_location:
3421
3268
            raise errors.LocalRequiresBoundBranch()
3422
3269
        master_branch = None
3423
 
        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:
3424
3271
            # not pulling from master, so we need to update master.
3425
3272
            master_branch = self.target.get_master_branch(possible_transports)
3426
3273
            master_branch.lock_write()