← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to graph.py

  • Committer: Aaron Bentley
  • Date: 2011-01-26 01:11:59 UTC
  • Revision ID: aaron@aaronbentley.com-20110126011159-xsh6z4n8bgxy0k9k
Ignore the_kraken changelogs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
graph.py
1
 
from dotgraph import Node, dot_output, invoke_dot, invoke_dot_aa, NoDot, NoRsvg
2
 
from dotgraph import RSVG_OUTPUT_TYPES, DOT_OUTPUT_TYPES, Edge, invoke_dot_html
 
1
# Copyright (C) 2005, 2008 Aaron Bentley
 
2
# <aaron@aaronbentley.com>
 
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
 
 
18
 
 
19
import time
 
20
 
3
21
from bzrlib.branch import Branch
4
 
from bzrlib.errors import BzrCommandError, NoCommonRoot, NoSuchRevision
5
 
from bzrlib.fetch import greedy_fetch
6
 
from bzrlib.graph import node_distances, select_farthest
7
 
from bzrlib.revision import combined_graph, revision_graph
8
 
from bzrlib.revision import MultipleRevisionSources
9
 
import bzrlib.errors
10
 
import re
11
 
import os.path
12
 
import time
 
22
from bzrlib.errors import BzrCommandError, NoSuchRevision
 
23
from bzrlib.deprecated_graph import node_distances, select_farthest
 
24
from bzrlib.revision import NULL_REVISION
 
25
 
 
26
from bzrtools import short_committer
 
27
from dotgraph import (
 
28
    dot_output,
 
29
    DOT_OUTPUT_TYPES,
 
30
    Edge,
 
31
    invoke_dot,
 
32
    invoke_dot_aa,
 
33
    invoke_dot_html,
 
34
    Node,
 
35
    NoDot,
 
36
    NoRsvg,
 
37
    RSVG_OUTPUT_TYPES,
 
38
    )
 
39
 
13
40
 
14
41
mail_map = {'aaron.bentley@utoronto.ca'     : 'Aaron Bentley',
15
42
            'abentley@panoramicfeedback.com': 'Aaron Bentley',
20
47
            }
21
48
 
22
49
committer_alias = {'abentley': 'Aaron Bentley'}
23
 
def short_committer(committer):
24
 
    new_committer = re.sub('<.*>', '', committer).strip(' ')
25
 
    if len(new_committer) < 2:
26
 
        return committer
27
 
    return new_committer
28
 
 
29
50
def can_skip(rev_id, descendants, ancestors):
30
51
    if rev_id not in descendants:
31
52
        return False
46
67
    for me, my_parents in ancestors.iteritems():
47
68
        if me in skip:
48
69
            continue
49
 
        new_ancestors[me] = {} 
 
70
        new_ancestors[me] = {}
50
71
        for parent in my_parents:
51
 
            new_parent = parent 
 
72
            new_parent = parent
52
73
            distance = 0
53
74
            while can_skip(new_parent, descendants, ancestors):
54
75
                if new_parent in exceptions:
59
80
                new_parent = list(ancestors[new_parent])[0]
60
81
                distance += 1
61
82
            new_ancestors[me][new_parent] = distance
62
 
    return new_ancestors    
 
83
    return new_ancestors
63
84
 
64
85
def get_rev_info(rev_id, source):
65
86
    """Return the committer, message, and date of a revision."""
67
88
    message = None
68
89
    date = None
69
90
    if rev_id == 'null:':
70
 
        return None, 'Null Revision', None
 
91
        return None, 'Null Revision', None, None
71
92
    try:
72
93
        rev = source.get_revision(rev_id)
73
94
    except NoSuchRevision:
74
95
        try:
75
96
            committer = '-'.join(rev_id.split('-')[:-2]).strip(' ')
76
97
            if committer == '':
77
 
                return None, None, None
 
98
                return None, None, None, None
78
99
        except ValueError:
79
 
            return None, None, None
 
100
            return None, None, None, None
80
101
    else:
81
102
        committer = short_committer(rev.committer)
82
103
        if rev.message is not None:
83
104
            message = rev.message.split('\n')[0]
84
105
        gmtime = time.gmtime(rev.timestamp + (rev.timezone or 0))
85
106
        date = time.strftime('%Y/%m/%d', gmtime)
 
107
        nick = rev.properties.get('branch-nick')
86
108
    if '@' in committer:
87
109
        try:
88
110
            committer = mail_map[committer]
92
114
        committer = committer_alias[committer]
93
115
    except KeyError:
94
116
        pass
95
 
    return committer, message, date
 
117
    return committer, message, nick, date
96
118
 
97
119
class Grapher(object):
 
120
 
98
121
    def __init__(self, branch, other_branch=None):
99
122
        object.__init__(self)
100
123
        self.branch = branch
101
124
        self.other_branch = other_branch
 
125
        if other_branch is not None:
 
126
            other_repo = other_branch.repository
 
127
            revision_b = self.other_branch.last_revision()
 
128
        else:
 
129
            other_repo = None
 
130
            revision_b = None
 
131
        self.graph = self.branch.repository.get_graph(other_repo)
102
132
        revision_a = self.branch.last_revision()
103
 
        if other_branch is not None:
104
 
            greedy_fetch(branch, other_branch)
105
 
            revision_b = self.other_branch.last_revision()
106
 
            try:
107
 
                self.root, self.ancestors, self.descendants, self.common = \
108
 
                    combined_graph(revision_a, revision_b, self.branch)
109
 
            except bzrlib.errors.NoCommonRoot:
110
 
                raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
111
 
        else:
112
 
            self.root, self.ancestors, self.descendants = \
113
 
                revision_graph(revision_a, branch)
114
 
            self.common = []
115
 
 
 
133
        self.scan_graph(revision_a, revision_b)
116
134
        self.n_history = branch.revision_history()
117
 
        self.distances = node_distances(self.descendants, self.ancestors, 
 
135
        self.n_revnos = branch.get_revision_id_to_revno_map()
 
136
        self.distances = node_distances(self.descendants, self.ancestors,
118
137
                                        self.root)
119
138
        if other_branch is not None:
120
139
            self.base = select_farthest(self.distances, self.common)
121
 
            self.m_history = other_branch.revision_history() 
 
140
            self.m_history = other_branch.revision_history()
 
141
            self.m_revnos = other_branch.get_revision_id_to_revno_map()
 
142
            self.new_base = self.graph.find_unique_lca(revision_a,
 
143
                                                       revision_b)
 
144
            self.lcas = self.graph.find_lca(revision_a, revision_b)
122
145
        else:
123
146
            self.base = None
 
147
            self.new_base = None
 
148
            self.lcas = set()
124
149
            self.m_history = []
 
150
            self.m_revnos = {}
 
151
 
 
152
    def scan_graph(self, revision_a, revision_b):
 
153
        a_ancestors = dict(self.graph.iter_ancestry([revision_a]))
 
154
        self.ancestors = a_ancestors
 
155
        self.root = NULL_REVISION
 
156
        if revision_b is not None:
 
157
            b_ancestors = dict(self.graph.iter_ancestry([revision_b]))
 
158
            self.common = set(a_ancestors.keys())
 
159
            self.common.intersection_update(b_ancestors)
 
160
            self.ancestors.update(b_ancestors)
 
161
        else:
 
162
            self.common = []
 
163
            revision_b = None
 
164
        self.descendants = {}
 
165
        ghosts = set()
 
166
        for revision, parents in self.ancestors.iteritems():
 
167
            self.descendants.setdefault(revision, [])
 
168
            if parents is None:
 
169
                ghosts.add(revision)
 
170
                parents = [NULL_REVISION]
 
171
            for parent in parents:
 
172
                self.descendants.setdefault(parent, []).append(revision)
 
173
        for ghost in ghosts:
 
174
            self.ancestors[ghost] = [NULL_REVISION]
 
175
 
 
176
    @staticmethod
 
177
    def _get_revno_str(prefix, revno_map, revision_id):
 
178
        try:
 
179
            revno = revno_map[revision_id]
 
180
        except KeyError:
 
181
            return None
 
182
        return '%s%s' % (prefix, '.'.join(str(n) for n in revno))
125
183
 
126
184
    def dot_node(self, node, num):
127
185
        try:
133
191
        except ValueError:
134
192
            m_rev = None
135
193
        if (n_rev, m_rev) == (None, None):
136
 
            name = node[-5:]
 
194
            name = self._get_revno_str('r', self.n_revnos, node)
 
195
            if name is None:
 
196
                name = self._get_revno_str('R', self.m_revnos, node)
 
197
            if name is None:
 
198
                name = node[-5:]
137
199
            cluster = None
138
200
        elif n_rev == m_rev:
139
201
            name = "rR%d" % n_rev
159
221
            assert m_rev is not None
160
222
            cluster = "other_history"
161
223
            color = "#ff0000"
 
224
        if node in self.lcas:
 
225
            color = "#9933cc"
162
226
        if node == self.base:
163
 
            color = "#33ff99"
 
227
            color = "#669933"
 
228
            if node == self.new_base:
 
229
                color = "#33ff33"
 
230
        if node == self.new_base:
 
231
            color = '#33cc99'
164
232
 
165
233
        label = [name]
166
 
        committer, message, date = get_rev_info(node, self.branch)
 
234
        committer, message, nick, date = get_rev_info(node,
 
235
                                                      self.branch.repository)
167
236
        if committer is not None:
168
237
            label.append(committer)
169
238
 
 
239
        if nick is not None:
 
240
            label.append(nick)
 
241
 
170
242
        if date is not None:
171
243
            label.append(date)
172
244
 
176
248
        else:
177
249
            rank = None
178
250
 
179
 
        d_node = Node("n%d" % num, color=color, label="\\n".join(label), 
 
251
        d_node = Node("n%d" % num, color=color, label="\\n".join(label),
180
252
                    rev_id=node, cluster=cluster, message=message,
181
253
                    date=date)
182
254
        d_node.rank = rank
185
257
            d_node.node_style.append('dotted')
186
258
 
187
259
        return d_node
188
 
        
189
 
    def get_relations(self, collapse=False):
 
260
 
 
261
    def get_relations(self, collapse=False, max_distance=None):
190
262
        dot_nodes = {}
191
263
        node_relations = []
192
264
        num = 0
193
265
        if collapse:
194
 
            visible_ancestors = compact_ancestors(self.descendants, 
195
 
                                                  self.ancestors, (self.base,))
 
266
            exceptions = self.lcas.union([self.base, self.new_base])
 
267
            visible_ancestors = compact_ancestors(self.descendants,
 
268
                                                  self.ancestors,
 
269
                                                  exceptions)
196
270
        else:
197
 
            visible_ancestors = self.ancestors
 
271
            visible_ancestors = {}
 
272
            for revision, parents in self.ancestors.iteritems():
 
273
                visible_ancestors[revision] = dict((p, 0) for p in parents)
 
274
        if max_distance is not None:
 
275
            min_distance = max(self.distances.values()) - max_distance
 
276
            visible_ancestors = dict((n, p) for n, p in
 
277
                                     visible_ancestors.iteritems() if
 
278
                                     self.distances[n] >= min_distance)
198
279
        for node, parents in visible_ancestors.iteritems():
199
280
            if node not in dot_nodes:
200
281
                dot_nodes[node] = self.dot_node(node, num)
201
282
                num += 1
202
 
            if visible_ancestors is self.ancestors:
203
 
                parent_iter = ((f, 0) for f in parents)
204
 
            else:
205
 
                parent_iter = (f for f in parents.iteritems())
206
 
            for parent, skipped in parent_iter:
 
283
            for parent, skipped in parents.iteritems():
207
284
                if parent not in dot_nodes:
208
285
                    dot_nodes[parent] = self.dot_node(parent, num)
209
286
                    num += 1
215
292
 
216
293
 
217
294
def write_ancestry_file(branch, filename, collapse=True, antialias=True,
218
 
                        merge_branch=None, ranking="forced"):
219
 
    b = Branch.open_containing(branch)
 
295
                        merge_branch=None, ranking="forced", max_distance=None):
 
296
    b = Branch.open_containing(branch)[0]
220
297
    if merge_branch is not None:
221
 
        m = Branch.open_containing(merge_branch)
 
298
        m = Branch.open_containing(merge_branch)[0]
222
299
    else:
223
300
        m = None
224
 
    grapher = Grapher(b, m)
225
 
    relations = grapher.get_relations(collapse)
 
301
    b.lock_write()
 
302
    try:
 
303
        if m is not None:
 
304
            m.lock_read()
 
305
        try:
 
306
            grapher = Grapher(b, m)
 
307
            relations = grapher.get_relations(collapse, max_distance)
 
308
        finally:
 
309
            if m is not None:
 
310
                m.unlock()
 
311
    finally:
 
312
        b.unlock()
226
313
 
227
314
    ext = filename.split('.')[-1]
228
315
    output = dot_output(relations, ranking)
229
316
    done = False
230
317
    if ext not in RSVG_OUTPUT_TYPES:
231
318
        antialias = False
232
 
    if antialias: 
 
319
    if antialias:
233
320
        output = list(output)
234
321
        try:
235
322
            invoke_dot_aa(output, filename, ext)
247
334
            done = True
248
335
        except NoDot, e:
249
336
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
250
 
                " is installed correctly, or use --noantialias")
 
337
                " is installed correctly.")
251
338
    elif ext == 'dot' and not done:
252
339
        my_file = file(filename, 'wb')
253
340
        for fragment in output:
254
 
            my_file.write(fragment)
 
341
            my_file.write(fragment.encode('utf-8'))
255
342
    elif ext == 'html':
256
343
        try:
257
344
            invoke_dot_html(output, filename)
258
345
        except NoDot, e:
259
346
            raise BzrCommandError("Can't find 'dot'.  Please ensure Graphviz"\
260
 
                " is installed correctly, or use --noantialias")
 
347
                " is installed correctly.")
261
348
    elif not done:
262
349
        print "Unknown file extension: %s" % ext
263