~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2006-03-16 14:55:45 UTC
  • mto: (1615.1.1 bzr.mbp.integration)
  • mto: This revision was merged to the branch mainline in revision 1613.
  • Revision ID: mbp@sourcefrog.net-20060316145545-124f96fa0c9e9461
Stop selftest failing when run outside of bzr source directory

It was trying to import tools.doc_generate, which is used to generate the man
page but is not installed by setup.py.  Skip the test if it can't be run.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
16
16
 
 
17
# TODO: Some kind of command-line display of revision properties: 
 
18
# perhaps show them in log -v and allow them as options to the commit command.
 
19
 
17
20
 
18
21
import bzrlib.errors
19
 
 
20
 
 
21
 
class RevisionReference(object):
22
 
    """
23
 
    Reference to a stored revision.
24
 
 
25
 
    Includes the revision_id and revision_sha1.
26
 
    """
27
 
    revision_id = None
28
 
    revision_sha1 = None
29
 
    def __init__(self, revision_id, revision_sha1=None):
30
 
        if revision_id == None \
31
 
           or isinstance(revision_id, basestring):
32
 
            self.revision_id = revision_id
33
 
        else:
34
 
            raise ValueError('bad revision_id %r' % revision_id)
35
 
 
36
 
        if revision_sha1 != None:
37
 
            if isinstance(revision_sha1, basestring) \
38
 
               and len(revision_sha1) == 40:
39
 
                self.revision_sha1 = revision_sha1
40
 
            else:
41
 
                raise ValueError('bad revision_sha1 %r' % revision_sha1)
42
 
                
43
 
 
 
22
import bzrlib.errors as errors
 
23
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
 
24
from bzrlib.osutils import contains_whitespace
 
25
from bzrlib.progress import DummyProgress
 
26
 
 
27
NULL_REVISION="null:"
44
28
 
45
29
class Revision(object):
46
30
    """Single revision on a branch.
51
35
 
52
36
    After bzr 0.0.5 revisions are allowed to have multiple parents.
53
37
 
54
 
    parents
55
 
        List of parent revisions, each is a RevisionReference.
 
38
    parent_ids
 
39
        List of parent revision_ids
 
40
 
 
41
    properties
 
42
        Dictionary of revision properties.  These are attached to the
 
43
        revision as extra metadata.  The name must be a single 
 
44
        word; the value can be an arbitrary string.
56
45
    """
57
 
    inventory_id = None
58
 
    inventory_sha1 = None
59
 
    revision_id = None
60
 
    timestamp = None
61
 
    message = None
62
 
    timezone = None
63
 
    committer = None
64
46
    
65
 
    def __init__(self, **args):
 
47
    def __init__(self, revision_id, properties=None, **args):
 
48
        self.revision_id = revision_id
 
49
        self.properties = properties or {}
 
50
        self._check_properties()
 
51
        self.parent_ids = []
 
52
        self.parent_sha1s = []
66
53
        self.__dict__.update(args)
67
 
        self.parents = []
68
 
 
69
54
 
70
55
    def __repr__(self):
71
56
        return "<Revision id %s>" % self.revision_id
73
58
    def __eq__(self, other):
74
59
        if not isinstance(other, Revision):
75
60
            return False
76
 
        return (self.inventory_id == other.inventory_id
77
 
                and self.inventory_sha1 == other.inventory_sha1
 
61
        # FIXME: rbc 20050930 parent_ids are not being compared
 
62
        return (
 
63
                self.inventory_sha1 == other.inventory_sha1
78
64
                and self.revision_id == other.revision_id
79
65
                and self.timestamp == other.timestamp
80
66
                and self.message == other.message
81
67
                and self.timezone == other.timezone
82
 
                and self.committer == other.committer)
 
68
                and self.committer == other.committer
 
69
                and self.properties == other.properties)
83
70
 
84
71
    def __ne__(self, other):
85
72
        return not self.__eq__(other)
86
73
 
87
 
        
88
 
 
89
 
REVISION_ID_RE = None
90
 
 
91
 
def validate_revision_id(rid):
92
 
    """Check rid is syntactically valid for a revision id."""
93
 
    global REVISION_ID_RE
94
 
    if not REVISION_ID_RE:
95
 
        import re
96
 
        REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
97
 
 
98
 
    if not REVISION_ID_RE.match(rid):
99
 
        raise ValueError("malformed revision-id %r" % rid)
100
 
 
101
 
def is_ancestor(revision_id, candidate_id, revision_source):
 
74
    def _check_properties(self):
 
75
        """Verify that all revision properties are OK.
 
76
        """
 
77
        for name, value in self.properties.iteritems():
 
78
            if not isinstance(name, basestring) or contains_whitespace(name):
 
79
                raise ValueError("invalid property name %r" % name)
 
80
            if not isinstance(value, basestring):
 
81
                raise ValueError("invalid property value %r for %r" % 
 
82
                                 (name, value))
 
83
 
 
84
    def get_history(self, repository):
 
85
        """Return the canonical line-of-history for this revision.
 
86
 
 
87
        If ghosts are present this may differ in result from a ghost-free
 
88
        repository.
 
89
        """
 
90
        current_revision = self
 
91
        reversed_result = []
 
92
        while current_revision is not None:
 
93
            reversed_result.append(current_revision.revision_id)
 
94
            if not len (current_revision.parent_ids):
 
95
                reversed_result.append(None)
 
96
                current_revision = None
 
97
            else:
 
98
                next_revision_id = current_revision.parent_ids[0]
 
99
                current_revision = repository.get_revision(next_revision_id)
 
100
        reversed_result.reverse()
 
101
        return reversed_result
 
102
 
 
103
 
 
104
def is_ancestor(revision_id, candidate_id, branch):
102
105
    """Return true if candidate_id is an ancestor of revision_id.
 
106
 
103
107
    A false negative will be returned if any intermediate descendent of
104
108
    candidate_id is not present in any of the revision_sources.
105
109
    
106
110
    revisions_source is an object supporting a get_revision operation that
107
111
    behaves like Branch's.
108
112
    """
 
113
    return candidate_id in branch.repository.get_ancestry(revision_id)
109
114
 
110
 
    for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
111
 
        if ancestor_id == candidate_id:
112
 
            return True
113
 
    return False
114
115
 
115
116
def iter_ancestors(revision_id, revision_source, only_present=False):
116
117
    ancestors = (revision_id,)
129
130
                    continue
130
131
            if only_present:
131
132
                yield ancestor, distance
132
 
            new_ancestors.extend([p.revision_id for p in revision.parents])
 
133
            new_ancestors.extend(revision.parent_ids)
133
134
        ancestors = new_ancestors
134
135
        distance += 1
135
136
 
159
160
    return matches
160
161
 
161
162
 
162
 
def common_ancestor(revision_a, revision_b, revision_source):
163
 
    """Find the ancestor common to both revisions that is closest to both.
 
163
def revision_graph(revision, revision_source):
 
164
    """Produce a graph of the ancestry of the specified revision.
 
165
    
 
166
    :return: root, ancestors map, descendants map
164
167
    """
165
 
    from bzrlib.trace import mutter
166
 
    a_ancestors = find_present_ancestors(revision_a, revision_source)
167
 
    b_ancestors = find_present_ancestors(revision_b, revision_source)
168
 
    a_intersection = []
169
 
    b_intersection = []
170
 
    # a_order is used as a tie-breaker when two equally-good bases are found
171
 
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
172
 
        if b_ancestors.has_key(revision):
173
 
            a_intersection.append((a_distance, a_order, revision))
174
 
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
175
 
    mutter("a intersection: %r" % a_intersection)
176
 
    mutter("b intersection: %r" % b_intersection)
177
 
 
178
 
    a_closest = __get_closest(a_intersection)
179
 
    if len(a_closest) == 0:
 
168
    revision_source.lock_read()
 
169
    try:
 
170
        return _revision_graph(revision, revision_source)
 
171
    finally:
 
172
        revision_source.unlock()
 
173
 
 
174
 
 
175
def _revision_graph(revision, revision_source):
 
176
    """See revision_graph."""
 
177
    from bzrlib.tsort import topo_sort
 
178
    graph = revision_source.get_revision_graph(revision)
 
179
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
180
    for node, parents in graph.items():
 
181
        if len(parents) == 0:
 
182
            graph[node] = [NULL_REVISION]
 
183
    # add NULL_REVISION to the graph
 
184
    graph[NULL_REVISION] = []
 
185
 
 
186
    # pick a root. If there are multiple roots
 
187
    # this could pick a random one.
 
188
    topo_order = topo_sort(graph.items())
 
189
    root = topo_order[0]
 
190
 
 
191
    ancestors = {}
 
192
    descendants = {}
 
193
 
 
194
    # map the descendants of the graph.
 
195
    # and setup our set based return graph.
 
196
    for node in graph.keys():
 
197
        descendants[node] = {}
 
198
    for node, parents in graph.items():
 
199
        for parent in parents:
 
200
            descendants[parent][node] = 1
 
201
        ancestors[node] = set(parents)
 
202
 
 
203
    assert root not in descendants[root]
 
204
    assert root not in ancestors[root]
 
205
    return root, ancestors, descendants
 
206
 
 
207
 
 
208
def combined_graph(revision_a, revision_b, revision_source):
 
209
    """Produce a combined ancestry graph.
 
210
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
211
    root, ancestors, descendants = revision_graph(
 
212
        revision_a, revision_source)
 
213
    root_b, ancestors_b, descendants_b = revision_graph(
 
214
        revision_b, revision_source)
 
215
    if root != root_b:
 
216
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
217
    common = set()
 
218
    for node, node_anc in ancestors_b.iteritems():
 
219
        if node in ancestors:
 
220
            common.add(node)
 
221
        else:
 
222
            ancestors[node] = set()
 
223
        ancestors[node].update(node_anc)
 
224
    for node, node_dec in descendants_b.iteritems():
 
225
        if node not in descendants:
 
226
            descendants[node] = {}
 
227
        descendants[node].update(node_dec)
 
228
    return root, ancestors, descendants, common
 
229
 
 
230
 
 
231
def common_ancestor(revision_a, revision_b, revision_source, 
 
232
                    pb=DummyProgress()):
 
233
    if None in (revision_a, revision_b):
180
234
        return None
181
 
    b_closest = __get_closest(b_intersection)
182
 
    assert len(b_closest) != 0
183
 
    mutter ("a_closest %r" % a_closest)
184
 
    mutter ("b_closest %r" % b_closest)
185
 
    if a_closest[0] in b_closest:
186
 
        return a_closest[0]
187
 
    elif b_closest[0] in a_closest:
188
 
        return b_closest[0]
189
 
    else:
190
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
191
 
    return a_closest[0]
 
235
    # trivial optimisation
 
236
    if revision_a == revision_b:
 
237
        return revision_a
 
238
    try:
 
239
        try:
 
240
            pb.update('Picking ancestor', 1, 3)
 
241
            graph = revision_source.get_revision_graph_with_ghosts(
 
242
                [revision_a, revision_b])
 
243
            # convert to a NULL_REVISION based graph.
 
244
            ancestors = graph.get_ancestors()
 
245
            descendants = graph.get_descendants()
 
246
            common = set(graph.get_ancestry(revision_a)).intersection(
 
247
                     set(graph.get_ancestry(revision_b)))
 
248
            descendants[NULL_REVISION] = {}
 
249
            ancestors[NULL_REVISION] = []
 
250
            for root in graph.roots:
 
251
                descendants[NULL_REVISION][root] = 1
 
252
                ancestors[root].append(NULL_REVISION)
 
253
            if len(graph.roots) == 0:
 
254
                # no reachable roots - not handled yet.
 
255
                raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
256
            root = NULL_REVISION
 
257
            common.add(NULL_REVISION)
 
258
        except bzrlib.errors.NoCommonRoot:
 
259
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
260
            
 
261
        pb.update('Picking ancestor', 2, 3)
 
262
        distances = node_distances (descendants, ancestors, root)
 
263
        pb.update('Picking ancestor', 3, 2)
 
264
        farthest = select_farthest(distances, common)
 
265
        if farthest is None or farthest == NULL_REVISION:
 
266
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
267
    finally:
 
268
        pb.clear()
 
269
    return farthest
 
270
 
192
271
 
193
272
class MultipleRevisionSources(object):
194
273
    """Proxy that looks in multiple branches for revisions."""
197
276
        assert len(args) != 0
198
277
        self._revision_sources = args
199
278
 
 
279
    def revision_parents(self, revision_id):
 
280
        for source in self._revision_sources:
 
281
            try:
 
282
                return source.revision_parents(revision_id)
 
283
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
284
                pass
 
285
        raise e
 
286
 
200
287
    def get_revision(self, revision_id):
201
288
        for source in self._revision_sources:
202
289
            try:
205
292
                pass
206
293
        raise e
207
294
 
 
295
    def get_revision_graph(self, revision_id):
 
296
        # we could probe incrementally until the pending
 
297
        # ghosts list stop growing, but its cheaper for now
 
298
        # to just ask for the complete graph for each repository.
 
299
        graphs = []
 
300
        for source in self._revision_sources:
 
301
            ghost_graph = source.get_revision_graph_with_ghosts()
 
302
            graphs.append(ghost_graph)
 
303
        absent = 0
 
304
        for graph in graphs:
 
305
            if not revision_id in graph.get_ancestors():
 
306
                absent += 1
 
307
        if absent == len(graphs):
 
308
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
309
 
 
310
        # combine the graphs
 
311
        result = {}
 
312
        pending = set([revision_id])
 
313
        def find_parents(node_id):
 
314
            """find the parents for node_id."""
 
315
            for graph in graphs:
 
316
                ancestors = graph.get_ancestors()
 
317
                try:
 
318
                    return ancestors[node_id]
 
319
                except KeyError:
 
320
                    pass
 
321
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
322
        while len(pending):
 
323
            # all the graphs should have identical parent lists
 
324
            node_id = pending.pop()
 
325
            try:
 
326
                result[node_id] = find_parents(node_id)
 
327
                for parent_node in result[node_id]:
 
328
                    if not parent_node in result:
 
329
                        pending.add(parent_node)
 
330
            except errors.NoSuchRevision:
 
331
                # ghost, ignore it.
 
332
                pass
 
333
        return result
 
334
 
 
335
    def get_revision_graph_with_ghosts(self, revision_ids):
 
336
        # query all the sources for their entire graphs 
 
337
        # and then build a combined graph for just
 
338
        # revision_ids.
 
339
        graphs = []
 
340
        for source in self._revision_sources:
 
341
            ghost_graph = source.get_revision_graph_with_ghosts()
 
342
            graphs.append(ghost_graph.get_ancestors())
 
343
        for revision_id in revision_ids:
 
344
            absent = 0
 
345
            for graph in graphs:
 
346
                    if not revision_id in graph:
 
347
                        absent += 1
 
348
            if absent == len(graphs):
 
349
                raise errors.NoSuchRevision(self._revision_sources[0],
 
350
                                            revision_id)
 
351
 
 
352
        # combine the graphs
 
353
        result = Graph()
 
354
        pending = set(revision_ids)
 
355
        done = set()
 
356
        def find_parents(node_id):
 
357
            """find the parents for node_id."""
 
358
            for graph in graphs:
 
359
                try:
 
360
                    return graph[node_id]
 
361
                except KeyError:
 
362
                    pass
 
363
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
364
        while len(pending):
 
365
            # all the graphs should have identical parent lists
 
366
            node_id = pending.pop()
 
367
            try:
 
368
                parents = find_parents(node_id)
 
369
                for parent_node in parents:
 
370
                    # queued or done? 
 
371
                    if (parent_node not in pending and
 
372
                        parent_node not in done):
 
373
                        # no, queue
 
374
                        pending.add(parent_node)
 
375
                result.add_node(node_id, parents)
 
376
                done.add(node_id)
 
377
            except errors.NoSuchRevision:
 
378
                # ghost
 
379
                result.add_ghost(node_id)
 
380
                continue
 
381
        return result
 
382
 
 
383
    def lock_read(self):
 
384
        for source in self._revision_sources:
 
385
            source.lock_read()
 
386
 
 
387
    def unlock(self):
 
388
        for source in self._revision_sources:
 
389
            source.unlock()
 
390
 
 
391
 
208
392
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
209
393
                              revision_history=None):
210
394
    """Find the longest line of descent from maybe_ancestor to revision.
214
398
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
215
399
    If ancestor_id is not an ancestor, NotAncestor will be thrown
216
400
    """
217
 
    [rev_source.get_revision(r) for r in (ancestor_id, rev_id)]
218
 
    if ancestor_id == rev_id:
219
 
        return []
220
 
    def historical_lines(line):
221
 
        """Return a tuple of historical/non_historical lines, for sorting.
222
 
        The non_historical count is negative, since non_historical lines are
223
 
        a bad thing.
224
 
        """
225
 
        good_count = 0
226
 
        bad_count = 0
227
 
        for revision in line:
228
 
            if revision in revision_history:
229
 
                good_count += 1
230
 
            else:
231
 
                bad_count -= 1
232
 
        return good_count, bad_count
233
 
    active = [[rev_id]]
234
 
    successful_lines = []
235
 
    while len(active) > 0:
236
 
        new_active = []
237
 
        for line in active:
238
 
            parent_ids = [p.revision_id for p in 
239
 
                          rev_source.get_revision(line[-1]).parents]
240
 
            for parent in parent_ids:
241
 
                line_copy = line[:]
242
 
                if parent == ancestor_id:
243
 
                    successful_lines.append(line_copy)
244
 
                else:
245
 
                    line_copy.append(parent)
246
 
                    new_active.append(line_copy)
247
 
        active = new_active
248
 
    if len(successful_lines) == 0:
249
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
250
 
    for line in successful_lines:
251
 
        line.reverse()
252
 
    if revision_history is not None:
253
 
        by_historical_lines = []
254
 
        for line in successful_lines:
255
 
            count = historical_lines(line)
256
 
            by_historical_lines.append((count, line))
257
 
        by_historical_lines.sort()
258
 
        if by_historical_lines[-1][0][0] > 0:
259
 
            return by_historical_lines[-1][1]
260
 
    assert len(successful_lines)
261
 
    successful_lines.sort(cmp, len)
262
 
    return successful_lines[-1]
 
401
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
402
    if len(descendants) == 0:
 
403
        raise NoSuchRevision(rev_source, rev_id)
 
404
    if ancestor_id not in descendants:
 
405
        rev_source.get_revision(ancestor_id)
 
406
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
407
    root_descendants = all_descendants(descendants, ancestor_id)
 
408
    root_descendants.add(ancestor_id)
 
409
    if rev_id not in root_descendants:
 
410
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
411
    distances = node_distances(descendants, ancestors, ancestor_id,
 
412
                               root_descendants=root_descendants)
 
413
 
 
414
    def best_ancestor(rev_id):
 
415
        best = None
 
416
        for anc_id in ancestors[rev_id]:
 
417
            try:
 
418
                distance = distances[anc_id]
 
419
            except KeyError:
 
420
                continue
 
421
            if revision_history is not None and anc_id in revision_history:
 
422
                return anc_id
 
423
            elif best is None or distance > best[1]:
 
424
                best = (anc_id, distance)
 
425
        return best[0]
 
426
 
 
427
    next = rev_id
 
428
    path = []
 
429
    while next != ancestor_id:
 
430
        path.append(next)
 
431
        next = best_ancestor(next)
 
432
    path.reverse()
 
433
    return path