/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Andrew Bennetts
  • Date: 2008-03-12 20:13:07 UTC
  • mfrom: (3267 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080312201307-ngd5bynt2nvhnlb7
Merge from bzr.dev.

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
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
23
from bzrlib import deprecated_graph
24
 
from bzrlib import bugtracker
25
24
""")
26
25
from bzrlib import (
27
26
    errors,
28
27
    symbol_versioning,
29
28
    )
30
29
from bzrlib.osutils import contains_whitespace
 
30
from bzrlib.progress import DummyProgress
 
31
from bzrlib.symbol_versioning import (deprecated_function,
 
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
114
        """
119
 
        if self.message:
120
 
            return self.message.lstrip().split('\n', 1)[0]
121
 
        else:
122
 
            return ''
 
115
        return self.message.lstrip().split('\n', 1)[0]
123
116
 
124
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
125
117
    def get_apparent_author(self):
126
118
        """Return the apparent author of this revision.
127
119
 
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
 
120
        If the revision properties contain the author name,
 
121
        return it. Otherwise return the committer name.
 
122
        """
 
123
        return self.properties.get('author', self.committer)
 
124
 
 
125
 
 
126
@deprecated_function(symbol_versioning.one_zero)
 
127
def is_ancestor(revision_id, candidate_id, branch):
 
128
    """Return true if candidate_id is an ancestor of revision_id.
 
129
 
 
130
    A false negative will be returned if any intermediate descendent of
 
131
    candidate_id is not present in any of the revision_sources.
 
132
    
 
133
    revisions_source is an object supporting a get_revision operation that
 
134
    behaves like Branch's.
 
135
 
 
136
    This function is deprecated, it is better for callers to directly use
 
137
    Graph.is_ancestor() (just watch out that the parameter order is switched)
 
138
    """
 
139
    return branch.repository.get_graph().is_ancestor(candidate_id, revision_id)
169
140
 
170
141
 
171
142
def iter_ancestors(revision_id, revision_source, only_present=False):
180
151
                revision = revision_source.get_revision(ancestor)
181
152
            except errors.NoSuchRevision, e:
182
153
                if e.revision == revision_id:
183
 
                    raise
 
154
                    raise 
184
155
                else:
185
156
                    continue
186
157
            if only_present:
194
165
    """Return the ancestors of a revision present in a branch.
195
166
 
196
167
    It's possible that a branch won't have the complete ancestry of
197
 
    one of its revisions.
 
168
    one of its revisions.  
198
169
 
199
170
    """
200
171
    found_ancestors = {}
204
175
        if anc_id not in found_ancestors:
205
176
            found_ancestors[anc_id] = (anc_order, anc_distance)
206
177
    return found_ancestors
207
 
 
 
178
    
208
179
 
209
180
def __get_closest(intersection):
210
181
    intersection.sort()
211
 
    matches = []
 
182
    matches = [] 
212
183
    for entry in intersection:
213
184
        if entry[0] == intersection[0][0]:
214
185
            matches.append(entry[2])
215
186
    return matches
216
187
 
217
188
 
 
189
def revision_graph(revision, revision_source):
 
190
    """Produce a graph of the ancestry of the specified revision.
 
191
    
 
192
    :return: root, ancestors map, descendants map
 
193
    """
 
194
    revision_source.lock_read()
 
195
    try:
 
196
        return _revision_graph(revision, revision_source)
 
197
    finally:
 
198
        revision_source.unlock()
 
199
 
 
200
 
 
201
def _revision_graph(revision, revision_source):
 
202
    """See revision_graph."""
 
203
    from bzrlib.tsort import topo_sort
 
204
    graph = revision_source.get_revision_graph(revision)
 
205
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
206
    for node, parents in graph.items():
 
207
        if len(parents) == 0:
 
208
            graph[node] = [NULL_REVISION]
 
209
    # add NULL_REVISION to the graph
 
210
    graph[NULL_REVISION] = []
 
211
 
 
212
    # pick a root. If there are multiple roots
 
213
    # this could pick a random one.
 
214
    topo_order = topo_sort(graph.items())
 
215
    root = topo_order[0]
 
216
 
 
217
    ancestors = {}
 
218
    descendants = {}
 
219
 
 
220
    # map the descendants of the graph.
 
221
    # and setup our set based return graph.
 
222
    for node in graph.keys():
 
223
        descendants[node] = {}
 
224
    for node, parents in graph.items():
 
225
        for parent in parents:
 
226
            descendants[parent][node] = 1
 
227
        ancestors[node] = set(parents)
 
228
 
 
229
    assert root not in descendants[root]
 
230
    assert root not in ancestors[root]
 
231
    return root, ancestors, descendants
 
232
 
 
233
 
 
234
def combined_graph(revision_a, revision_b, revision_source):
 
235
    """Produce a combined ancestry graph.
 
236
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
237
    root, ancestors, descendants = revision_graph(
 
238
        revision_a, revision_source)
 
239
    root_b, ancestors_b, descendants_b = revision_graph(
 
240
        revision_b, revision_source)
 
241
    if root != root_b:
 
242
        raise errors.NoCommonRoot(revision_a, revision_b)
 
243
    common = set()
 
244
    for node, node_anc in ancestors_b.iteritems():
 
245
        if node in ancestors:
 
246
            common.add(node)
 
247
        else:
 
248
            ancestors[node] = set()
 
249
        ancestors[node].update(node_anc)
 
250
    for node, node_dec in descendants_b.iteritems():
 
251
        if node not in descendants:
 
252
            descendants[node] = {}
 
253
        descendants[node].update(node_dec)
 
254
    return root, ancestors, descendants, common
 
255
 
 
256
 
 
257
def common_ancestor(revision_a, revision_b, revision_source, 
 
258
                    pb=DummyProgress()):
 
259
    if None in (revision_a, revision_b):
 
260
        return None
 
261
    if NULL_REVISION in (revision_a, revision_b):
 
262
        return NULL_REVISION
 
263
    # trivial optimisation
 
264
    if revision_a == revision_b:
 
265
        return revision_a
 
266
    try:
 
267
        try:
 
268
            pb.update('Picking ancestor', 1, 3)
 
269
            graph = revision_source.get_revision_graph_with_ghosts(
 
270
                [revision_a, revision_b])
 
271
            # Shortcut the case where one of the tips is already included in
 
272
            # the other graphs ancestry.
 
273
            ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
 
274
            if revision_b in ancestry_a:
 
275
                return revision_b
 
276
            ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
 
277
            if revision_a in ancestry_b:
 
278
                return revision_a
 
279
            # convert to a NULL_REVISION based graph.
 
280
            ancestors = graph.get_ancestors()
 
281
            descendants = graph.get_descendants()
 
282
            common = set(ancestry_a)
 
283
            common.intersection_update(ancestry_b)
 
284
            descendants[NULL_REVISION] = {}
 
285
            ancestors[NULL_REVISION] = []
 
286
            for root in graph.roots:
 
287
                descendants[NULL_REVISION][root] = 1
 
288
                ancestors[root].append(NULL_REVISION)
 
289
            for ghost in graph.ghosts:
 
290
                # ghosts act as roots for the purpose of finding 
 
291
                # the longest paths from the root: any ghost *might*
 
292
                # be directly attached to the root, so we treat them
 
293
                # as being such.
 
294
                # ghost now descends from NULL
 
295
                descendants[NULL_REVISION][ghost] = 1
 
296
                # that is it has an ancestor of NULL
 
297
                ancestors[ghost] = [NULL_REVISION]
 
298
                # ghost is common if any of ghosts descendants are common:
 
299
                for ghost_descendant in descendants[ghost]:
 
300
                    if ghost_descendant in common:
 
301
                        common.add(ghost)
 
302
                
 
303
            root = NULL_REVISION
 
304
            common.add(NULL_REVISION)
 
305
        except errors.NoCommonRoot:
 
306
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
307
            
 
308
        pb.update('Picking ancestor', 2, 3)
 
309
        distances = deprecated_graph.node_distances(
 
310
            descendants, ancestors, root)
 
311
        pb.update('Picking ancestor', 3, 2)
 
312
        farthest = deprecated_graph.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 = deprecated_graph.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
 
218
440
def is_reserved_id(revision_id):
219
441
    """Determine whether a revision id is reserved
220
442
 
221
 
    :return: True if the revision is reserved, False otherwise
 
443
    :return: True if the revision is is reserved, False otherwise
222
444
    """
223
445
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
446