← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

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