← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Aaron Bentley
  • Date: 2007-07-04 18:24:24 UTC
  • mto: This revision was merged to the branch mainline in revision 2586.
  • Revision ID: abentley@panoramicfeedback.com-20070704182424-q55ffb9o09qxw787
Unify MutableTree.smart_add behavior by disabling quirky memory-only Inventory

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