← 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-12-11 02:07:30 UTC
  • mto: (3119.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3120.
  • Revision ID: ian.clatworthy@internode.on.net-20071211020730-sdj4kj794dw0628e
make help topics more discoverable

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
 
    symbol_versioning,
 
23
    symbol_versioning
 
24
    )
 
25
from bzrlib.deprecated_graph import (
 
26
    all_descendants,
 
27
    Graph,
 
28
    node_distances,
 
29
    select_farthest,
29
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.zero_ninetythree)
 
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
def revision_graph(revision, revision_source):
 
192
    """Produce a graph of the ancestry of the specified revision.
 
193
    
 
194
    :return: root, ancestors map, descendants map
 
195
    """
 
196
    revision_source.lock_read()
 
197
    try:
 
198
        return _revision_graph(revision, revision_source)
 
199
    finally:
 
200
        revision_source.unlock()
 
201
 
 
202
 
 
203
def _revision_graph(revision, revision_source):
 
204
    """See revision_graph."""
 
205
    from bzrlib.tsort import topo_sort
 
206
    graph = revision_source.get_revision_graph(revision)
 
207
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
208
    for node, parents in graph.items():
 
209
        if len(parents) == 0:
 
210
            graph[node] = [NULL_REVISION]
 
211
    # add NULL_REVISION to the graph
 
212
    graph[NULL_REVISION] = []
 
213
 
 
214
    # pick a root. If there are multiple roots
 
215
    # this could pick a random one.
 
216
    topo_order = topo_sort(graph.items())
 
217
    root = topo_order[0]
 
218
 
 
219
    ancestors = {}
 
220
    descendants = {}
 
221
 
 
222
    # map the descendants of the graph.
 
223
    # and setup our set based return graph.
 
224
    for node in graph.keys():
 
225
        descendants[node] = {}
 
226
    for node, parents in graph.items():
 
227
        for parent in parents:
 
228
            descendants[parent][node] = 1
 
229
        ancestors[node] = set(parents)
 
230
 
 
231
    assert root not in descendants[root]
 
232
    assert root not in ancestors[root]
 
233
    return root, ancestors, descendants
 
234
 
 
235
 
 
236
def combined_graph(revision_a, revision_b, revision_source):
 
237
    """Produce a combined ancestry graph.
 
238
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
239
    root, ancestors, descendants = revision_graph(
 
240
        revision_a, revision_source)
 
241
    root_b, ancestors_b, descendants_b = revision_graph(
 
242
        revision_b, revision_source)
 
243
    if root != root_b:
 
244
        raise errors.NoCommonRoot(revision_a, revision_b)
 
245
    common = set()
 
246
    for node, node_anc in ancestors_b.iteritems():
 
247
        if node in ancestors:
 
248
            common.add(node)
 
249
        else:
 
250
            ancestors[node] = set()
 
251
        ancestors[node].update(node_anc)
 
252
    for node, node_dec in descendants_b.iteritems():
 
253
        if node not in descendants:
 
254
            descendants[node] = {}
 
255
        descendants[node].update(node_dec)
 
256
    return root, ancestors, descendants, common
 
257
 
 
258
 
 
259
def common_ancestor(revision_a, revision_b, revision_source, 
 
260
                    pb=DummyProgress()):
 
261
    if None in (revision_a, revision_b):
 
262
        return None
 
263
    if NULL_REVISION in (revision_a, revision_b):
 
264
        return NULL_REVISION
 
265
    # trivial optimisation
 
266
    if revision_a == revision_b:
 
267
        return revision_a
 
268
    try:
 
269
        try:
 
270
            pb.update('Picking ancestor', 1, 3)
 
271
            graph = revision_source.get_revision_graph_with_ghosts(
 
272
                [revision_a, revision_b])
 
273
            # Shortcut the case where one of the tips is already included in
 
274
            # the other graphs ancestry.
 
275
            ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
 
276
            if revision_b in ancestry_a:
 
277
                return revision_b
 
278
            ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
 
279
            if revision_a in ancestry_b:
 
280
                return revision_a
 
281
            # convert to a NULL_REVISION based graph.
 
282
            ancestors = graph.get_ancestors()
 
283
            descendants = graph.get_descendants()
 
284
            common = set(ancestry_a)
 
285
            common.intersection_update(ancestry_b)
 
286
            descendants[NULL_REVISION] = {}
 
287
            ancestors[NULL_REVISION] = []
 
288
            for root in graph.roots:
 
289
                descendants[NULL_REVISION][root] = 1
 
290
                ancestors[root].append(NULL_REVISION)
 
291
            for ghost in graph.ghosts:
 
292
                # ghosts act as roots for the purpose of finding 
 
293
                # the longest paths from the root: any ghost *might*
 
294
                # be directly attached to the root, so we treat them
 
295
                # as being such.
 
296
                # ghost now descends from NULL
 
297
                descendants[NULL_REVISION][ghost] = 1
 
298
                # that is it has an ancestor of NULL
 
299
                ancestors[ghost] = [NULL_REVISION]
 
300
                # ghost is common if any of ghosts descendants are common:
 
301
                for ghost_descendant in descendants[ghost]:
 
302
                    if ghost_descendant in common:
 
303
                        common.add(ghost)
 
304
                
 
305
            root = NULL_REVISION
 
306
            common.add(NULL_REVISION)
 
307
        except errors.NoCommonRoot:
 
308
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
309
            
 
310
        pb.update('Picking ancestor', 2, 3)
 
311
        distances = node_distances (descendants, ancestors, root)
 
312
        pb.update('Picking ancestor', 3, 2)
 
313
        farthest = select_farthest(distances, common)
 
314
        if farthest is None or farthest == NULL_REVISION:
 
315
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
316
    finally:
 
317
        pb.clear()
 
318
    return farthest
 
319
 
 
320
 
 
321
class MultipleRevisionSources(object):
 
322
    """Proxy that looks in multiple branches for revisions."""
 
323
    def __init__(self, *args):
 
324
        object.__init__(self)
 
325
        assert len(args) != 0
 
326
        self._revision_sources = args
 
327
 
 
328
    def revision_parents(self, revision_id):
 
329
        for source in self._revision_sources:
 
330
            try:
 
331
                return source.revision_parents(revision_id)
 
332
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
333
                pass
 
334
        raise e
 
335
 
 
336
    def get_revision(self, revision_id):
 
337
        for source in self._revision_sources:
 
338
            try:
 
339
                return source.get_revision(revision_id)
 
340
            except errors.NoSuchRevision, e:
 
341
                pass
 
342
        raise e
 
343
 
 
344
    def get_revision_graph(self, revision_id):
 
345
        # we could probe incrementally until the pending
 
346
        # ghosts list stop growing, but its cheaper for now
 
347
        # to just ask for the complete graph for each repository.
 
348
        graphs = []
 
349
        for source in self._revision_sources:
 
350
            ghost_graph = source.get_revision_graph_with_ghosts()
 
351
            graphs.append(ghost_graph)
 
352
        absent = 0
 
353
        for graph in graphs:
 
354
            if not revision_id in graph.get_ancestors():
 
355
                absent += 1
 
356
        if absent == len(graphs):
 
357
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
358
 
 
359
        # combine the graphs
 
360
        result = {}
 
361
        pending = set([revision_id])
 
362
        def find_parents(node_id):
 
363
            """find the parents for node_id."""
 
364
            for graph in graphs:
 
365
                ancestors = graph.get_ancestors()
 
366
                try:
 
367
                    return ancestors[node_id]
 
368
                except KeyError:
 
369
                    pass
 
370
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
371
        while len(pending):
 
372
            # all the graphs should have identical parent lists
 
373
            node_id = pending.pop()
 
374
            try:
 
375
                result[node_id] = find_parents(node_id)
 
376
                for parent_node in result[node_id]:
 
377
                    if not parent_node in result:
 
378
                        pending.add(parent_node)
 
379
            except errors.NoSuchRevision:
 
380
                # ghost, ignore it.
 
381
                pass
 
382
        return result
 
383
 
 
384
    def get_revision_graph_with_ghosts(self, revision_ids):
 
385
        # query all the sources for their entire graphs 
 
386
        # and then build a combined graph for just
 
387
        # revision_ids.
 
388
        graphs = []
 
389
        for source in self._revision_sources:
 
390
            ghost_graph = source.get_revision_graph_with_ghosts()
 
391
            graphs.append(ghost_graph.get_ancestors())
 
392
        for revision_id in revision_ids:
 
393
            absent = 0
 
394
            for graph in graphs:
 
395
                    if not revision_id in graph:
 
396
                        absent += 1
 
397
            if absent == len(graphs):
 
398
                raise errors.NoSuchRevision(self._revision_sources[0],
 
399
                                            revision_id)
 
400
 
 
401
        # combine the graphs
 
402
        result = Graph()
 
403
        pending = set(revision_ids)
 
404
        done = set()
 
405
        def find_parents(node_id):
 
406
            """find the parents for node_id."""
 
407
            for graph in graphs:
 
408
                try:
 
409
                    return graph[node_id]
 
410
                except KeyError:
 
411
                    pass
 
412
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
413
        while len(pending):
 
414
            # all the graphs should have identical parent lists
 
415
            node_id = pending.pop()
 
416
            try:
 
417
                parents = find_parents(node_id)
 
418
                for parent_node in parents:
 
419
                    # queued or done? 
 
420
                    if (parent_node not in pending and
 
421
                        parent_node not in done):
 
422
                        # no, queue
 
423
                        pending.add(parent_node)
 
424
                result.add_node(node_id, parents)
 
425
                done.add(node_id)
 
426
            except errors.NoSuchRevision:
 
427
                # ghost
 
428
                result.add_ghost(node_id)
 
429
                continue
 
430
        return result
 
431
 
 
432
    def lock_read(self):
 
433
        for source in self._revision_sources:
 
434
            source.lock_read()
 
435
 
 
436
    def unlock(self):
 
437
        for source in self._revision_sources:
 
438
            source.unlock()
 
439
 
 
440
 
218
441
def is_reserved_id(revision_id):
219
442
    """Determine whether a revision id is reserved
220
443
 
221
 
    :return: True if the revision is reserved, False otherwise
 
444
    :return: True if the revision is is reserved, False otherwise
222
445
    """
223
446
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
447