← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# (C) 2005 Canonical
2
 
 
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
# TODO: Some kind of command-line display of revision properties: 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
# TODO: Some kind of command-line display of revision properties:
18
20
# perhaps show them in log -v and allow them as options to the commit command.
19
21
 
20
 
import bzrlib.errors
21
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
 
22
 
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
from bzrlib import bugtracker
 
26
""")
 
27
from bzrlib import (
 
28
    errors,
 
29
    symbol_versioning,
 
30
    )
22
31
from bzrlib.osutils import contains_whitespace
23
32
 
24
33
NULL_REVISION="null:"
 
34
CURRENT_REVISION="current:"
 
35
 
25
36
 
26
37
class Revision(object):
27
38
    """Single revision on a branch.
37
48
 
38
49
    properties
39
50
        Dictionary of revision properties.  These are attached to the
40
 
        revision as extra metadata.  The name must be a single 
 
51
        revision as extra metadata.  The name must be a single
41
52
        word; the value can be an arbitrary string.
42
53
    """
43
 
    
 
54
 
44
55
    def __init__(self, revision_id, properties=None, **args):
45
56
        self.revision_id = revision_id
46
 
        self.properties = properties or {}
47
 
        self._check_properties()
48
 
        self.__dict__.update(args)
 
57
        if properties is None:
 
58
            self.properties = {}
 
59
        else:
 
60
            self.properties = properties
 
61
            self._check_properties()
 
62
        self.committer = None
49
63
        self.parent_ids = []
50
64
        self.parent_sha1s = []
 
65
        """Not used anymore - legacy from for 4."""
 
66
        self.__dict__.update(args)
51
67
 
52
68
    def __repr__(self):
53
69
        return "<Revision id %s>" % self.revision_id
55
71
    def __eq__(self, other):
56
72
        if not isinstance(other, Revision):
57
73
            return False
58
 
        # FIXME: rbc 20050930 parent_ids are not being compared
59
74
        return (
60
75
                self.inventory_sha1 == other.inventory_sha1
61
76
                and self.revision_id == other.revision_id
63
78
                and self.message == other.message
64
79
                and self.timezone == other.timezone
65
80
                and self.committer == other.committer
66
 
                and self.properties == other.properties)
 
81
                and self.properties == other.properties
 
82
                and self.parent_ids == other.parent_ids)
67
83
 
68
84
    def __ne__(self, other):
69
85
        return not self.__eq__(other)
70
86
 
71
87
    def _check_properties(self):
72
 
        """Verify that all revision properties are OK.
73
 
        """
 
88
        """Verify that all revision properties are OK."""
74
89
        for name, value in self.properties.iteritems():
75
90
            if not isinstance(name, basestring) or contains_whitespace(name):
76
91
                raise ValueError("invalid property name %r" % name)
77
92
            if not isinstance(value, basestring):
78
 
                raise ValueError("invalid property value %r for %r" % 
79
 
                                 (name, value))
80
 
 
81
 
 
82
 
def is_ancestor(revision_id, candidate_id, branch):
83
 
    """Return true if candidate_id is an ancestor of revision_id.
84
 
 
85
 
    A false negative will be returned if any intermediate descendent of
86
 
    candidate_id is not present in any of the revision_sources.
87
 
    
88
 
    revisions_source is an object supporting a get_revision operation that
89
 
    behaves like Branch's.
90
 
    """
91
 
    return candidate_id in branch.get_ancestry(revision_id)
 
93
                raise ValueError("invalid property value %r for %r" %
 
94
                                 (value, name))
 
95
 
 
96
    def get_history(self, repository):
 
97
        """Return the canonical line-of-history for this revision.
 
98
 
 
99
        If ghosts are present this may differ in result from a ghost-free
 
100
        repository.
 
101
        """
 
102
        current_revision = self
 
103
        reversed_result = []
 
104
        while current_revision is not None:
 
105
            reversed_result.append(current_revision.revision_id)
 
106
            if not len (current_revision.parent_ids):
 
107
                reversed_result.append(None)
 
108
                current_revision = None
 
109
            else:
 
110
                next_revision_id = current_revision.parent_ids[0]
 
111
                current_revision = repository.get_revision(next_revision_id)
 
112
        reversed_result.reverse()
 
113
        return reversed_result
 
114
 
 
115
    def get_summary(self):
 
116
        """Get the first line of the log message for this revision.
 
117
 
 
118
        Return an empty string if message is None.
 
119
        """
 
120
        if self.message:
 
121
            return self.message.lstrip().split('\n', 1)[0]
 
122
        else:
 
123
            return ''
 
124
 
 
125
    def get_apparent_authors(self):
 
126
        """Return the apparent authors of this revision.
 
127
 
 
128
        If the revision properties contain the names of the authors,
 
129
        return them. Otherwise return the committer name.
 
130
 
 
131
        The return value will be a list containing at least one element.
 
132
        """
 
133
        authors = self.properties.get('authors', None)
 
134
        if authors is None:
 
135
            author = self.properties.get('author', self.committer)
 
136
            if author is None:
 
137
                return []
 
138
            return [author]
 
139
        else:
 
140
            return authors.split("\n")
 
141
 
 
142
    def iter_bugs(self):
 
143
        """Iterate over the bugs associated with this revision."""
 
144
        bug_property = self.properties.get('bugs', None)
 
145
        if bug_property is None:
 
146
            return
 
147
        for line in bug_property.splitlines():
 
148
            try:
 
149
                url, status = line.split(None, 2)
 
150
            except ValueError:
 
151
                raise errors.InvalidLineInBugsProperty(line)
 
152
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
 
153
                raise errors.InvalidBugStatus(status)
 
154
            yield url, status
92
155
 
93
156
 
94
157
def iter_ancestors(revision_id, revision_source, only_present=False):
101
164
                yield ancestor, distance
102
165
            try:
103
166
                revision = revision_source.get_revision(ancestor)
104
 
            except bzrlib.errors.NoSuchRevision, e:
 
167
            except errors.NoSuchRevision, e:
105
168
                if e.revision == revision_id:
106
 
                    raise 
 
169
                    raise
107
170
                else:
108
171
                    continue
109
172
            if only_present:
117
180
    """Return the ancestors of a revision present in a branch.
118
181
 
119
182
    It's possible that a branch won't have the complete ancestry of
120
 
    one of its revisions.  
 
183
    one of its revisions.
121
184
 
122
185
    """
123
186
    found_ancestors = {}
124
187
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
125
188
                         only_present=True))
126
189
    for anc_order, (anc_id, anc_distance) in anc_iter:
127
 
        if not found_ancestors.has_key(anc_id):
 
190
        if anc_id not in found_ancestors:
128
191
            found_ancestors[anc_id] = (anc_order, anc_distance)
129
192
    return found_ancestors
130
 
    
 
193
 
131
194
 
132
195
def __get_closest(intersection):
133
196
    intersection.sort()
134
 
    matches = [] 
 
197
    matches = []
135
198
    for entry in intersection:
136
199
        if entry[0] == intersection[0][0]:
137
200
            matches.append(entry[2])
138
201
    return matches
139
202
 
140
203
 
141
 
def old_common_ancestor(revision_a, revision_b, revision_source):
142
 
    """Find the ancestor common to both revisions that is closest to both.
 
204
def is_reserved_id(revision_id):
 
205
    """Determine whether a revision id is reserved
 
206
 
 
207
    :return: True if the revision is reserved, False otherwise
143
208
    """
144
 
    from bzrlib.trace import mutter
145
 
    a_ancestors = find_present_ancestors(revision_a, revision_source)
146
 
    b_ancestors = find_present_ancestors(revision_b, revision_source)
147
 
    a_intersection = []
148
 
    b_intersection = []
149
 
    # a_order is used as a tie-breaker when two equally-good bases are found
150
 
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
151
 
        if b_ancestors.has_key(revision):
152
 
            a_intersection.append((a_distance, a_order, revision))
153
 
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
154
 
    mutter("a intersection: %r" % a_intersection)
155
 
    mutter("b intersection: %r" % b_intersection)
156
 
 
157
 
    a_closest = __get_closest(a_intersection)
158
 
    if len(a_closest) == 0:
159
 
        return None
160
 
    b_closest = __get_closest(b_intersection)
161
 
    assert len(b_closest) != 0
162
 
    mutter ("a_closest %r" % a_closest)
163
 
    mutter ("b_closest %r" % b_closest)
164
 
    if a_closest[0] in b_closest:
165
 
        return a_closest[0]
166
 
    elif b_closest[0] in a_closest:
167
 
        return b_closest[0]
 
209
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
 
210
 
 
211
 
 
212
def check_not_reserved_id(revision_id):
 
213
    """Raise ReservedId if the supplied revision_id is reserved"""
 
214
    if is_reserved_id(revision_id):
 
215
        raise errors.ReservedId(revision_id)
 
216
 
 
217
 
 
218
def ensure_null(revision_id):
 
219
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
220
    if revision_id is None:
 
221
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
222
            ' revision instead of None, as of bzr 0.91.',
 
223
            DeprecationWarning, stacklevel=2)
 
224
        return NULL_REVISION
168
225
    else:
169
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
170
 
    return a_closest[0]
171
 
 
172
 
def revision_graph(revision, revision_source):
173
 
    """Produce a graph of the ancestry of the specified revision.
174
 
    Return root, ancestors map, descendants map
175
 
 
176
 
    TODO: Produce graphs with the NULL revision as root, so that we can find
177
 
    a common even when trees are not branches don't represent a single line
178
 
    of descent.
179
 
    """
180
 
    ancestors = {}
181
 
    descendants = {}
182
 
    lines = [revision]
183
 
    root = None
184
 
    descendants[revision] = {}
185
 
    while len(lines) > 0:
186
 
        new_lines = set()
187
 
        for line in lines:
188
 
            if line == NULL_REVISION:
189
 
                parents = []
190
 
                root = NULL_REVISION
191
 
            else:
192
 
                try:
193
 
                    rev = revision_source.get_revision(line)
194
 
                    parents = list(rev.parent_ids)
195
 
                    if len(parents) == 0:
196
 
                        parents = [NULL_REVISION]
197
 
                except bzrlib.errors.NoSuchRevision:
198
 
                    if line == revision:
199
 
                        raise
200
 
                    parents = None
201
 
            if parents is not None:
202
 
                for parent in parents:
203
 
                    if parent not in ancestors:
204
 
                        new_lines.add(parent)
205
 
                    if parent not in descendants:
206
 
                        descendants[parent] = {}
207
 
                    descendants[parent][line] = 1
208
 
            if parents is not None:
209
 
                ancestors[line] = set(parents)
210
 
        lines = new_lines
211
 
    assert root not in descendants[root]
212
 
    assert root not in ancestors[root]
213
 
    return root, ancestors, descendants
214
 
 
215
 
 
216
 
def combined_graph(revision_a, revision_b, revision_source):
217
 
    """Produce a combined ancestry graph.
218
 
    Return graph root, ancestors map, descendants map, set of common nodes"""
219
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
220
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
221
 
                                                        revision_source)
222
 
    if root != root_b:
223
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
224
 
    common = set()
225
 
    for node, node_anc in ancestors_b.iteritems():
226
 
        if node in ancestors:
227
 
            common.add(node)
228
 
        else:
229
 
            ancestors[node] = set()
230
 
        ancestors[node].update(node_anc)
231
 
    for node, node_dec in descendants_b.iteritems():
232
 
        if node not in descendants:
233
 
            descendants[node] = {}
234
 
        descendants[node].update(node_dec)
235
 
    return root, ancestors, descendants, common
236
 
 
237
 
 
238
 
def common_ancestor(revision_a, revision_b, revision_source):
239
 
    try:
240
 
        root, ancestors, descendants, common = \
241
 
            combined_graph(revision_a, revision_b, revision_source)
242
 
    except bzrlib.errors.NoCommonRoot:
243
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
244
 
        
245
 
    distances = node_distances (descendants, ancestors, root)
246
 
    farthest = select_farthest(distances, common)
247
 
    if farthest is None or farthest == NULL_REVISION:
248
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
249
 
    return farthest
250
 
 
251
 
 
252
 
class MultipleRevisionSources(object):
253
 
    """Proxy that looks in multiple branches for revisions."""
254
 
    def __init__(self, *args):
255
 
        object.__init__(self)
256
 
        assert len(args) != 0
257
 
        self._revision_sources = args
258
 
 
259
 
    def get_revision(self, revision_id):
260
 
        for source in self._revision_sources:
261
 
            try:
262
 
                return source.get_revision(revision_id)
263
 
            except bzrlib.errors.NoSuchRevision, e:
264
 
                pass
265
 
        raise e
266
 
 
267
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
268
 
                              revision_history=None):
269
 
    """Find the longest line of descent from maybe_ancestor to revision.
270
 
    Revision history is followed where possible.
271
 
 
272
 
    If ancestor_id == rev_id, list will be empty.
273
 
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
274
 
    If ancestor_id is not an ancestor, NotAncestor will be thrown
275
 
    """
276
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
277
 
    if len(descendants) == 0:
278
 
        raise NoSuchRevision(rev_source, rev_id)
279
 
    if ancestor_id not in descendants:
280
 
        rev_source.get_revision(ancestor_id)
281
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
282
 
    root_descendants = all_descendants(descendants, ancestor_id)
283
 
    root_descendants.add(ancestor_id)
284
 
    if rev_id not in root_descendants:
285
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
286
 
    distances = node_distances(descendants, ancestors, ancestor_id,
287
 
                               root_descendants=root_descendants)
288
 
 
289
 
    def best_ancestor(rev_id):
290
 
        best = None
291
 
        for anc_id in ancestors[rev_id]:
292
 
            try:
293
 
                distance = distances[anc_id]
294
 
            except KeyError:
295
 
                continue
296
 
            if revision_history is not None and anc_id in revision_history:
297
 
                return anc_id
298
 
            elif best is None or distance > best[1]:
299
 
                best = (anc_id, distance)
300
 
        return best[0]
301
 
 
302
 
    next = rev_id
303
 
    path = []
304
 
    while next != ancestor_id:
305
 
        path.append(next)
306
 
        next = best_ancestor(next)
307
 
    path.reverse()
308
 
    return path
 
226
        return revision_id
 
227
 
 
228
 
 
229
def is_null(revision_id):
 
230
    if revision_id is None:
 
231
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
232
            ' revision instead of None, as of bzr 0.90.',
 
233
            DeprecationWarning, stacklevel=2)
 
234
    return revision_id in (None, NULL_REVISION)