~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2006-02-21 22:46:09 UTC
  • mto: This revision was merged to the branch mainline in revision 1569.
  • Revision ID: mbp@sourcefrog.net-20060221224609-a7f433d0488c080d
Confirm that only the intended holder of a lock was broken.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
# TODO: Some kind of command-line display of revision properties: 
18
18
# perhaps show them in log -v and allow them as options to the commit command.
19
19
 
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import deprecated_graph
24
 
""")
25
 
from bzrlib import (
26
 
    errors,
27
 
    symbol_versioning,
28
 
    )
 
20
import bzrlib.errors
 
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
29
22
from bzrlib.osutils import contains_whitespace
30
 
from bzrlib.progress import DummyProgress
31
23
 
32
24
NULL_REVISION="null:"
33
 
CURRENT_REVISION="current:"
34
 
 
35
25
 
36
26
class Revision(object):
37
27
    """Single revision on a branch.
57
47
        self._check_properties()
58
48
        self.parent_ids = []
59
49
        self.parent_sha1s = []
60
 
        """Not used anymore - legacy from for 4."""
61
50
        self.__dict__.update(args)
62
51
 
63
52
    def __repr__(self):
80
69
        return not self.__eq__(other)
81
70
 
82
71
    def _check_properties(self):
83
 
        """Verify that all revision properties are OK."""
 
72
        """Verify that all revision properties are OK.
 
73
        """
84
74
        for name, value in self.properties.iteritems():
85
75
            if not isinstance(name, basestring) or contains_whitespace(name):
86
76
                raise ValueError("invalid property name %r" % name)
88
78
                raise ValueError("invalid property value %r for %r" % 
89
79
                                 (name, value))
90
80
 
91
 
    def get_history(self, repository):
92
 
        """Return the canonical line-of-history for this revision.
93
 
 
94
 
        If ghosts are present this may differ in result from a ghost-free
95
 
        repository.
96
 
        """
97
 
        current_revision = self
98
 
        reversed_result = []
99
 
        while current_revision is not None:
100
 
            reversed_result.append(current_revision.revision_id)
101
 
            if not len (current_revision.parent_ids):
102
 
                reversed_result.append(None)
103
 
                current_revision = None
104
 
            else:
105
 
                next_revision_id = current_revision.parent_ids[0]
106
 
                current_revision = repository.get_revision(next_revision_id)
107
 
        reversed_result.reverse()
108
 
        return reversed_result
109
 
 
110
 
    def get_summary(self):
111
 
        """Get the first line of the log message for this revision.
112
 
        """
113
 
        return self.message.lstrip().split('\n', 1)[0]
114
 
 
115
 
    def get_apparent_author(self):
116
 
        """Return the apparent author of this revision.
117
 
 
118
 
        If the revision properties contain the author name,
119
 
        return it. Otherwise return the committer name.
120
 
        """
121
 
        return self.properties.get('author', self.committer)
 
81
 
 
82
def is_ancestor(revision_id, candidate_id, branch):
 
83
    """Return true if candidate_id is an ancestor of revision_id.
 
84
 
 
85
    A false negative will be returned if any intermediate descendent of
 
86
    candidate_id is not present in any of the revision_sources.
 
87
    
 
88
    revisions_source is an object supporting a get_revision operation that
 
89
    behaves like Branch's.
 
90
    """
 
91
    return candidate_id in branch.repository.get_ancestry(revision_id)
122
92
 
123
93
 
124
94
def iter_ancestors(revision_id, revision_source, only_present=False):
131
101
                yield ancestor, distance
132
102
            try:
133
103
                revision = revision_source.get_revision(ancestor)
134
 
            except errors.NoSuchRevision, e:
 
104
            except bzrlib.errors.NoSuchRevision, e:
135
105
                if e.revision == revision_id:
136
106
                    raise 
137
107
                else:
154
124
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
155
125
                         only_present=True))
156
126
    for anc_order, (anc_id, anc_distance) in anc_iter:
157
 
        if anc_id not in found_ancestors:
 
127
        if not found_ancestors.has_key(anc_id):
158
128
            found_ancestors[anc_id] = (anc_order, anc_distance)
159
129
    return found_ancestors
160
130
    
168
138
    return matches
169
139
 
170
140
 
171
 
def is_reserved_id(revision_id):
172
 
    """Determine whether a revision id is reserved
173
 
 
174
 
    :return: True if the revision is is reserved, False otherwise
 
141
def old_common_ancestor(revision_a, revision_b, revision_source):
 
142
    """Find the ancestor common to both revisions that is closest to both.
175
143
    """
176
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
177
 
 
178
 
 
179
 
def check_not_reserved_id(revision_id):
180
 
    """Raise ReservedId if the supplied revision_id is reserved"""
181
 
    if is_reserved_id(revision_id):
182
 
        raise errors.ReservedId(revision_id)
183
 
 
184
 
 
185
 
def ensure_null(revision_id):
186
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
187
 
    if revision_id is None:
188
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
189
 
            ' revision instead of None, as of bzr 0.91.',
190
 
            DeprecationWarning, stacklevel=2)
191
 
        return NULL_REVISION
 
144
    from bzrlib.trace import mutter
 
145
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
146
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
147
    a_intersection = []
 
148
    b_intersection = []
 
149
    # a_order is used as a tie-breaker when two equally-good bases are found
 
150
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
151
        if b_ancestors.has_key(revision):
 
152
            a_intersection.append((a_distance, a_order, revision))
 
153
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
154
    mutter("a intersection: %r", a_intersection)
 
155
    mutter("b intersection: %r", b_intersection)
 
156
 
 
157
    a_closest = __get_closest(a_intersection)
 
158
    if len(a_closest) == 0:
 
159
        return None
 
160
    b_closest = __get_closest(b_intersection)
 
161
    assert len(b_closest) != 0
 
162
    mutter ("a_closest %r", a_closest)
 
163
    mutter ("b_closest %r", b_closest)
 
164
    if a_closest[0] in b_closest:
 
165
        return a_closest[0]
 
166
    elif b_closest[0] in a_closest:
 
167
        return b_closest[0]
192
168
    else:
193
 
        return revision_id
194
 
 
195
 
 
196
 
def is_null(revision_id):
197
 
    if revision_id is None:
198
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
199
 
            ' revision instead of None, as of bzr 0.90.',
200
 
            DeprecationWarning, stacklevel=2)
201
 
    return revision_id in (None, NULL_REVISION)
 
169
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
170
    return a_closest[0]
 
171
 
 
172
def revision_graph(revision, revision_source):
 
173
    """Produce a graph of the ancestry of the specified revision.
 
174
    Return root, ancestors map, descendants map
 
175
 
 
176
    TODO: Produce graphs with the NULL revision as root, so that we can find
 
177
    a common even when trees are not branches don't represent a single line
 
178
    of descent.
 
179
    RBC: 20051024: note that when we have two partial histories, this may not
 
180
         be possible. But if we are willing to pretend :)... sure.
 
181
    """
 
182
    ancestors = {}
 
183
    descendants = {}
 
184
    lines = [revision]
 
185
    root = None
 
186
    descendants[revision] = {}
 
187
    while len(lines) > 0:
 
188
        new_lines = set()
 
189
        for line in lines:
 
190
            if line == NULL_REVISION:
 
191
                parents = []
 
192
                root = NULL_REVISION
 
193
            else:
 
194
                try:
 
195
                    rev = revision_source.get_revision(line)
 
196
                    parents = list(rev.parent_ids)
 
197
                    if len(parents) == 0:
 
198
                        parents = [NULL_REVISION]
 
199
                except bzrlib.errors.NoSuchRevision:
 
200
                    if line == revision:
 
201
                        raise
 
202
                    parents = None
 
203
            if parents is not None:
 
204
                for parent in parents:
 
205
                    if parent not in ancestors:
 
206
                        new_lines.add(parent)
 
207
                    if parent not in descendants:
 
208
                        descendants[parent] = {}
 
209
                    descendants[parent][line] = 1
 
210
            if parents is not None:
 
211
                ancestors[line] = set(parents)
 
212
        lines = new_lines
 
213
    if root is None:
 
214
        # The history for revision becomes inaccessible without
 
215
        # actually hitting a no-parents revision. This then
 
216
        # makes these asserts below trigger. So, if root is None
 
217
        # determine the actual root by walking the accessible tree
 
218
        # and then stash NULL_REVISION at the end.
 
219
        root = NULL_REVISION
 
220
        descendants[root] = {}
 
221
        # for every revision, check we can access at least
 
222
        # one parent, if we cant, add NULL_REVISION and
 
223
        # a link
 
224
        for rev in ancestors:
 
225
            if len(ancestors[rev]) == 0:
 
226
                raise RuntimeError('unreachable code ?!')
 
227
            ok = False
 
228
            for parent in ancestors[rev]:
 
229
                if parent in ancestors:
 
230
                    ok = True
 
231
            if ok:
 
232
                continue
 
233
            descendants[root][rev] = 1
 
234
            ancestors[rev].add(root)
 
235
        ancestors[root] = set()
 
236
    assert root not in descendants[root]
 
237
    assert root not in ancestors[root]
 
238
    return root, ancestors, descendants
 
239
 
 
240
 
 
241
def combined_graph(revision_a, revision_b, revision_source):
 
242
    """Produce a combined ancestry graph.
 
243
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
244
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
245
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
246
                                                        revision_source)
 
247
    if root != root_b:
 
248
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
249
    common = set()
 
250
    for node, node_anc in ancestors_b.iteritems():
 
251
        if node in ancestors:
 
252
            common.add(node)
 
253
        else:
 
254
            ancestors[node] = set()
 
255
        ancestors[node].update(node_anc)
 
256
    for node, node_dec in descendants_b.iteritems():
 
257
        if node not in descendants:
 
258
            descendants[node] = {}
 
259
        descendants[node].update(node_dec)
 
260
    return root, ancestors, descendants, common
 
261
 
 
262
 
 
263
def common_ancestor(revision_a, revision_b, revision_source):
 
264
    try:
 
265
        root, ancestors, descendants, common = \
 
266
            combined_graph(revision_a, revision_b, revision_source)
 
267
    except bzrlib.errors.NoCommonRoot:
 
268
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
269
        
 
270
    distances = node_distances (descendants, ancestors, root)
 
271
    farthest = select_farthest(distances, common)
 
272
    if farthest is None or farthest == NULL_REVISION:
 
273
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
274
    return farthest
 
275
 
 
276
 
 
277
class MultipleRevisionSources(object):
 
278
    """Proxy that looks in multiple branches for revisions."""
 
279
    def __init__(self, *args):
 
280
        object.__init__(self)
 
281
        assert len(args) != 0
 
282
        self._revision_sources = args
 
283
 
 
284
    def get_revision(self, revision_id):
 
285
        for source in self._revision_sources:
 
286
            try:
 
287
                return source.get_revision(revision_id)
 
288
            except bzrlib.errors.NoSuchRevision, e:
 
289
                pass
 
290
        raise e
 
291
 
 
292
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
293
                              revision_history=None):
 
294
    """Find the longest line of descent from maybe_ancestor to revision.
 
295
    Revision history is followed where possible.
 
296
 
 
297
    If ancestor_id == rev_id, list will be empty.
 
298
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
299
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
300
    """
 
301
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
302
    if len(descendants) == 0:
 
303
        raise NoSuchRevision(rev_source, rev_id)
 
304
    if ancestor_id not in descendants:
 
305
        rev_source.get_revision(ancestor_id)
 
306
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
307
    root_descendants = all_descendants(descendants, ancestor_id)
 
308
    root_descendants.add(ancestor_id)
 
309
    if rev_id not in root_descendants:
 
310
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
311
    distances = node_distances(descendants, ancestors, ancestor_id,
 
312
                               root_descendants=root_descendants)
 
313
 
 
314
    def best_ancestor(rev_id):
 
315
        best = None
 
316
        for anc_id in ancestors[rev_id]:
 
317
            try:
 
318
                distance = distances[anc_id]
 
319
            except KeyError:
 
320
                continue
 
321
            if revision_history is not None and anc_id in revision_history:
 
322
                return anc_id
 
323
            elif best is None or distance > best[1]:
 
324
                best = (anc_id, distance)
 
325
        return best[0]
 
326
 
 
327
    next = rev_id
 
328
    path = []
 
329
    while next != ancestor_id:
 
330
        path.append(next)
 
331
        next = best_ancestor(next)
 
332
    path.reverse()
 
333
    return path