← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Robert Collins
  • Date: 2008-04-09 20:13:46 UTC
  • mto: This revision was merged to the branch mainline in revision 3350.
  • Revision ID: robertc@robertcollins.net-20080409201346-2m5dpim3cowzwacs
Spelling in NEWS.

Show diffs side-by-side

added added

removed removed

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