/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-04-02 00:14:00 UTC
  • mfrom: (3324 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080402001400-r1pqse38i03dl97w
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
@deprecated_function(symbol_versioning.one_four)
 
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
@deprecated_function(symbol_versioning.one_three)
 
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
@deprecated_function(symbol_versioning.one_three)
 
260
def common_ancestor(revision_a, revision_b, revision_source, 
 
261
                    pb=DummyProgress()):
 
262
    if None in (revision_a, revision_b):
 
263
        return None
 
264
    if NULL_REVISION in (revision_a, revision_b):
 
265
        return NULL_REVISION
 
266
    # trivial optimisation
 
267
    if revision_a == revision_b:
 
268
        return revision_a
 
269
    try:
 
270
        try:
 
271
            pb.update('Picking ancestor', 1, 3)
 
272
            graph = revision_source.get_revision_graph_with_ghosts(
 
273
                [revision_a, revision_b])
 
274
            # Shortcut the case where one of the tips is already included in
 
275
            # the other graphs ancestry.
 
276
            ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
 
277
            if revision_b in ancestry_a:
 
278
                return revision_b
 
279
            ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
 
280
            if revision_a in ancestry_b:
 
281
                return revision_a
 
282
            # convert to a NULL_REVISION based graph.
 
283
            ancestors = graph.get_ancestors()
 
284
            descendants = graph.get_descendants()
 
285
            common = set(ancestry_a)
 
286
            common.intersection_update(ancestry_b)
 
287
            descendants[NULL_REVISION] = {}
 
288
            ancestors[NULL_REVISION] = []
 
289
            for root in graph.roots:
 
290
                descendants[NULL_REVISION][root] = 1
 
291
                ancestors[root].append(NULL_REVISION)
 
292
            for ghost in graph.ghosts:
 
293
                # ghosts act as roots for the purpose of finding 
 
294
                # the longest paths from the root: any ghost *might*
 
295
                # be directly attached to the root, so we treat them
 
296
                # as being such.
 
297
                # ghost now descends from NULL
 
298
                descendants[NULL_REVISION][ghost] = 1
 
299
                # that is it has an ancestor of NULL
 
300
                ancestors[ghost] = [NULL_REVISION]
 
301
                # ghost is common if any of ghosts descendants are common:
 
302
                for ghost_descendant in descendants[ghost]:
 
303
                    if ghost_descendant in common:
 
304
                        common.add(ghost)
 
305
                
 
306
            root = NULL_REVISION
 
307
            common.add(NULL_REVISION)
 
308
        except errors.NoCommonRoot:
 
309
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
310
            
 
311
        pb.update('Picking ancestor', 2, 3)
 
312
        distances = deprecated_graph.node_distances(
 
313
            descendants, ancestors, root)
 
314
        pb.update('Picking ancestor', 3, 2)
 
315
        farthest = deprecated_graph.select_farthest(distances, common)
 
316
        if farthest is None or farthest == NULL_REVISION:
 
317
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
318
    finally:
 
319
        pb.clear()
 
320
    return farthest
 
321
 
 
322
 
 
323
class MultipleRevisionSources(object):
 
324
    """Proxy that looks in multiple branches for revisions."""
 
325
 
 
326
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
327
    def __init__(self, *args):
 
328
        object.__init__(self)
 
329
        assert len(args) != 0
 
330
        self._revision_sources = args
 
331
 
 
332
    def revision_parents(self, revision_id):
 
333
        for source in self._revision_sources:
 
334
            try:
 
335
                return source.revision_parents(revision_id)
 
336
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
337
                pass
 
338
        raise e
 
339
 
 
340
    def get_revision(self, revision_id):
 
341
        for source in self._revision_sources:
 
342
            try:
 
343
                return source.get_revision(revision_id)
 
344
            except errors.NoSuchRevision, e:
 
345
                pass
 
346
        raise e
 
347
 
 
348
    def get_revision_graph(self, revision_id):
 
349
        # we could probe incrementally until the pending
 
350
        # ghosts list stop growing, but its cheaper for now
 
351
        # to just ask for the complete graph for each repository.
 
352
        graphs = []
 
353
        for source in self._revision_sources:
 
354
            ghost_graph = source.get_revision_graph_with_ghosts()
 
355
            graphs.append(ghost_graph)
 
356
        absent = 0
 
357
        for graph in graphs:
 
358
            if not revision_id in graph.get_ancestors():
 
359
                absent += 1
 
360
        if absent == len(graphs):
 
361
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
362
 
 
363
        # combine the graphs
 
364
        result = {}
 
365
        pending = set([revision_id])
 
366
        def find_parents(node_id):
 
367
            """find the parents for node_id."""
 
368
            for graph in graphs:
 
369
                ancestors = graph.get_ancestors()
 
370
                try:
 
371
                    return ancestors[node_id]
 
372
                except KeyError:
 
373
                    pass
 
374
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
375
        while len(pending):
 
376
            # all the graphs should have identical parent lists
 
377
            node_id = pending.pop()
 
378
            try:
 
379
                result[node_id] = find_parents(node_id)
 
380
                for parent_node in result[node_id]:
 
381
                    if not parent_node in result:
 
382
                        pending.add(parent_node)
 
383
            except errors.NoSuchRevision:
 
384
                # ghost, ignore it.
 
385
                pass
 
386
        return result
 
387
 
 
388
    def get_revision_graph_with_ghosts(self, revision_ids):
 
389
        # query all the sources for their entire graphs 
 
390
        # and then build a combined graph for just
 
391
        # revision_ids.
 
392
        graphs = []
 
393
        for source in self._revision_sources:
 
394
            ghost_graph = source.get_revision_graph_with_ghosts()
 
395
            graphs.append(ghost_graph.get_ancestors())
 
396
        for revision_id in revision_ids:
 
397
            absent = 0
 
398
            for graph in graphs:
 
399
                    if not revision_id in graph:
 
400
                        absent += 1
 
401
            if absent == len(graphs):
 
402
                raise errors.NoSuchRevision(self._revision_sources[0],
 
403
                                            revision_id)
 
404
 
 
405
        # combine the graphs
 
406
        result = deprecated_graph.Graph()
 
407
        pending = set(revision_ids)
 
408
        done = set()
 
409
        def find_parents(node_id):
 
410
            """find the parents for node_id."""
 
411
            for graph in graphs:
 
412
                try:
 
413
                    return graph[node_id]
 
414
                except KeyError:
 
415
                    pass
 
416
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
417
        while len(pending):
 
418
            # all the graphs should have identical parent lists
 
419
            node_id = pending.pop()
 
420
            try:
 
421
                parents = find_parents(node_id)
 
422
                for parent_node in parents:
 
423
                    # queued or done? 
 
424
                    if (parent_node not in pending and
 
425
                        parent_node not in done):
 
426
                        # no, queue
 
427
                        pending.add(parent_node)
 
428
                result.add_node(node_id, parents)
 
429
                done.add(node_id)
 
430
            except errors.NoSuchRevision:
 
431
                # ghost
 
432
                result.add_ghost(node_id)
 
433
                continue
 
434
        return result
 
435
 
 
436
    def lock_read(self):
 
437
        for source in self._revision_sources:
 
438
            source.lock_read()
 
439
 
 
440
    def unlock(self):
 
441
        for source in self._revision_sources:
 
442
            source.unlock()
 
443
 
 
444
 
218
445
def is_reserved_id(revision_id):
219
446
    """Determine whether a revision id is reserved
220
447
 
221
 
    :return: True if the revision is reserved, False otherwise
 
448
    :return: True if the revision is is reserved, False otherwise
222
449
    """
223
450
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
451