← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Robey Pointer
  • Date: 2006-09-08 18:46:29 UTC
  • mto: This revision was merged to the branch mainline in revision 1996.
  • Revision ID: robey@lag.net-20060908184629-e3fc4c61ca21508c
pychecker is on crack; go back to using 'is None'.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# (C) 2005 Canonical
2
 
 
 
1
# Copyright (C) 2005, 2006 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
 
import bzrlib.errors
21
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
20
 
 
21
import bzrlib.errors as errors
 
22
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
22
23
from bzrlib.osutils import contains_whitespace
 
24
from bzrlib.progress import DummyProgress
 
25
from bzrlib.symbol_versioning import (deprecated_function,
 
26
        zero_eight,
 
27
        )
23
28
 
24
29
NULL_REVISION="null:"
25
30
 
 
31
 
26
32
class Revision(object):
27
33
    """Single revision on a branch.
28
34
 
47
53
        self._check_properties()
48
54
        self.parent_ids = []
49
55
        self.parent_sha1s = []
 
56
        """Not used anymore - legacy from for 4."""
50
57
        self.__dict__.update(args)
51
58
 
52
59
    def __repr__(self):
69
76
        return not self.__eq__(other)
70
77
 
71
78
    def _check_properties(self):
72
 
        """Verify that all revision properties are OK.
73
 
        """
 
79
        """Verify that all revision properties are OK."""
74
80
        for name, value in self.properties.iteritems():
75
81
            if not isinstance(name, basestring) or contains_whitespace(name):
76
82
                raise ValueError("invalid property name %r" % name)
78
84
                raise ValueError("invalid property value %r for %r" % 
79
85
                                 (name, value))
80
86
 
 
87
    def get_history(self, repository):
 
88
        """Return the canonical line-of-history for this revision.
 
89
 
 
90
        If ghosts are present this may differ in result from a ghost-free
 
91
        repository.
 
92
        """
 
93
        current_revision = self
 
94
        reversed_result = []
 
95
        while current_revision is not None:
 
96
            reversed_result.append(current_revision.revision_id)
 
97
            if not len (current_revision.parent_ids):
 
98
                reversed_result.append(None)
 
99
                current_revision = None
 
100
            else:
 
101
                next_revision_id = current_revision.parent_ids[0]
 
102
                current_revision = repository.get_revision(next_revision_id)
 
103
        reversed_result.reverse()
 
104
        return reversed_result
 
105
 
 
106
    def get_summary(self):
 
107
        """Get the first line of the log message for this revision.
 
108
        """
 
109
        return self.message.split('\n', 1)[0]
 
110
 
81
111
 
82
112
def is_ancestor(revision_id, candidate_id, branch):
83
113
    """Return true if candidate_id is an ancestor of revision_id.
88
118
    revisions_source is an object supporting a get_revision operation that
89
119
    behaves like Branch's.
90
120
    """
91
 
    return candidate_id in branch.get_ancestry(revision_id)
 
121
    return (candidate_id in branch.repository.get_ancestry(revision_id))
92
122
 
93
123
 
94
124
def iter_ancestors(revision_id, revision_source, only_present=False):
101
131
                yield ancestor, distance
102
132
            try:
103
133
                revision = revision_source.get_revision(ancestor)
104
 
            except bzrlib.errors.NoSuchRevision, e:
 
134
            except errors.NoSuchRevision, e:
105
135
                if e.revision == revision_id:
106
136
                    raise 
107
137
                else:
124
154
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
125
155
                         only_present=True))
126
156
    for anc_order, (anc_id, anc_distance) in anc_iter:
127
 
        if not found_ancestors.has_key(anc_id):
 
157
        if anc_id not in found_ancestors:
128
158
            found_ancestors[anc_id] = (anc_order, anc_distance)
129
159
    return found_ancestors
130
160
    
138
168
    return matches
139
169
 
140
170
 
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
171
def revision_graph(revision, revision_source):
173
172
    """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.
 
173
    
 
174
    :return: root, ancestors map, descendants map
181
175
    """
 
176
    revision_source.lock_read()
 
177
    try:
 
178
        return _revision_graph(revision, revision_source)
 
179
    finally:
 
180
        revision_source.unlock()
 
181
 
 
182
 
 
183
def _revision_graph(revision, revision_source):
 
184
    """See revision_graph."""
 
185
    from bzrlib.tsort import topo_sort
 
186
    graph = revision_source.get_revision_graph(revision)
 
187
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
188
    for node, parents in graph.items():
 
189
        if len(parents) == 0:
 
190
            graph[node] = [NULL_REVISION]
 
191
    # add NULL_REVISION to the graph
 
192
    graph[NULL_REVISION] = []
 
193
 
 
194
    # pick a root. If there are multiple roots
 
195
    # this could pick a random one.
 
196
    topo_order = topo_sort(graph.items())
 
197
    root = topo_order[0]
 
198
 
182
199
    ancestors = {}
183
200
    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()
 
201
 
 
202
    # map the descendants of the graph.
 
203
    # and setup our set based return graph.
 
204
    for node in graph.keys():
 
205
        descendants[node] = {}
 
206
    for node, parents in graph.items():
 
207
        for parent in parents:
 
208
            descendants[parent][node] = 1
 
209
        ancestors[node] = set(parents)
 
210
 
236
211
    assert root not in descendants[root]
237
212
    assert root not in ancestors[root]
238
213
    return root, ancestors, descendants
241
216
def combined_graph(revision_a, revision_b, revision_source):
242
217
    """Produce a combined ancestry graph.
243
218
    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)
 
219
    root, ancestors, descendants = revision_graph(
 
220
        revision_a, revision_source)
 
221
    root_b, ancestors_b, descendants_b = revision_graph(
 
222
        revision_b, revision_source)
247
223
    if root != root_b:
248
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
224
        raise errors.NoCommonRoot(revision_a, revision_b)
249
225
    common = set()
250
226
    for node, node_anc in ancestors_b.iteritems():
251
227
        if node in ancestors:
260
236
    return root, ancestors, descendants, common
261
237
 
262
238
 
263
 
def common_ancestor(revision_a, revision_b, revision_source):
 
239
def common_ancestor(revision_a, revision_b, revision_source, 
 
240
                    pb=DummyProgress()):
 
241
    if None in (revision_a, revision_b):
 
242
        return None
 
243
    if NULL_REVISION in (revision_a, revision_b):
 
244
        return NULL_REVISION
 
245
    # trivial optimisation
 
246
    if revision_a == revision_b:
 
247
        return revision_a
264
248
    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)
 
249
        try:
 
250
            pb.update('Picking ancestor', 1, 3)
 
251
            graph = revision_source.get_revision_graph_with_ghosts(
 
252
                [revision_a, revision_b])
 
253
            # convert to a NULL_REVISION based graph.
 
254
            ancestors = graph.get_ancestors()
 
255
            descendants = graph.get_descendants()
 
256
            common = set(graph.get_ancestry(revision_a)).intersection(
 
257
                     set(graph.get_ancestry(revision_b)))
 
258
            descendants[NULL_REVISION] = {}
 
259
            ancestors[NULL_REVISION] = []
 
260
            for root in graph.roots:
 
261
                descendants[NULL_REVISION][root] = 1
 
262
                ancestors[root].append(NULL_REVISION)
 
263
            for ghost in graph.ghosts:
 
264
                # ghosts act as roots for the purpose of finding 
 
265
                # the longest paths from the root: any ghost *might*
 
266
                # be directly attached to the root, so we treat them
 
267
                # as being such.
 
268
                # ghost now descends from NULL
 
269
                descendants[NULL_REVISION][ghost] = 1
 
270
                # that is it has an ancestor of NULL
 
271
                ancestors[ghost] = [NULL_REVISION]
 
272
                # ghost is common if any of ghosts descendants are common:
 
273
                for ghost_descendant in descendants[ghost]:
 
274
                    if ghost_descendant in common:
 
275
                        common.add(ghost)
 
276
                
 
277
            root = NULL_REVISION
 
278
            common.add(NULL_REVISION)
 
279
        except errors.NoCommonRoot:
 
280
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
281
            
 
282
        pb.update('Picking ancestor', 2, 3)
 
283
        distances = node_distances (descendants, ancestors, root)
 
284
        pb.update('Picking ancestor', 3, 2)
 
285
        farthest = select_farthest(distances, common)
 
286
        if farthest is None or farthest == NULL_REVISION:
 
287
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
288
    finally:
 
289
        pb.clear()
274
290
    return farthest
275
291
 
276
292
 
281
297
        assert len(args) != 0
282
298
        self._revision_sources = args
283
299
 
 
300
    def revision_parents(self, revision_id):
 
301
        for source in self._revision_sources:
 
302
            try:
 
303
                return source.revision_parents(revision_id)
 
304
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
305
                pass
 
306
        raise e
 
307
 
284
308
    def get_revision(self, revision_id):
285
309
        for source in self._revision_sources:
286
310
            try:
287
311
                return source.get_revision(revision_id)
288
 
            except bzrlib.errors.NoSuchRevision, e:
 
312
            except errors.NoSuchRevision, e:
289
313
                pass
290
314
        raise e
291
315
 
292
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
316
    def get_revision_graph(self, revision_id):
 
317
        # we could probe incrementally until the pending
 
318
        # ghosts list stop growing, but its cheaper for now
 
319
        # to just ask for the complete graph for each repository.
 
320
        graphs = []
 
321
        for source in self._revision_sources:
 
322
            ghost_graph = source.get_revision_graph_with_ghosts()
 
323
            graphs.append(ghost_graph)
 
324
        absent = 0
 
325
        for graph in graphs:
 
326
            if not revision_id in graph.get_ancestors():
 
327
                absent += 1
 
328
        if absent == len(graphs):
 
329
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
330
 
 
331
        # combine the graphs
 
332
        result = {}
 
333
        pending = set([revision_id])
 
334
        def find_parents(node_id):
 
335
            """find the parents for node_id."""
 
336
            for graph in graphs:
 
337
                ancestors = graph.get_ancestors()
 
338
                try:
 
339
                    return ancestors[node_id]
 
340
                except KeyError:
 
341
                    pass
 
342
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
343
        while len(pending):
 
344
            # all the graphs should have identical parent lists
 
345
            node_id = pending.pop()
 
346
            try:
 
347
                result[node_id] = find_parents(node_id)
 
348
                for parent_node in result[node_id]:
 
349
                    if not parent_node in result:
 
350
                        pending.add(parent_node)
 
351
            except errors.NoSuchRevision:
 
352
                # ghost, ignore it.
 
353
                pass
 
354
        return result
 
355
 
 
356
    def get_revision_graph_with_ghosts(self, revision_ids):
 
357
        # query all the sources for their entire graphs 
 
358
        # and then build a combined graph for just
 
359
        # revision_ids.
 
360
        graphs = []
 
361
        for source in self._revision_sources:
 
362
            ghost_graph = source.get_revision_graph_with_ghosts()
 
363
            graphs.append(ghost_graph.get_ancestors())
 
364
        for revision_id in revision_ids:
 
365
            absent = 0
 
366
            for graph in graphs:
 
367
                    if not revision_id in graph:
 
368
                        absent += 1
 
369
            if absent == len(graphs):
 
370
                raise errors.NoSuchRevision(self._revision_sources[0],
 
371
                                            revision_id)
 
372
 
 
373
        # combine the graphs
 
374
        result = Graph()
 
375
        pending = set(revision_ids)
 
376
        done = set()
 
377
        def find_parents(node_id):
 
378
            """find the parents for node_id."""
 
379
            for graph in graphs:
 
380
                try:
 
381
                    return graph[node_id]
 
382
                except KeyError:
 
383
                    pass
 
384
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
385
        while len(pending):
 
386
            # all the graphs should have identical parent lists
 
387
            node_id = pending.pop()
 
388
            try:
 
389
                parents = find_parents(node_id)
 
390
                for parent_node in parents:
 
391
                    # queued or done? 
 
392
                    if (parent_node not in pending and
 
393
                        parent_node not in done):
 
394
                        # no, queue
 
395
                        pending.add(parent_node)
 
396
                result.add_node(node_id, parents)
 
397
                done.add(node_id)
 
398
            except errors.NoSuchRevision:
 
399
                # ghost
 
400
                result.add_ghost(node_id)
 
401
                continue
 
402
        return result
 
403
 
 
404
    def lock_read(self):
 
405
        for source in self._revision_sources:
 
406
            source.lock_read()
 
407
 
 
408
    def unlock(self):
 
409
        for source in self._revision_sources:
 
410
            source.unlock()
 
411
 
 
412
 
 
413
@deprecated_function(zero_eight)
 
414
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
293
415
                              revision_history=None):
294
416
    """Find the longest line of descent from maybe_ancestor to revision.
295
417
    Revision history is followed where possible.
300
422
    """
301
423
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
302
424
    if len(descendants) == 0:
303
 
        raise NoSuchRevision(rev_source, rev_id)
 
425
        raise errors.NoSuchRevision(rev_source, rev_id)
304
426
    if ancestor_id not in descendants:
305
427
        rev_source.get_revision(ancestor_id)
306
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
428
        raise errors.NotAncestor(rev_id, ancestor_id)
307
429
    root_descendants = all_descendants(descendants, ancestor_id)
308
430
    root_descendants.add(ancestor_id)
309
431
    if rev_id not in root_descendants:
310
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
432
        raise errors.NotAncestor(rev_id, ancestor_id)
311
433
    distances = node_distances(descendants, ancestors, ancestor_id,
312
434
                               root_descendants=root_descendants)
313
435