← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-19 06:14:38 UTC
  • mfrom: (1704.2.23 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060519061438-6300caf3926c3cff
(mbp) small fixes

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
 
# 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.
111
101
        reversed_result.reverse()
112
102
        return reversed_result
113
103
 
114
 
    def get_summary(self):
115
 
        """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
 
104
 
 
105
def is_ancestor(revision_id, candidate_id, branch):
 
106
    """Return true if candidate_id is an ancestor of revision_id.
 
107
 
 
108
    A false negative will be returned if any intermediate descendent of
 
109
    candidate_id is not present in any of the revision_sources.
 
110
    
 
111
    revisions_source is an object supporting a get_revision operation that
 
112
    behaves like Branch's.
 
113
    """
 
114
    return candidate_id in branch.repository.get_ancestry(revision_id)
169
115
 
170
116
 
171
117
def iter_ancestors(revision_id, revision_source, only_present=False):
178
124
                yield ancestor, distance
179
125
            try:
180
126
                revision = revision_source.get_revision(ancestor)
181
 
            except errors.NoSuchRevision, e:
 
127
            except bzrlib.errors.NoSuchRevision, e:
182
128
                if e.revision == revision_id:
183
 
                    raise
 
129
                    raise 
184
130
                else:
185
131
                    continue
186
132
            if only_present:
194
140
    """Return the ancestors of a revision present in a branch.
195
141
 
196
142
    It's possible that a branch won't have the complete ancestry of
197
 
    one of its revisions.
 
143
    one of its revisions.  
198
144
 
199
145
    """
200
146
    found_ancestors = {}
201
147
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
202
148
                         only_present=True))
203
149
    for anc_order, (anc_id, anc_distance) in anc_iter:
204
 
        if anc_id not in found_ancestors:
 
150
        if not found_ancestors.has_key(anc_id):
205
151
            found_ancestors[anc_id] = (anc_order, anc_distance)
206
152
    return found_ancestors
207
 
 
 
153
    
208
154
 
209
155
def __get_closest(intersection):
210
156
    intersection.sort()
211
 
    matches = []
 
157
    matches = [] 
212
158
    for entry in intersection:
213
159
        if entry[0] == intersection[0][0]:
214
160
            matches.append(entry[2])
215
161
    return matches
216
162
 
217
163
 
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
 
164
def revision_graph(revision, revision_source):
 
165
    """Produce a graph of the ancestry of the specified revision.
 
166
    
 
167
    :return: root, ancestors map, descendants map
222
168
    """
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
    revision_source.lock_read()
 
170
    try:
 
171
        return _revision_graph(revision, revision_source)
 
172
    finally:
 
173
        revision_source.unlock()
 
174
 
 
175
 
 
176
def _revision_graph(revision, revision_source):
 
177
    """See revision_graph."""
 
178
    from bzrlib.tsort import topo_sort
 
179
    graph = revision_source.get_revision_graph(revision)
 
180
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
181
    for node, parents in graph.items():
 
182
        if len(parents) == 0:
 
183
            graph[node] = [NULL_REVISION]
 
184
    # add NULL_REVISION to the graph
 
185
    graph[NULL_REVISION] = []
 
186
 
 
187
    # pick a root. If there are multiple roots
 
188
    # this could pick a random one.
 
189
    topo_order = topo_sort(graph.items())
 
190
    root = topo_order[0]
 
191
 
 
192
    ancestors = {}
 
193
    descendants = {}
 
194
 
 
195
    # map the descendants of the graph.
 
196
    # and setup our set based return graph.
 
197
    for node in graph.keys():
 
198
        descendants[node] = {}
 
199
    for node, parents in graph.items():
 
200
        for parent in parents:
 
201
            descendants[parent][node] = 1
 
202
        ancestors[node] = set(parents)
 
203
 
 
204
    assert root not in descendants[root]
 
205
    assert root not in ancestors[root]
 
206
    return root, ancestors, descendants
 
207
 
 
208
 
 
209
def combined_graph(revision_a, revision_b, revision_source):
 
210
    """Produce a combined ancestry graph.
 
211
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
212
    root, ancestors, descendants = revision_graph(
 
213
        revision_a, revision_source)
 
214
    root_b, ancestors_b, descendants_b = revision_graph(
 
215
        revision_b, revision_source)
 
216
    if root != root_b:
 
217
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
218
    common = set()
 
219
    for node, node_anc in ancestors_b.iteritems():
 
220
        if node in ancestors:
 
221
            common.add(node)
 
222
        else:
 
223
            ancestors[node] = set()
 
224
        ancestors[node].update(node_anc)
 
225
    for node, node_dec in descendants_b.iteritems():
 
226
        if node not in descendants:
 
227
            descendants[node] = {}
 
228
        descendants[node].update(node_dec)
 
229
    return root, ancestors, descendants, common
 
230
 
 
231
 
 
232
def common_ancestor(revision_a, revision_b, revision_source, 
 
233
                    pb=DummyProgress()):
 
234
    if None in (revision_a, revision_b):
 
235
        return None
 
236
    # trivial optimisation
 
237
    if revision_a == revision_b:
 
238
        return revision_a
 
239
    try:
 
240
        try:
 
241
            pb.update('Picking ancestor', 1, 3)
 
242
            graph = revision_source.get_revision_graph_with_ghosts(
 
243
                [revision_a, revision_b])
 
244
            # convert to a NULL_REVISION based graph.
 
245
            ancestors = graph.get_ancestors()
 
246
            descendants = graph.get_descendants()
 
247
            common = set(graph.get_ancestry(revision_a)).intersection(
 
248
                     set(graph.get_ancestry(revision_b)))
 
249
            descendants[NULL_REVISION] = {}
 
250
            ancestors[NULL_REVISION] = []
 
251
            for root in graph.roots:
 
252
                descendants[NULL_REVISION][root] = 1
 
253
                ancestors[root].append(NULL_REVISION)
 
254
            for ghost in graph.ghosts:
 
255
                # ghosts act as roots for the purpose of finding 
 
256
                # the longest paths from the root: any ghost *might*
 
257
                # be directly attached to the root, so we treat them
 
258
                # as being such.
 
259
                # ghost now descends from NULL
 
260
                descendants[NULL_REVISION][ghost] = 1
 
261
                # that is it has an ancestor of NULL
 
262
                ancestors[ghost] = [NULL_REVISION]
 
263
                # ghost is common if any of ghosts descendants are common:
 
264
                for ghost_descendant in descendants[ghost]:
 
265
                    if ghost_descendant in common:
 
266
                        common.add(ghost)
 
267
                
 
268
            root = NULL_REVISION
 
269
            common.add(NULL_REVISION)
 
270
        except bzrlib.errors.NoCommonRoot:
 
271
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
272
            
 
273
        pb.update('Picking ancestor', 2, 3)
 
274
        distances = node_distances (descendants, ancestors, root)
 
275
        pb.update('Picking ancestor', 3, 2)
 
276
        farthest = select_farthest(distances, common)
 
277
        if farthest is None or farthest == NULL_REVISION:
 
278
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
279
    finally:
 
280
        pb.clear()
 
281
    return farthest
 
282
 
 
283
 
 
284
class MultipleRevisionSources(object):
 
285
    """Proxy that looks in multiple branches for revisions."""
 
286
    def __init__(self, *args):
 
287
        object.__init__(self)
 
288
        assert len(args) != 0
 
289
        self._revision_sources = args
 
290
 
 
291
    def revision_parents(self, revision_id):
 
292
        for source in self._revision_sources:
 
293
            try:
 
294
                return source.revision_parents(revision_id)
 
295
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
296
                pass
 
297
        raise e
 
298
 
 
299
    def get_revision(self, revision_id):
 
300
        for source in self._revision_sources:
 
301
            try:
 
302
                return source.get_revision(revision_id)
 
303
            except bzrlib.errors.NoSuchRevision, e:
 
304
                pass
 
305
        raise e
 
306
 
 
307
    def get_revision_graph(self, revision_id):
 
308
        # we could probe incrementally until the pending
 
309
        # ghosts list stop growing, but its cheaper for now
 
310
        # to just ask for the complete graph for each repository.
 
311
        graphs = []
 
312
        for source in self._revision_sources:
 
313
            ghost_graph = source.get_revision_graph_with_ghosts()
 
314
            graphs.append(ghost_graph)
 
315
        absent = 0
 
316
        for graph in graphs:
 
317
            if not revision_id in graph.get_ancestors():
 
318
                absent += 1
 
319
        if absent == len(graphs):
 
320
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
321
 
 
322
        # combine the graphs
 
323
        result = {}
 
324
        pending = set([revision_id])
 
325
        def find_parents(node_id):
 
326
            """find the parents for node_id."""
 
327
            for graph in graphs:
 
328
                ancestors = graph.get_ancestors()
 
329
                try:
 
330
                    return ancestors[node_id]
 
331
                except KeyError:
 
332
                    pass
 
333
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
334
        while len(pending):
 
335
            # all the graphs should have identical parent lists
 
336
            node_id = pending.pop()
 
337
            try:
 
338
                result[node_id] = find_parents(node_id)
 
339
                for parent_node in result[node_id]:
 
340
                    if not parent_node in result:
 
341
                        pending.add(parent_node)
 
342
            except errors.NoSuchRevision:
 
343
                # ghost, ignore it.
 
344
                pass
 
345
        return result
 
346
 
 
347
    def get_revision_graph_with_ghosts(self, revision_ids):
 
348
        # query all the sources for their entire graphs 
 
349
        # and then build a combined graph for just
 
350
        # revision_ids.
 
351
        graphs = []
 
352
        for source in self._revision_sources:
 
353
            ghost_graph = source.get_revision_graph_with_ghosts()
 
354
            graphs.append(ghost_graph.get_ancestors())
 
355
        for revision_id in revision_ids:
 
356
            absent = 0
 
357
            for graph in graphs:
 
358
                    if not revision_id in graph:
 
359
                        absent += 1
 
360
            if absent == len(graphs):
 
361
                raise errors.NoSuchRevision(self._revision_sources[0],
 
362
                                            revision_id)
 
363
 
 
364
        # combine the graphs
 
365
        result = Graph()
 
366
        pending = set(revision_ids)
 
367
        done = set()
 
368
        def find_parents(node_id):
 
369
            """find the parents for node_id."""
 
370
            for graph in graphs:
 
371
                try:
 
372
                    return graph[node_id]
 
373
                except KeyError:
 
374
                    pass
 
375
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
376
        while len(pending):
 
377
            # all the graphs should have identical parent lists
 
378
            node_id = pending.pop()
 
379
            try:
 
380
                parents = find_parents(node_id)
 
381
                for parent_node in parents:
 
382
                    # queued or done? 
 
383
                    if (parent_node not in pending and
 
384
                        parent_node not in done):
 
385
                        # no, queue
 
386
                        pending.add(parent_node)
 
387
                result.add_node(node_id, parents)
 
388
                done.add(node_id)
 
389
            except errors.NoSuchRevision:
 
390
                # ghost
 
391
                result.add_ghost(node_id)
 
392
                continue
 
393
        return result
 
394
 
 
395
    def lock_read(self):
 
396
        for source in self._revision_sources:
 
397
            source.lock_read()
 
398
 
 
399
    def unlock(self):
 
400
        for source in self._revision_sources:
 
401
            source.unlock()