← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

(vila) Calling super() instead of mentioning the base class in setUp avoid
 mistakes. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# (C) 2005 Canonical
2
 
 
 
1
# Copyright (C) 2005-2011 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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
# TODO: Some kind of command-line display of revision properties: 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
# TODO: Some kind of command-line display of revision properties:
18
20
# perhaps show them in log -v and allow them as options to the commit command.
19
21
 
20
22
 
21
 
import bzrlib.errors
22
 
import bzrlib.errors as errors
23
 
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
from bzrlib import bugtracker
 
26
""")
 
27
from bzrlib import (
 
28
    errors,
 
29
    symbol_versioning,
 
30
    )
24
31
from bzrlib.osutils import contains_whitespace
25
 
from bzrlib.progress import DummyProgress
26
32
 
27
33
NULL_REVISION="null:"
 
34
CURRENT_REVISION="current:"
 
35
 
28
36
 
29
37
class Revision(object):
30
38
    """Single revision on a branch.
40
48
 
41
49
    properties
42
50
        Dictionary of revision properties.  These are attached to the
43
 
        revision as extra metadata.  The name must be a single 
 
51
        revision as extra metadata.  The name must be a single
44
52
        word; the value can be an arbitrary string.
45
53
    """
46
 
    
 
54
 
47
55
    def __init__(self, revision_id, properties=None, **args):
48
56
        self.revision_id = revision_id
49
 
        self.properties = properties or {}
50
 
        self._check_properties()
 
57
        if properties is None:
 
58
            self.properties = {}
 
59
        else:
 
60
            self.properties = properties
 
61
            self._check_properties()
 
62
        self.committer = None
51
63
        self.parent_ids = []
52
64
        self.parent_sha1s = []
 
65
        """Not used anymore - legacy from for 4."""
53
66
        self.__dict__.update(args)
54
67
 
55
68
    def __repr__(self):
58
71
    def __eq__(self, other):
59
72
        if not isinstance(other, Revision):
60
73
            return False
61
 
        # FIXME: rbc 20050930 parent_ids are not being compared
62
74
        return (
63
75
                self.inventory_sha1 == other.inventory_sha1
64
76
                and self.revision_id == other.revision_id
66
78
                and self.message == other.message
67
79
                and self.timezone == other.timezone
68
80
                and self.committer == other.committer
69
 
                and self.properties == other.properties)
 
81
                and self.properties == other.properties
 
82
                and self.parent_ids == other.parent_ids)
70
83
 
71
84
    def __ne__(self, other):
72
85
        return not self.__eq__(other)
73
86
 
74
87
    def _check_properties(self):
75
 
        """Verify that all revision properties are OK.
76
 
        """
 
88
        """Verify that all revision properties are OK."""
77
89
        for name, value in self.properties.iteritems():
78
90
            if not isinstance(name, basestring) or contains_whitespace(name):
79
91
                raise ValueError("invalid property name %r" % name)
80
92
            if not isinstance(value, basestring):
81
 
                raise ValueError("invalid property value %r for %r" % 
82
 
                                 (name, value))
 
93
                raise ValueError("invalid property value %r for %r" %
 
94
                                 (value, name))
83
95
 
84
96
    def get_history(self, repository):
85
97
        """Return the canonical line-of-history for this revision.
100
112
        reversed_result.reverse()
101
113
        return reversed_result
102
114
 
103
 
 
104
 
def is_ancestor(revision_id, candidate_id, branch):
105
 
    """Return true if candidate_id is an ancestor of revision_id.
106
 
 
107
 
    A false negative will be returned if any intermediate descendent of
108
 
    candidate_id is not present in any of the revision_sources.
109
 
    
110
 
    revisions_source is an object supporting a get_revision operation that
111
 
    behaves like Branch's.
112
 
    """
113
 
    return candidate_id in branch.repository.get_ancestry(revision_id)
 
115
    def get_summary(self):
 
116
        """Get the first line of the log message for this revision.
 
117
 
 
118
        Return an empty string if message is None.
 
119
        """
 
120
        if self.message:
 
121
            return self.message.lstrip().split('\n', 1)[0]
 
122
        else:
 
123
            return ''
 
124
 
 
125
    def get_apparent_authors(self):
 
126
        """Return the apparent authors of this revision.
 
127
 
 
128
        If the revision properties contain the names of the authors,
 
129
        return them. Otherwise return the committer name.
 
130
 
 
131
        The return value will be a list containing at least one element.
 
132
        """
 
133
        authors = self.properties.get('authors', None)
 
134
        if authors is None:
 
135
            author = self.properties.get('author', self.committer)
 
136
            if author is None:
 
137
                return []
 
138
            return [author]
 
139
        else:
 
140
            return authors.split("\n")
 
141
 
 
142
    def iter_bugs(self):
 
143
        """Iterate over the bugs associated with this revision."""
 
144
        bug_property = self.properties.get('bugs', None)
 
145
        if bug_property is None:
 
146
            return
 
147
        for line in bug_property.splitlines():
 
148
            try:
 
149
                url, status = line.split(None, 2)
 
150
            except ValueError:
 
151
                raise errors.InvalidLineInBugsProperty(line)
 
152
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
 
153
                raise errors.InvalidBugStatus(status)
 
154
            yield url, status
114
155
 
115
156
 
116
157
def iter_ancestors(revision_id, revision_source, only_present=False):
123
164
                yield ancestor, distance
124
165
            try:
125
166
                revision = revision_source.get_revision(ancestor)
126
 
            except bzrlib.errors.NoSuchRevision, e:
 
167
            except errors.NoSuchRevision, e:
127
168
                if e.revision == revision_id:
128
 
                    raise 
 
169
                    raise
129
170
                else:
130
171
                    continue
131
172
            if only_present:
139
180
    """Return the ancestors of a revision present in a branch.
140
181
 
141
182
    It's possible that a branch won't have the complete ancestry of
142
 
    one of its revisions.  
 
183
    one of its revisions.
143
184
 
144
185
    """
145
186
    found_ancestors = {}
146
187
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
147
188
                         only_present=True))
148
189
    for anc_order, (anc_id, anc_distance) in anc_iter:
149
 
        if not found_ancestors.has_key(anc_id):
 
190
        if anc_id not in found_ancestors:
150
191
            found_ancestors[anc_id] = (anc_order, anc_distance)
151
192
    return found_ancestors
152
 
    
 
193
 
153
194
 
154
195
def __get_closest(intersection):
155
196
    intersection.sort()
156
 
    matches = [] 
 
197
    matches = []
157
198
    for entry in intersection:
158
199
        if entry[0] == intersection[0][0]:
159
200
            matches.append(entry[2])
160
201
    return matches
161
202
 
162
203
 
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
167
 
    """
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):
234
 
        return None
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
 
            for ghost in graph.ghosts:
254
 
                # ghosts act as roots for the purpose of finding 
255
 
                # the longest paths from the root: any ghost *might*
256
 
                # be directly attached to the root, so we treat them
257
 
                # as being such.
258
 
                # ghost now descends from NULL
259
 
                descendants[NULL_REVISION][ghost] = 1
260
 
                # that is it has an ancestor of NULL
261
 
                ancestors[ghost] = [NULL_REVISION]
262
 
                # ghost is common if any of ghosts descendants are common:
263
 
                for ghost_descendant in descendants[ghost]:
264
 
                    if ghost_descendant in common:
265
 
                        common.add(ghost)
266
 
                
267
 
            root = NULL_REVISION
268
 
            common.add(NULL_REVISION)
269
 
        except bzrlib.errors.NoCommonRoot:
270
 
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
271
 
            
272
 
        pb.update('Picking ancestor', 2, 3)
273
 
        distances = node_distances (descendants, ancestors, root)
274
 
        pb.update('Picking ancestor', 3, 2)
275
 
        farthest = select_farthest(distances, common)
276
 
        if farthest is None or farthest == NULL_REVISION:
277
 
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
278
 
    finally:
279
 
        pb.clear()
280
 
    return farthest
281
 
 
282
 
 
283
 
class MultipleRevisionSources(object):
284
 
    """Proxy that looks in multiple branches for revisions."""
285
 
    def __init__(self, *args):
286
 
        object.__init__(self)
287
 
        assert len(args) != 0
288
 
        self._revision_sources = args
289
 
 
290
 
    def revision_parents(self, revision_id):
291
 
        for source in self._revision_sources:
292
 
            try:
293
 
                return source.revision_parents(revision_id)
294
 
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
295
 
                pass
296
 
        raise e
297
 
 
298
 
    def get_revision(self, revision_id):
299
 
        for source in self._revision_sources:
300
 
            try:
301
 
                return source.get_revision(revision_id)
302
 
            except bzrlib.errors.NoSuchRevision, e:
303
 
                pass
304
 
        raise e
305
 
 
306
 
    def get_revision_graph(self, revision_id):
307
 
        # we could probe incrementally until the pending
308
 
        # ghosts list stop growing, but its cheaper for now
309
 
        # to just ask for the complete graph for each repository.
310
 
        graphs = []
311
 
        for source in self._revision_sources:
312
 
            ghost_graph = source.get_revision_graph_with_ghosts()
313
 
            graphs.append(ghost_graph)
314
 
        absent = 0
315
 
        for graph in graphs:
316
 
            if not revision_id in graph.get_ancestors():
317
 
                absent += 1
318
 
        if absent == len(graphs):
319
 
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
320
 
 
321
 
        # combine the graphs
322
 
        result = {}
323
 
        pending = set([revision_id])
324
 
        def find_parents(node_id):
325
 
            """find the parents for node_id."""
326
 
            for graph in graphs:
327
 
                ancestors = graph.get_ancestors()
328
 
                try:
329
 
                    return ancestors[node_id]
330
 
                except KeyError:
331
 
                    pass
332
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
333
 
        while len(pending):
334
 
            # all the graphs should have identical parent lists
335
 
            node_id = pending.pop()
336
 
            try:
337
 
                result[node_id] = find_parents(node_id)
338
 
                for parent_node in result[node_id]:
339
 
                    if not parent_node in result:
340
 
                        pending.add(parent_node)
341
 
            except errors.NoSuchRevision:
342
 
                # ghost, ignore it.
343
 
                pass
344
 
        return result
345
 
 
346
 
    def get_revision_graph_with_ghosts(self, revision_ids):
347
 
        # query all the sources for their entire graphs 
348
 
        # and then build a combined graph for just
349
 
        # revision_ids.
350
 
        graphs = []
351
 
        for source in self._revision_sources:
352
 
            ghost_graph = source.get_revision_graph_with_ghosts()
353
 
            graphs.append(ghost_graph.get_ancestors())
354
 
        for revision_id in revision_ids:
355
 
            absent = 0
356
 
            for graph in graphs:
357
 
                    if not revision_id in graph:
358
 
                        absent += 1
359
 
            if absent == len(graphs):
360
 
                raise errors.NoSuchRevision(self._revision_sources[0],
361
 
                                            revision_id)
362
 
 
363
 
        # combine the graphs
364
 
        result = Graph()
365
 
        pending = set(revision_ids)
366
 
        done = set()
367
 
        def find_parents(node_id):
368
 
            """find the parents for node_id."""
369
 
            for graph in graphs:
370
 
                try:
371
 
                    return graph[node_id]
372
 
                except KeyError:
373
 
                    pass
374
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
375
 
        while len(pending):
376
 
            # all the graphs should have identical parent lists
377
 
            node_id = pending.pop()
378
 
            try:
379
 
                parents = find_parents(node_id)
380
 
                for parent_node in parents:
381
 
                    # queued or done? 
382
 
                    if (parent_node not in pending and
383
 
                        parent_node not in done):
384
 
                        # no, queue
385
 
                        pending.add(parent_node)
386
 
                result.add_node(node_id, parents)
387
 
                done.add(node_id)
388
 
            except errors.NoSuchRevision:
389
 
                # ghost
390
 
                result.add_ghost(node_id)
391
 
                continue
392
 
        return result
393
 
 
394
 
    def lock_read(self):
395
 
        for source in self._revision_sources:
396
 
            source.lock_read()
397
 
 
398
 
    def unlock(self):
399
 
        for source in self._revision_sources:
400
 
            source.unlock()
401
 
 
402
 
 
403
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
404
 
                              revision_history=None):
405
 
    """Find the longest line of descent from maybe_ancestor to revision.
406
 
    Revision history is followed where possible.
407
 
 
408
 
    If ancestor_id == rev_id, list will be empty.
409
 
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
410
 
    If ancestor_id is not an ancestor, NotAncestor will be thrown
411
 
    """
412
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
413
 
    if len(descendants) == 0:
414
 
        raise NoSuchRevision(rev_source, rev_id)
415
 
    if ancestor_id not in descendants:
416
 
        rev_source.get_revision(ancestor_id)
417
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
418
 
    root_descendants = all_descendants(descendants, ancestor_id)
419
 
    root_descendants.add(ancestor_id)
420
 
    if rev_id not in root_descendants:
421
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
422
 
    distances = node_distances(descendants, ancestors, ancestor_id,
423
 
                               root_descendants=root_descendants)
424
 
 
425
 
    def best_ancestor(rev_id):
426
 
        best = None
427
 
        for anc_id in ancestors[rev_id]:
428
 
            try:
429
 
                distance = distances[anc_id]
430
 
            except KeyError:
431
 
                continue
432
 
            if revision_history is not None and anc_id in revision_history:
433
 
                return anc_id
434
 
            elif best is None or distance > best[1]:
435
 
                best = (anc_id, distance)
436
 
        return best[0]
437
 
 
438
 
    next = rev_id
439
 
    path = []
440
 
    while next != ancestor_id:
441
 
        path.append(next)
442
 
        next = best_ancestor(next)
443
 
    path.reverse()
444
 
    return path
 
204
def is_reserved_id(revision_id):
 
205
    """Determine whether a revision id is reserved
 
206
 
 
207
    :return: True if the revision is reserved, False otherwise
 
208
    """
 
209
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
 
210
 
 
211
 
 
212
def check_not_reserved_id(revision_id):
 
213
    """Raise ReservedId if the supplied revision_id is reserved"""
 
214
    if is_reserved_id(revision_id):
 
215
        raise errors.ReservedId(revision_id)
 
216
 
 
217
 
 
218
def ensure_null(revision_id):
 
219
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
220
    if revision_id is None:
 
221
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
222
            ' revision instead of None, as of bzr 0.91.',
 
223
            DeprecationWarning, stacklevel=2)
 
224
        return NULL_REVISION
 
225
    else:
 
226
        return revision_id
 
227
 
 
228
 
 
229
def is_null(revision_id):
 
230
    if revision_id is None:
 
231
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
232
            ' revision instead of None, as of bzr 0.90.',
 
233
            DeprecationWarning, stacklevel=2)
 
234
    return revision_id in (None, NULL_REVISION)