← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Wouter van Heyst
  • Date: 2006-06-07 11:13:02 UTC
  • mfrom: (1747 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: larstiq@larstiq.dyndns.org-20060607111302-bce5a90c86f0d764
[merge] bzr.dev 1747

Show diffs side-by-side

added added

removed removed

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