← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

- more refactoring and tests of commandline

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005, 2006 Canonical
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
 
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
 
from bzrlib.progress import DummyProgress
25
 
from bzrlib.symbol_versioning import (deprecated_function,
26
 
        zero_eight,
27
 
        )
28
23
 
29
24
NULL_REVISION="null:"
30
25
 
31
 
 
32
26
class Revision(object):
33
27
    """Single revision on a branch.
34
28
 
51
45
        self.revision_id = revision_id
52
46
        self.properties = properties or {}
53
47
        self._check_properties()
 
48
        self.__dict__.update(args)
54
49
        self.parent_ids = []
55
50
        self.parent_sha1s = []
56
 
        """Not used anymore - legacy from for 4."""
57
 
        self.__dict__.update(args)
58
51
 
59
52
    def __repr__(self):
60
53
        return "<Revision id %s>" % self.revision_id
76
69
        return not self.__eq__(other)
77
70
 
78
71
    def _check_properties(self):
79
 
        """Verify that all revision properties are OK."""
 
72
        """Verify that all revision properties are OK.
 
73
        """
80
74
        for name, value in self.properties.iteritems():
81
75
            if not isinstance(name, basestring) or contains_whitespace(name):
82
76
                raise ValueError("invalid property name %r" % name)
84
78
                raise ValueError("invalid property value %r for %r" % 
85
79
                                 (name, value))
86
80
 
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
 
 
111
81
 
112
82
def is_ancestor(revision_id, candidate_id, branch):
113
83
    """Return true if candidate_id is an ancestor of revision_id.
118
88
    revisions_source is an object supporting a get_revision operation that
119
89
    behaves like Branch's.
120
90
    """
121
 
    return (candidate_id in branch.repository.get_ancestry(revision_id))
 
91
    return candidate_id in branch.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
 
 
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
 
171
172
def revision_graph(revision, revision_source):
172
173
    """Produce a graph of the ancestry of the specified revision.
173
 
    
174
 
    :return: root, ancestors map, descendants map
 
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.
175
179
    """
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
 
 
199
180
    ancestors = {}
200
181
    descendants = {}
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
 
 
 
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
211
211
    assert root not in descendants[root]
212
212
    assert root not in ancestors[root]
213
213
    return root, ancestors, descendants
216
216
def combined_graph(revision_a, revision_b, revision_source):
217
217
    """Produce a combined ancestry graph.
218
218
    Return graph root, ancestors map, descendants map, set of common nodes"""
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)
 
219
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
220
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
221
                                                        revision_source)
223
222
    if root != root_b:
224
 
        raise errors.NoCommonRoot(revision_a, revision_b)
 
223
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
225
224
    common = set()
226
225
    for node, node_anc in ancestors_b.iteritems():
227
226
        if node in ancestors:
236
235
    return root, ancestors, descendants, common
237
236
 
238
237
 
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
 
238
def common_ancestor(revision_a, revision_b, revision_source):
248
239
    try:
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()
 
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)
290
249
    return farthest
291
250
 
292
251
 
297
256
        assert len(args) != 0
298
257
        self._revision_sources = args
299
258
 
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
 
 
308
259
    def get_revision(self, revision_id):
309
260
        for source in self._revision_sources:
310
261
            try:
311
262
                return source.get_revision(revision_id)
312
 
            except errors.NoSuchRevision, e:
 
263
            except bzrlib.errors.NoSuchRevision, e:
313
264
                pass
314
265
        raise e
315
266
 
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,
 
267
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
415
268
                              revision_history=None):
416
269
    """Find the longest line of descent from maybe_ancestor to revision.
417
270
    Revision history is followed where possible.
422
275
    """
423
276
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
424
277
    if len(descendants) == 0:
425
 
        raise errors.NoSuchRevision(rev_source, rev_id)
 
278
        raise NoSuchRevision(rev_source, rev_id)
426
279
    if ancestor_id not in descendants:
427
280
        rev_source.get_revision(ancestor_id)
428
 
        raise errors.NotAncestor(rev_id, ancestor_id)
 
281
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
429
282
    root_descendants = all_descendants(descendants, ancestor_id)
430
283
    root_descendants.add(ancestor_id)
431
284
    if rev_id not in root_descendants:
432
 
        raise errors.NotAncestor(rev_id, ancestor_id)
 
285
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
433
286
    distances = node_distances(descendants, ancestors, ancestor_id,
434
287
                               root_descendants=root_descendants)
435
288