← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

(mbp) merge bzr.dev to 0.8, prepare for release

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
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
 
20
21
import bzrlib.errors
21
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
22
import bzrlib.errors as errors
 
23
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
22
24
from bzrlib.osutils import contains_whitespace
 
25
from bzrlib.progress import DummyProgress
 
26
from bzrlib.symbol_versioning import *
23
27
 
24
28
NULL_REVISION="null:"
25
29
 
45
49
        self.revision_id = revision_id
46
50
        self.properties = properties or {}
47
51
        self._check_properties()
48
 
        self.__dict__.update(args)
49
52
        self.parent_ids = []
50
53
        self.parent_sha1s = []
 
54
        self.__dict__.update(args)
51
55
 
52
56
    def __repr__(self):
53
57
        return "<Revision id %s>" % self.revision_id
78
82
                raise ValueError("invalid property value %r for %r" % 
79
83
                                 (name, value))
80
84
 
 
85
    def get_history(self, repository):
 
86
        """Return the canonical line-of-history for this revision.
 
87
 
 
88
        If ghosts are present this may differ in result from a ghost-free
 
89
        repository.
 
90
        """
 
91
        current_revision = self
 
92
        reversed_result = []
 
93
        while current_revision is not None:
 
94
            reversed_result.append(current_revision.revision_id)
 
95
            if not len (current_revision.parent_ids):
 
96
                reversed_result.append(None)
 
97
                current_revision = None
 
98
            else:
 
99
                next_revision_id = current_revision.parent_ids[0]
 
100
                current_revision = repository.get_revision(next_revision_id)
 
101
        reversed_result.reverse()
 
102
        return reversed_result
 
103
 
81
104
 
82
105
def is_ancestor(revision_id, candidate_id, branch):
83
106
    """Return true if candidate_id is an ancestor of revision_id.
88
111
    revisions_source is an object supporting a get_revision operation that
89
112
    behaves like Branch's.
90
113
    """
91
 
    return candidate_id in branch.get_ancestry(revision_id)
 
114
    return candidate_id in branch.repository.get_ancestry(revision_id)
92
115
 
93
116
 
94
117
def iter_ancestors(revision_id, revision_source, only_present=False):
138
161
    return matches
139
162
 
140
163
 
141
 
def old_common_ancestor(revision_a, revision_b, revision_source):
142
 
    """Find the ancestor common to both revisions that is closest to both.
143
 
    """
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]
168
 
    else:
169
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
170
 
    return a_closest[0]
171
 
 
172
164
def revision_graph(revision, revision_source):
173
165
    """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.
 
166
    
 
167
    :return: root, ancestors map, descendants map
179
168
    """
 
169
    revision_source.lock_read()
 
170
    try:
 
171
        return _revision_graph(revision, revision_source)
 
172
    finally:
 
173
        revision_source.unlock()
 
174
 
 
175
 
 
176
def _revision_graph(revision, revision_source):
 
177
    """See revision_graph."""
 
178
    from bzrlib.tsort import topo_sort
 
179
    graph = revision_source.get_revision_graph(revision)
 
180
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
181
    for node, parents in graph.items():
 
182
        if len(parents) == 0:
 
183
            graph[node] = [NULL_REVISION]
 
184
    # add NULL_REVISION to the graph
 
185
    graph[NULL_REVISION] = []
 
186
 
 
187
    # pick a root. If there are multiple roots
 
188
    # this could pick a random one.
 
189
    topo_order = topo_sort(graph.items())
 
190
    root = topo_order[0]
 
191
 
180
192
    ancestors = {}
181
193
    descendants = {}
182
 
    lines = [revision]
183
 
    root = None
184
 
    descendants[revision] = {}
185
 
    while len(lines) > 0:
186
 
        new_lines = set()
187
 
        for line in lines:
188
 
            if line == NULL_REVISION:
189
 
                parents = []
190
 
                root = NULL_REVISION
191
 
            else:
192
 
                try:
193
 
                    rev = revision_source.get_revision(line)
194
 
                    parents = list(rev.parent_ids)
195
 
                    if len(parents) == 0:
196
 
                        parents = [NULL_REVISION]
197
 
                except bzrlib.errors.NoSuchRevision:
198
 
                    if line == revision:
199
 
                        raise
200
 
                    parents = None
201
 
            if parents is not None:
202
 
                for parent in parents:
203
 
                    if parent not in ancestors:
204
 
                        new_lines.add(parent)
205
 
                    if parent not in descendants:
206
 
                        descendants[parent] = {}
207
 
                    descendants[parent][line] = 1
208
 
            if parents is not None:
209
 
                ancestors[line] = set(parents)
210
 
        lines = new_lines
 
194
 
 
195
    # map the descendants of the graph.
 
196
    # and setup our set based return graph.
 
197
    for node in graph.keys():
 
198
        descendants[node] = {}
 
199
    for node, parents in graph.items():
 
200
        for parent in parents:
 
201
            descendants[parent][node] = 1
 
202
        ancestors[node] = set(parents)
 
203
 
211
204
    assert root not in descendants[root]
212
205
    assert root not in ancestors[root]
213
206
    return root, ancestors, descendants
216
209
def combined_graph(revision_a, revision_b, revision_source):
217
210
    """Produce a combined ancestry graph.
218
211
    Return graph root, ancestors map, descendants map, set of common nodes"""
219
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
220
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
221
 
                                                        revision_source)
 
212
    root, ancestors, descendants = revision_graph(
 
213
        revision_a, revision_source)
 
214
    root_b, ancestors_b, descendants_b = revision_graph(
 
215
        revision_b, revision_source)
222
216
    if root != root_b:
223
217
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
224
218
    common = set()
235
229
    return root, ancestors, descendants, common
236
230
 
237
231
 
238
 
def common_ancestor(revision_a, revision_b, revision_source):
 
232
def common_ancestor(revision_a, revision_b, revision_source, 
 
233
                    pb=DummyProgress()):
 
234
    if None in (revision_a, revision_b):
 
235
        return None
 
236
    # trivial optimisation
 
237
    if revision_a == revision_b:
 
238
        return revision_a
239
239
    try:
240
 
        root, ancestors, descendants, common = \
241
 
            combined_graph(revision_a, revision_b, revision_source)
242
 
    except bzrlib.errors.NoCommonRoot:
243
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
244
 
        
245
 
    distances = node_distances (descendants, ancestors, root)
246
 
    farthest = select_farthest(distances, common)
247
 
    if farthest is None or farthest == NULL_REVISION:
248
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
240
        try:
 
241
            pb.update('Picking ancestor', 1, 3)
 
242
            graph = revision_source.get_revision_graph_with_ghosts(
 
243
                [revision_a, revision_b])
 
244
            # convert to a NULL_REVISION based graph.
 
245
            ancestors = graph.get_ancestors()
 
246
            descendants = graph.get_descendants()
 
247
            common = set(graph.get_ancestry(revision_a)).intersection(
 
248
                     set(graph.get_ancestry(revision_b)))
 
249
            descendants[NULL_REVISION] = {}
 
250
            ancestors[NULL_REVISION] = []
 
251
            for root in graph.roots:
 
252
                descendants[NULL_REVISION][root] = 1
 
253
                ancestors[root].append(NULL_REVISION)
 
254
            for ghost in graph.ghosts:
 
255
                # ghosts act as roots for the purpose of finding 
 
256
                # the longest paths from the root: any ghost *might*
 
257
                # be directly attached to the root, so we treat them
 
258
                # as being such.
 
259
                # ghost now descends from NULL
 
260
                descendants[NULL_REVISION][ghost] = 1
 
261
                # that is it has an ancestor of NULL
 
262
                ancestors[ghost] = [NULL_REVISION]
 
263
                # ghost is common if any of ghosts descendants are common:
 
264
                for ghost_descendant in descendants[ghost]:
 
265
                    if ghost_descendant in common:
 
266
                        common.add(ghost)
 
267
                
 
268
            root = NULL_REVISION
 
269
            common.add(NULL_REVISION)
 
270
        except bzrlib.errors.NoCommonRoot:
 
271
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
272
            
 
273
        pb.update('Picking ancestor', 2, 3)
 
274
        distances = node_distances (descendants, ancestors, root)
 
275
        pb.update('Picking ancestor', 3, 2)
 
276
        farthest = select_farthest(distances, common)
 
277
        if farthest is None or farthest == NULL_REVISION:
 
278
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
279
    finally:
 
280
        pb.clear()
249
281
    return farthest
250
282
 
251
283
 
256
288
        assert len(args) != 0
257
289
        self._revision_sources = args
258
290
 
 
291
    def revision_parents(self, revision_id):
 
292
        for source in self._revision_sources:
 
293
            try:
 
294
                return source.revision_parents(revision_id)
 
295
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
296
                pass
 
297
        raise e
 
298
 
259
299
    def get_revision(self, revision_id):
260
300
        for source in self._revision_sources:
261
301
            try:
264
304
                pass
265
305
        raise e
266
306
 
 
307
    def get_revision_graph(self, revision_id):
 
308
        # we could probe incrementally until the pending
 
309
        # ghosts list stop growing, but its cheaper for now
 
310
        # to just ask for the complete graph for each repository.
 
311
        graphs = []
 
312
        for source in self._revision_sources:
 
313
            ghost_graph = source.get_revision_graph_with_ghosts()
 
314
            graphs.append(ghost_graph)
 
315
        absent = 0
 
316
        for graph in graphs:
 
317
            if not revision_id in graph.get_ancestors():
 
318
                absent += 1
 
319
        if absent == len(graphs):
 
320
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
321
 
 
322
        # combine the graphs
 
323
        result = {}
 
324
        pending = set([revision_id])
 
325
        def find_parents(node_id):
 
326
            """find the parents for node_id."""
 
327
            for graph in graphs:
 
328
                ancestors = graph.get_ancestors()
 
329
                try:
 
330
                    return ancestors[node_id]
 
331
                except KeyError:
 
332
                    pass
 
333
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
334
        while len(pending):
 
335
            # all the graphs should have identical parent lists
 
336
            node_id = pending.pop()
 
337
            try:
 
338
                result[node_id] = find_parents(node_id)
 
339
                for parent_node in result[node_id]:
 
340
                    if not parent_node in result:
 
341
                        pending.add(parent_node)
 
342
            except errors.NoSuchRevision:
 
343
                # ghost, ignore it.
 
344
                pass
 
345
        return result
 
346
 
 
347
    def get_revision_graph_with_ghosts(self, revision_ids):
 
348
        # query all the sources for their entire graphs 
 
349
        # and then build a combined graph for just
 
350
        # revision_ids.
 
351
        graphs = []
 
352
        for source in self._revision_sources:
 
353
            ghost_graph = source.get_revision_graph_with_ghosts()
 
354
            graphs.append(ghost_graph.get_ancestors())
 
355
        for revision_id in revision_ids:
 
356
            absent = 0
 
357
            for graph in graphs:
 
358
                    if not revision_id in graph:
 
359
                        absent += 1
 
360
            if absent == len(graphs):
 
361
                raise errors.NoSuchRevision(self._revision_sources[0],
 
362
                                            revision_id)
 
363
 
 
364
        # combine the graphs
 
365
        result = Graph()
 
366
        pending = set(revision_ids)
 
367
        done = set()
 
368
        def find_parents(node_id):
 
369
            """find the parents for node_id."""
 
370
            for graph in graphs:
 
371
                try:
 
372
                    return graph[node_id]
 
373
                except KeyError:
 
374
                    pass
 
375
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
376
        while len(pending):
 
377
            # all the graphs should have identical parent lists
 
378
            node_id = pending.pop()
 
379
            try:
 
380
                parents = find_parents(node_id)
 
381
                for parent_node in parents:
 
382
                    # queued or done? 
 
383
                    if (parent_node not in pending and
 
384
                        parent_node not in done):
 
385
                        # no, queue
 
386
                        pending.add(parent_node)
 
387
                result.add_node(node_id, parents)
 
388
                done.add(node_id)
 
389
            except errors.NoSuchRevision:
 
390
                # ghost
 
391
                result.add_ghost(node_id)
 
392
                continue
 
393
        return result
 
394
 
 
395
    def lock_read(self):
 
396
        for source in self._revision_sources:
 
397
            source.lock_read()
 
398
 
 
399
    def unlock(self):
 
400
        for source in self._revision_sources:
 
401
            source.unlock()
 
402
 
 
403
 
 
404
@deprecated_method(zero_eight)
267
405
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
268
406
                              revision_history=None):
269
407
    """Find the longest line of descent from maybe_ancestor to revision.