← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-23 00:18:12 UTC
  • mfrom: (2743.1.5 misc-fixen)
  • Revision ID: pqm@pqm.ubuntu.com-20070823001812-eermtd2vfr5o6b7o
(robertc) Several minor miscellaneous code cleanup fixes. (Robert Collins)

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