1
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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.
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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.
21
from bzrlib.graph import node_distances, select_farthest, all_descendants
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
24
from bzrlib import bugtracker
22
30
from bzrlib.osutils import contains_whitespace
23
31
from bzrlib.progress import DummyProgress
25
33
NULL_REVISION="null:"
34
CURRENT_REVISION="current:"
27
37
class Revision(object):
28
38
"""Single revision on a branch.
98
109
reversed_result.reverse()
99
110
return reversed_result
102
def is_ancestor(revision_id, candidate_id, branch):
103
"""Return true if candidate_id is an ancestor of revision_id.
105
A false negative will be returned if any intermediate descendent of
106
candidate_id is not present in any of the revision_sources.
108
revisions_source is an object supporting a get_revision operation that
109
behaves like Branch's.
111
return candidate_id in branch.repository.get_ancestry(revision_id)
112
def get_summary(self):
113
"""Get the first line of the log message for this revision.
115
Return an empty string if message is None.
118
return self.message.lstrip().split('\n', 1)[0]
122
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
123
def get_apparent_author(self):
124
"""Return the apparent author of this revision.
126
This method is deprecated in favour of get_apparent_authors.
128
If the revision properties contain any author names,
129
return the first. Otherwise return the committer name.
131
authors = self.get_apparent_authors()
137
def get_apparent_authors(self):
138
"""Return the apparent authors of this revision.
140
If the revision properties contain the names of the authors,
141
return them. Otherwise return the committer name.
143
The return value will be a list containing at least one element.
145
authors = self.properties.get('authors', None)
147
author = self.properties.get('author', self.committer)
152
return authors.split("\n")
155
"""Iterate over the bugs associated with this revision."""
156
bug_property = self.properties.get('bugs', None)
157
if bug_property is None:
159
for line in bug_property.splitlines():
161
url, status = line.split(None, 2)
163
raise errors.InvalidLineInBugsProperty(line)
164
if status not in bugtracker.ALLOWED_BUG_STATUSES:
165
raise errors.InvalidBugStatus(status)
114
169
def iter_ancestors(revision_id, revision_source, only_present=False):
137
192
"""Return the ancestors of a revision present in a branch.
139
194
It's possible that a branch won't have the complete ancestry of
140
one of its revisions.
195
one of its revisions.
143
198
found_ancestors = {}
144
199
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
145
200
only_present=True))
146
201
for anc_order, (anc_id, anc_distance) in anc_iter:
147
if not found_ancestors.has_key(anc_id):
202
if anc_id not in found_ancestors:
148
203
found_ancestors[anc_id] = (anc_order, anc_distance)
149
204
return found_ancestors
152
207
def __get_closest(intersection):
153
208
intersection.sort()
155
210
for entry in intersection:
156
211
if entry[0] == intersection[0][0]:
157
212
matches.append(entry[2])
161
def old_common_ancestor(revision_a, revision_b, revision_source):
162
"""Find the ancestor common to both revisions that is closest to both.
216
def is_reserved_id(revision_id):
217
"""Determine whether a revision id is reserved
219
:return: True if the revision is reserved, False otherwise
164
from bzrlib.trace import mutter
165
a_ancestors = find_present_ancestors(revision_a, revision_source)
166
b_ancestors = find_present_ancestors(revision_b, revision_source)
169
# a_order is used as a tie-breaker when two equally-good bases are found
170
for revision, (a_order, a_distance) in a_ancestors.iteritems():
171
if b_ancestors.has_key(revision):
172
a_intersection.append((a_distance, a_order, revision))
173
b_intersection.append((b_ancestors[revision][1], a_order, revision))
174
mutter("a intersection: %r", a_intersection)
175
mutter("b intersection: %r", b_intersection)
177
a_closest = __get_closest(a_intersection)
178
if len(a_closest) == 0:
180
b_closest = __get_closest(b_intersection)
181
assert len(b_closest) != 0
182
mutter ("a_closest %r", a_closest)
183
mutter ("b_closest %r", b_closest)
184
if a_closest[0] in b_closest:
186
elif b_closest[0] in a_closest:
221
return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
def check_not_reserved_id(revision_id):
225
"""Raise ReservedId if the supplied revision_id is reserved"""
226
if is_reserved_id(revision_id):
227
raise errors.ReservedId(revision_id)
230
def ensure_null(revision_id):
231
"""Ensure only NULL_REVISION is used to represent the null revision"""
232
if revision_id is None:
233
symbol_versioning.warn('NULL_REVISION should be used for the null'
234
' revision instead of None, as of bzr 0.91.',
235
DeprecationWarning, stacklevel=2)
189
raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
192
def revision_graph(revision, revision_source):
193
"""Produce a graph of the ancestry of the specified revision.
194
Return root, ancestors map, descendants map
196
TODO: Produce graphs with the NULL revision as root, so that we can find
197
a common even when trees are not branches don't represent a single line
199
RBC: 20051024: note that when we have two partial histories, this may not
200
be possible. But if we are willing to pretend :)... sure.
206
descendants[revision] = {}
207
while len(lines) > 0:
210
if line == NULL_REVISION:
215
rev = revision_source.get_revision(line)
216
parents = list(rev.parent_ids)
217
if len(parents) == 0:
218
parents = [NULL_REVISION]
219
except bzrlib.errors.NoSuchRevision:
223
if parents is not None:
224
for parent in parents:
225
if parent not in ancestors:
226
new_lines.add(parent)
227
if parent not in descendants:
228
descendants[parent] = {}
229
descendants[parent][line] = 1
230
if parents is not None:
231
ancestors[line] = set(parents)
234
# The history for revision becomes inaccessible without
235
# actually hitting a no-parents revision. This then
236
# makes these asserts below trigger. So, if root is None
237
# determine the actual root by walking the accessible tree
238
# and then stash NULL_REVISION at the end.
240
descendants[root] = {}
241
# for every revision, check we can access at least
242
# one parent, if we cant, add NULL_REVISION and
244
for rev in ancestors:
245
if len(ancestors[rev]) == 0:
246
raise RuntimeError('unreachable code ?!')
248
for parent in ancestors[rev]:
249
if parent in ancestors:
253
descendants[root][rev] = 1
254
ancestors[rev].add(root)
255
ancestors[root] = set()
256
assert root not in descendants[root]
257
assert root not in ancestors[root]
258
return root, ancestors, descendants
261
def combined_graph(revision_a, revision_b, revision_source):
262
"""Produce a combined ancestry graph.
263
Return graph root, ancestors map, descendants map, set of common nodes"""
264
root, ancestors, descendants = revision_graph(revision_a, revision_source)
265
root_b, ancestors_b, descendants_b = revision_graph(revision_b,
268
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
270
for node, node_anc in ancestors_b.iteritems():
271
if node in ancestors:
274
ancestors[node] = set()
275
ancestors[node].update(node_anc)
276
for node, node_dec in descendants_b.iteritems():
277
if node not in descendants:
278
descendants[node] = {}
279
descendants[node].update(node_dec)
280
return root, ancestors, descendants, common
283
def common_ancestor(revision_a, revision_b, revision_source,
287
pb.update('Picking ancestor', 1, 3)
288
root, ancestors, descendants, common = \
289
combined_graph(revision_a, revision_b, revision_source)
290
except bzrlib.errors.NoCommonRoot:
291
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
293
pb.update('Picking ancestor', 2, 3)
294
distances = node_distances (descendants, ancestors, root)
295
pb.update('Picking ancestor', 3, 2)
296
farthest = select_farthest(distances, common)
297
if farthest is None or farthest == NULL_REVISION:
298
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
304
class MultipleRevisionSources(object):
305
"""Proxy that looks in multiple branches for revisions."""
306
def __init__(self, *args):
307
object.__init__(self)
308
assert len(args) != 0
309
self._revision_sources = args
311
def get_revision(self, revision_id):
312
for source in self._revision_sources:
314
return source.get_revision(revision_id)
315
except bzrlib.errors.NoSuchRevision, e:
319
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
320
revision_history=None):
321
"""Find the longest line of descent from maybe_ancestor to revision.
322
Revision history is followed where possible.
324
If ancestor_id == rev_id, list will be empty.
325
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
326
If ancestor_id is not an ancestor, NotAncestor will be thrown
328
root, ancestors, descendants = revision_graph(rev_id, rev_source)
329
if len(descendants) == 0:
330
raise NoSuchRevision(rev_source, rev_id)
331
if ancestor_id not in descendants:
332
rev_source.get_revision(ancestor_id)
333
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
334
root_descendants = all_descendants(descendants, ancestor_id)
335
root_descendants.add(ancestor_id)
336
if rev_id not in root_descendants:
337
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
338
distances = node_distances(descendants, ancestors, ancestor_id,
339
root_descendants=root_descendants)
341
def best_ancestor(rev_id):
343
for anc_id in ancestors[rev_id]:
345
distance = distances[anc_id]
348
if revision_history is not None and anc_id in revision_history:
350
elif best is None or distance > best[1]:
351
best = (anc_id, distance)
356
while next != ancestor_id:
358
next = best_ancestor(next)
241
def is_null(revision_id):
242
if revision_id is None:
243
symbol_versioning.warn('NULL_REVISION should be used for the null'
244
' revision instead of None, as of bzr 0.90.',
245
DeprecationWarning, stacklevel=2)
246
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
