← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Martin Pool
  • Date: 2010-06-02 05:03:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5279.
  • Revision ID: mbp@canonical.com-20100602050331-n2p1qt8hfsahspnv
Correct more sloppy use of the term 'Linux'

Show diffs side-by-side

added added

removed removed

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