2010-09-19 Adam Barth <abarth@webkit.org>
[WebKit-https.git] / BugsSite / code-review.js
1 // Copyright (C) 2010 Adam Barth. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are met:
5 //
6 // 1. Redistributions of source code must retain the above copyright notice,
7 // this list of conditions and the following disclaimer.
8 //
9 // 2. Redistributions in binary form must reproduce the above copyright notice,
10 // this list of conditions and the following disclaimer in the documentation
11 // and/or other materials provided with the distribution.
12 //
13 // THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
14 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 // DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR
17 // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
20 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
23 // DAMAGE.
24
25 (function() {
26   function determineAttachmentID() {
27     try {
28       return /id=(\d+)/.exec(window.location.search)[1]
29     } catch (ex) {
30       return;
31     }
32   }
33
34   // Attempt to activate only in the "Review Patch" context.
35   if (window.top != window)
36     return;
37   if (!window.location.search.match(/action=review/))
38     return;
39   var attachment_id = determineAttachmentID();
40   if (!attachment_id)
41     return;
42
43   var next_line_id = 0;
44
45   function idForLine(number) {
46     return 'line' + number;
47   }
48
49   function nextLineID() {
50     return idForLine(next_line_id++);
51   }
52
53   function forEachLine(callback) {
54     for (var i = 0; i < next_line_id; ++i) {
55       callback($('#' + idForLine(i)));
56     }
57   }
58
59   function idify() {
60     this.id = nextLineID();
61   }
62
63   function hoverify() {
64     $(this).hover(function() {
65       $(this).addClass('hot');
66     },
67     function () {
68       $(this).removeClass('hot');
69     });
70   }
71
72   function previousCommentsFor(line) {
73     var comments = [];
74     var position = line;
75     while (position.next() && position.next().hasClass('previousComment')) {
76       position = position.next();
77       comments.push(position.get());
78     }
79     return $(comments);
80   }
81
82   function findCommentPositionFor(line) {
83     var position = line;
84     while (position.next() && position.next().hasClass('previousComment'))
85       position = position.next();
86     return position;
87   }
88
89   function findCommentBlockFor(line) {
90     var comment_block = findCommentPositionFor(line).next();
91     if (!comment_block.hasClass('comment'))
92       return;
93     return comment_block;
94   }
95
96   function insertCommentFor(line, block) {
97     findCommentPositionFor(line).after(block);
98   }
99
100   function addCommentFor(line) {
101     if (line.attr('data-has-comment')) {
102       // FIXME: This query is overly complex because we place comment blocks
103       // after Lines.  Instead, comment blocks should be children of Lines.
104       findCommentPositionFor(line).next().next().filter('.frozenComment').each(unfreezeComment);
105       return;
106     }
107     line.attr('data-has-comment', 'true');
108     line.addClass('commentContext');
109
110     var comment_block = $('<div class="comment"><textarea data-comment-for="' + line.attr('id') + '"></textarea><div class="actions"><button class="ok">OK</button><button class="discard">Discard</button></div></div>');
111     insertCommentFor(line, comment_block);
112     comment_block.hide().slideDown('fast', function() {
113       $(this).children('textarea').focus();
114     });
115   }
116
117   function addCommentField() {
118     var id = $(this).attr('data-comment-for');
119     if (!id)
120       id = this.id;
121     addCommentFor($('#' + id));
122   }
123
124   var files = {}
125
126   function addPreviousComment(line, author, comment_text) {
127     var comment_block = $('<div data-comment-for="' + line.attr('id') + '" class="previousComment"></div>');
128     var author_block = $('<div class="author"></div>').text(author + ':');
129     var text_block = $('<div class="content"></div>').text(comment_text);
130     comment_block.append(author_block).append(text_block).each(hoverify).click(addCommentField);
131     insertCommentFor(line, comment_block);
132   }
133
134   function displayPreviousComments(comments) {
135     for (var i = 0; i < comments.length; ++i) {
136       var author = comments[i].author;
137       var file_name = comments[i].file_name;
138       var line_number = comments[i].line_number;
139       var comment_text = comments[i].comment_text;
140
141       var file = files[file_name];
142
143       var query = '.Line .to';
144       if (line_number[0] == '-') {
145         // The line_number represent a removal.  We need to adjust the query to
146         // look at the "from" lines.
147         query = '.Line .from';
148         // Trim off the '-' control character.
149         line_number = line_number.substr(1);
150       }
151
152       $(file).find(query).each(function() {
153         if ($(this).text() != line_number)
154           return;
155         var line = $(this).parent();
156         addPreviousComment(line, author, comment_text);
157       });
158     }
159     if (comments.length == 0)
160       return;
161     descriptor = comments.length + ' comment';
162     if (comments.length > 1)
163       descriptor += 's';
164     $('#toolbar .commentStatus').text('This patch has ' + descriptor + '.  Scroll through them with the "n" and "p" keys.');
165   }
166
167   function scanForComments(author, text) {
168     var comments = []
169     var lines = text.split('\n');
170     for (var i = 0; i < lines.length; ++i) {
171       var parts = lines[i].match(/^([> ]+)([^:]+):(-?\d+)$/);
172       if (!parts)
173         continue;
174       var quote_markers = parts[1];
175       var file_name = parts[2];
176       var line_number = parts[3];
177       if (!file_name in files)
178         continue;
179       while (i < lines.length && lines[i].length > 0 && lines[i][0] == '>')
180         ++i;
181       var comment_lines = [];
182       while (i < lines.length && (lines[i].length == 0 || lines[i][0] != '>')) {
183         comment_lines.push(lines[i]);
184         ++i;
185       }
186       --i; // Decrement i because the for loop will increment it again in a second.
187       var comment_text = comment_lines.join('\n').trim();
188       comments.push({
189         'author': author,
190         'file_name': file_name,
191         'line_number': line_number,
192         'comment_text': comment_text
193       });
194     }
195     return comments;
196   }
197
198   function isReviewFlag(select) {
199     return $(select).attr('title') == 'Request for patch review.';
200   }
201
202   function isCommitQueueFlag(select) {
203     return $(select).attr('title').match(/commit-queue/);
204   }
205
206   function findControlForFlag(select) {
207     if (isReviewFlag(select))
208       return $('#toolbar .review select');
209     else if (isCommitQueueFlag(select))
210       return $('#toolbar .commitQueue select');
211     return $();
212   }
213
214   function addFlagsForAttachment(details) {
215     var flag_control = "<select><option></option><option>?</option><option>+</option><option>-</option></select>";
216     $('#toolbar .actions').append(
217       $('<span class="review"> r: ' + flag_control + '</span>')).append(
218       $('<span class="commitQueue"> cq: ' + flag_control + '</span>'));
219
220     details.find('#flags select').each(function() {
221       findControlForFlag(this).attr('selectedIndex', $(this).attr('selectedIndex'));
222     });
223   }
224
225   function fetchHistory() {
226     $.get('attachment.cgi?id=' + attachment_id + '&action=edit', function(data) {
227       var bug_id = /Attachment \d+ Details for Bug (\d+)/.exec(data)[1];
228       $.get('show_bug.cgi?id=' + bug_id, function(data) {
229         var comments = [];
230         $(data).find('.bz_comment').each(function() {
231           var author = $(this).find('.email').text();
232           var text = $(this).find('.bz_comment_text').text();
233           var comment_marker = '(From update of attachment ' + attachment_id + ' .details.)';
234           if (text.match(comment_marker))
235             $.merge(comments, scanForComments(author, text));
236         });
237         displayPreviousComments(comments);
238       });
239
240       var details = $(data);
241       addFlagsForAttachment(details);
242       $('#toolbar .actions').append($('<iframe class="statusBubble" src="https://webkit-commit-queue.appspot.com/status-bubble/' + attachment_id + '" scrolling="no"></iframe>'));
243     });
244   }
245
246   function crawlDiff() {
247     $('.Line').each(idify).each(hoverify).dblclick(addCommentField);
248     $('.FileDiff').each(function() {
249       var file_name = $(this).children('h1').text();
250       files[file_name] = this;
251     });
252   }
253
254   $(document).ready(function() {
255     crawlDiff();
256     fetchHistory();
257     $(document.body).prepend('<div id="toolbar"><div class="actions"><button id="post_comments">Publish</button></div><div class="message"><span class="commentStatus"></span> <span class="help">Double-click a line to add a comment.</span></div></div>');
258     $(document.body).prepend('<div id="comment_form" class="inactive"><div class="winter"></div><div class="lightbox"><iframe id="reviewform" src="attachment.cgi?id=' + attachment_id + '&action=reviewform"></iframe></div></div>');
259     $(document.body).append('<div class="overallComments"><div class="description">Overall comments:</div><textarea></textarea></div>');
260   });
261
262   function discardComment() {
263     var line_id = $(this).parentsUntil('.comment').parent().find('textarea').attr('data-comment-for');
264     var line = $('#' + line_id)
265     findCommentBlockFor(line).slideUp('fast', function() {
266       $(this).remove();
267       line.removeAttr('data-has-comment');
268       trimCommentContextToBefore(line);
269     });
270   }
271
272   function unfreezeComment() {
273     $(this).prev().show();
274     $(this).remove();
275   }
276
277   $('.comment .discard').live('click', discardComment);
278
279   $('.comment .ok').live('click', function() {
280     var comment_textarea = $(this).parentsUntil('.comment').parent().find('textarea');
281     if (comment_textarea.val().trim() == '') {
282       discardComment.call(this);
283       return;
284     }
285     var line_id = comment_textarea.attr('data-comment-for');
286     var line = $('#' + line_id)
287     findCommentBlockFor(line).hide().after($('<div class="frozenComment"></div>').text(comment_textarea.val()));
288   });
289
290   $('.frozenComment').live('click', unfreezeComment);
291
292   function focusOn(comment) {
293     $('.focused').removeClass('focused');
294     if (comment.length == 0)
295       return;
296     $(document).scrollTop(comment.addClass('focused').position().top - window.innerHeight/2);
297   }
298
299   function focusNextComment() {
300     var comments = $('.previousComment');
301     if (comments.length == 0)
302       return;
303     var index = comments.index($('.focused'));
304     // Notice that -1 gets mapped to 0.
305     focusOn($(comments.get(index + 1)));
306   }
307
308   function focusPreviousComment() {
309     var comments = $('.previousComment');
310     if (comments.length == 0)
311       return;
312     var index = comments.index($('.focused'));
313     if (index == -1)
314       index = comments.length;
315     if (index == 0) {
316       focusOn([]);
317       return;
318     }
319     focusOn($(comments.get(index - 1)));
320   }
321
322   var kCharCodeForN = 'n'.charCodeAt(0);
323   var kCharCodeForP = 'p'.charCodeAt(0);
324
325   $('body').live('keypress', function() {
326     // FIXME: There's got to be a better way to avoid seeing these keypress
327     // events.
328     if (event.target.nodeName == 'TEXTAREA')
329       return;
330     if (event.charCode == kCharCodeForN)
331       focusNextComment();
332     else if (event.charCode == kCharCodeForP)
333       focusPreviousComment();
334   });
335
336   function contextLinesFor(line) {
337     var context = [];
338     while (line.hasClass('commentContext')) {
339       $.merge(context, line);
340       line = line.prev();
341     }
342     return $(context.reverse());
343   }
344
345   function trimCommentContextToBefore(line) {
346     while (line.hasClass('commentContext') && line.attr('data-has-comment') != 'true') {
347       line.removeClass('commentContext');
348       line = line.prev();
349     }
350   }
351
352   var in_drag_select = false;
353
354   function stopDragSelect() {
355     $('.selected').removeClass('selected');
356     in_drag_select = false;
357   }
358
359   $('.lineNumber').live('click', function() {
360     var line = $(this).parent();
361     if (line.hasClass('commentContext'))
362       trimCommentContextToBefore(line.prev());
363   }).live('mousedown', function() {
364     in_drag_select = true;
365     $(this).parent().addClass('selected');
366     event.preventDefault();
367   });
368   
369   $('.Line').live('mouseenter', function() {
370     if (!in_drag_select)
371       return;
372
373     var before = $(this).prevUntil('.selected')
374     if (before.prev().hasClass('selected'))
375       before.addClass('selected');
376
377     var after = $(this).nextUntil('.selected')
378     if (after.next().hasClass('selected'))
379       after.addClass('selected');
380
381     $(this).addClass('selected');
382   }).live('mouseup', function() {
383     if (!in_drag_select)
384       return;
385     var selected = $('.selected');
386     var should_add_comment = !selected.last().next().hasClass('commentContext');
387     selected.addClass('commentContext');
388     if (should_add_comment)
389       addCommentFor(selected.last());
390   });
391
392   $('.DiffSection').live('mouseleave', stopDragSelect).live('mouseup', stopDragSelect);
393
394   function contextSnippetFor(line, indent) {
395     var snippets = []
396     contextLinesFor(line).each(function() {
397       var action = ' ';
398       if ($(this).hasClass('add'))
399         action = '+';
400       else if ($(this).hasClass('remove'))
401         action = '-';
402       var text = $(this).children('.text').text();
403       snippets.push(indent + action + text);
404     });
405     return snippets.join('\n');
406   }
407
408   function fileNameFor(line) {
409     return line.parentsUntil('.FileDiff').parent().find('h1').text();
410   }
411
412   function indentFor(depth) {
413     return (new Array(depth + 1)).join('>') + ' ';
414   }
415
416   function snippetFor(line, indent) {
417     var file_name = fileNameFor(line);
418     var line_number = line.hasClass('remove') ? '-' + line.children('.from').text() : line.children('.to').text();
419     return indent + file_name + ':' + line_number + '\n' + contextSnippetFor(line, indent);
420   }
421
422   function quotePreviousComments(comments) {
423     var quoted_comments = [];
424     var depth = comments.size();
425     comments.each(function() {
426       var indent = indentFor(depth--);
427       var text = $(this).children('.content').text();
428       quoted_comments.push(indent + '\n' + indent + text.split('\n').join('\n' + indent));
429     });
430     return quoted_comments.join('\n');
431   }
432
433   $('#comment_form .winter').live('click', function() {
434     $('#comment_form').addClass('inactive');
435   });
436
437   $('#post_comments').live('click', function() {
438     var comments_in_context = []
439     forEachLine(function(line) {
440       if (line.attr('data-has-comment') != 'true')
441         return;
442       var comment = findCommentBlockFor(line).children('textarea').val().trim();
443       if (comment == '')
444         return;
445       var previous_comments = previousCommentsFor(line);
446       var snippet = snippetFor(line, indentFor(previous_comments.size() + 1));
447       var quoted_comments = quotePreviousComments(previous_comments);
448       var comment_with_context = [];
449       comment_with_context.push(snippet);
450       if (quoted_comments != '')
451         comment_with_context.push(quoted_comments);
452       comment_with_context.push('\n' + comment);
453       comments_in_context.push(comment_with_context.join('\n'));
454     });
455     $('#comment_form').removeClass('inactive');
456     var comment = $('.overallComments textarea').val().trim();
457     if (comment != '')
458       comment += '\n\n';
459     comment += comments_in_context.join('\n\n');
460     if (comments_in_context.length > 0)
461       comment = 'View in context: ' + window.location + '\n\n' + comment;
462     var review_form = $('#reviewform').contents();
463     review_form.find('#comment').val(comment);
464     review_form.find('#flags select').each(function() {
465       var control = findControlForFlag(this);
466       if (!control.size())
467         return;
468       $(this).attr('selectedIndex', control.attr('selectedIndex'));
469     });
470   });
471 })();