← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-28 03:56:39 UTC
  • mfrom: (2747.1.1 revspec)
  • Revision ID: pqm@pqm.ubuntu.com-20070828035639-q7qmg7gafaevlvku
(Lukas Lalinsky) Accept ..\ as a path in revision specifiers.

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
21
from bzrlib import (
27
22
    errors,
28
 
    symbol_versioning,
 
23
    symbol_versioning
 
24
    )
 
25
from bzrlib.deprecated_graph import (
 
26
    all_descendants,
 
27
    Graph,
 
28
    node_distances,
 
29
    select_farthest,
29
30
    )
30
31
from bzrlib.osutils import contains_whitespace
 
32
from bzrlib.progress import DummyProgress
 
33
from bzrlib.symbol_versioning import (deprecated_function,
 
34
        )
31
35
 
32
36
NULL_REVISION="null:"
33
37
CURRENT_REVISION="current:"
47
51
 
48
52
    properties
49
53
        Dictionary of revision properties.  These are attached to the
50
 
        revision as extra metadata.  The name must be a single
 
54
        revision as extra metadata.  The name must be a single 
51
55
        word; the value can be an arbitrary string.
52
56
    """
53
 
 
 
57
    
54
58
    def __init__(self, revision_id, properties=None, **args):
55
59
        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
 
60
        self.properties = properties or {}
 
61
        self._check_properties()
62
62
        self.parent_ids = []
63
63
        self.parent_sha1s = []
64
64
        """Not used anymore - legacy from for 4."""
70
70
    def __eq__(self, other):
71
71
        if not isinstance(other, Revision):
72
72
            return False
 
73
        # FIXME: rbc 20050930 parent_ids are not being compared
73
74
        return (
74
75
                self.inventory_sha1 == other.inventory_sha1
75
76
                and self.revision_id == other.revision_id
77
78
                and self.message == other.message
78
79
                and self.timezone == other.timezone
79
80
                and self.committer == other.committer
80
 
                and self.properties == other.properties
81
 
                and self.parent_ids == other.parent_ids)
 
81
                and self.properties == other.properties)
82
82
 
83
83
    def __ne__(self, other):
84
84
        return not self.__eq__(other)
89
89
            if not isinstance(name, basestring) or contains_whitespace(name):
90
90
                raise ValueError("invalid property name %r" % name)
91
91
            if not isinstance(value, basestring):
92
 
                raise ValueError("invalid property value %r for %r" %
93
 
                                 (value, name))
 
92
                raise ValueError("invalid property value %r for %r" % 
 
93
                                 (name, value))
94
94
 
95
95
    def get_history(self, repository):
96
96
        """Return the canonical line-of-history for this revision.
113
113
 
114
114
    def get_summary(self):
115
115
        """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
 
116
        """
 
117
        return self.message.split('\n', 1)[0]
 
118
 
 
119
 
 
120
def is_ancestor(revision_id, candidate_id, branch):
 
121
    """Return true if candidate_id is an ancestor of revision_id.
 
122
 
 
123
    A false negative will be returned if any intermediate descendent of
 
124
    candidate_id is not present in any of the revision_sources.
 
125
    
 
126
    revisions_source is an object supporting a get_revision operation that
 
127
    behaves like Branch's.
 
128
    """
 
129
    if is_null(candidate_id):
 
130
        return True
 
131
    return (candidate_id in branch.repository.get_ancestry(revision_id,
 
132
            topo_sorted=False))
169
133
 
170
134
 
171
135
def iter_ancestors(revision_id, revision_source, only_present=False):
180
144
                revision = revision_source.get_revision(ancestor)
181
145
            except errors.NoSuchRevision, e:
182
146
                if e.revision == revision_id:
183
 
                    raise
 
147
                    raise 
184
148
                else:
185
149
                    continue
186
150
            if only_present:
194
158
    """Return the ancestors of a revision present in a branch.
195
159
 
196
160
    It's possible that a branch won't have the complete ancestry of
197
 
    one of its revisions.
 
161
    one of its revisions.  
198
162
 
199
163
    """
200
164
    found_ancestors = {}
204
168
        if anc_id not in found_ancestors:
205
169
            found_ancestors[anc_id] = (anc_order, anc_distance)
206
170
    return found_ancestors
207
 
 
 
171
    
208
172
 
209
173
def __get_closest(intersection):
210
174
    intersection.sort()
211
 
    matches = []
 
175
    matches = [] 
212
176
    for entry in intersection:
213
177
        if entry[0] == intersection[0][0]:
214
178
            matches.append(entry[2])
215
179
    return matches
216
180
 
217
181
 
 
182
def revision_graph(revision, revision_source):
 
183
    """Produce a graph of the ancestry of the specified revision.
 
184
    
 
185
    :return: root, ancestors map, descendants map
 
186
    """
 
187
    revision_source.lock_read()
 
188
    try:
 
189
        return _revision_graph(revision, revision_source)
 
190
    finally:
 
191
        revision_source.unlock()
 
192
 
 
193
 
 
194
def _revision_graph(revision, revision_source):
 
195
    """See revision_graph."""
 
196
    from bzrlib.tsort import topo_sort
 
197
    graph = revision_source.get_revision_graph(revision)
 
198
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
199
    for node, parents in graph.items():
 
200
        if len(parents) == 0:
 
201
            graph[node] = [NULL_REVISION]
 
202
    # add NULL_REVISION to the graph
 
203
    graph[NULL_REVISION] = []
 
204
 
 
205
    # pick a root. If there are multiple roots
 
206
    # this could pick a random one.
 
207
    topo_order = topo_sort(graph.items())
 
208
    root = topo_order[0]
 
209
 
 
210
    ancestors = {}
 
211
    descendants = {}
 
212
 
 
213
    # map the descendants of the graph.
 
214
    # and setup our set based return graph.
 
215
    for node in graph.keys():
 
216
        descendants[node] = {}
 
217
    for node, parents in graph.items():
 
218
        for parent in parents:
 
219
            descendants[parent][node] = 1
 
220
        ancestors[node] = set(parents)
 
221
 
 
222
    assert root not in descendants[root]
 
223
    assert root not in ancestors[root]
 
224
    return root, ancestors, descendants
 
225
 
 
226
 
 
227
def combined_graph(revision_a, revision_b, revision_source):
 
228
    """Produce a combined ancestry graph.
 
229
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
230
    root, ancestors, descendants = revision_graph(
 
231
        revision_a, revision_source)
 
232
    root_b, ancestors_b, descendants_b = revision_graph(
 
233
        revision_b, revision_source)
 
234
    if root != root_b:
 
235
        raise errors.NoCommonRoot(revision_a, revision_b)
 
236
    common = set()
 
237
    for node, node_anc in ancestors_b.iteritems():
 
238
        if node in ancestors:
 
239
            common.add(node)
 
240
        else:
 
241
            ancestors[node] = set()
 
242
        ancestors[node].update(node_anc)
 
243
    for node, node_dec in descendants_b.iteritems():
 
244
        if node not in descendants:
 
245
            descendants[node] = {}
 
246
        descendants[node].update(node_dec)
 
247
    return root, ancestors, descendants, common
 
248
 
 
249
 
 
250
def common_ancestor(revision_a, revision_b, revision_source, 
 
251
                    pb=DummyProgress()):
 
252
    if None in (revision_a, revision_b):
 
253
        return None
 
254
    if NULL_REVISION in (revision_a, revision_b):
 
255
        return NULL_REVISION
 
256
    # trivial optimisation
 
257
    if revision_a == revision_b:
 
258
        return revision_a
 
259
    try:
 
260
        try:
 
261
            pb.update('Picking ancestor', 1, 3)
 
262
            graph = revision_source.get_revision_graph_with_ghosts(
 
263
                [revision_a, revision_b])
 
264
            # Shortcut the case where one of the tips is already included in
 
265
            # the other graphs ancestry.
 
266
            ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
 
267
            if revision_b in ancestry_a:
 
268
                return revision_b
 
269
            ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
 
270
            if revision_a in ancestry_b:
 
271
                return revision_a
 
272
            # convert to a NULL_REVISION based graph.
 
273
            ancestors = graph.get_ancestors()
 
274
            descendants = graph.get_descendants()
 
275
            common = set(ancestry_a)
 
276
            common.intersection_update(ancestry_b)
 
277
            descendants[NULL_REVISION] = {}
 
278
            ancestors[NULL_REVISION] = []
 
279
            for root in graph.roots:
 
280
                descendants[NULL_REVISION][root] = 1
 
281
                ancestors[root].append(NULL_REVISION)
 
282
            for ghost in graph.ghosts:
 
283
                # ghosts act as roots for the purpose of finding 
 
284
                # the longest paths from the root: any ghost *might*
 
285
                # be directly attached to the root, so we treat them
 
286
                # as being such.
 
287
                # ghost now descends from NULL
 
288
                descendants[NULL_REVISION][ghost] = 1
 
289
                # that is it has an ancestor of NULL
 
290
                ancestors[ghost] = [NULL_REVISION]
 
291
                # ghost is common if any of ghosts descendants are common:
 
292
                for ghost_descendant in descendants[ghost]:
 
293
                    if ghost_descendant in common:
 
294
                        common.add(ghost)
 
295
                
 
296
            root = NULL_REVISION
 
297
            common.add(NULL_REVISION)
 
298
        except errors.NoCommonRoot:
 
299
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
300
            
 
301
        pb.update('Picking ancestor', 2, 3)
 
302
        distances = node_distances (descendants, ancestors, root)
 
303
        pb.update('Picking ancestor', 3, 2)
 
304
        farthest = select_farthest(distances, common)
 
305
        if farthest is None or farthest == NULL_REVISION:
 
306
            raise errors.NoCommonAncestor(revision_a, revision_b)
 
307
    finally:
 
308
        pb.clear()
 
309
    return farthest
 
310
 
 
311
 
 
312
class MultipleRevisionSources(object):
 
313
    """Proxy that looks in multiple branches for revisions."""
 
314
    def __init__(self, *args):
 
315
        object.__init__(self)
 
316
        assert len(args) != 0
 
317
        self._revision_sources = args
 
318
 
 
319
    def revision_parents(self, revision_id):
 
320
        for source in self._revision_sources:
 
321
            try:
 
322
                return source.revision_parents(revision_id)
 
323
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
324
                pass
 
325
        raise e
 
326
 
 
327
    def get_revision(self, revision_id):
 
328
        for source in self._revision_sources:
 
329
            try:
 
330
                return source.get_revision(revision_id)
 
331
            except errors.NoSuchRevision, e:
 
332
                pass
 
333
        raise e
 
334
 
 
335
    def get_revision_graph(self, revision_id):
 
336
        # we could probe incrementally until the pending
 
337
        # ghosts list stop growing, but its cheaper for now
 
338
        # to just ask for the complete graph for each repository.
 
339
        graphs = []
 
340
        for source in self._revision_sources:
 
341
            ghost_graph = source.get_revision_graph_with_ghosts()
 
342
            graphs.append(ghost_graph)
 
343
        absent = 0
 
344
        for graph in graphs:
 
345
            if not revision_id in graph.get_ancestors():
 
346
                absent += 1
 
347
        if absent == len(graphs):
 
348
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
 
349
 
 
350
        # combine the graphs
 
351
        result = {}
 
352
        pending = set([revision_id])
 
353
        def find_parents(node_id):
 
354
            """find the parents for node_id."""
 
355
            for graph in graphs:
 
356
                ancestors = graph.get_ancestors()
 
357
                try:
 
358
                    return ancestors[node_id]
 
359
                except KeyError:
 
360
                    pass
 
361
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
362
        while len(pending):
 
363
            # all the graphs should have identical parent lists
 
364
            node_id = pending.pop()
 
365
            try:
 
366
                result[node_id] = find_parents(node_id)
 
367
                for parent_node in result[node_id]:
 
368
                    if not parent_node in result:
 
369
                        pending.add(parent_node)
 
370
            except errors.NoSuchRevision:
 
371
                # ghost, ignore it.
 
372
                pass
 
373
        return result
 
374
 
 
375
    def get_revision_graph_with_ghosts(self, revision_ids):
 
376
        # query all the sources for their entire graphs 
 
377
        # and then build a combined graph for just
 
378
        # revision_ids.
 
379
        graphs = []
 
380
        for source in self._revision_sources:
 
381
            ghost_graph = source.get_revision_graph_with_ghosts()
 
382
            graphs.append(ghost_graph.get_ancestors())
 
383
        for revision_id in revision_ids:
 
384
            absent = 0
 
385
            for graph in graphs:
 
386
                    if not revision_id in graph:
 
387
                        absent += 1
 
388
            if absent == len(graphs):
 
389
                raise errors.NoSuchRevision(self._revision_sources[0],
 
390
                                            revision_id)
 
391
 
 
392
        # combine the graphs
 
393
        result = Graph()
 
394
        pending = set(revision_ids)
 
395
        done = set()
 
396
        def find_parents(node_id):
 
397
            """find the parents for node_id."""
 
398
            for graph in graphs:
 
399
                try:
 
400
                    return graph[node_id]
 
401
                except KeyError:
 
402
                    pass
 
403
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
 
404
        while len(pending):
 
405
            # all the graphs should have identical parent lists
 
406
            node_id = pending.pop()
 
407
            try:
 
408
                parents = find_parents(node_id)
 
409
                for parent_node in parents:
 
410
                    # queued or done? 
 
411
                    if (parent_node not in pending and
 
412
                        parent_node not in done):
 
413
                        # no, queue
 
414
                        pending.add(parent_node)
 
415
                result.add_node(node_id, parents)
 
416
                done.add(node_id)
 
417
            except errors.NoSuchRevision:
 
418
                # ghost
 
419
                result.add_ghost(node_id)
 
420
                continue
 
421
        return result
 
422
 
 
423
    def lock_read(self):
 
424
        for source in self._revision_sources:
 
425
            source.lock_read()
 
426
 
 
427
    def unlock(self):
 
428
        for source in self._revision_sources:
 
429
            source.unlock()
 
430
 
 
431
 
218
432
def is_reserved_id(revision_id):
219
433
    """Determine whether a revision id is reserved
220
434
 
221
 
    :return: True if the revision is reserved, False otherwise
 
435
    :return: True if the revision is is reserved, False otherwise
222
436
    """
223
437
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
438
 
230
444
 
231
445
 
232
446
def ensure_null(revision_id):
233
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
447
    """Ensure only NULL_REVISION is used to represent the null revisionn"""
234
448
    if revision_id is None:
235
449
        symbol_versioning.warn('NULL_REVISION should be used for the null'
236
450
            ' revision instead of None, as of bzr 0.91.',