1
# Copyright (C) 2005 Aaron Bentley
2
# <aaron.bentley@utoronto.ca>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from bzrtools import short_committer
18
from dotgraph import Node, dot_output, invoke_dot, invoke_dot_aa, NoDot, NoRsvg
19
from dotgraph import RSVG_OUTPUT_TYPES, DOT_OUTPUT_TYPES, Edge, invoke_dot_html
20
from bzrlib.branch import Branch
21
from bzrlib.errors import BzrCommandError, NoCommonRoot, NoSuchRevision
22
from bzrlib.graph import node_distances, select_farthest
23
from bzrlib.revision import combined_graph, revision_graph
24
from bzrlib.revision import MultipleRevisionSources
30
mail_map = {'aaron.bentley@utoronto.ca' : 'Aaron Bentley',
31
'abentley@panoramicfeedback.com': 'Aaron Bentley',
32
'abentley@lappy' : 'Aaron Bentley',
33
'john@arbash-meinel.com' : 'John Arbash Meinel',
34
'mbp@sourcefrog.net' : 'Martin Pool',
35
'robertc@robertcollins.net' : 'Robert Collins',
38
committer_alias = {'abentley': 'Aaron Bentley'}
39
def can_skip(rev_id, descendants, ancestors):
40
if rev_id not in descendants:
42
elif rev_id not in ancestors:
44
elif len(ancestors[rev_id]) != 1:
46
elif len(descendants[list(ancestors[rev_id])[0]]) != 1:
48
elif len(descendants[rev_id]) != 1:
53
def compact_ancestors(descendants, ancestors, exceptions=()):
56
for me, my_parents in ancestors.iteritems():
59
new_ancestors[me] = {}
60
for parent in my_parents:
63
while can_skip(new_parent, descendants, ancestors):
64
if new_parent in exceptions:
67
if new_parent in new_ancestors:
68
del new_ancestors[new_parent]
69
new_parent = list(ancestors[new_parent])[0]
71
new_ancestors[me][new_parent] = distance
74
def get_rev_info(rev_id, source):
75
"""Return the committer, message, and date of a revision."""
80
return None, 'Null Revision', None, None
82
rev = source.get_revision(rev_id)
83
except NoSuchRevision:
85
committer = '-'.join(rev_id.split('-')[:-2]).strip(' ')
87
return None, None, None, None
89
return None, None, None, None
91
committer = short_committer(rev.committer)
92
if rev.message is not None:
93
message = rev.message.split('\n')[0]
94
gmtime = time.gmtime(rev.timestamp + (rev.timezone or 0))
95
date = time.strftime('%Y/%m/%d', gmtime)
96
nick = rev.properties.get('branch-nick')
99
committer = mail_map[committer]
103
committer = committer_alias[committer]
106
return committer, message, nick, date
108
class Grapher(object):
109
def __init__(self, branch, other_branch=None):
110
object.__init__(self)
112
self.other_branch = other_branch
113
revision_a = self.branch.last_revision()
114
if other_branch is not None:
115
branch.fetch(other_branch)
116
revision_b = self.other_branch.last_revision()
118
self.root, self.ancestors, self.descendants, self.common = \
119
combined_graph(revision_a, revision_b,
120
self.branch.repository)
121
except bzrlib.errors.NoCommonRoot:
122
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
124
self.root, self.ancestors, self.descendants = \
125
revision_graph(revision_a, branch.repository)
128
self.n_history = branch.revision_history()
129
self.distances = node_distances(self.descendants, self.ancestors,
131
if other_branch is not None:
132
self.base = select_farthest(self.distances, self.common)
133
self.m_history = other_branch.revision_history()
138
def dot_node(self, node, num):
140
n_rev = self.n_history.index(node) + 1
144
m_rev = self.m_history.index(node) + 1
147
if (n_rev, m_rev) == (None, None):
151
name = "rR%d" % n_rev
154
for prefix, revno in (('r', n_rev), ('R', m_rev)):
155
if revno is not None:
156
namelist.append("%s%d" % (prefix, revno))
157
name = ' '.join(namelist)
158
if None not in (n_rev, m_rev):
159
cluster = "common_history"
161
elif (None, None) == (n_rev, m_rev):
163
if node in self.common:
167
elif n_rev is not None:
168
cluster = "my_history"
171
assert m_rev is not None
172
cluster = "other_history"
174
if node == self.base:
178
committer, message, nick, date = get_rev_info(node,
179
self.branch.repository)
180
if committer is not None:
181
label.append(committer)
189
if node in self.distances:
190
rank = self.distances[node]
191
label.append('d%d' % self.distances[node])
195
d_node = Node("n%d" % num, color=color, label="\\n".join(label),
196
rev_id=node, cluster=cluster, message=message,
200
if node not in self.ancestors:
201
d_node.node_style.append('dotted')
205
def get_relations(self, collapse=False, max_distance=None):
210
visible_ancestors = compact_ancestors(self.descendants,
211
self.ancestors, (self.base,))
213
visible_ancestors = self.ancestors
214
if max_distance is not None:
215
min_distance = max(self.distances.values()) - max_distance
216
visible_ancestors = dict((n, p) for n, p in visible_ancestors.iteritems() if
217
self.distances[n] >= min_distance)
218
for node, parents in visible_ancestors.iteritems():
219
if node not in dot_nodes:
220
dot_nodes[node] = self.dot_node(node, num)
222
if visible_ancestors is self.ancestors:
223
parent_iter = ((f, 0) for f in parents)
225
parent_iter = (f for f in parents.iteritems())
226
for parent, skipped in parent_iter:
227
if parent not in dot_nodes:
228
dot_nodes[parent] = self.dot_node(parent, num)
230
edge = Edge(dot_nodes[parent], dot_nodes[node])
232
edge.label = "%d" % skipped
233
node_relations.append(edge)
234
return node_relations
237
def write_ancestry_file(branch, filename, collapse=True, antialias=True,
238
merge_branch=None, ranking="forced", max_distance=None):
239
b = Branch.open_containing(branch)[0]
240
if merge_branch is not None:
241
m = Branch.open_containing(merge_branch)[0]
249
grapher = Grapher(b, m)
250
relations = grapher.get_relations(collapse, max_distance)
257
ext = filename.split('.')[-1]
258
output = dot_output(relations, ranking)
260
if ext not in RSVG_OUTPUT_TYPES:
263
output = list(output)
265
invoke_dot_aa(output, filename, ext)
268
raise BzrCommandError("Can't find 'dot'. Please ensure Graphviz"\
269
" is installed correctly.")
271
print "Not antialiasing because rsvg (from librsvg-bin) is not"\
274
if ext in DOT_OUTPUT_TYPES and not antialias and not done:
276
invoke_dot(output, filename, ext)
279
raise BzrCommandError("Can't find 'dot'. Please ensure Graphviz"\
280
" is installed correctly, or use --noantialias")
281
elif ext == 'dot' and not done:
282
my_file = file(filename, 'wb')
283
for fragment in output:
284
my_file.write(fragment.encode('utf-8'))
287
invoke_dot_html(output, filename)
289
raise BzrCommandError("Can't find 'dot'. Please ensure Graphviz"\
290
" is installed correctly, or use --noantialias")
292
print "Unknown file extension: %s" % ext