← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Michael Ellerman
  • Date: 2006-02-28 14:45:51 UTC
  • mto: (1558.1.18 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 1586.
  • Revision ID: michael@ellerman.id.au-20060228144551-3d9941ecde4a0b0a
Update contrib/pwk for -p1 diffs from bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005, 2006 Canonical
 
1
# (C) 2005 Canonical
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
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
 
import bzrlib.errors as errors
22
 
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
 
20
import bzrlib.errors
 
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
23
22
from bzrlib.osutils import contains_whitespace
24
23
from bzrlib.progress import DummyProgress
25
 
from bzrlib.symbol_versioning import (deprecated_function,
26
 
        zero_eight,
27
 
        )
28
24
 
29
25
NULL_REVISION="null:"
30
26
 
52
48
        self._check_properties()
53
49
        self.parent_ids = []
54
50
        self.parent_sha1s = []
55
 
        """Not used anymore - legacy from for 4."""
56
51
        self.__dict__.update(args)
57
52
 
58
53
    def __repr__(self):
75
70
        return not self.__eq__(other)
76
71
 
77
72
    def _check_properties(self):
78
 
        """Verify that all revision properties are OK."""
 
73
        """Verify that all revision properties are OK.
 
74
        """
79
75
        for name, value in self.properties.iteritems():
80
76
            if not isinstance(name, basestring) or contains_whitespace(name):
81
77
                raise ValueError("invalid property name %r" % name)
102
98
        reversed_result.reverse()
103
99
        return reversed_result
104
100
 
105
 
    def get_summary(self):
106
 
        """Get the first line of the log message for this revision.
107
 
        """
108
 
        return self.message.split('\n', 1)[0]
109
 
 
110
101
 
111
102
def is_ancestor(revision_id, candidate_id, branch):
112
103
    """Return true if candidate_id is an ancestor of revision_id.
130
121
                yield ancestor, distance
131
122
            try:
132
123
                revision = revision_source.get_revision(ancestor)
133
 
            except errors.NoSuchRevision, e:
 
124
            except bzrlib.errors.NoSuchRevision, e:
134
125
                if e.revision == revision_id:
135
126
                    raise 
136
127
                else:
167
158
    return matches
168
159
 
169
160
 
 
161
def old_common_ancestor(revision_a, revision_b, revision_source):
 
162
    """Find the ancestor common to both revisions that is closest to both.
 
163
    """
 
164
    from bzrlib.trace import mutter
 
165
    a_ancestors = find_present_ancestors(revision_a, revision_source)
 
166
    b_ancestors = find_present_ancestors(revision_b, revision_source)
 
167
    a_intersection = []
 
168
    b_intersection = []
 
169
    # a_order is used as a tie-breaker when two equally-good bases are found
 
170
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
 
171
        if b_ancestors.has_key(revision):
 
172
            a_intersection.append((a_distance, a_order, revision))
 
173
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
 
174
    mutter("a intersection: %r", a_intersection)
 
175
    mutter("b intersection: %r", b_intersection)
 
176
 
 
177
    a_closest = __get_closest(a_intersection)
 
178
    if len(a_closest) == 0:
 
179
        return None
 
180
    b_closest = __get_closest(b_intersection)
 
181
    assert len(b_closest) != 0
 
182
    mutter ("a_closest %r", a_closest)
 
183
    mutter ("b_closest %r", b_closest)
 
184
    if a_closest[0] in b_closest:
 
185
        return a_closest[0]
 
186
    elif b_closest[0] in a_closest:
 
187
        return b_closest[0]
 
188
    else:
 
189
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
 
190
    return a_closest[0]
 
191
 
170
192
def revision_graph(revision, revision_source):
171
193
    """Produce a graph of the ancestry of the specified revision.
172
 
    
173
 
    :return: root, ancestors map, descendants map
 
194
    Return root, ancestors map, descendants map
 
195
 
 
196
    TODO: Produce graphs with the NULL revision as root, so that we can find
 
197
    a common even when trees are not branches don't represent a single line
 
198
    of descent.
 
199
    RBC: 20051024: note that when we have two partial histories, this may not
 
200
         be possible. But if we are willing to pretend :)... sure.
174
201
    """
175
 
    revision_source.lock_read()
176
 
    try:
177
 
        return _revision_graph(revision, revision_source)
178
 
    finally:
179
 
        revision_source.unlock()
180
 
 
181
 
 
182
 
def _revision_graph(revision, revision_source):
183
 
    """See revision_graph."""
184
 
    from bzrlib.tsort import topo_sort
185
 
    graph = revision_source.get_revision_graph(revision)
186
 
    # mark all no-parent revisions as being NULL_REVISION parentage.
187
 
    for node, parents in graph.items():
188
 
        if len(parents) == 0:
189
 
            graph[node] = [NULL_REVISION]
190
 
    # add NULL_REVISION to the graph
191
 
    graph[NULL_REVISION] = []
192
 
 
193
 
    # pick a root. If there are multiple roots
194
 
    # this could pick a random one.
195
 
    topo_order = topo_sort(graph.items())
196
 
    root = topo_order[0]
197
 
 
198
202
    ancestors = {}
199
203
    descendants = {}
200
 
 
201
 
    # map the descendants of the graph.
202
 
    # and setup our set based return graph.
203
 
    for node in graph.keys():
204
 
        descendants[node] = {}
205
 
    for node, parents in graph.items():
206
 
        for parent in parents:
207
 
            descendants[parent][node] = 1
208
 
        ancestors[node] = set(parents)
209
 
 
 
204
    lines = [revision]
 
205
    root = None
 
206
    descendants[revision] = {}
 
207
    while len(lines) > 0:
 
208
        new_lines = set()
 
209
        for line in lines:
 
210
            if line == NULL_REVISION:
 
211
                parents = []
 
212
                root = NULL_REVISION
 
213
            else:
 
214
                try:
 
215
                    rev = revision_source.get_revision(line)
 
216
                    parents = list(rev.parent_ids)
 
217
                    if len(parents) == 0:
 
218
                        parents = [NULL_REVISION]
 
219
                except bzrlib.errors.NoSuchRevision:
 
220
                    if line == revision:
 
221
                        raise
 
222
                    parents = None
 
223
            if parents is not None:
 
224
                for parent in parents:
 
225
                    if parent not in ancestors:
 
226
                        new_lines.add(parent)
 
227
                    if parent not in descendants:
 
228
                        descendants[parent] = {}
 
229
                    descendants[parent][line] = 1
 
230
            if parents is not None:
 
231
                ancestors[line] = set(parents)
 
232
        lines = new_lines
 
233
    if root is None:
 
234
        # The history for revision becomes inaccessible without
 
235
        # actually hitting a no-parents revision. This then
 
236
        # makes these asserts below trigger. So, if root is None
 
237
        # determine the actual root by walking the accessible tree
 
238
        # and then stash NULL_REVISION at the end.
 
239
        root = NULL_REVISION
 
240
        descendants[root] = {}
 
241
        # for every revision, check we can access at least
 
242
        # one parent, if we cant, add NULL_REVISION and
 
243
        # a link
 
244
        for rev in ancestors:
 
245
            if len(ancestors[rev]) == 0:
 
246
                raise RuntimeError('unreachable code ?!')
 
247
            ok = False
 
248
            for parent in ancestors[rev]:
 
249
                if parent in ancestors:
 
250
                    ok = True
 
251
            if ok:
 
252
                continue
 
253
            descendants[root][rev] = 1
 
254
            ancestors[rev].add(root)
 
255
        ancestors[root] = set()
210
256
    assert root not in descendants[root]
211
257
    assert root not in ancestors[root]
212
258
    return root, ancestors, descendants
215
261
def combined_graph(revision_a, revision_b, revision_source):
216
262
    """Produce a combined ancestry graph.
217
263
    Return graph root, ancestors map, descendants map, set of common nodes"""
218
 
    root, ancestors, descendants = revision_graph(
219
 
        revision_a, revision_source)
220
 
    root_b, ancestors_b, descendants_b = revision_graph(
221
 
        revision_b, revision_source)
 
264
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
265
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
266
                                                        revision_source)
222
267
    if root != root_b:
223
 
        raise errors.NoCommonRoot(revision_a, revision_b)
 
268
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
224
269
    common = set()
225
270
    for node, node_anc in ancestors_b.iteritems():
226
271
        if node in ancestors:
237
282
 
238
283
def common_ancestor(revision_a, revision_b, revision_source, 
239
284
                    pb=DummyProgress()):
240
 
    if None in (revision_a, revision_b):
241
 
        return None
242
 
    if NULL_REVISION in (revision_a, revision_b):
243
 
        return NULL_REVISION
244
 
    # trivial optimisation
245
 
    if revision_a == revision_b:
246
 
        return revision_a
247
285
    try:
248
286
        try:
249
287
            pb.update('Picking ancestor', 1, 3)
250
 
            graph = revision_source.get_revision_graph_with_ghosts(
251
 
                [revision_a, revision_b])
252
 
            # convert to a NULL_REVISION based graph.
253
 
            ancestors = graph.get_ancestors()
254
 
            descendants = graph.get_descendants()
255
 
            common = set(graph.get_ancestry(revision_a)).intersection(
256
 
                     set(graph.get_ancestry(revision_b)))
257
 
            descendants[NULL_REVISION] = {}
258
 
            ancestors[NULL_REVISION] = []
259
 
            for root in graph.roots:
260
 
                descendants[NULL_REVISION][root] = 1
261
 
                ancestors[root].append(NULL_REVISION)
262
 
            for ghost in graph.ghosts:
263
 
                # ghosts act as roots for the purpose of finding 
264
 
                # the longest paths from the root: any ghost *might*
265
 
                # be directly attached to the root, so we treat them
266
 
                # as being such.
267
 
                # ghost now descends from NULL
268
 
                descendants[NULL_REVISION][ghost] = 1
269
 
                # that is it has an ancestor of NULL
270
 
                ancestors[ghost] = [NULL_REVISION]
271
 
                # ghost is common if any of ghosts descendants are common:
272
 
                for ghost_descendant in descendants[ghost]:
273
 
                    if ghost_descendant in common:
274
 
                        common.add(ghost)
275
 
                
276
 
            root = NULL_REVISION
277
 
            common.add(NULL_REVISION)
278
 
        except errors.NoCommonRoot:
279
 
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
288
            root, ancestors, descendants, common = \
 
289
                combined_graph(revision_a, revision_b, revision_source)
 
290
        except bzrlib.errors.NoCommonRoot:
 
291
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
280
292
            
281
293
        pb.update('Picking ancestor', 2, 3)
282
294
        distances = node_distances (descendants, ancestors, root)
283
295
        pb.update('Picking ancestor', 3, 2)
284
296
        farthest = select_farthest(distances, common)
285
297
        if farthest is None or farthest == NULL_REVISION:
286
 
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
298
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
287
299
    finally:
288
300
        pb.clear()
289
301
    return farthest
296
308
        assert len(args) != 0
297
309
        self._revision_sources = args
298
310
 
299
 
    def revision_parents(self, revision_id):
300
 
        for source in self._revision_sources:
301
 
            try:
302
 
                return source.revision_parents(revision_id)
303
 
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
304
 
                pass
305
 
        raise e
306
 
 
307
311
    def get_revision(self, revision_id):
308
312
        for source in self._revision_sources:
309
313
            try:
310
314
                return source.get_revision(revision_id)
311
 
            except errors.NoSuchRevision, e:
 
315
            except bzrlib.errors.NoSuchRevision, e:
312
316
                pass
313
317
        raise e
314
318
 
315
 
    def get_revision_graph(self, revision_id):
316
 
        # we could probe incrementally until the pending
317
 
        # ghosts list stop growing, but its cheaper for now
318
 
        # to just ask for the complete graph for each repository.
319
 
        graphs = []
320
 
        for source in self._revision_sources:
321
 
            ghost_graph = source.get_revision_graph_with_ghosts()
322
 
            graphs.append(ghost_graph)
323
 
        absent = 0
324
 
        for graph in graphs:
325
 
            if not revision_id in graph.get_ancestors():
326
 
                absent += 1
327
 
        if absent == len(graphs):
328
 
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
329
 
 
330
 
        # combine the graphs
331
 
        result = {}
332
 
        pending = set([revision_id])
333
 
        def find_parents(node_id):
334
 
            """find the parents for node_id."""
335
 
            for graph in graphs:
336
 
                ancestors = graph.get_ancestors()
337
 
                try:
338
 
                    return ancestors[node_id]
339
 
                except KeyError:
340
 
                    pass
341
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
342
 
        while len(pending):
343
 
            # all the graphs should have identical parent lists
344
 
            node_id = pending.pop()
345
 
            try:
346
 
                result[node_id] = find_parents(node_id)
347
 
                for parent_node in result[node_id]:
348
 
                    if not parent_node in result:
349
 
                        pending.add(parent_node)
350
 
            except errors.NoSuchRevision:
351
 
                # ghost, ignore it.
352
 
                pass
353
 
        return result
354
 
 
355
 
    def get_revision_graph_with_ghosts(self, revision_ids):
356
 
        # query all the sources for their entire graphs 
357
 
        # and then build a combined graph for just
358
 
        # revision_ids.
359
 
        graphs = []
360
 
        for source in self._revision_sources:
361
 
            ghost_graph = source.get_revision_graph_with_ghosts()
362
 
            graphs.append(ghost_graph.get_ancestors())
363
 
        for revision_id in revision_ids:
364
 
            absent = 0
365
 
            for graph in graphs:
366
 
                    if not revision_id in graph:
367
 
                        absent += 1
368
 
            if absent == len(graphs):
369
 
                raise errors.NoSuchRevision(self._revision_sources[0],
370
 
                                            revision_id)
371
 
 
372
 
        # combine the graphs
373
 
        result = Graph()
374
 
        pending = set(revision_ids)
375
 
        done = set()
376
 
        def find_parents(node_id):
377
 
            """find the parents for node_id."""
378
 
            for graph in graphs:
379
 
                try:
380
 
                    return graph[node_id]
381
 
                except KeyError:
382
 
                    pass
383
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
384
 
        while len(pending):
385
 
            # all the graphs should have identical parent lists
386
 
            node_id = pending.pop()
387
 
            try:
388
 
                parents = find_parents(node_id)
389
 
                for parent_node in parents:
390
 
                    # queued or done? 
391
 
                    if (parent_node not in pending and
392
 
                        parent_node not in done):
393
 
                        # no, queue
394
 
                        pending.add(parent_node)
395
 
                result.add_node(node_id, parents)
396
 
                done.add(node_id)
397
 
            except errors.NoSuchRevision:
398
 
                # ghost
399
 
                result.add_ghost(node_id)
400
 
                continue
401
 
        return result
402
 
 
403
 
    def lock_read(self):
404
 
        for source in self._revision_sources:
405
 
            source.lock_read()
406
 
 
407
 
    def unlock(self):
408
 
        for source in self._revision_sources:
409
 
            source.unlock()
410
 
 
411
 
 
412
 
@deprecated_function(zero_eight)
413
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
 
319
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
414
320
                              revision_history=None):
415
321
    """Find the longest line of descent from maybe_ancestor to revision.
416
322
    Revision history is followed where possible.
421
327
    """
422
328
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
423
329
    if len(descendants) == 0:
424
 
        raise errors.NoSuchRevision(rev_source, rev_id)
 
330
        raise NoSuchRevision(rev_source, rev_id)
425
331
    if ancestor_id not in descendants:
426
332
        rev_source.get_revision(ancestor_id)
427
 
        raise errors.NotAncestor(rev_id, ancestor_id)
 
333
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
428
334
    root_descendants = all_descendants(descendants, ancestor_id)
429
335
    root_descendants.add(ancestor_id)
430
336
    if rev_id not in root_descendants:
431
 
        raise errors.NotAncestor(rev_id, ancestor_id)
 
337
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
432
338
    distances = node_distances(descendants, ancestors, ancestor_id,
433
339
                               root_descendants=root_descendants)
434
340