~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to graph.py

  • Committer: Aaron Bentley
  • Date: 2005-11-10 21:04:19 UTC
  • Revision ID: aaron.bentley@utoronto.ca-20051110210419-a402638d94693825
Handled whitespace branch names better

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2008 Aaron Bentley
2
 
# <aaron@aaronbentley.com>
 
1
# Copyright (C) 2005 Aaron Bentley
 
2
# <aaron.bentley@utoronto.ca>
3
3
#
4
4
#    This program is free software; you can redistribute it and/or modify
5
5
#    it under the terms of the GNU General Public License as published by
14
14
#    You should have received a copy of the GNU General Public License
15
15
#    along with this program; if not, write to the Free Software
16
16
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
 
 
18
 
 
 
17
from dotgraph import Node, dot_output, invoke_dot, invoke_dot_aa, NoDot, NoRsvg
 
18
from dotgraph import RSVG_OUTPUT_TYPES, DOT_OUTPUT_TYPES, Edge, invoke_dot_html
 
19
from bzrlib.branch import Branch
 
20
from bzrlib.errors import BzrCommandError, NoCommonRoot, NoSuchRevision
 
21
from bzrlib.fetch import greedy_fetch
 
22
from bzrlib.graph import node_distances, select_farthest
 
23
from bzrlib.revision import combined_graph, revision_graph
 
24
from bzrlib.revision import MultipleRevisionSources
 
25
import bzrlib.errors
 
26
import re
 
27
import os.path
19
28
import time
20
29
 
21
 
from bzrlib.branch import Branch
22
 
from bzrlib.errors import BzrCommandError, NoSuchRevision
23
 
from bzrlib.revision import NULL_REVISION
24
 
 
25
 
from bzrtools import short_committer
26
 
from dotgraph import (
27
 
    dot_output,
28
 
    DOT_OUTPUT_TYPES,
29
 
    Edge,
30
 
    invoke_dot,
31
 
    invoke_dot_aa,
32
 
    invoke_dot_html,
33
 
    Node,
34
 
    NoDot,
35
 
    NoRsvg,
36
 
    RSVG_OUTPUT_TYPES,
37
 
    )
38
 
 
39
 
 
40
 
def max_distance(node, ancestors, distances, root_descendants):
41
 
    """Calculate the max distance to an ancestor.
42
 
    Return None if not all possible ancestors have known distances"""
43
 
    best = None
44
 
    if node in distances:
45
 
        best = distances[node]
46
 
    for ancestor in ancestors[node]:
47
 
        # skip ancestors we will never traverse:
48
 
        if root_descendants is not None and ancestor not in root_descendants:
49
 
            continue
50
 
        # An ancestor which is not listed in ancestors will never be in
51
 
        # distances, so we pretend it never existed.
52
 
        if ancestor not in ancestors:
53
 
            continue
54
 
        if ancestor not in distances:
55
 
            return None
56
 
        if best is None or distances[ancestor]+1 > best:
57
 
            best = distances[ancestor] + 1
58
 
    return best
59
 
 
60
 
 
61
 
def node_distances(graph, ancestors, start, root_descendants=None):
62
 
    """Produce a list of nodes, sorted by distance from a start node.
63
 
    This is an algorithm devised by Aaron Bentley, because applying Dijkstra
64
 
    backwards seemed too complicated.
65
 
 
66
 
    For each node, we walk its descendants.  If all the descendant's ancestors
67
 
    have a max-distance-to-start, (excluding ones that can never reach start),
68
 
    we calculate their max-distance-to-start, and schedule their descendants.
69
 
 
70
 
    So when a node's last parent acquires a distance, it will acquire a
71
 
    distance on the next iteration.
72
 
 
73
 
    Once we know the max distances for all nodes, we can return a list sorted
74
 
    by distance, farthest first.
75
 
    """
76
 
    distances = {start: 0}
77
 
    lines = set([start])
78
 
    while len(lines) > 0:
79
 
        new_lines = set()
80
 
        for line in lines:
81
 
            line_descendants = graph[line]
82
 
            for descendant in line_descendants:
83
 
                distance = max_distance(descendant, ancestors, distances,
84
 
                                        root_descendants)
85
 
                if distance is None:
86
 
                    continue
87
 
                distances[descendant] = distance
88
 
                new_lines.add(descendant)
89
 
        lines = new_lines
90
 
    return distances
91
 
 
92
 
 
93
 
def nodes_by_distance(distances):
94
 
    """Return a list of nodes sorted by distance"""
95
 
    def by_distance(n):
96
 
        return distances[n],n
97
 
 
98
 
    node_list = distances.keys()
99
 
    node_list.sort(key=by_distance, reverse=True)
100
 
    return node_list
101
 
 
102
 
 
103
 
def select_farthest(distances, common):
104
 
    """Return the farthest common node, or None if no node qualifies."""
105
 
    node_list = nodes_by_distance(distances)
106
 
    for node in node_list:
107
 
        if node in common:
108
 
            return node
109
 
 
110
 
 
111
30
mail_map = {'aaron.bentley@utoronto.ca'     : 'Aaron Bentley',
112
31
            'abentley@panoramicfeedback.com': 'Aaron Bentley',
113
32
            'abentley@lappy'                : 'Aaron Bentley',
117
36
            }
118
37
 
119
38
committer_alias = {'abentley': 'Aaron Bentley'}
 
39
def short_committer(committer):
 
40
    new_committer = re.sub('<.*>', '', committer).strip(' ')
 
41
    if len(new_committer) < 2:
 
42
        return committer
 
43
    return new_committer
 
44
 
120
45
def can_skip(rev_id, descendants, ancestors):
121
46
    if rev_id not in descendants:
122
47
        return False
137
62
    for me, my_parents in ancestors.iteritems():
138
63
        if me in skip:
139
64
            continue
140
 
        new_ancestors[me] = {}
 
65
        new_ancestors[me] = {} 
141
66
        for parent in my_parents:
142
 
            new_parent = parent
 
67
            new_parent = parent 
143
68
            distance = 0
144
69
            while can_skip(new_parent, descendants, ancestors):
145
70
                if new_parent in exceptions:
150
75
                new_parent = list(ancestors[new_parent])[0]
151
76
                distance += 1
152
77
            new_ancestors[me][new_parent] = distance
153
 
    return new_ancestors
 
78
    return new_ancestors    
154
79
 
155
80
def get_rev_info(rev_id, source):
156
 
    """Return the committer, message, nick and date of a revision."""
 
81
    """Return the committer, message, and date of a revision."""
157
82
    committer = None
158
83
    message = None
159
84
    date = None
160
 
    nick = None
161
85
    if rev_id == 'null:':
162
 
        return None, 'Null Revision', None, None
 
86
        return None, 'Null Revision', None
163
87
    try:
164
88
        rev = source.get_revision(rev_id)
165
89
    except NoSuchRevision:
166
90
        try:
167
91
            committer = '-'.join(rev_id.split('-')[:-2]).strip(' ')
168
92
            if committer == '':
169
 
                return None, None, None, None
 
93
                return None, None, None
170
94
        except ValueError:
171
 
            return None, None, None, None
 
95
            return None, None, None
172
96
    else:
173
97
        committer = short_committer(rev.committer)
174
98
        if rev.message is not None:
175
99
            message = rev.message.split('\n')[0]
176
100
        gmtime = time.gmtime(rev.timestamp + (rev.timezone or 0))
177
101
        date = time.strftime('%Y/%m/%d', gmtime)
178
 
        nick = rev.properties.get('branch-nick')
179
102
    if '@' in committer:
180
103
        try:
181
104
            committer = mail_map[committer]
185
108
        committer = committer_alias[committer]
186
109
    except KeyError:
187
110
        pass
188
 
    return committer, message, nick, date
 
111
    return committer, message, date
189
112
 
190
113
class Grapher(object):
191
 
 
192
114
    def __init__(self, branch, other_branch=None):
193
115
        object.__init__(self)
194
116
        self.branch = branch
195
117
        self.other_branch = other_branch
 
118
        revision_a = self.branch.last_revision()
196
119
        if other_branch is not None:
197
 
            other_repo = other_branch.repository
 
120
            greedy_fetch(branch, other_branch)
198
121
            revision_b = self.other_branch.last_revision()
 
122
            try:
 
123
                self.root, self.ancestors, self.descendants, self.common = \
 
124
                    combined_graph(revision_a, revision_b, self.branch)
 
125
            except bzrlib.errors.NoCommonRoot:
 
126
                raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
199
127
        else:
200
 
            other_repo = None
201
 
            revision_b = None
202
 
        self.graph = self.branch.repository.get_graph(other_repo)
203
 
        revision_a = self.branch.last_revision()
204
 
        self.scan_graph(revision_a, revision_b)
205
 
        self.n_history = list(self.graph.iter_lefthand_ancestry(revision_a))
206
 
        self.n_history.reverse()
207
 
        self.n_revnos = branch.get_revision_id_to_revno_map()
208
 
        self.distances = node_distances(self.descendants, self.ancestors,
 
128
            self.root, self.ancestors, self.descendants = \
 
129
                revision_graph(revision_a, branch)
 
130
            self.common = []
 
131
 
 
132
        self.n_history = branch.revision_history()
 
133
        self.distances = node_distances(self.descendants, self.ancestors, 
209
134
                                        self.root)
210
135
        if other_branch is not None:
211
136
            self.base = select_farthest(self.distances, self.common)
212
 
            self.m_history = self.graph.iter_lefthand_ancestry(revision_b)
213
 
            self.m_history = list(self.m_history)
214
 
            self.m_history.reverse()
215
 
            self.m_revnos = other_branch.get_revision_id_to_revno_map()
216
 
            self.new_base = self.graph.find_unique_lca(revision_a,
217
 
                                                       revision_b)
218
 
            self.lcas = self.graph.find_lca(revision_a, revision_b)
 
137
            self.m_history = other_branch.revision_history() 
219
138
        else:
220
139
            self.base = None
221
 
            self.new_base = None
222
 
            self.lcas = set()
223
140
            self.m_history = []
224
 
            self.m_revnos = {}
225
 
 
226
 
    def scan_graph(self, revision_a, revision_b):
227
 
        a_ancestors = dict(self.graph.iter_ancestry([revision_a]))
228
 
        self.ancestors = a_ancestors
229
 
        self.root = NULL_REVISION
230
 
        if revision_b is not None:
231
 
            b_ancestors = dict(self.graph.iter_ancestry([revision_b]))
232
 
            self.common = set(a_ancestors.keys())
233
 
            self.common.intersection_update(b_ancestors)
234
 
            self.ancestors.update(b_ancestors)
235
 
        else:
236
 
            self.common = []
237
 
            revision_b = None
238
 
        self.descendants = {}
239
 
        ghosts = set()
240
 
        for revision, parents in self.ancestors.iteritems():
241
 
            self.descendants.setdefault(revision, [])
242
 
            if parents is None:
243
 
                ghosts.add(revision)
244
 
                parents = [NULL_REVISION]
245
 
            for parent in parents:
246
 
                self.descendants.setdefault(parent, []).append(revision)
247
 
        for ghost in ghosts:
248
 
            self.ancestors[ghost] = [NULL_REVISION]
249
 
 
250
 
    @staticmethod
251
 
    def _get_revno_str(prefix, revno_map, revision_id):
252
 
        try:
253
 
            revno = revno_map[revision_id]
254
 
        except KeyError:
255
 
            return None
256
 
        return '%s%s' % (prefix, '.'.join(str(n) for n in revno))
257
141
 
258
142
    def dot_node(self, node, num):
259
143
        try:
265
149
        except ValueError:
266
150
            m_rev = None
267
151
        if (n_rev, m_rev) == (None, None):
268
 
            name = self._get_revno_str('r', self.n_revnos, node)
269
 
            if name is None:
270
 
                name = self._get_revno_str('R', self.m_revnos, node)
271
 
            if name is None:
272
 
                name = node[-5:]
 
152
            name = node[-5:]
273
153
            cluster = None
274
154
        elif n_rev == m_rev:
275
155
            name = "rR%d" % n_rev
295
175
            assert m_rev is not None
296
176
            cluster = "other_history"
297
177
            color = "#ff0000"
298
 
        if node in self.lcas:
299
 
            color = "#9933cc"
300
178
        if node == self.base:
301
 
            color = "#669933"
302
 
            if node == self.new_base:
303
 
                color = "#33ff33"
304
 
        if node == self.new_base:
305
 
            color = '#33cc99'
 
179
            color = "#33ff99"
306
180
 
307
181
        label = [name]
308
 
        committer, message, nick, date = get_rev_info(node,
309
 
                                                      self.branch.repository)
 
182
        committer, message, date = get_rev_info(node, self.branch)
310
183
        if committer is not None:
311
184
            label.append(committer)
312
185
 
313
 
        if nick is not None:
314
 
            label.append(nick)
315
 
 
316
186
        if date is not None:
317
187
            label.append(date)
318
188
 
322
192
        else:
323
193
            rank = None
324
194
 
325
 
        d_node = Node("n%d" % num, color=color, label="\\n".join(label),
 
195
        d_node = Node("n%d" % num, color=color, label="\\n".join(label), 
326
196
                    rev_id=node, cluster=cluster, message=message,
327
197
                    date=date)
328
198
        d_node.rank = rank
331
201
            d_node.node_style.append('dotted')
332
202
 
333
203
        return d_node
334
 
 
335
 
    def get_relations(self, collapse=False, max_distance=None):
 
204
        
 
205
    def get_relations(self, collapse=False):
336
206
        dot_nodes = {}
337
207
        node_relations = []
338
208
        num = 0
339
209
        if collapse:
340
 
            exceptions = self.lcas.union([self.base, self.new_base])
341
 
            visible_ancestors = compact_ancestors(self.descendants,
342
 
                                                  self.ancestors,
343
 
                                                  exceptions)
 
210
            visible_ancestors = compact_ancestors(self.descendants, 
 
211
                                                  self.ancestors, (self.base,))
344
212
        else:
345
 
            visible_ancestors = {}
346
 
            for revision, parents in self.ancestors.iteritems():
347
 
                visible_ancestors[revision] = dict((p, 0) for p in parents)
348
 
        if max_distance is not None:
349
 
            min_distance = max(self.distances.values()) - max_distance
350
 
            visible_ancestors = dict((n, p) for n, p in
351
 
                                     visible_ancestors.iteritems() if
352
 
                                     self.distances[n] >= min_distance)
 
213
            visible_ancestors = self.ancestors
353
214
        for node, parents in visible_ancestors.iteritems():
354
215
            if node not in dot_nodes:
355
216
                dot_nodes[node] = self.dot_node(node, num)
356
217
                num += 1
357
 
            for parent, skipped in parents.iteritems():
 
218
            if visible_ancestors is self.ancestors:
 
219
                parent_iter = ((f, 0) for f in parents)
 
220
            else:
 
221
                parent_iter = (f for f in parents.iteritems())
 
222
            for parent, skipped in parent_iter:
358
223
                if parent not in dot_nodes:
359
224
                    dot_nodes[parent] = self.dot_node(parent, num)
360
225
                    num += 1
366
231
 
367
232
 
368
233
def write_ancestry_file(branch, filename, collapse=True, antialias=True,
369
 
                        merge_branch=None, ranking="forced", max_distance=None):
 
234
                        merge_branch=None, ranking="forced"):
370
235
    b = Branch.open_containing(branch)[0]
371
236
    if merge_branch is not None:
372
237
        m = Branch.open_containing(merge_branch)[0]
373
238
    else:
374
239
        m = None
375
 
    b.lock_write()
 
240
    b.lock_read()
376
241
    try:
377
242
        if m is not None:
378
243
            m.lock_read()
379
244
        try:
380
245
            grapher = Grapher(b, m)
381
 
            relations = grapher.get_relations(collapse, max_distance)
 
246
            relations = grapher.get_relations(collapse)
382
247
        finally:
383
248
            if m is not None:
384
249
                m.unlock()
390
255
    done = False
391
256
    if ext not in RSVG_OUTPUT_TYPES:
392
257
        antialias = False
393
 
    if antialias:
 
258
    if antialias: 
394
259
        output = list(output)
395
260
        try:
396
261
            invoke_dot_aa(output, filename, ext)
408
273
            done = True
409
274
        except NoDot, e:
410
275
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
411
 
                " is installed correctly.")
 
276
                " is installed correctly, or use --noantialias")
412
277
    elif ext == 'dot' and not done:
413
278
        my_file = file(filename, 'wb')
414
279
        for fragment in output:
415
 
            my_file.write(fragment.encode('utf-8'))
 
280
            my_file.write(fragment)
416
281
    elif ext == 'html':
417
282
        try:
418
283
            invoke_dot_html(output, filename)
419
284
        except NoDot, e:
420
285
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
421
 
                " is installed correctly.")
 
286
                " is installed correctly, or use --noantialias")
422
287
    elif not done:
423
288
        print "Unknown file extension: %s" % ext
 
289