Initial checkin of bmo/4.0 extensions. Still todo: port changes to core Bugzilla code

2 files changed, 417 insertions, 0 deletions

diff --git a/extensions/Splinter/template/en/default/pages/splinter.html.tmpl b/extensions/Splinter/template/en/default/pages/splinter.html.tmpl
new file mode 100644
index 000000000..adb8b52f9
--- /dev/null
+++ b/extensions/Splinter/template/en/default/pages/splinter.html.tmpl
@@ -0,0 +1,264 @@
+[%#
+  # The contents of this file are subject to the Mozilla Public
+  # License Version 1.1 (the "License"); you may not use this file
+  # except in compliance with the License. You may obtain a copy of
+  # the License at http://www.mozilla.org/MPL/
+  #
+  # Software distributed under the License is distributed on an "AS
+  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+  # implied. See the License for the specific language governing
+  # rights and limitations under the License.
+  #
+  # The Original Code is the Splinter Bugzilla Extension.
+  #
+  # The Initial Developer of the Original Code is Red Hat, Inc.
+  # Portions created by Red Hat, Inc. are Copyright (C) 2008
+  # Red Hat, Inc. All Rights Reserved.
+  #
+  # Contributor(s): Owen Taylor <otaylor@redhat.com>
+  #                 David Lawrence <dkl@mozilla.com>
+  #%]
+
+[% PROCESS global/header.html.tmpl
+  title = "Patch Review"
+  header = "Patch Review"
+  style_urls = [ "js/yui/assets/skins/sam/container.css",
+                 "js/yui/assets/skins/sam/button.css",
+                 "js/yui/assets/skins/sam/datatable.css",
+                 "extensions/Splinter/web/splinter.css" ]
+  javascript_urls = [ "js/yui/element/element-min.js",
+                      "js/yui/connection/connection-min.js",
+                      "js/yui/container/container-min.js",
+                      "js/yui/button/button-min.js", 
+                      "js/yui/json/json-min.js",
+                      "js/yui/datasource/datasource-min.js",
+                      "js/yui/datatable/datatable-min.js",
+                      "extensions/Splinter/web/splinter.js" ]
+%]
+
+[% can_edit = 0 %]
+
+<script type="text/javascript">
+  Splinter.configBase = '[% urlbase FILTER none %][% Param('splinter_base') FILTER js %]';
+  Splinter.configBugzillaUrl = '[% urlbase FILTER none %]';
+  Splinter.configHaveExtension = true;
+  Splinter.configHelp = '[% urlbase FILTER none %]page.cgi?id=splinter/help.html';
+  Splinter.configNote = '';
+
+  Splinter.configAttachmentStatuses = [
+  [% FOREACH status = attachment_statuses %]
+    '[% status FILTER js %]',
+  [% END %]
+  ];
+
+  Splinter.bugId = Splinter.Utils.isDigits('[% bug_id FILTER js %]') ? parseInt('[% bug_id FILTER js %]') : NaN;
+  Splinter.attachmentId = Splinter.Utils.isDigits('[% attach_id FILTER html %]') ? parseInt('[% attach_id FILTER js %]') : NaN;
+
+  if (!isNaN(Splinter.bugId)) {
+      var theBug = new Splinter.Bug.Bug();
+      theBug.id = parseInt('[% bug.id FILTER js %]');
+      theBug.token = '[% update_token FILTER js %]';
+      theBug.shortDesc = Splinter.Utils.strip('[% bug.short_desc FILTER js %]');
+      theBug.creationDate = Splinter.Bug.parseDate('[% bug.creation_ts FILTER time("%Y-%m-%d %T %z") FILTER js %]');
+      theBug.reporterEmail = Splinter.Utils.strip('[% bug.reporter.email FILTER js %]');
+      theBug.reporterName = Splinter.Utils.strip('[% bug.reporter.name FILTER js %]');
+  
+      [% FOREACH comment = bug.comments %]
+         var comment = new Splinter.Bug.Comment();
+         comment.whoName = Splinter.Utils.strip('[% comment.author.name FILTER js %]');
+         comment.whoEmail = Splinter.Utils.strip('[% comment.author.email FILTER js %]');
+         comment.date = Splinter.Bug.parseDate('[% comment.creation_ts FILTER time("%Y-%m-%d %T %z") FILTER js %]');
+         comment.text = '[% comment.thetext FILTER js %]';
+         theBug.comments.push(comment);
+      [% END %]
+
+      [% FOREACH attachment = bug.attachments %]
+         [% NEXT IF attachment.isprivate && !user.is_insider && attachment.attacher.id != user.id %]        
+         var attachid = parseInt('[% attachment.id FILTER js %]');
+         var attachment = new Splinter.Bug.Attachment('', attachid);
+         [% IF attachment.id == attach_id && attachment.ispatch %]
+           [% flag_types = attachment.flag_types %]
+           [% can_edit = attachment.validate_can_edit %]
+           attachment.data = '[% attach_data FILTER js %]';
+           attachment.token = '[% issue_hash_token([attachment.id, attachment.modification_time]) FILTER js %]';
+         [% END %]
+         attachment.description = Splinter.Utils.strip('[% attachment.description FILTER js %]');
+         attachment.filename = Splinter.Utils.strip('[% attachment.filename FILTER js %]');
+         attachment.contenttypeentry = Splinter.Utils.strip('[% attachment.contenttypeentry FILTER js %]');
+         attachment.date = Splinter.Bug.parseDate('[% attachment.attached FILTER time("%Y-%m-%d %T %z") FILTER js %]');
+         attachment.whoName = Splinter.Utils.strip('[% attachment.attacher.name FILTER js %]');
+         attachment.whoEmail = Splinter.Utils.strip('[% attachment.attacher.email FILTER js %]');
+         // attachment.status = Splinter.Utils.strip($(this).children('status').text());
+         // if (attachment.status == "")
+         //     attachment.status = null;
+         attachment.isPatch = [% attachment.ispatch ? 1 : 0 %];
+         attachment.isObsolete = [% attachment.isobsolete ? 1 : 0 %];
+         attachment.isPrivate = [% attachment.isprivate ? 1 : 0 %];
+         theBug.attachments.push(attachment);
+      [% END %]
+     
+      Splinter.theBug = theBug;
+  }
+</script>
+
+<!--[if lt IE 7]>
+<p style="border: 1px solid #880000; padding: 1em; background: #ffee88; font-size: 120%;">
+   Splinter Patch Review requires a modern browser, such as
+   <a href="http://www.firefox.com">Firefox</a>, for correct operation.
+</p>
+<![endif]-->
+
+<div id="helpful-links">
+  <a id="allReviewsLink" href="[% urlbase FILTER none %][% Param('splinter_base') FILTER js %]">
+    [reviews]</a>
+  <a id='helpLink' target='splinterHelp' 
+     href="[% urlbase FILTER none %]page.cgi?id=splinter/help.html">
+    [help]</a>
+</div>
+
+<div id="bugInfo" style="display: none;">
+  <b>[% terms.Bug %] <a id="bugLink"><span id="bugId"></span></a>:</b>
+  <span id="bugShortDesc"></span> -
+  <span id="bugReporter"></span> -
+  <span id="bugCreationDate"></span>
+</div>
+
+<div id="attachInfo" style="display:none;">
+  <b>Attachment <a id="attachLink"><span id="attachId"></span></a>:</b>
+  <span id="attachDesc"></span> -
+  <span id="attachCreator"></span> -
+  <span id="attachDate"></span>
+  [% IF feature_enabled('patch_viewer') %]
+    <a href="[% urlbase FILTER none %]attachment.cgi?id=[% attach_id FILTER uri %]&amp;action=diff"
+       target="_blank">[diff]</a>
+  [% END %]
+  <a href="[% urlbase FILTER none %]attachment.cgi?id=[% attach_id FILTER uri %]&amp;action=edit"
+     target="_blank">[details]</a>
+</div>
+
+<div id="error" style="display: none;"> </div>
+
+<div id="enterBug" style="display: none;">
+  [% terms.Bug %] to review:
+  <input id="enterBugInput" />
+  <input id="enterBugGo" type="button" value="Go" />
+  <div id="chooseReview" style="display: none;">
+    Drafts and published reviews:
+    <div id="chooseReviewTable"></div>
+  </div>
+</div>
+
+<div id="chooseAttachment" style="display: none;">
+  <div id="chooseAttachmentTable"></div>
+</div>
+
+<div id="quickHelpShow" style="display:none;">
+  <p>
+    <a href="javascript:Splinter.quickHelpToggle();" title="Show the quick help section" id="quickHelpToggle">
+    Show Quick Help</a>
+  </p>
+</div>
+
+<div id="quickHelpContent" style="display:none;">
+  <p>
+    <a href="javascript:Splinter.quickHelpToggle();" title="Hide the quick help section" id="quickHelpToggle">Close Quick Help</a>
+  </p>
+  <ul id="quickHelpList">
+    <li>From the Overview page, you can add a more generic overview comment that will appear at the beginning of your review.</li>
+    <li>To comment on a specific lines in the patch, first select the filename from the file navigation links.</li>
+    <li>Then double click the line you want to review and a comment box will appear below the line.</li>
+    <li>When the review is complete and you publish it, the overview comment and all line specific comments with their context, 
+        will be combined together into a single review comment on the [% terms.bug %] report.</li>
+    <li>For more detailed instructions, read the Splinter 
+        <a id='helpLink' target='splinterHelp' href="[% urlbase FILTER none %]page.cgi?id=splinter/help.html">help page</a>.
+    </li>
+  </ul>
+</div>
+
+<div id="navigationContainer" style="display: none;">
+  <b>Navigation:</b> <span id="navigation"></span>
+</div>
+
+<div id="overview" style="display: none;">
+  <div id="patchIntro"></div>
+  <div>
+    <span id="restored" style="display: none;">
+      (Restored from draft; last edited <span id="restoredLastModified"></span>)
+    </span>
+  </div>
+  <div>
+    <div id="myCommentFrame">
+      <textarea id="myComment"></textarea>
+      <div id="emptyCommentNotice">&lt;Overall Comment&gt;</div>
+    </div>
+    <div id="myPatchComments"></div>
+    <form id="publish" method="post" action="attachment.cgi" onsubmit="normalizeComments();">
+      <input type="hidden" id="publish_token" name="token" value="">
+      <input type="hidden" id="publish_action" name="action" value="update">
+      <input type="hidden" id="publish_review" name="comment" value="">
+      <input type="hidden" id="publish_attach_id" name="id" value="">
+      <input type="hidden" id="publish_attach_desc" name="description" value="">
+      <input type="hidden" id="publish_attach_filename" name="filename" value="">
+      <input type="hidden" id="publish_attach_contenttype" name="contenttypeentry" value="">
+      <input type="hidden" id="publish_attach_ispatch" name="ispatch" value="">
+      <input type="hidden" id="publish_attach_isobsolete" name="isobsolete" value="">
+      <input type="hidden" id="publish_attach_isprivate" name="isprivate" value="">
+      <div id="attachment_flags">
+        [% any_flags_requesteeble = 0 %]
+        [% FOREACH flag_type = flag_types %]
+          [% NEXT UNLESS flag_type.is_active %]
+          [% SET any_flags_requesteeble = 1 IF flag_type.is_requestable && flag_type.is_requesteeble %]
+        [% END %]
+        [% IF flag_types.size > 0 %]
+          [% PROCESS "flag/list.html.tmpl" bug_id = bug_id
+                                           attach_id = attach_d
+                                           flag_types = flag_types
+                                           read_only_flags = !can_edit
+                                           any_flags_requesteeble = any_flags_requesteeble
+           %]
+        [% END %]
+        <script>
+          [% FOREACH flag_type = flag_types %]
+            [% NEXT UNLESS flag_type.is_active %]
+            Event.addListener('flag_type-[% flag_type.id FILTER js %]', 'change', 
+                              function() { Splinter.flagChanged = 1;        
+                                           Splinter.queueUpdateHaveDraft(); });
+            [% FOREACH flag = flag_type.flags %]
+              Event.addListener('flag-[% flag.id FILTER js %]', 'change', 
+                                function() { Splinter.flagChanged = 1;
+                                             Splinter.queueUpdateHaveDraft(); });
+            [% END %]
+          [% END %]
+        </script>
+      </div>
+    </form>
+    <div id="buttonBox">
+      <span id="attachmentStatusSpan">Patch Status:
+        <select id="attachmentStatus"> </select>
+      </span>
+      <input id="publishButton" type="button" value="Publish" />
+      <input id="cancelButton" type="button" value="Cancel" />
+    </div>
+    <div class="clear"></div>
+  </div>
+  <div id="oldReviews" style="display: none;">
+    <div class="review-title">
+      Previous Reviews
+    </div>
+  </div>
+</div>
+
+<div id="files" style="display: none;">
+  <div id="file-collapse-all" style="display:none;">
+    <a href="javascript:void(0);" onclick="Splinter.toggleCollapsed('', 'none')">Collapse All</a> |
+    <a href="javascript:void(0);" onclick="Splinter.toggleCollapsed('', 'block')">Expand All</a> 
+  </div>
+</div>
+
+<div id="credits">
+  Powered by <a href="http://fishsoup.net/software/splinter">Splinter</a> 
+</div>
+
+<div id="saveDraftNotice" style="display: none;"></div>
+
+[% PROCESS global/footer.html.tmpl %]
diff --git a/extensions/Splinter/template/en/default/pages/splinter/help.html.tmpl b/extensions/Splinter/template/en/default/pages/splinter/help.html.tmpl
new file mode 100644
index 000000000..bff004c8f
--- /dev/null
+++ b/extensions/Splinter/template/en/default/pages/splinter/help.html.tmpl
@@ -0,0 +1,153 @@
+[%#
+  # The contents of this file are subject to the Mozilla Public
+  # License Version 1.1 (the "License"); you may not use this file
+  # except in compliance with the License. You may obtain a copy of
+  # the License at http://www.mozilla.org/MPL/
+  #
+  # Software distributed under the License is distributed on an "AS
+  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+  # implied. See the License for the specific language governing
+  # rights and limitations under the License.
+  #
+  # The Original Code is the Splinter Bugzilla Extension.
+  #
+  # The Initial Developer of the Original Code is Red Hat, Inc.
+  # Portions created by Red Hat, Inc. are Copyright (C) 2008
+  # Red Hat, Inc. All Rights Reserved.
+  #
+  # Contributor(s): Owen Taylor <otaylor@redhat.com>
+  #%]
+
+[% PROCESS global/header.html.tmpl
+  title = "Patch Review Help"
+  header = "Patch Review Help"
+%]
+
+<h2>Splinter Patch Review</h2>
+<p>
+  Splinter is an add-on for [% terms.Bugzilla %] to allow conveniently
+  reviewing patches that people have attached to
+  [% terms.Bugzilla %]. <a href="http://fishsoup.net/software/splinter">More
+  information about Splinter</a>.
+</p>
+<h3>The patch review view</h3>
+<p>
+  If you get to Splinter by clicking on a link next to an
+  attachment in [% terms.Bugzilla %], you are presented with the patch
+  review view. This view has a number of different pages that can
+  be switched between with the links at the top of the screen.
+  The first page is the Overview page, the other pages correspond to
+  individual files changed by the review.
+</p>
+<p>
+  On the Overview page, from top to bottom are shown:
+</p>
+<ul>
+  <li>Introductory text to the patch. For a patch that was created
+  using 'git format-patch' this will be the Git commit
+  message.</li>
+  <li>Controls for creating a new review</li>
+  <li>Previous reviews that other people have written.</li>
+</ul>
+<p>
+  The pages for each file show a two-column view of the changes.
+  The left column is the previous contents of the file,
+  the right column is the new contents of the file. (If the file
+  is an entirely new file or an entirely deleted file, only one
+  column will be shown.) Red indicates lines that have been
+  removed, green lines that have been added, and blue lines that
+  were modified.
+</p>
+<p>
+  If people have previously made comments on individual lines of
+  the patch, they will show up both summarized on the Overview
+  page and also inline when looking at the files of the patch.
+</p>
+<h3>Reviewing an existing patch</h3>
+<p>
+  There are three components to a review:
+</p>
+<ul>
+  <li>
+  An overall comment. The text area on the first page allows
+  you to enter your overall thoughts on the [% terms.bug %].
+  </li>
+  <li>
+  Detailed comments on changes within the files. To comment on a
+  line in a patch, double click on it, and a text area will open
+  beneath that comment. When you are done, click the Save button
+  to save your comment or the Cancel button to throw your
+  comment away. You can double-click on a saved comment to start
+  editing it again and make further changes.
+  </li>
+  <li>
+  A change to the attachment status. (This is specific to
+  [% terms.Bugzilla %] instances that have attachment status, which is a
+  non-upstream patch. It's somewhat similar to attachment flags,
+  which splinter doesn't currently support displaying or
+  changing.) This allows you to mark a patch as read to commit
+  or needing additional work. This is done by changing the
+  drop-down next to the Publish button.
+  </li>
+</ul>
+<p>
+  Once you are done writing your review, go back to Overview page
+  and click the "Publish" button to submit it as a comment on the
+  [% terms.bug %]. The comment will have a link back to the review page so
+  that people can see your comments with the full context.
+</p>
+<h3>Saved drafts</h3>
+<p>
+  Whenever you start making changes, a draft is automatically
+  saved. If you come back to the patch review page for the same
+  attachment, that draft will automatically be resumed. Drafts are
+  not visible to anybody else until published.
+</p>
+<p>
+  Note that saving drafts requires the your browser to have support
+  for the "DOM Storage" standard. At time of writing, this is
+  available only in a few very recent browsers, like Firefox
+  3.5. Strict privacy protections like disabling cookies may also
+  disable DOM Storage, since it provides another mechanism for
+  sites to track information about their users.
+</p>
+<h3>Responding to someone's review</h3>
+<p>
+  A response is treated just like any other review and created the
+  same way. A couple of features are helpful when responding: you
+  can double-click on an inline comment to respond to it. And on
+  the overview page, when you click on a detailed comment, you are
+  taken directly to the original location of the comment.
+</p>
+<h3>Uploading patches for review</h3>
+<p>
+  Splinter doesn't really care how patches are provided to
+  [% terms.Bugzilla %], as long as they are well-formatted patches. If you are
+  using Git for version control, you can either format changes as
+  patches
+  using <a href="http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html">'git
+  format-patch</a> and attach them manually to the [% terms.bug %], or you
+  can
+  use <a href="http://fishsoup.net/software/git-bz">git-bz</a>.
+  git-bz is highly recommended; it automates most of the steps
+  that Splinter can't handle: it files new [% terms.bugs %], attaches updated
+  attachments to existing [% terms.bugs %], and closes [% terms.bugs %] when you push the
+  corresponding git commits to your central repository.
+</p>
+<h3>The [% terms.bug %] review view</h3>
+<p>
+  Splinter also has a view where it shows all patches attached to
+  the [% terms.bug %] with their status and links to review them. You are
+  taken to this page after publishing a review. You can also get
+  to this page with the [% terms.bug %] link in the upper-right corner of the
+  patch review view.
+</p>
+<h3>Your reviews</h3>
+<p>
+  Splinter can also show you a list of all your draft and
+  published reviews. Access this page with the "Your reviews"
+  link at the bottom of the [% terms.bug %] review view. In-progress drafts
+  are shown in bold.
+</p>
+
+[% PROCESS global/footer.html.tmpl %]