← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
 
import bzrlib.errors as errors
22
 
from bzrlib.deprecated_graph import (
23
 
    all_descendants,
24
 
    Graph,
25
 
    node_distances,
26
 
    select_farthest,
 
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,
27
29
    )
28
30
from bzrlib.osutils import contains_whitespace
29
31
from bzrlib.progress import DummyProgress
30
 
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        zero_eight,
32
 
        )
33
32
 
34
33
NULL_REVISION="null:"
35
34
CURRENT_REVISION="current:"
49
48
 
50
49
    properties
51
50
        Dictionary of revision properties.  These are attached to the
52
 
        revision as extra metadata.  The name must be a single 
 
51
        revision as extra metadata.  The name must be a single
53
52
        word; the value can be an arbitrary string.
54
53
    """
55
 
    
 
54
 
56
55
    def __init__(self, revision_id, properties=None, **args):
57
56
        self.revision_id = revision_id
58
57
        self.properties = properties or {}
59
58
        self._check_properties()
 
59
        self.committer = None
60
60
        self.parent_ids = []
61
61
        self.parent_sha1s = []
62
62
        """Not used anymore - legacy from for 4."""
68
68
    def __eq__(self, other):
69
69
        if not isinstance(other, Revision):
70
70
            return False
71
 
        # FIXME: rbc 20050930 parent_ids are not being compared
72
71
        return (
73
72
                self.inventory_sha1 == other.inventory_sha1
74
73
                and self.revision_id == other.revision_id
76
75
                and self.message == other.message
77
76
                and self.timezone == other.timezone
78
77
                and self.committer == other.committer
79
 
                and self.properties == other.properties)
 
78
                and self.properties == other.properties
 
79
                and self.parent_ids == other.parent_ids)
80
80
 
81
81
    def __ne__(self, other):
82
82
        return not self.__eq__(other)
87
87
            if not isinstance(name, basestring) or contains_whitespace(name):
88
88
                raise ValueError("invalid property name %r" % name)
89
89
            if not isinstance(value, basestring):
90
 
                raise ValueError("invalid property value %r for %r" % 
91
 
                                 (name, value))
 
90
                raise ValueError("invalid property value %r for %r" %
 
91
                                 (value, name))
92
92
 
93
93
    def get_history(self, repository):
94
94
        """Return the canonical line-of-history for this revision.
111
111
 
112
112
    def get_summary(self):
113
113
        """Get the first line of the log message for this revision.
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))
 
114
 
 
115
        Return an empty string if message is None.
 
116
        """
 
117
        if self.message:
 
118
            return self.message.lstrip().split('\n', 1)[0]
 
119
        else:
 
120
            return ''
 
121
 
 
122
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
 
123
    def get_apparent_author(self):
 
124
        """Return the apparent author of this revision.
 
125
 
 
126
        This method is deprecated in favour of get_apparent_authors.
 
127
 
 
128
        If the revision properties contain any author names,
 
129
        return the first. Otherwise return the committer name.
 
130
        """
 
131
        authors = self.get_apparent_authors()
 
132
        if authors:
 
133
            return authors[0]
 
134
        else:
 
135
            return None
 
136
 
 
137
    def get_apparent_authors(self):
 
138
        """Return the apparent authors of this revision.
 
139
 
 
140
        If the revision properties contain the names of the authors,
 
141
        return them. Otherwise return the committer name.
 
142
 
 
143
        The return value will be a list containing at least one element.
 
144
        """
 
145
        authors = self.properties.get('authors', None)
 
146
        if authors is None:
 
147
            author = self.properties.get('author', self.committer)
 
148
            if author is None:
 
149
                return []
 
150
            return [author]
 
151
        else:
 
152
            return authors.split("\n")
 
153
 
 
154
    def iter_bugs(self):
 
155
        """Iterate over the bugs associated with this revision."""
 
156
        bug_property = self.properties.get('bugs', None)
 
157
        if bug_property is None:
 
158
            return
 
159
        for line in bug_property.splitlines():
 
160
            try:
 
161
                url, status = line.split(None, 2)
 
162
            except ValueError:
 
163
                raise errors.InvalidLineInBugsProperty(line)
 
164
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
 
165
                raise errors.InvalidBugStatus(status)
 
166
            yield url, status
129
167
 
130
168
 
131
169
def iter_ancestors(revision_id, revision_source, only_present=False):
140
178
                revision = revision_source.get_revision(ancestor)
141
179
            except errors.NoSuchRevision, e:
142
180
                if e.revision == revision_id:
143
 
                    raise 
 
181
                    raise
144
182
                else:
145
183
                    continue
146
184
            if only_present:
154
192
    """Return the ancestors of a revision present in a branch.
155
193
 
156
194
    It's possible that a branch won't have the complete ancestry of
157
 
    one of its revisions.  
 
195
    one of its revisions.
158
196
 
159
197
    """
160
198
    found_ancestors = {}
164
202
        if anc_id not in found_ancestors:
165
203
            found_ancestors[anc_id] = (anc_order, anc_distance)
166
204
    return found_ancestors
167
 
    
 
205
 
168
206
 
169
207
def __get_closest(intersection):
170
208
    intersection.sort()
171
 
    matches = [] 
 
209
    matches = []
172
210
    for entry in intersection:
173
211
        if entry[0] == intersection[0][0]:
174
212
            matches.append(entry[2])
175
213
    return matches
176
214
 
177
215
 
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
 
 
473
216
def is_reserved_id(revision_id):
474
217
    """Determine whether a revision id is reserved
475
218
 
476
 
    :return: True if the revision is is reserved, False otherwise
 
219
    :return: True if the revision is reserved, False otherwise
477
220
    """
478
221
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
479
222
 
483
226
    if is_reserved_id(revision_id):
484
227
        raise errors.ReservedId(revision_id)
485
228
 
 
229
 
486
230
def ensure_null(revision_id):
487
 
    """Ensure only NULL_REVISION is used to represent the null revisionn"""
 
231
    """Ensure only NULL_REVISION is used to represent the null revision"""
488
232
    if revision_id is None:
 
233
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
234
            ' revision instead of None, as of bzr 0.91.',
 
235
            DeprecationWarning, stacklevel=2)
489
236
        return NULL_REVISION
490
237
    else:
491
238
        return revision_id
 
239
 
 
240
 
 
241
def is_null(revision_id):
 
242
    if revision_id is None:
 
243
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
244
            ' revision instead of None, as of bzr 0.90.',
 
245
            DeprecationWarning, stacklevel=2)
 
246
    return revision_id in (None, NULL_REVISION)