← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: John Arbash Meinel
  • Date: 2006-07-03 18:27:35 UTC
  • mto: This revision was merged to the branch mainline in revision 1851.
  • Revision ID: john@arbash-meinel.com-20060703182735-3081f13e92d7f657
WorkingTree.open_containing() was directly calling os.getcwdu(), which on mac returns the wrong normalization, and on win32 would have the wrong slashes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# (C) 2005 Canonical
 
1
# Copyright (C) 2005, 2006 Canonical
2
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
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
 
 
18
 
import bzrlib.errors
19
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
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
 
 
20
 
 
21
import bzrlib.errors as errors
 
22
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
 
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
        )
20
28
 
21
29
NULL_REVISION="null:"
22
30
 
31
39
 
32
40
    parent_ids
33
41
        List of parent revision_ids
 
42
 
 
43
    properties
 
44
        Dictionary of revision properties.  These are attached to the
 
45
        revision as extra metadata.  The name must be a single 
 
46
        word; the value can be an arbitrary string.
34
47
    """
35
48
    
36
 
    def __init__(self, revision_id, **args):
 
49
    def __init__(self, revision_id, properties=None, **args):
37
50
        self.revision_id = revision_id
38
 
        self.__dict__.update(args)
 
51
        self.properties = properties or {}
 
52
        self._check_properties()
39
53
        self.parent_ids = []
40
54
        self.parent_sha1s = []
 
55
        """Not used anymore - legacy from for 4."""
 
56
        self.__dict__.update(args)
41
57
 
42
58
    def __repr__(self):
43
59
        return "<Revision id %s>" % self.revision_id
52
68
                and self.timestamp == other.timestamp
53
69
                and self.message == other.message
54
70
                and self.timezone == other.timezone
55
 
                and self.committer == other.committer)
 
71
                and self.committer == other.committer
 
72
                and self.properties == other.properties)
56
73
 
57
74
    def __ne__(self, other):
58
75
        return not self.__eq__(other)
59
76
 
60
 
        
61
 
REVISION_ID_RE = None
62
 
 
63
 
def validate_revision_id(rid):
64
 
    """Check rid is syntactically valid for a revision id."""
65
 
    global REVISION_ID_RE
66
 
    if not REVISION_ID_RE:
67
 
        import re
68
 
        REVISION_ID_RE = re.compile('[\w:.-]+@[\w%.-]+--?[\w]+--?[0-9a-f]+\Z')
69
 
 
70
 
    if not REVISION_ID_RE.match(rid):
71
 
        raise ValueError("malformed revision-id %r" % rid)
 
77
    def _check_properties(self):
 
78
        """Verify that all revision properties are OK.
 
79
        """
 
80
        for name, value in self.properties.iteritems():
 
81
            if not isinstance(name, basestring) or contains_whitespace(name):
 
82
                raise ValueError("invalid property name %r" % name)
 
83
            if not isinstance(value, basestring):
 
84
                raise ValueError("invalid property value %r for %r" % 
 
85
                                 (name, value))
 
86
 
 
87
    def get_history(self, repository):
 
88
        """Return the canonical line-of-history for this revision.
 
89
 
 
90
        If ghosts are present this may differ in result from a ghost-free
 
91
        repository.
 
92
        """
 
93
        current_revision = self
 
94
        reversed_result = []
 
95
        while current_revision is not None:
 
96
            reversed_result.append(current_revision.revision_id)
 
97
            if not len (current_revision.parent_ids):
 
98
                reversed_result.append(None)
 
99
                current_revision = None
 
100
            else:
 
101
                next_revision_id = current_revision.parent_ids[0]
 
102
                current_revision = repository.get_revision(next_revision_id)
 
103
        reversed_result.reverse()
 
104
        return reversed_result
 
105
 
 
106
    def get_summary(self):
 
107
        """Get the first line of the log message for this revision.
 
108
        """
 
109
        return self.message.split('\n', 1)[0]
72
110
 
73
111
 
74
112
def is_ancestor(revision_id, candidate_id, branch):
80
118
    revisions_source is an object supporting a get_revision operation that
81
119
    behaves like Branch's.
82
120
    """
83
 
    return candidate_id in branch.get_ancestry(revision_id)
 
121
    return candidate_id in branch.repository.get_ancestry(revision_id)
84
122
 
85
123
 
86
124
def iter_ancestors(revision_id, revision_source, only_present=False):
93
131
                yield ancestor, distance
94
132
            try:
95
133
                revision = revision_source.get_revision(ancestor)
96
 
            except bzrlib.errors.NoSuchRevision, e:
 
134
            except errors.NoSuchRevision, e:
97
135
                if e.revision == revision_id:
98
136
                    raise 
99
137
                else:
130
168
    return matches
131
169
 
132
170
 
133
 
def old_common_ancestor(revision_a, revision_b, revision_source):
134
 
    """Find the ancestor common to both revisions that is closest to both.
135
 
    """
136
 
    from bzrlib.trace import mutter
137
 
    a_ancestors = find_present_ancestors(revision_a, revision_source)
138
 
    b_ancestors = find_present_ancestors(revision_b, revision_source)
139
 
    a_intersection = []
140
 
    b_intersection = []
141
 
    # a_order is used as a tie-breaker when two equally-good bases are found
142
 
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
143
 
        if b_ancestors.has_key(revision):
144
 
            a_intersection.append((a_distance, a_order, revision))
145
 
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
146
 
    mutter("a intersection: %r" % a_intersection)
147
 
    mutter("b intersection: %r" % b_intersection)
148
 
 
149
 
    a_closest = __get_closest(a_intersection)
150
 
    if len(a_closest) == 0:
151
 
        return None
152
 
    b_closest = __get_closest(b_intersection)
153
 
    assert len(b_closest) != 0
154
 
    mutter ("a_closest %r" % a_closest)
155
 
    mutter ("b_closest %r" % b_closest)
156
 
    if a_closest[0] in b_closest:
157
 
        return a_closest[0]
158
 
    elif b_closest[0] in a_closest:
159
 
        return b_closest[0]
160
 
    else:
161
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
162
 
    return a_closest[0]
163
 
 
164
171
def revision_graph(revision, revision_source):
165
172
    """Produce a graph of the ancestry of the specified revision.
166
 
    Return root, ancestors map, descendants map
167
 
 
168
 
    TODO: Produce graphs with the NULL revision as root, so that we can find
169
 
    a common even when trees are not branches don't represent a single line
170
 
    of descent.
 
173
    
 
174
    :return: root, ancestors map, descendants map
171
175
    """
 
176
    revision_source.lock_read()
 
177
    try:
 
178
        return _revision_graph(revision, revision_source)
 
179
    finally:
 
180
        revision_source.unlock()
 
181
 
 
182
 
 
183
def _revision_graph(revision, revision_source):
 
184
    """See revision_graph."""
 
185
    from bzrlib.tsort import topo_sort
 
186
    graph = revision_source.get_revision_graph(revision)
 
187
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
188
    for node, parents in graph.items():
 
189
        if len(parents) == 0:
 
190
            graph[node] = [NULL_REVISION]
 
191
    # add NULL_REVISION to the graph
 
192
    graph[NULL_REVISION] = []
 
193
 
 
194
    # pick a root. If there are multiple roots
 
195
    # this could pick a random one.
 
196
    topo_order = topo_sort(graph.items())
 
197
    root = topo_order[0]
 
198
 
172
199
    ancestors = {}
173
200
    descendants = {}
174
 
    lines = [revision]
175
 
    root = None
176
 
    descendants[revision] = {}
177
 
    while len(lines) > 0:
178
 
        new_lines = set()
179
 
        for line in lines:
180
 
            if line == NULL_REVISION:
181
 
                parents = []
182
 
                root = NULL_REVISION
183
 
            else:
184
 
                try:
185
 
                    rev = revision_source.get_revision(line)
186
 
                    parents = list(rev.parent_ids)
187
 
                    if len(parents) == 0:
188
 
                        parents = [NULL_REVISION]
189
 
                except bzrlib.errors.NoSuchRevision:
190
 
                    if line == revision:
191
 
                        raise
192
 
                    parents = None
193
 
            if parents is not None:
194
 
                for parent in parents:
195
 
                    if parent not in ancestors:
196
 
                        new_lines.add(parent)
197
 
                    if parent not in descendants:
198
 
                        descendants[parent] = {}
199
 
                    descendants[parent][line] = 1
200
 
            if parents is not None:
201
 
                ancestors[line] = set(parents)
202
 
        lines = new_lines
 
201
 
 
202
    # map the descendants of the graph.
 
203
    # and setup our set based return graph.
 
204
    for node in graph.keys():
 
205
        descendants[node] = {}
 
206
    for node, parents in graph.items():
 
207
        for parent in parents:
 
208
            descendants[parent][node] = 1
 
209
        ancestors[node] = set(parents)
 
210
 
203
211
    assert root not in descendants[root]
204
212
    assert root not in ancestors[root]
205
213
    return root, ancestors, descendants
208
216
def combined_graph(revision_a, revision_b, revision_source):
209
217
    """Produce a combined ancestry graph.
210
218
    Return graph root, ancestors map, descendants map, set of common nodes"""
211
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
212
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
213
 
                                                        revision_source)
 
219
    root, ancestors, descendants = revision_graph(
 
220
        revision_a, revision_source)
 
221
    root_b, ancestors_b, descendants_b = revision_graph(
 
222
        revision_b, revision_source)
214
223
    if root != root_b:
215
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
224
        raise errors.NoCommonRoot(revision_a, revision_b)
216
225
    common = set()
217
226
    for node, node_anc in ancestors_b.iteritems():
218
227
        if node in ancestors:
227
236
    return root, ancestors, descendants, common
228
237
 
229
238
 
230
 
def common_ancestor(revision_a, revision_b, revision_source):
 
239
def common_ancestor(revision_a, revision_b, revision_source, 
 
240
                    pb=DummyProgress()):
 
241
    if None in (revision_a, revision_b):
 
242
        return None
 
243
    # trivial optimisation
 
244
    if revision_a == revision_b:
 
245
        return revision_a
231
246
    try:
232
 
        root, ancestors, descendants, common = \
233
 
            combined_graph(revision_a, revision_b, revision_source)
234
 
    except bzrlib.errors.NoCommonRoot:
235
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
236
 
        
237
 
    distances = node_distances (descendants, ancestors, root)
238
 
    farthest = select_farthest(distances, common)
239
 
    if farthest is None or farthest == NULL_REVISION:
240
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
247
        try:
 
248
            pb.update('Picking ancestor', 1, 3)
 
249
            graph = revision_source.get_revision_graph_with_ghosts(
 
250
                [revision_a, revision_b])
 
251
            # convert to a NULL_REVISION based graph.
 
252
            ancestors = graph.get_ancestors()
 
253
            descendants = graph.get_descendants()
 
254
            common = set(graph.get_ancestry(revision_a)).intersection(
 
255
                     set(graph.get_ancestry(revision_b)))
 
256
            descendants[NULL_REVISION] = {}
 
257
            ancestors[NULL_REVISION] = []
 
258
            for root in graph.roots:
 
259
                descendants[NULL_REVISION][root] = 1
 
260
                ancestors[root].append(NULL_REVISION)
 
261
            for ghost in graph.ghosts:
 
262
                # ghosts act as roots for the purpose of finding 
 
263
                # the longest paths from the root: any ghost *might*
 
264
                # be directly attached to the root, so we treat them
 
265
                # as being such.
 
266
                # ghost now descends from NULL
 
267
                descendants[NULL_REVISION][ghost] = 1
 
268
                # that is it has an ancestor of NULL
 
269
                ancestors[ghost] = [NULL_REVISION]
 
270
                # ghost is common if any of ghosts descendants are common:
 
271
                for ghost_descendant in descendants[ghost]:
 
272
                    if ghost_descendant in common:
 
273
                        common.add(ghost)
 
274
                
 
275
            root = NULL_REVISION
 
276
            common.add(NULL_REVISION)
 
277
        except errors.NoCommonRoot:
 
278
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
279
            
 
280
        pb.update('Picking ancestor', 2, 3)
 
281
        distances = node_distances (descendants, ancestors, root)
 
282
        pb.update('Picking ancestor', 3, 2)
 
283
        farthest = select_farthest(distances, common)
 
284
        if farthest is None or farthest == NULL_REVISION:
 
285
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
286
    finally:
 
287
        pb.clear()
241
288
    return farthest
242
289
 
243
290
 
248
295
        assert len(args) != 0
249
296
        self._revision_sources = args
250
297
 
 
298
    def revision_parents(self, revision_id):
 
299
        for source in self._revision_sources:
 
300
            try:
 
301
                return source.revision_parents(revision_id)
 
302
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
303
                pass
 
304
        raise e
 
305
 
251
306
    def get_revision(self, revision_id):
252
307
        for source in self._revision_sources:
253
308
            try:
254
309
                return source.get_revision(revision_id)
255
 
            except bzrlib.errors.NoSuchRevision, e:
 
310
            except errors.NoSuchRevision, e:
256
311
                pass
257
312
        raise e
258
313
 
259
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
314
    def get_revision_graph(self, revision_id):
 
315
        # we could probe incrementally until the pending
 
316
        # ghosts list stop growing, but its cheaper for now
 
317
        # to just ask for the complete graph for each repository.
 
318
        graphs = []
 
319
        for source in self._revision_sources:
 
320
            ghost_graph = source.get_revision_graph_with_ghosts()
 
321
            graphs.append(ghost_graph)
 
322
        absent = 0
 
323
        for graph in graphs:
 
324
            if not revision_id in graph.get_ancestors():
 
325
                absent += 1
 
326
        if absent == len(graphs):
 
327
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
328
 
 
329
        # combine the graphs
 
330
        result = {}
 
331
        pending = set([revision_id])
 
332
        def find_parents(node_id):
 
333
            """find the parents for node_id."""
 
334
            for graph in graphs:
 
335
                ancestors = graph.get_ancestors()
 
336
                try:
 
337
                    return ancestors[node_id]
 
338
                except KeyError:
 
339
                    pass
 
340
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
341
        while len(pending):
 
342
            # all the graphs should have identical parent lists
 
343
            node_id = pending.pop()
 
344
            try:
 
345
                result[node_id] = find_parents(node_id)
 
346
                for parent_node in result[node_id]:
 
347
                    if not parent_node in result:
 
348
                        pending.add(parent_node)
 
349
            except errors.NoSuchRevision:
 
350
                # ghost, ignore it.
 
351
                pass
 
352
        return result
 
353
 
 
354
    def get_revision_graph_with_ghosts(self, revision_ids):
 
355
        # query all the sources for their entire graphs 
 
356
        # and then build a combined graph for just
 
357
        # revision_ids.
 
358
        graphs = []
 
359
        for source in self._revision_sources:
 
360
            ghost_graph = source.get_revision_graph_with_ghosts()
 
361
            graphs.append(ghost_graph.get_ancestors())
 
362
        for revision_id in revision_ids:
 
363
            absent = 0
 
364
            for graph in graphs:
 
365
                    if not revision_id in graph:
 
366
                        absent += 1
 
367
            if absent == len(graphs):
 
368
                raise errors.NoSuchRevision(self._revision_sources[0],
 
369
                                            revision_id)
 
370
 
 
371
        # combine the graphs
 
372
        result = Graph()
 
373
        pending = set(revision_ids)
 
374
        done = set()
 
375
        def find_parents(node_id):
 
376
            """find the parents for node_id."""
 
377
            for graph in graphs:
 
378
                try:
 
379
                    return graph[node_id]
 
380
                except KeyError:
 
381
                    pass
 
382
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
383
        while len(pending):
 
384
            # all the graphs should have identical parent lists
 
385
            node_id = pending.pop()
 
386
            try:
 
387
                parents = find_parents(node_id)
 
388
                for parent_node in parents:
 
389
                    # queued or done? 
 
390
                    if (parent_node not in pending and
 
391
                        parent_node not in done):
 
392
                        # no, queue
 
393
                        pending.add(parent_node)
 
394
                result.add_node(node_id, parents)
 
395
                done.add(node_id)
 
396
            except errors.NoSuchRevision:
 
397
                # ghost
 
398
                result.add_ghost(node_id)
 
399
                continue
 
400
        return result
 
401
 
 
402
    def lock_read(self):
 
403
        for source in self._revision_sources:
 
404
            source.lock_read()
 
405
 
 
406
    def unlock(self):
 
407
        for source in self._revision_sources:
 
408
            source.unlock()
 
409
 
 
410
 
 
411
@deprecated_function(zero_eight)
 
412
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
260
413
                              revision_history=None):
261
414
    """Find the longest line of descent from maybe_ancestor to revision.
262
415
    Revision history is followed where possible.
267
420
    """
268
421
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
269
422
    if len(descendants) == 0:
270
 
        raise NoSuchRevision(rev_source, rev_id)
 
423
        raise errors.NoSuchRevision(rev_source, rev_id)
271
424
    if ancestor_id not in descendants:
272
425
        rev_source.get_revision(ancestor_id)
273
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
426
        raise errors.NotAncestor(rev_id, ancestor_id)
274
427
    root_descendants = all_descendants(descendants, ancestor_id)
275
428
    root_descendants.add(ancestor_id)
276
429
    if rev_id not in root_descendants:
277
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
430
        raise errors.NotAncestor(rev_id, ancestor_id)
278
431
    distances = node_distances(descendants, ancestors, ancestor_id,
279
432
                               root_descendants=root_descendants)
280
433