← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

Don't encode unicode messages to UTF-8 in mutter() (the stream writer does it).

Use a codec wrapped log file in tests to match the real environment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical
 
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
 
 
21
 
import bzrlib.errors as errors
22
 
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
 
20
import bzrlib.errors
 
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
23
22
from bzrlib.osutils import contains_whitespace
24
 
from bzrlib.progress import DummyProgress
25
 
from bzrlib.symbol_versioning import (deprecated_function,
26
 
        zero_eight,
27
 
        )
28
23
 
29
24
NULL_REVISION="null:"
30
 
CURRENT_REVISION="current:"
31
 
 
32
25
 
33
26
class Revision(object):
34
27
    """Single revision on a branch.
54
47
        self._check_properties()
55
48
        self.parent_ids = []
56
49
        self.parent_sha1s = []
57
 
        """Not used anymore - legacy from for 4."""
58
50
        self.__dict__.update(args)
59
51
 
60
52
    def __repr__(self):
77
69
        return not self.__eq__(other)
78
70
 
79
71
    def _check_properties(self):
80
 
        """Verify that all revision properties are OK."""
 
72
        """Verify that all revision properties are OK.
 
73
        """
81
74
        for name, value in self.properties.iteritems():
82
75
            if not isinstance(name, basestring) or contains_whitespace(name):
83
76
                raise ValueError("invalid property name %r" % name)
85
78
                raise ValueError("invalid property value %r for %r" % 
86
79
                                 (name, value))
87
80
 
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
 
 
112
81
 
113
82
def is_ancestor(revision_id, candidate_id, branch):
114
83
    """Return true if candidate_id is an ancestor of revision_id.
119
88
    revisions_source is an object supporting a get_revision operation that
120
89
    behaves like Branch's.
121
90
    """
122
 
    return (candidate_id in branch.repository.get_ancestry(revision_id))
 
91
    return candidate_id in branch.get_ancestry(revision_id)
123
92
 
124
93
 
125
94
def iter_ancestors(revision_id, revision_source, only_present=False):
132
101
                yield ancestor, distance
133
102
            try:
134
103
                revision = revision_source.get_revision(ancestor)
135
 
            except errors.NoSuchRevision, e:
 
104
            except bzrlib.errors.NoSuchRevision, e:
136
105
                if e.revision == revision_id:
137
106
                    raise 
138
107
                else:
155
124
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
156
125
                         only_present=True))
157
126
    for anc_order, (anc_id, anc_distance) in anc_iter:
158
 
        if anc_id not in found_ancestors:
 
127
        if not found_ancestors.has_key(anc_id):
159
128
            found_ancestors[anc_id] = (anc_order, anc_distance)
160
129
    return found_ancestors
161
130
    
169
138
    return matches
170
139
 
171
140
 
 
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
 
    
175
 
    :return: root, ancestors map, descendants map
 
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.
176
181
    """
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
 
 
200
182
    ancestors = {}
201
183
    descendants = {}
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
 
 
 
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
236
    assert root not in descendants[root]
213
237
    assert root not in ancestors[root]
214
238
    return root, ancestors, descendants
217
241
def combined_graph(revision_a, revision_b, revision_source):
218
242
    """Produce a combined ancestry graph.
219
243
    Return graph root, ancestors map, descendants map, set of common nodes"""
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)
 
244
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
 
245
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
 
246
                                                        revision_source)
224
247
    if root != root_b:
225
 
        raise errors.NoCommonRoot(revision_a, revision_b)
 
248
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
226
249
    common = set()
227
250
    for node, node_anc in ancestors_b.iteritems():
228
251
        if node in ancestors:
237
260
    return root, ancestors, descendants, common
238
261
 
239
262
 
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
 
263
def common_ancestor(revision_a, revision_b, revision_source):
249
264
    try:
250
 
        try:
251
 
            pb.update('Picking ancestor', 1, 3)
252
 
            graph = revision_source.get_revision_graph_with_ghosts(
253
 
                [revision_a, revision_b])
254
 
            # Shortcut the case where one of the tips is already included in
255
 
            # the other graphs ancestry.
256
 
            ancestry_a = graph.get_ancestry(revision_a)
257
 
            if revision_b in ancestry_a:
258
 
                return revision_b
259
 
            ancestry_b = graph.get_ancestry(revision_b)
260
 
            if revision_a in ancestry_b:
261
 
                return revision_a
262
 
            # convert to a NULL_REVISION based graph.
263
 
            ancestors = graph.get_ancestors()
264
 
            descendants = graph.get_descendants()
265
 
            common = set(ancestry_a)
266
 
            common.intersection_update(ancestry_b)
267
 
            descendants[NULL_REVISION] = {}
268
 
            ancestors[NULL_REVISION] = []
269
 
            for root in graph.roots:
270
 
                descendants[NULL_REVISION][root] = 1
271
 
                ancestors[root].append(NULL_REVISION)
272
 
            for ghost in graph.ghosts:
273
 
                # ghosts act as roots for the purpose of finding 
274
 
                # the longest paths from the root: any ghost *might*
275
 
                # be directly attached to the root, so we treat them
276
 
                # as being such.
277
 
                # ghost now descends from NULL
278
 
                descendants[NULL_REVISION][ghost] = 1
279
 
                # that is it has an ancestor of NULL
280
 
                ancestors[ghost] = [NULL_REVISION]
281
 
                # ghost is common if any of ghosts descendants are common:
282
 
                for ghost_descendant in descendants[ghost]:
283
 
                    if ghost_descendant in common:
284
 
                        common.add(ghost)
285
 
                
286
 
            root = NULL_REVISION
287
 
            common.add(NULL_REVISION)
288
 
        except errors.NoCommonRoot:
289
 
            raise errors.NoCommonAncestor(revision_a, revision_b)
290
 
            
291
 
        pb.update('Picking ancestor', 2, 3)
292
 
        distances = node_distances (descendants, ancestors, root)
293
 
        pb.update('Picking ancestor', 3, 2)
294
 
        farthest = select_farthest(distances, common)
295
 
        if farthest is None or farthest == NULL_REVISION:
296
 
            raise errors.NoCommonAncestor(revision_a, revision_b)
297
 
    finally:
298
 
        pb.clear()
 
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)
299
274
    return farthest
300
275
 
301
276
 
306
281
        assert len(args) != 0
307
282
        self._revision_sources = args
308
283
 
309
 
    def revision_parents(self, revision_id):
310
 
        for source in self._revision_sources:
311
 
            try:
312
 
                return source.revision_parents(revision_id)
313
 
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
314
 
                pass
315
 
        raise e
316
 
 
317
284
    def get_revision(self, revision_id):
318
285
        for source in self._revision_sources:
319
286
            try:
320
287
                return source.get_revision(revision_id)
321
 
            except errors.NoSuchRevision, e:
 
288
            except bzrlib.errors.NoSuchRevision, e:
322
289
                pass
323
290
        raise e
324
291
 
325
 
    def get_revision_graph(self, revision_id):
326
 
        # we could probe incrementally until the pending
327
 
        # ghosts list stop growing, but its cheaper for now
328
 
        # to just ask for the complete graph for each repository.
329
 
        graphs = []
330
 
        for source in self._revision_sources:
331
 
            ghost_graph = source.get_revision_graph_with_ghosts()
332
 
            graphs.append(ghost_graph)
333
 
        absent = 0
334
 
        for graph in graphs:
335
 
            if not revision_id in graph.get_ancestors():
336
 
                absent += 1
337
 
        if absent == len(graphs):
338
 
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
339
 
 
340
 
        # combine the graphs
341
 
        result = {}
342
 
        pending = set([revision_id])
343
 
        def find_parents(node_id):
344
 
            """find the parents for node_id."""
345
 
            for graph in graphs:
346
 
                ancestors = graph.get_ancestors()
347
 
                try:
348
 
                    return ancestors[node_id]
349
 
                except KeyError:
350
 
                    pass
351
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
352
 
        while len(pending):
353
 
            # all the graphs should have identical parent lists
354
 
            node_id = pending.pop()
355
 
            try:
356
 
                result[node_id] = find_parents(node_id)
357
 
                for parent_node in result[node_id]:
358
 
                    if not parent_node in result:
359
 
                        pending.add(parent_node)
360
 
            except errors.NoSuchRevision:
361
 
                # ghost, ignore it.
362
 
                pass
363
 
        return result
364
 
 
365
 
    def get_revision_graph_with_ghosts(self, revision_ids):
366
 
        # query all the sources for their entire graphs 
367
 
        # and then build a combined graph for just
368
 
        # revision_ids.
369
 
        graphs = []
370
 
        for source in self._revision_sources:
371
 
            ghost_graph = source.get_revision_graph_with_ghosts()
372
 
            graphs.append(ghost_graph.get_ancestors())
373
 
        for revision_id in revision_ids:
374
 
            absent = 0
375
 
            for graph in graphs:
376
 
                    if not revision_id in graph:
377
 
                        absent += 1
378
 
            if absent == len(graphs):
379
 
                raise errors.NoSuchRevision(self._revision_sources[0],
380
 
                                            revision_id)
381
 
 
382
 
        # combine the graphs
383
 
        result = Graph()
384
 
        pending = set(revision_ids)
385
 
        done = set()
386
 
        def find_parents(node_id):
387
 
            """find the parents for node_id."""
388
 
            for graph in graphs:
389
 
                try:
390
 
                    return graph[node_id]
391
 
                except KeyError:
392
 
                    pass
393
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
394
 
        while len(pending):
395
 
            # all the graphs should have identical parent lists
396
 
            node_id = pending.pop()
397
 
            try:
398
 
                parents = find_parents(node_id)
399
 
                for parent_node in parents:
400
 
                    # queued or done? 
401
 
                    if (parent_node not in pending and
402
 
                        parent_node not in done):
403
 
                        # no, queue
404
 
                        pending.add(parent_node)
405
 
                result.add_node(node_id, parents)
406
 
                done.add(node_id)
407
 
            except errors.NoSuchRevision:
408
 
                # ghost
409
 
                result.add_ghost(node_id)
410
 
                continue
411
 
        return result
412
 
 
413
 
    def lock_read(self):
414
 
        for source in self._revision_sources:
415
 
            source.lock_read()
416
 
 
417
 
    def unlock(self):
418
 
        for source in self._revision_sources:
419
 
            source.unlock()
420
 
 
421
 
 
422
 
@deprecated_function(zero_eight)
423
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
 
292
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
424
293
                              revision_history=None):
425
294
    """Find the longest line of descent from maybe_ancestor to revision.
426
295
    Revision history is followed where possible.
431
300
    """
432
301
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
433
302
    if len(descendants) == 0:
434
 
        raise errors.NoSuchRevision(rev_source, rev_id)
 
303
        raise NoSuchRevision(rev_source, rev_id)
435
304
    if ancestor_id not in descendants:
436
305
        rev_source.get_revision(ancestor_id)
437
 
        raise errors.NotAncestor(rev_id, ancestor_id)
 
306
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
438
307
    root_descendants = all_descendants(descendants, ancestor_id)
439
308
    root_descendants.add(ancestor_id)
440
309
    if rev_id not in root_descendants:
441
 
        raise errors.NotAncestor(rev_id, ancestor_id)
 
310
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
442
311
    distances = node_distances(descendants, ancestors, ancestor_id,
443
312
                               root_descendants=root_descendants)
444
313
 
462
331
        next = best_ancestor(next)
463
332
    path.reverse()
464
333
    return path
465
 
 
466
 
 
467
 
def is_reserved_id(revision_id):
468
 
    """Determine whether a revision id is reserved
469
 
 
470
 
    :return: True if the revision is is reserved, False otherwise
471
 
    """
472
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
473
 
 
474
 
 
475
 
def check_not_reserved_id(revision_id):
476
 
    """Raise ReservedId if the supplied revision_id is reserved"""
477
 
    if is_reserved_id(revision_id):
478
 
        raise errors.ReservedId(revision_id)