← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Marius Kruger
  • Date: 2007-04-14 11:57:26 UTC
  • mto: This revision was merged to the branch mainline in revision 2455.
  • Revision ID: amanic@gmail.com-20070414115726-kykcsm9pztykst1w
Revert test_too_much.py and just do the minimum te get the tests to pass.
Add some test to test_remove.py.
Let test_remove.py make safe id's.

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