← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Vincent Ladeuil
  • Date: 2007-06-20 14:25:06 UTC
  • mfrom: (2540 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2646.
  • Revision ID: v.ladeuil+lp@free.fr-20070620142506-txsb1v8538kpsafw
merge bzr.dev @ 2540

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