← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Robert Collins
  • Date: 2006-03-07 12:39:38 UTC
  • mfrom: (1594 +trunk)
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060307123938-f75ff66ebcc0c4d0
Merge in bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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,
29
 
    )
 
21
import bzrlib.errors
 
22
import bzrlib.errors as errors
 
23
from bzrlib.graph import node_distances, select_farthest, all_descendants
30
24
from bzrlib.osutils import contains_whitespace
 
25
from bzrlib.progress import DummyProgress
31
26
 
32
27
NULL_REVISION="null:"
33
 
CURRENT_REVISION="current:"
34
 
 
35
28
 
36
29
class Revision(object):
37
30
    """Single revision on a branch.
47
40
 
48
41
    properties
49
42
        Dictionary of revision properties.  These are attached to the
50
 
        revision as extra metadata.  The name must be a single
 
43
        revision as extra metadata.  The name must be a single 
51
44
        word; the value can be an arbitrary string.
52
45
    """
53
 
 
 
46
    
54
47
    def __init__(self, revision_id, properties=None, **args):
55
48
        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
 
49
        self.properties = properties or {}
 
50
        self._check_properties()
62
51
        self.parent_ids = []
63
52
        self.parent_sha1s = []
64
 
        """Not used anymore - legacy from for 4."""
65
53
        self.__dict__.update(args)
66
54
 
67
55
    def __repr__(self):
70
58
    def __eq__(self, other):
71
59
        if not isinstance(other, Revision):
72
60
            return False
 
61
        # FIXME: rbc 20050930 parent_ids are not being compared
73
62
        return (
74
63
                self.inventory_sha1 == other.inventory_sha1
75
64
                and self.revision_id == other.revision_id
77
66
                and self.message == other.message
78
67
                and self.timezone == other.timezone
79
68
                and self.committer == other.committer
80
 
                and self.properties == other.properties
81
 
                and self.parent_ids == other.parent_ids)
 
69
                and self.properties == other.properties)
82
70
 
83
71
    def __ne__(self, other):
84
72
        return not self.__eq__(other)
85
73
 
86
74
    def _check_properties(self):
87
 
        """Verify that all revision properties are OK."""
 
75
        """Verify that all revision properties are OK.
 
76
        """
88
77
        for name, value in self.properties.iteritems():
89
78
            if not isinstance(name, basestring) or contains_whitespace(name):
90
79
                raise ValueError("invalid property name %r" % name)
91
80
            if not isinstance(value, basestring):
92
 
                raise ValueError("invalid property value %r for %r" %
93
 
                                 (value, name))
 
81
                raise ValueError("invalid property value %r for %r" % 
 
82
                                 (name, value))
94
83
 
95
84
    def get_history(self, repository):
96
85
        """Return the canonical line-of-history for this revision.
111
100
        reversed_result.reverse()
112
101
        return reversed_result
113
102
 
114
 
    def get_summary(self):
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
 
103
 
 
104
def is_ancestor(revision_id, candidate_id, branch):
 
105
    """Return true if candidate_id is an ancestor of revision_id.
 
106
 
 
107
    A false negative will be returned if any intermediate descendent of
 
108
    candidate_id is not present in any of the revision_sources.
 
109
    
 
110
    revisions_source is an object supporting a get_revision operation that
 
111
    behaves like Branch's.
 
112
    """
 
113
    return candidate_id in branch.repository.get_ancestry(revision_id)
169
114
 
170
115
 
171
116
def iter_ancestors(revision_id, revision_source, only_present=False):
178
123
                yield ancestor, distance
179
124
            try:
180
125
                revision = revision_source.get_revision(ancestor)
181
 
            except errors.NoSuchRevision, e:
 
126
            except bzrlib.errors.NoSuchRevision, e:
182
127
                if e.revision == revision_id:
183
 
                    raise
 
128
                    raise 
184
129
                else:
185
130
                    continue
186
131
            if only_present:
194
139
    """Return the ancestors of a revision present in a branch.
195
140
 
196
141
    It's possible that a branch won't have the complete ancestry of
197
 
    one of its revisions.
 
142
    one of its revisions.  
198
143
 
199
144
    """
200
145
    found_ancestors = {}
201
146
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
202
147
                         only_present=True))
203
148
    for anc_order, (anc_id, anc_distance) in anc_iter:
204
 
        if anc_id not in found_ancestors:
 
149
        if not found_ancestors.has_key(anc_id):
205
150
            found_ancestors[anc_id] = (anc_order, anc_distance)
206
151
    return found_ancestors
207
 
 
 
152
    
208
153
 
209
154
def __get_closest(intersection):
210
155
    intersection.sort()
211
 
    matches = []
 
156
    matches = [] 
212
157
    for entry in intersection:
213
158
        if entry[0] == intersection[0][0]:
214
159
            matches.append(entry[2])
215
160
    return matches
216
161
 
217
162
 
218
 
def is_reserved_id(revision_id):
219
 
    """Determine whether a revision id is reserved
220
 
 
221
 
    :return: True if the revision is reserved, False otherwise
222
 
    """
223
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
 
 
225
 
 
226
 
def check_not_reserved_id(revision_id):
227
 
    """Raise ReservedId if the supplied revision_id is reserved"""
228
 
    if is_reserved_id(revision_id):
229
 
        raise errors.ReservedId(revision_id)
230
 
 
231
 
 
232
 
def ensure_null(revision_id):
233
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
234
 
    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
 
        return NULL_REVISION
239
 
    else:
240
 
        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)
 
163
def revision_graph(revision, revision_source):
 
164
    """Produce a graph of the ancestry of the specified revision.
 
165
    
 
166
    :return: root, ancestors map, descendants map
 
167
    """
 
168
    revision_source.lock_read()
 
169
    try:
 
170
        return _revision_graph(revision, revision_source)
 
171
    finally:
 
172
        revision_source.unlock()
 
173
 
 
174
 
 
175
def _revision_graph(revision, revision_source):
 
176
    """See revision_graph."""
 
177
    from bzrlib.tsort import topo_sort
 
178
    graph = revision_source.get_revision_graph(revision)
 
179
    # mark all no-parent revisions as being NULL_REVISION parentage.
 
180
    for node, parents in graph.items():
 
181
        if len(parents) == 0:
 
182
            graph[node] = [NULL_REVISION]
 
183
    # add NULL_REVISION to the graph
 
184
    graph[NULL_REVISION] = []
 
185
 
 
186
    # pick a root. If there are multiple roots
 
187
    # this could pick a random one.
 
188
    topo_order = topo_sort(graph.items())
 
189
    root = topo_order[0]
 
190
 
 
191
    ancestors = {}
 
192
    descendants = {}
 
193
 
 
194
    # map the descendants of the graph.
 
195
    # and setup our set based return graph.
 
196
    for node in graph.keys():
 
197
        descendants[node] = {}
 
198
    for node, parents in graph.items():
 
199
        for parent in parents:
 
200
            descendants[parent][node] = 1
 
201
        ancestors[node] = set(parents)
 
202
 
 
203
    assert root not in descendants[root]
 
204
    assert root not in ancestors[root]
 
205
    return root, ancestors, descendants
 
206
 
 
207
 
 
208
def combined_graph(revision_a, revision_b, revision_source):
 
209
    """Produce a combined ancestry graph.
 
210
    Return graph root, ancestors map, descendants map, set of common nodes"""
 
211
    root, ancestors, descendants = revision_graph(
 
212
        revision_a, revision_source)
 
213
    root_b, ancestors_b, descendants_b = revision_graph(
 
214
        revision_b, revision_source)
 
215
    if root != root_b:
 
216
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
 
217
    common = set()
 
218
    for node, node_anc in ancestors_b.iteritems():
 
219
        if node in ancestors:
 
220
            common.add(node)
 
221
        else:
 
222
            ancestors[node] = set()
 
223
        ancestors[node].update(node_anc)
 
224
    for node, node_dec in descendants_b.iteritems():
 
225
        if node not in descendants:
 
226
            descendants[node] = {}
 
227
        descendants[node].update(node_dec)
 
228
    return root, ancestors, descendants, common
 
229
 
 
230
 
 
231
def common_ancestor(revision_a, revision_b, revision_source, 
 
232
                    pb=DummyProgress()):
 
233
    if None in (revision_a, revision_b):
 
234
        return None
 
235
    try:
 
236
        try:
 
237
            pb.update('Picking ancestor', 1, 3)
 
238
            root, ancestors, descendants, common = \
 
239
                combined_graph(revision_a,
 
240
                               revision_b,
 
241
                               revision_source)
 
242
        except bzrlib.errors.NoCommonRoot:
 
243
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
244
            
 
245
        pb.update('Picking ancestor', 2, 3)
 
246
        distances = node_distances (descendants, ancestors, root)
 
247
        pb.update('Picking ancestor', 3, 2)
 
248
        farthest = select_farthest(distances, common)
 
249
        if farthest is None or farthest == NULL_REVISION:
 
250
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
 
251
    finally:
 
252
        pb.clear()
 
253
    return farthest
 
254
 
 
255
 
 
256
class MultipleRevisionSources(object):
 
257
    """Proxy that looks in multiple branches for revisions."""
 
258
    def __init__(self, *args):
 
259
        object.__init__(self)
 
260
        assert len(args) != 0
 
261
        self._revision_sources = args
 
262
 
 
263
    def revision_parents(self, revision_id):
 
264
        for source in self._revision_sources:
 
265
            try:
 
266
                return source.revision_parents(revision_id)
 
267
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
268
                pass
 
269
        raise e
 
270
 
 
271
    def get_revision(self, revision_id):
 
272
        for source in self._revision_sources:
 
273
            try:
 
274
                return source.get_revision(revision_id)
 
275
            except bzrlib.errors.NoSuchRevision, e:
 
276
                pass
 
277
        raise e
 
278
 
 
279
    def get_revision_graph(self, revision_id):
 
280
        result = {}
 
281
        for source in self._revision_sources:
 
282
            try:
 
283
                result.update(source.get_revision_graph(revision_id))
 
284
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
 
285
                pass
 
286
        if result:
 
287
            return result
 
288
        raise e
 
289
 
 
290
    def lock_read(self):
 
291
        for source in self._revision_sources:
 
292
            source.lock_read()
 
293
 
 
294
    def unlock(self):
 
295
        for source in self._revision_sources:
 
296
            source.unlock()
 
297
 
 
298
 
 
299
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
 
300
                              revision_history=None):
 
301
    """Find the longest line of descent from maybe_ancestor to revision.
 
302
    Revision history is followed where possible.
 
303
 
 
304
    If ancestor_id == rev_id, list will be empty.
 
305
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
 
306
    If ancestor_id is not an ancestor, NotAncestor will be thrown
 
307
    """
 
308
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
 
309
    if len(descendants) == 0:
 
310
        raise NoSuchRevision(rev_source, rev_id)
 
311
    if ancestor_id not in descendants:
 
312
        rev_source.get_revision(ancestor_id)
 
313
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
314
    root_descendants = all_descendants(descendants, ancestor_id)
 
315
    root_descendants.add(ancestor_id)
 
316
    if rev_id not in root_descendants:
 
317
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
 
318
    distances = node_distances(descendants, ancestors, ancestor_id,
 
319
                               root_descendants=root_descendants)
 
320
 
 
321
    def best_ancestor(rev_id):
 
322
        best = None
 
323
        for anc_id in ancestors[rev_id]:
 
324
            try:
 
325
                distance = distances[anc_id]
 
326
            except KeyError:
 
327
                continue
 
328
            if revision_history is not None and anc_id in revision_history:
 
329
                return anc_id
 
330
            elif best is None or distance > best[1]:
 
331
                best = (anc_id, distance)
 
332
        return best[0]
 
333
 
 
334
    next = rev_id
 
335
    path = []
 
336
    while next != ancestor_id:
 
337
        path.append(next)
 
338
        next = best_ancestor(next)
 
339
    path.reverse()
 
340
    return path