/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: Aaron Bentley
  • Date: 2007-07-11 19:44:51 UTC
  • mto: This revision was merged to the branch mainline in revision 2606.
  • Revision ID: abentley@panoramicfeedback.com-20070711194451-3jqhye1nnd02a9uv
Restore original Branch.last_revision behavior, fix bits that care

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
    if is_null(candidate_id):
 
128
        return True
 
129
    return (candidate_id in branch.repository.get_ancestry(revision_id,
 
130
            topo_sorted=False))
169
131
 
170
132
 
171
133
def iter_ancestors(revision_id, revision_source, only_present=False):
180
142
                revision = revision_source.get_revision(ancestor)
181
143
            except errors.NoSuchRevision, e:
182
144
                if e.revision == revision_id:
183
 
                    raise
 
145
                    raise 
184
146
                else:
185
147
                    continue
186
148
            if only_present:
194
156
    """Return the ancestors of a revision present in a branch.
195
157
 
196
158
    It's possible that a branch won't have the complete ancestry of
197
 
    one of its revisions.
 
159
    one of its revisions.  
198
160
 
199
161
    """
200
162
    found_ancestors = {}
204
166
        if anc_id not in found_ancestors:
205
167
            found_ancestors[anc_id] = (anc_order, anc_distance)
206
168
    return found_ancestors
207
 
 
 
169
    
208
170
 
209
171
def __get_closest(intersection):
210
172
    intersection.sort()
211
 
    matches = []
 
173
    matches = [] 
212
174
    for entry in intersection:
213
175
        if entry[0] == intersection[0][0]:
214
176
            matches.append(entry[2])
215
177
    return matches
216
178
 
217
179
 
 
180
def revision_graph(revision, revision_source):
 
181
    """Produce a graph of the ancestry of the specified revision.
 
182
    
 
183
    :return: root, ancestors map, descendants map
 
184
    """
 
185
    revision_source.lock_read()
 
186
    try:
 
187
        return _revision_graph(revision, revision_source)
 
188
    finally:
 
189
        revision_source.unlock()
 
190
 
 
191
 
 
192
def _revision_graph(revision, revision_source):
 
193
    """See revision_graph."""
 
194
    from bzrlib.tsort import topo_sort
 
195
    graph = revision_source.get_revision_graph(revision)
 
196
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
197
    for node, parents in graph.items():
 
198
        if len(parents) == 0:
 
199
            graph[node] = [NULL_REVISION]
 
200
    # add NULL_REVISION to the graph
 
201
    graph[NULL_REVISION] = []
 
202
 
 
203
    # pick a root. If there are multiple roots
 
204
    # this could pick a random one.
 
205
    topo_order = topo_sort(graph.items())
 
206
    root = topo_order[0]
 
207
 
 
208
    ancestors = {}
 
209
    descendants = {}
 
210
 
 
211
    # map the descendants of the graph.
 
212
    # and setup our set based return graph.
 
213
    for node in graph.keys():
 
214
        descendants[node] = {}
 
215
    for node, parents in graph.items():
 
216
        for parent in parents:
 
217
            descendants[parent][node] = 1
 
218
        ancestors[node] = set(parents)
 
219
 
 
220
    assert root not in descendants[root]
 
221
    assert root not in ancestors[root]
 
222
    return root, ancestors, descendants
 
223
 
 
224
 
 
225
def combined_graph(revision_a, revision_b, revision_source):
 
226
    """Produce a combined ancestry graph.
 
227
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
228
    root, ancestors, descendants = revision_graph(
 
229
        revision_a, revision_source)
 
230
    root_b, ancestors_b, descendants_b = revision_graph(
 
231
        revision_b, revision_source)
 
232
    if root != root_b:
 
233
        raise errors.NoCommonRoot(revision_a, revision_b)
 
234
    common = set()
 
235
    for node, node_anc in ancestors_b.iteritems():
 
236
        if node in ancestors:
 
237
            common.add(node)
 
238
        else:
 
239
            ancestors[node] = set()
 
240
        ancestors[node].update(node_anc)
 
241
    for node, node_dec in descendants_b.iteritems():
 
242
        if node not in descendants:
 
243
            descendants[node] = {}
 
244
        descendants[node].update(node_dec)
 
245
    return root, ancestors, descendants, common
 
246
 
 
247
 
 
248
def common_ancestor(revision_a, revision_b, revision_source, 
 
249
                    pb=DummyProgress()):
 
250
    if None in (revision_a, revision_b):
 
251
        return None
 
252
    if NULL_REVISION in (revision_a, revision_b):
 
253
        return NULL_REVISION
 
254
    # trivial optimisation
 
255
    if revision_a == revision_b:
 
256
        return revision_a
 
257
    try:
 
258
        try:
 
259
            pb.update('Picking ancestor', 1, 3)
 
260
            graph = revision_source.get_revision_graph_with_ghosts(
 
261
                [revision_a, revision_b])
 
262
            # Shortcut the case where one of the tips is already included in
 
263
            # the other graphs ancestry.
 
264
            ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
 
265
            if revision_b in ancestry_a:
 
266
                return revision_b
 
267
            ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
 
268
            if revision_a in ancestry_b:
 
269
                return revision_a
 
270
            # convert to a NULL_REVISION based graph.
 
271
            ancestors = graph.get_ancestors()
 
272
            descendants = graph.get_descendants()
 
273
            common = set(ancestry_a)
 
274
            common.intersection_update(ancestry_b)
 
275
            descendants[NULL_REVISION] = {}
 
276
            ancestors[NULL_REVISION] = []
 
277
            for root in graph.roots:
 
278
                descendants[NULL_REVISION][root] = 1
 
279
                ancestors[root].append(NULL_REVISION)
 
280
            for ghost in graph.ghosts:
 
281
                # ghosts act as roots for the purpose of finding 
 
282
                # the longest paths from the root: any ghost *might*
 
283
                # be directly attached to the root, so we treat them
 
284
                # as being such.
 
285
                # ghost now descends from NULL
 
286
                descendants[NULL_REVISION][ghost] = 1
 
287
                # that is it has an ancestor of NULL
 
288
                ancestors[ghost] = [NULL_REVISION]
 
289
                # ghost is common if any of ghosts descendants are common:
 
290
                for ghost_descendant in descendants[ghost]:
 
291
                    if ghost_descendant in common:
 
292
                        common.add(ghost)
 
293
                
 
294
            root = NULL_REVISION
 
295
            common.add(NULL_REVISION)
 
296
        except errors.NoCommonRoot:
 
297
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
298
            
 
299
        pb.update('Picking ancestor', 2, 3)
 
300
        distances = node_distances (descendants, ancestors, root)
 
301
        pb.update('Picking ancestor', 3, 2)
 
302
        farthest = select_farthest(distances, common)
 
303
        if farthest is None or farthest == NULL_REVISION:
 
304
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
305
    finally:
 
306
        pb.clear()
 
307
    return farthest
 
308
 
 
309
 
 
310
class MultipleRevisionSources(object):
 
311
    """Proxy that looks in multiple branches for revisions."""
 
312
    def __init__(self, *args):
 
313
        object.__init__(self)
 
314
        assert len(args) != 0
 
315
        self._revision_sources = args
 
316
 
 
317
    def revision_parents(self, revision_id):
 
318
        for source in self._revision_sources:
 
319
            try:
 
320
                return source.revision_parents(revision_id)
 
321
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
322
                pass
 
323
        raise e
 
324
 
 
325
    def get_revision(self, revision_id):
 
326
        for source in self._revision_sources:
 
327
            try:
 
328
                return source.get_revision(revision_id)
 
329
            except errors.NoSuchRevision, e:
 
330
                pass
 
331
        raise e
 
332
 
 
333
    def get_revision_graph(self, revision_id):
 
334
        # we could probe incrementally until the pending
 
335
        # ghosts list stop growing, but its cheaper for now
 
336
        # to just ask for the complete graph for each repository.
 
337
        graphs = []
 
338
        for source in self._revision_sources:
 
339
            ghost_graph = source.get_revision_graph_with_ghosts()
 
340
            graphs.append(ghost_graph)
 
341
        absent = 0
 
342
        for graph in graphs:
 
343
            if not revision_id in graph.get_ancestors():
 
344
                absent += 1
 
345
        if absent == len(graphs):
 
346
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
347
 
 
348
        # combine the graphs
 
349
        result = {}
 
350
        pending = set([revision_id])
 
351
        def find_parents(node_id):
 
352
            """find the parents for node_id."""
 
353
            for graph in graphs:
 
354
                ancestors = graph.get_ancestors()
 
355
                try:
 
356
                    return ancestors[node_id]
 
357
                except KeyError:
 
358
                    pass
 
359
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
360
        while len(pending):
 
361
            # all the graphs should have identical parent lists
 
362
            node_id = pending.pop()
 
363
            try:
 
364
                result[node_id] = find_parents(node_id)
 
365
                for parent_node in result[node_id]:
 
366
                    if not parent_node in result:
 
367
                        pending.add(parent_node)
 
368
            except errors.NoSuchRevision:
 
369
                # ghost, ignore it.
 
370
                pass
 
371
        return result
 
372
 
 
373
    def get_revision_graph_with_ghosts(self, revision_ids):
 
374
        # query all the sources for their entire graphs 
 
375
        # and then build a combined graph for just
 
376
        # revision_ids.
 
377
        graphs = []
 
378
        for source in self._revision_sources:
 
379
            ghost_graph = source.get_revision_graph_with_ghosts()
 
380
            graphs.append(ghost_graph.get_ancestors())
 
381
        for revision_id in revision_ids:
 
382
            absent = 0
 
383
            for graph in graphs:
 
384
                    if not revision_id in graph:
 
385
                        absent += 1
 
386
            if absent == len(graphs):
 
387
                raise errors.NoSuchRevision(self._revision_sources[0],
 
388
                                            revision_id)
 
389
 
 
390
        # combine the graphs
 
391
        result = Graph()
 
392
        pending = set(revision_ids)
 
393
        done = set()
 
394
        def find_parents(node_id):
 
395
            """find the parents for node_id."""
 
396
            for graph in graphs:
 
397
                try:
 
398
                    return graph[node_id]
 
399
                except KeyError:
 
400
                    pass
 
401
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
402
        while len(pending):
 
403
            # all the graphs should have identical parent lists
 
404
            node_id = pending.pop()
 
405
            try:
 
406
                parents = find_parents(node_id)
 
407
                for parent_node in parents:
 
408
                    # queued or done? 
 
409
                    if (parent_node not in pending and
 
410
                        parent_node not in done):
 
411
                        # no, queue
 
412
                        pending.add(parent_node)
 
413
                result.add_node(node_id, parents)
 
414
                done.add(node_id)
 
415
            except errors.NoSuchRevision:
 
416
                # ghost
 
417
                result.add_ghost(node_id)
 
418
                continue
 
419
        return result
 
420
 
 
421
    def lock_read(self):
 
422
        for source in self._revision_sources:
 
423
            source.lock_read()
 
424
 
 
425
    def unlock(self):
 
426
        for source in self._revision_sources:
 
427
            source.unlock()
 
428
 
 
429
 
 
430
@deprecated_function(zero_eight)
 
431
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
 
432
                              revision_history=None):
 
433
    """Find the longest line of descent from maybe_ancestor to revision.
 
434
    Revision history is followed where possible.
 
435
 
 
436
    If ancestor_id == rev_id, list will be empty.
 
437
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
438
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
439
    """
 
440
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
441
    if len(descendants) == 0:
 
442
        raise errors.NoSuchRevision(rev_source, rev_id)
 
443
    if ancestor_id not in descendants:
 
444
        rev_source.get_revision(ancestor_id)
 
445
        raise errors.NotAncestor(rev_id, ancestor_id)
 
446
    root_descendants = all_descendants(descendants, ancestor_id)
 
447
    root_descendants.add(ancestor_id)
 
448
    if rev_id not in root_descendants:
 
449
        raise errors.NotAncestor(rev_id, ancestor_id)
 
450
    distances = node_distances(descendants, ancestors, ancestor_id,
 
451
                               root_descendants=root_descendants)
 
452
 
 
453
    def best_ancestor(rev_id):
 
454
        best = None
 
455
        for anc_id in ancestors[rev_id]:
 
456
            try:
 
457
                distance = distances[anc_id]
 
458
            except KeyError:
 
459
                continue
 
460
            if revision_history is not None and anc_id in revision_history:
 
461
                return anc_id
 
462
            elif best is None or distance > best[1]:
 
463
                best = (anc_id, distance)
 
464
        return best[0]
 
465
 
 
466
    next = rev_id
 
467
    path = []
 
468
    while next != ancestor_id:
 
469
        path.append(next)
 
470
        next = best_ancestor(next)
 
471
    path.reverse()
 
472
    return path
 
473
 
 
474
 
218
475
def is_reserved_id(revision_id):
219
476
    """Determine whether a revision id is reserved
220
477
 
221
 
    :return: True if the revision is reserved, False otherwise
 
478
    :return: True if the revision is is reserved, False otherwise
222
479
    """
223
480
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
481
 
230
487
 
231
488
 
232
489
def ensure_null(revision_id):
233
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
490
    """Ensure only NULL_REVISION is used to represent the null revisionn"""
234
491
    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
492
        return NULL_REVISION
239
493
    else:
240
494
        return revision_id
241
495
 
242
496
 
243
497
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)
 
498
    assert revision_id is not None
248
499
    return revision_id in (None, NULL_REVISION)