~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to graph.py

  • Committer: Jeff Bailey
  • Date: 2005-06-08 22:30:34 UTC
  • Revision ID: jbailey@ppc64-20050608223034-3cbc9567103c4810
Add Debian directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Aaron Bentley
2
 
# <aaron.bentley@utoronto.ca>
3
 
#
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.
8
 
#
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.
13
 
#
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.fetch import greedy_fetch
23
 
from bzrlib.graph import node_distances, select_farthest
24
 
from bzrlib.revision import combined_graph, revision_graph
25
 
from bzrlib.revision import MultipleRevisionSources
26
 
import bzrlib.errors
27
 
import re
28
 
import os.path
29
 
import time
30
 
 
31
 
mail_map = {'aaron.bentley@utoronto.ca'     : 'Aaron Bentley',
32
 
            'abentley@panoramicfeedback.com': 'Aaron Bentley',
33
 
            'abentley@lappy'                : 'Aaron Bentley',
34
 
            'john@arbash-meinel.com'        : 'John Arbash Meinel',
35
 
            'mbp@sourcefrog.net'            : 'Martin Pool',
36
 
            'robertc@robertcollins.net'     : 'Robert Collins',
37
 
            }
38
 
 
39
 
committer_alias = {'abentley': 'Aaron Bentley'}
40
 
def can_skip(rev_id, descendants, ancestors):
41
 
    if rev_id not in descendants:
42
 
        return False
43
 
    elif rev_id not in ancestors:
44
 
        return False
45
 
    elif len(ancestors[rev_id]) != 1:
46
 
        return False
47
 
    elif len(descendants[list(ancestors[rev_id])[0]]) != 1:
48
 
        return False
49
 
    elif len(descendants[rev_id]) != 1:
50
 
        return False
51
 
    else:
52
 
        return True
53
 
 
54
 
def compact_ancestors(descendants, ancestors, exceptions=()):
55
 
    new_ancestors={}
56
 
    skip = set()
57
 
    for me, my_parents in ancestors.iteritems():
58
 
        if me in skip:
59
 
            continue
60
 
        new_ancestors[me] = {} 
61
 
        for parent in my_parents:
62
 
            new_parent = parent 
63
 
            distance = 0
64
 
            while can_skip(new_parent, descendants, ancestors):
65
 
                if new_parent in exceptions:
66
 
                    break
67
 
                skip.add(new_parent)
68
 
                if new_parent in new_ancestors:
69
 
                    del new_ancestors[new_parent]
70
 
                new_parent = list(ancestors[new_parent])[0]
71
 
                distance += 1
72
 
            new_ancestors[me][new_parent] = distance
73
 
    return new_ancestors    
74
 
 
75
 
def get_rev_info(rev_id, source):
76
 
    """Return the committer, message, and date of a revision."""
77
 
    committer = None
78
 
    message = None
79
 
    date = None
80
 
    if rev_id == 'null:':
81
 
        return None, 'Null Revision', None
82
 
    try:
83
 
        rev = source.get_revision(rev_id)
84
 
    except NoSuchRevision:
85
 
        try:
86
 
            committer = '-'.join(rev_id.split('-')[:-2]).strip(' ')
87
 
            if committer == '':
88
 
                return None, None, None
89
 
        except ValueError:
90
 
            return None, None, None
91
 
    else:
92
 
        committer = short_committer(rev.committer)
93
 
        if rev.message is not None:
94
 
            message = rev.message.split('\n')[0]
95
 
        gmtime = time.gmtime(rev.timestamp + (rev.timezone or 0))
96
 
        date = time.strftime('%Y/%m/%d', gmtime)
97
 
    if '@' in committer:
98
 
        try:
99
 
            committer = mail_map[committer]
100
 
        except KeyError:
101
 
            pass
102
 
    try:
103
 
        committer = committer_alias[committer]
104
 
    except KeyError:
105
 
        pass
106
 
    return committer, message, date
107
 
 
108
 
class Grapher(object):
109
 
    def __init__(self, branch, other_branch=None):
110
 
        object.__init__(self)
111
 
        self.branch = branch
112
 
        self.other_branch = other_branch
113
 
        revision_a = self.branch.last_revision()
114
 
        if other_branch is not None:
115
 
            greedy_fetch(branch, other_branch)
116
 
            revision_b = self.other_branch.last_revision()
117
 
            try:
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)
123
 
        else:
124
 
            self.root, self.ancestors, self.descendants = \
125
 
                revision_graph(revision_a, branch.repository)
126
 
            self.common = []
127
 
 
128
 
        self.n_history = branch.revision_history()
129
 
        self.distances = node_distances(self.descendants, self.ancestors, 
130
 
                                        self.root)
131
 
        if other_branch is not None:
132
 
            self.base = select_farthest(self.distances, self.common)
133
 
            self.m_history = other_branch.revision_history() 
134
 
        else:
135
 
            self.base = None
136
 
            self.m_history = []
137
 
 
138
 
    def dot_node(self, node, num):
139
 
        try:
140
 
            n_rev = self.n_history.index(node) + 1
141
 
        except ValueError:
142
 
            n_rev = None
143
 
        try:
144
 
            m_rev = self.m_history.index(node) + 1
145
 
        except ValueError:
146
 
            m_rev = None
147
 
        if (n_rev, m_rev) == (None, None):
148
 
            name = node[-5:]
149
 
            cluster = None
150
 
        elif n_rev == m_rev:
151
 
            name = "rR%d" % n_rev
152
 
        else:
153
 
            namelist = []
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"
160
 
            color = "#ff9900"
161
 
        elif (None, None) == (n_rev, m_rev):
162
 
            cluster = None
163
 
            if node in self.common:
164
 
                color = "#6699ff"
165
 
            else:
166
 
                color = "white"
167
 
        elif n_rev is not None:
168
 
            cluster = "my_history"
169
 
            color = "#ffff00"
170
 
        else:
171
 
            assert m_rev is not None
172
 
            cluster = "other_history"
173
 
            color = "#ff0000"
174
 
        if node == self.base:
175
 
            color = "#33ff99"
176
 
 
177
 
        label = [name]
178
 
        committer, message, date = get_rev_info(node, self.branch.repository)
179
 
        if committer is not None:
180
 
            label.append(committer)
181
 
 
182
 
        if date is not None:
183
 
            label.append(date)
184
 
 
185
 
        if node in self.distances:
186
 
            rank = self.distances[node]
187
 
            label.append('d%d' % self.distances[node])
188
 
        else:
189
 
            rank = None
190
 
 
191
 
        d_node = Node("n%d" % num, color=color, label="\\n".join(label), 
192
 
                    rev_id=node, cluster=cluster, message=message,
193
 
                    date=date)
194
 
        d_node.rank = rank
195
 
 
196
 
        if node not in self.ancestors:
197
 
            d_node.node_style.append('dotted')
198
 
 
199
 
        return d_node
200
 
        
201
 
    def get_relations(self, collapse=False):
202
 
        dot_nodes = {}
203
 
        node_relations = []
204
 
        num = 0
205
 
        if collapse:
206
 
            visible_ancestors = compact_ancestors(self.descendants, 
207
 
                                                  self.ancestors, (self.base,))
208
 
        else:
209
 
            visible_ancestors = self.ancestors
210
 
        for node, parents in visible_ancestors.iteritems():
211
 
            if node not in dot_nodes:
212
 
                dot_nodes[node] = self.dot_node(node, num)
213
 
                num += 1
214
 
            if visible_ancestors is self.ancestors:
215
 
                parent_iter = ((f, 0) for f in parents)
216
 
            else:
217
 
                parent_iter = (f for f in parents.iteritems())
218
 
            for parent, skipped in parent_iter:
219
 
                if parent not in dot_nodes:
220
 
                    dot_nodes[parent] = self.dot_node(parent, num)
221
 
                    num += 1
222
 
                edge = Edge(dot_nodes[parent], dot_nodes[node])
223
 
                if skipped != 0:
224
 
                    edge.label = "%d" % skipped
225
 
                node_relations.append(edge)
226
 
        return node_relations
227
 
 
228
 
 
229
 
def write_ancestry_file(branch, filename, collapse=True, antialias=True,
230
 
                        merge_branch=None, ranking="forced"):
231
 
    b = Branch.open_containing(branch)[0]
232
 
    if merge_branch is not None:
233
 
        m = Branch.open_containing(merge_branch)[0]
234
 
    else:
235
 
        m = None
236
 
    b.lock_write()
237
 
    try:
238
 
        if m is not None:
239
 
            m.lock_read()
240
 
        try:
241
 
            grapher = Grapher(b, m)
242
 
            relations = grapher.get_relations(collapse)
243
 
        finally:
244
 
            if m is not None:
245
 
                m.unlock()
246
 
    finally:
247
 
        b.unlock()
248
 
 
249
 
    ext = filename.split('.')[-1]
250
 
    output = dot_output(relations, ranking)
251
 
    done = False
252
 
    if ext not in RSVG_OUTPUT_TYPES:
253
 
        antialias = False
254
 
    if antialias: 
255
 
        output = list(output)
256
 
        try:
257
 
            invoke_dot_aa(output, filename, ext)
258
 
            done = True
259
 
        except NoDot, e:
260
 
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
261
 
                " is installed correctly.")
262
 
        except NoRsvg, e:
263
 
            print "Not antialiasing because rsvg (from librsvg-bin) is not"\
264
 
                " installed."
265
 
            antialias = False
266
 
    if ext in DOT_OUTPUT_TYPES and not antialias and not done:
267
 
        try:
268
 
            invoke_dot(output, filename, ext)
269
 
            done = True
270
 
        except NoDot, e:
271
 
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
272
 
                " is installed correctly, or use --noantialias")
273
 
    elif ext == 'dot' and not done:
274
 
        my_file = file(filename, 'wb')
275
 
        for fragment in output:
276
 
            my_file.write(fragment)
277
 
    elif ext == 'html':
278
 
        try:
279
 
            invoke_dot_html(output, filename)
280
 
        except NoDot, e:
281
 
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
282
 
                " is installed correctly, or use --noantialias")
283
 
    elif not done:
284
 
        print "Unknown file extension: %s" % ext
285