~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: John Arbash Meinel
  • Date: 2007-11-13 20:37:09 UTC
  • mto: This revision was merged to the branch mainline in revision 3001.
  • Revision ID: john@arbash-meinel.com-20071113203709-kysdte0emqv84pnj
Fix bug #162486, by having RemoteBranch properly initialize self._revision_id_to_revno_map.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.lstrip().split('\n', 1)[0]
 
118
 
 
119
    def get_apparent_author(self):
 
120
        """Return the apparent author of this revision.
 
121
 
 
122
        If the revision properties contain the author name,
 
123
        return it. Otherwise return the committer name.
 
124
        """
 
125
        return self.properties.get('author', self.committer)
 
126
 
81
127
 
82
128
def is_ancestor(revision_id, candidate_id, branch):
83
129
    """Return true if candidate_id is an ancestor of revision_id.
88
134
    revisions_source is an object supporting a get_revision operation that
89
135
    behaves like Branch's.
90
136
    """
91
 
    return candidate_id in branch.get_ancestry(revision_id)
 
137
    if is_null(candidate_id):
 
138
        return True
 
139
    return (candidate_id in branch.repository.get_ancestry(revision_id,
 
140
            topo_sorted=False))
92
141
 
93
142
 
94
143
def iter_ancestors(revision_id, revision_source, only_present=False):
101
150
                yield ancestor, distance
102
151
            try:
103
152
                revision = revision_source.get_revision(ancestor)
104
 
            except bzrlib.errors.NoSuchRevision, e:
 
153
            except errors.NoSuchRevision, e:
105
154
                if e.revision == revision_id:
106
155
                    raise 
107
156
                else:
124
173
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
125
174
                         only_present=True))
126
175
    for anc_order, (anc_id, anc_distance) in anc_iter:
127
 
        if not found_ancestors.has_key(anc_id):
 
176
        if anc_id not in found_ancestors:
128
177
            found_ancestors[anc_id] = (anc_order, anc_distance)
129
178
    return found_ancestors
130
179
    
138
187
    return matches
139
188
 
140
189
 
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
190
def revision_graph(revision, revision_source):
173
191
    """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.
 
192
    
 
193
    :return: root, ancestors map, descendants map
181
194
    """
 
195
    revision_source.lock_read()
 
196
    try:
 
197
        return _revision_graph(revision, revision_source)
 
198
    finally:
 
199
        revision_source.unlock()
 
200
 
 
201
 
 
202
def _revision_graph(revision, revision_source):
 
203
    """See revision_graph."""
 
204
    from bzrlib.tsort import topo_sort
 
205
    graph = revision_source.get_revision_graph(revision)
 
206
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
207
    for node, parents in graph.items():
 
208
        if len(parents) == 0:
 
209
            graph[node] = [NULL_REVISION]
 
210
    # add NULL_REVISION to the graph
 
211
    graph[NULL_REVISION] = []
 
212
 
 
213
    # pick a root. If there are multiple roots
 
214
    # this could pick a random one.
 
215
    topo_order = topo_sort(graph.items())
 
216
    root = topo_order[0]
 
217
 
182
218
    ancestors = {}
183
219
    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()
 
220
 
 
221
    # map the descendants of the graph.
 
222
    # and setup our set based return graph.
 
223
    for node in graph.keys():
 
224
        descendants[node] = {}
 
225
    for node, parents in graph.items():
 
226
        for parent in parents:
 
227
            descendants[parent][node] = 1
 
228
        ancestors[node] = set(parents)
 
229
 
236
230
    assert root not in descendants[root]
237
231
    assert root not in ancestors[root]
238
232
    return root, ancestors, descendants
241
235
def combined_graph(revision_a, revision_b, revision_source):
242
236
    """Produce a combined ancestry graph.
243
237
    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)
 
238
    root, ancestors, descendants = revision_graph(
 
239
        revision_a, revision_source)
 
240
    root_b, ancestors_b, descendants_b = revision_graph(
 
241
        revision_b, revision_source)
247
242
    if root != root_b:
248
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
243
        raise errors.NoCommonRoot(revision_a, revision_b)
249
244
    common = set()
250
245
    for node, node_anc in ancestors_b.iteritems():
251
246
        if node in ancestors:
260
255
    return root, ancestors, descendants, common
261
256
 
262
257
 
263
 
def common_ancestor(revision_a, revision_b, revision_source):
 
258
def common_ancestor(revision_a, revision_b, revision_source, 
 
259
                    pb=DummyProgress()):
 
260
    if None in (revision_a, revision_b):
 
261
        return None
 
262
    if NULL_REVISION in (revision_a, revision_b):
 
263
        return NULL_REVISION
 
264
    # trivial optimisation
 
265
    if revision_a == revision_b:
 
266
        return revision_a
264
267
    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)
 
268
        try:
 
269
            pb.update('Picking ancestor', 1, 3)
 
270
            graph = revision_source.get_revision_graph_with_ghosts(
 
271
                [revision_a, revision_b])
 
272
            # Shortcut the case where one of the tips is already included in
 
273
            # the other graphs ancestry.
 
274
            ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
 
275
            if revision_b in ancestry_a:
 
276
                return revision_b
 
277
            ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
 
278
            if revision_a in ancestry_b:
 
279
                return revision_a
 
280
            # convert to a NULL_REVISION based graph.
 
281
            ancestors = graph.get_ancestors()
 
282
            descendants = graph.get_descendants()
 
283
            common = set(ancestry_a)
 
284
            common.intersection_update(ancestry_b)
 
285
            descendants[NULL_REVISION] = {}
 
286
            ancestors[NULL_REVISION] = []
 
287
            for root in graph.roots:
 
288
                descendants[NULL_REVISION][root] = 1
 
289
                ancestors[root].append(NULL_REVISION)
 
290
            for ghost in graph.ghosts:
 
291
                # ghosts act as roots for the purpose of finding 
 
292
                # the longest paths from the root: any ghost *might*
 
293
                # be directly attached to the root, so we treat them
 
294
                # as being such.
 
295
                # ghost now descends from NULL
 
296
                descendants[NULL_REVISION][ghost] = 1
 
297
                # that is it has an ancestor of NULL
 
298
                ancestors[ghost] = [NULL_REVISION]
 
299
                # ghost is common if any of ghosts descendants are common:
 
300
                for ghost_descendant in descendants[ghost]:
 
301
                    if ghost_descendant in common:
 
302
                        common.add(ghost)
 
303
                
 
304
            root = NULL_REVISION
 
305
            common.add(NULL_REVISION)
 
306
        except errors.NoCommonRoot:
 
307
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
308
            
 
309
        pb.update('Picking ancestor', 2, 3)
 
310
        distances = node_distances (descendants, ancestors, root)
 
311
        pb.update('Picking ancestor', 3, 2)
 
312
        farthest = select_farthest(distances, common)
 
313
        if farthest is None or farthest == NULL_REVISION:
 
314
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
315
    finally:
 
316
        pb.clear()
274
317
    return farthest
275
318
 
276
319
 
281
324
        assert len(args) != 0
282
325
        self._revision_sources = args
283
326
 
 
327
    def revision_parents(self, revision_id):
 
328
        for source in self._revision_sources:
 
329
            try:
 
330
                return source.revision_parents(revision_id)
 
331
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
332
                pass
 
333
        raise e
 
334
 
284
335
    def get_revision(self, revision_id):
285
336
        for source in self._revision_sources:
286
337
            try:
287
338
                return source.get_revision(revision_id)
288
 
            except bzrlib.errors.NoSuchRevision, e:
 
339
            except errors.NoSuchRevision, e:
289
340
                pass
290
341
        raise e
291
342
 
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
 
343
    def get_revision_graph(self, revision_id):
 
344
        # we could probe incrementally until the pending
 
345
        # ghosts list stop growing, but its cheaper for now
 
346
        # to just ask for the complete graph for each repository.
 
347
        graphs = []
 
348
        for source in self._revision_sources:
 
349
            ghost_graph = source.get_revision_graph_with_ghosts()
 
350
            graphs.append(ghost_graph)
 
351
        absent = 0
 
352
        for graph in graphs:
 
353
            if not revision_id in graph.get_ancestors():
 
354
                absent += 1
 
355
        if absent == len(graphs):
 
356
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
357
 
 
358
        # combine the graphs
 
359
        result = {}
 
360
        pending = set([revision_id])
 
361
        def find_parents(node_id):
 
362
            """find the parents for node_id."""
 
363
            for graph in graphs:
 
364
                ancestors = graph.get_ancestors()
 
365
                try:
 
366
                    return ancestors[node_id]
 
367
                except KeyError:
 
368
                    pass
 
369
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
370
        while len(pending):
 
371
            # all the graphs should have identical parent lists
 
372
            node_id = pending.pop()
 
373
            try:
 
374
                result[node_id] = find_parents(node_id)
 
375
                for parent_node in result[node_id]:
 
376
                    if not parent_node in result:
 
377
                        pending.add(parent_node)
 
378
            except errors.NoSuchRevision:
 
379
                # ghost, ignore it.
 
380
                pass
 
381
        return result
 
382
 
 
383
    def get_revision_graph_with_ghosts(self, revision_ids):
 
384
        # query all the sources for their entire graphs 
 
385
        # and then build a combined graph for just
 
386
        # revision_ids.
 
387
        graphs = []
 
388
        for source in self._revision_sources:
 
389
            ghost_graph = source.get_revision_graph_with_ghosts()
 
390
            graphs.append(ghost_graph.get_ancestors())
 
391
        for revision_id in revision_ids:
 
392
            absent = 0
 
393
            for graph in graphs:
 
394
                    if not revision_id in graph:
 
395
                        absent += 1
 
396
            if absent == len(graphs):
 
397
                raise errors.NoSuchRevision(self._revision_sources[0],
 
398
                                            revision_id)
 
399
 
 
400
        # combine the graphs
 
401
        result = Graph()
 
402
        pending = set(revision_ids)
 
403
        done = set()
 
404
        def find_parents(node_id):
 
405
            """find the parents for node_id."""
 
406
            for graph in graphs:
 
407
                try:
 
408
                    return graph[node_id]
 
409
                except KeyError:
 
410
                    pass
 
411
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
412
        while len(pending):
 
413
            # all the graphs should have identical parent lists
 
414
            node_id = pending.pop()
 
415
            try:
 
416
                parents = find_parents(node_id)
 
417
                for parent_node in parents:
 
418
                    # queued or done? 
 
419
                    if (parent_node not in pending and
 
420
                        parent_node not in done):
 
421
                        # no, queue
 
422
                        pending.add(parent_node)
 
423
                result.add_node(node_id, parents)
 
424
                done.add(node_id)
 
425
            except errors.NoSuchRevision:
 
426
                # ghost
 
427
                result.add_ghost(node_id)
 
428
                continue
 
429
        return result
 
430
 
 
431
    def lock_read(self):
 
432
        for source in self._revision_sources:
 
433
            source.lock_read()
 
434
 
 
435
    def unlock(self):
 
436
        for source in self._revision_sources:
 
437
            source.unlock()
 
438
 
 
439
 
 
440
def is_reserved_id(revision_id):
 
441
    """Determine whether a revision id is reserved
 
442
 
 
443
    :return: True if the revision is is reserved, False otherwise
300
444
    """
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
 
445
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
 
446
 
 
447
 
 
448
def check_not_reserved_id(revision_id):
 
449
    """Raise ReservedId if the supplied revision_id is reserved"""
 
450
    if is_reserved_id(revision_id):
 
451
        raise errors.ReservedId(revision_id)
 
452
 
 
453
 
 
454
def ensure_null(revision_id):
 
455
    """Ensure only NULL_REVISION is used to represent the null revisionn"""
 
456
    if revision_id is None:
 
457
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
458
            ' revision instead of None, as of bzr 0.91.',
 
459
            DeprecationWarning, stacklevel=2)
 
460
        return NULL_REVISION
 
461
    else:
 
462
        return revision_id
 
463
 
 
464
 
 
465
def is_null(revision_id):
 
466
    if revision_id is None:
 
467
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
468
            ' revision instead of None, as of bzr 0.90.',
 
469
            DeprecationWarning, stacklevel=2)
 
470
    return revision_id in (None, NULL_REVISION)