~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to graph.py

  • Committer: Jelmer Vernooij
  • Date: 2011-06-24 13:35:53 UTC
  • mto: This revision was merged to the branch mainline in revision 771.
  • Revision ID: jelmer@samba.org-20110624133553-h9s8syvvvsvpd1o9
Add support for importing .tar.xz and .tar.lzma files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Aaron Bentley
2
 
# <aaron.bentley@utoronto.ca>
 
1
# Copyright (C) 2005, 2008 Aaron Bentley
 
2
# <aaron@aaronbentley.com>
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
 
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
 
17
 
 
18
 
 
19
import time
 
20
 
19
21
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
28
 
import time
 
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
 
29
110
 
30
111
mail_map = {'aaron.bentley@utoronto.ca'     : 'Aaron Bentley',
31
112
            'abentley@panoramicfeedback.com': 'Aaron Bentley',
36
117
            }
37
118
 
38
119
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
 
 
45
120
def can_skip(rev_id, descendants, ancestors):
46
121
    if rev_id not in descendants:
47
122
        return False
62
137
    for me, my_parents in ancestors.iteritems():
63
138
        if me in skip:
64
139
            continue
65
 
        new_ancestors[me] = {} 
 
140
        new_ancestors[me] = {}
66
141
        for parent in my_parents:
67
 
            new_parent = parent 
 
142
            new_parent = parent
68
143
            distance = 0
69
144
            while can_skip(new_parent, descendants, ancestors):
70
145
                if new_parent in exceptions:
75
150
                new_parent = list(ancestors[new_parent])[0]
76
151
                distance += 1
77
152
            new_ancestors[me][new_parent] = distance
78
 
    return new_ancestors    
 
153
    return new_ancestors
79
154
 
80
155
def get_rev_info(rev_id, source):
81
156
    """Return the committer, message, and date of a revision."""
83
158
    message = None
84
159
    date = None
85
160
    if rev_id == 'null:':
86
 
        return None, 'Null Revision', None
 
161
        return None, 'Null Revision', None, None
87
162
    try:
88
163
        rev = source.get_revision(rev_id)
89
164
    except NoSuchRevision:
90
165
        try:
91
166
            committer = '-'.join(rev_id.split('-')[:-2]).strip(' ')
92
167
            if committer == '':
93
 
                return None, None, None
 
168
                return None, None, None, None
94
169
        except ValueError:
95
 
            return None, None, None
 
170
            return None, None, None, None
96
171
    else:
97
172
        committer = short_committer(rev.committer)
98
173
        if rev.message is not None:
99
174
            message = rev.message.split('\n')[0]
100
175
        gmtime = time.gmtime(rev.timestamp + (rev.timezone or 0))
101
176
        date = time.strftime('%Y/%m/%d', gmtime)
 
177
        nick = rev.properties.get('branch-nick')
102
178
    if '@' in committer:
103
179
        try:
104
180
            committer = mail_map[committer]
108
184
        committer = committer_alias[committer]
109
185
    except KeyError:
110
186
        pass
111
 
    return committer, message, date
 
187
    return committer, message, nick, date
112
188
 
113
189
class Grapher(object):
 
190
 
114
191
    def __init__(self, branch, other_branch=None):
115
192
        object.__init__(self)
116
193
        self.branch = branch
117
194
        self.other_branch = other_branch
 
195
        if other_branch is not None:
 
196
            other_repo = other_branch.repository
 
197
            revision_b = self.other_branch.last_revision()
 
198
        else:
 
199
            other_repo = None
 
200
            revision_b = None
 
201
        self.graph = self.branch.repository.get_graph(other_repo)
118
202
        revision_a = self.branch.last_revision()
119
 
        if other_branch is not None:
120
 
            greedy_fetch(branch, other_branch)
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)
127
 
        else:
128
 
            self.root, self.ancestors, self.descendants = \
129
 
                revision_graph(revision_a, branch)
130
 
            self.common = []
131
 
 
 
203
        self.scan_graph(revision_a, revision_b)
132
204
        self.n_history = branch.revision_history()
133
 
        self.distances = node_distances(self.descendants, self.ancestors, 
 
205
        self.n_revnos = branch.get_revision_id_to_revno_map()
 
206
        self.distances = node_distances(self.descendants, self.ancestors,
134
207
                                        self.root)
135
208
        if other_branch is not None:
136
209
            self.base = select_farthest(self.distances, self.common)
137
 
            self.m_history = other_branch.revision_history() 
 
210
            self.m_history = other_branch.revision_history()
 
211
            self.m_revnos = other_branch.get_revision_id_to_revno_map()
 
212
            self.new_base = self.graph.find_unique_lca(revision_a,
 
213
                                                       revision_b)
 
214
            self.lcas = self.graph.find_lca(revision_a, revision_b)
138
215
        else:
139
216
            self.base = None
 
217
            self.new_base = None
 
218
            self.lcas = set()
140
219
            self.m_history = []
 
220
            self.m_revnos = {}
 
221
 
 
222
    def scan_graph(self, revision_a, revision_b):
 
223
        a_ancestors = dict(self.graph.iter_ancestry([revision_a]))
 
224
        self.ancestors = a_ancestors
 
225
        self.root = NULL_REVISION
 
226
        if revision_b is not None:
 
227
            b_ancestors = dict(self.graph.iter_ancestry([revision_b]))
 
228
            self.common = set(a_ancestors.keys())
 
229
            self.common.intersection_update(b_ancestors)
 
230
            self.ancestors.update(b_ancestors)
 
231
        else:
 
232
            self.common = []
 
233
            revision_b = None
 
234
        self.descendants = {}
 
235
        ghosts = set()
 
236
        for revision, parents in self.ancestors.iteritems():
 
237
            self.descendants.setdefault(revision, [])
 
238
            if parents is None:
 
239
                ghosts.add(revision)
 
240
                parents = [NULL_REVISION]
 
241
            for parent in parents:
 
242
                self.descendants.setdefault(parent, []).append(revision)
 
243
        for ghost in ghosts:
 
244
            self.ancestors[ghost] = [NULL_REVISION]
 
245
 
 
246
    @staticmethod
 
247
    def _get_revno_str(prefix, revno_map, revision_id):
 
248
        try:
 
249
            revno = revno_map[revision_id]
 
250
        except KeyError:
 
251
            return None
 
252
        return '%s%s' % (prefix, '.'.join(str(n) for n in revno))
141
253
 
142
254
    def dot_node(self, node, num):
143
255
        try:
149
261
        except ValueError:
150
262
            m_rev = None
151
263
        if (n_rev, m_rev) == (None, None):
152
 
            name = node[-5:]
 
264
            name = self._get_revno_str('r', self.n_revnos, node)
 
265
            if name is None:
 
266
                name = self._get_revno_str('R', self.m_revnos, node)
 
267
            if name is None:
 
268
                name = node[-5:]
153
269
            cluster = None
154
270
        elif n_rev == m_rev:
155
271
            name = "rR%d" % n_rev
175
291
            assert m_rev is not None
176
292
            cluster = "other_history"
177
293
            color = "#ff0000"
 
294
        if node in self.lcas:
 
295
            color = "#9933cc"
178
296
        if node == self.base:
179
 
            color = "#33ff99"
 
297
            color = "#669933"
 
298
            if node == self.new_base:
 
299
                color = "#33ff33"
 
300
        if node == self.new_base:
 
301
            color = '#33cc99'
180
302
 
181
303
        label = [name]
182
 
        committer, message, date = get_rev_info(node, self.branch)
 
304
        committer, message, nick, date = get_rev_info(node,
 
305
                                                      self.branch.repository)
183
306
        if committer is not None:
184
307
            label.append(committer)
185
308
 
 
309
        if nick is not None:
 
310
            label.append(nick)
 
311
 
186
312
        if date is not None:
187
313
            label.append(date)
188
314
 
192
318
        else:
193
319
            rank = None
194
320
 
195
 
        d_node = Node("n%d" % num, color=color, label="\\n".join(label), 
 
321
        d_node = Node("n%d" % num, color=color, label="\\n".join(label),
196
322
                    rev_id=node, cluster=cluster, message=message,
197
323
                    date=date)
198
324
        d_node.rank = rank
201
327
            d_node.node_style.append('dotted')
202
328
 
203
329
        return d_node
204
 
        
205
 
    def get_relations(self, collapse=False):
 
330
 
 
331
    def get_relations(self, collapse=False, max_distance=None):
206
332
        dot_nodes = {}
207
333
        node_relations = []
208
334
        num = 0
209
335
        if collapse:
210
 
            visible_ancestors = compact_ancestors(self.descendants, 
211
 
                                                  self.ancestors, (self.base,))
 
336
            exceptions = self.lcas.union([self.base, self.new_base])
 
337
            visible_ancestors = compact_ancestors(self.descendants,
 
338
                                                  self.ancestors,
 
339
                                                  exceptions)
212
340
        else:
213
 
            visible_ancestors = self.ancestors
 
341
            visible_ancestors = {}
 
342
            for revision, parents in self.ancestors.iteritems():
 
343
                visible_ancestors[revision] = dict((p, 0) for p in parents)
 
344
        if max_distance is not None:
 
345
            min_distance = max(self.distances.values()) - max_distance
 
346
            visible_ancestors = dict((n, p) for n, p in
 
347
                                     visible_ancestors.iteritems() if
 
348
                                     self.distances[n] >= min_distance)
214
349
        for node, parents in visible_ancestors.iteritems():
215
350
            if node not in dot_nodes:
216
351
                dot_nodes[node] = self.dot_node(node, num)
217
352
                num += 1
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:
 
353
            for parent, skipped in parents.iteritems():
223
354
                if parent not in dot_nodes:
224
355
                    dot_nodes[parent] = self.dot_node(parent, num)
225
356
                    num += 1
231
362
 
232
363
 
233
364
def write_ancestry_file(branch, filename, collapse=True, antialias=True,
234
 
                        merge_branch=None, ranking="forced"):
 
365
                        merge_branch=None, ranking="forced", max_distance=None):
235
366
    b = Branch.open_containing(branch)[0]
236
367
    if merge_branch is not None:
237
368
        m = Branch.open_containing(merge_branch)[0]
238
369
    else:
239
370
        m = None
240
 
    b.lock_read()
 
371
    b.lock_write()
241
372
    try:
242
373
        if m is not None:
243
374
            m.lock_read()
244
375
        try:
245
376
            grapher = Grapher(b, m)
246
 
            relations = grapher.get_relations(collapse)
 
377
            relations = grapher.get_relations(collapse, max_distance)
247
378
        finally:
248
379
            if m is not None:
249
380
                m.unlock()
255
386
    done = False
256
387
    if ext not in RSVG_OUTPUT_TYPES:
257
388
        antialias = False
258
 
    if antialias: 
 
389
    if antialias:
259
390
        output = list(output)
260
391
        try:
261
392
            invoke_dot_aa(output, filename, ext)
273
404
            done = True
274
405
        except NoDot, e:
275
406
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
276
 
                " is installed correctly, or use --noantialias")
 
407
                " is installed correctly.")
277
408
    elif ext == 'dot' and not done:
278
409
        my_file = file(filename, 'wb')
279
410
        for fragment in output:
280
 
            my_file.write(fragment)
 
411
            my_file.write(fragment.encode('utf-8'))
281
412
    elif ext == 'html':
282
413
        try:
283
414
            invoke_dot_html(output, filename)
284
415
        except NoDot, e:
285
416
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
286
 
                " is installed correctly, or use --noantialias")
 
417
                " is installed correctly.")
287
418
    elif not done:
288
419
        print "Unknown file extension: %s" % ext
289