Bug 312197: Templatize sanitycheck.cgi - Patch by Frédéric Buclin <LpSolit@gmail.com> r/a=mkanat

3 files changed, 331 insertions, 0 deletions

diff --git a/template/en/default/admin/sanitycheck/list.html.tmpl b/template/en/default/admin/sanitycheck/list.html.tmpl
new file mode 100644
index 000000000..2e4a7e0db
--- /dev/null
+++ b/template/en/default/admin/sanitycheck/list.html.tmpl
@@ -0,0 +1,38 @@
+[%# 1.0@bugzilla.org %]
+[%# 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 Bugzilla Bug Tracking System.
+  #
+  # The Initial Developer of the Original Code is Frédéric Buclin.
+  #
+  # Contributor(s): Frédéric Buclin <LpSolit@gmail.com>
+  #%]
+
+[% PROCESS global/variables.none.tmpl %]
+
+[% PROCESS global/header.html.tmpl title = "Sanity Check"
+                                   style_urls = ['skins/standard/admin.css'] %]
+
+<div>
+  <p>
+    [% terms.Bugzilla %] is checking the referential integrity of your database.
+    This may take several minutes to complete.
+  </p>
+
+  <p>
+    Errors, if any, will be <span class="alert">emphasized like this</span>.
+    Depending on the errors found, some links will be displayed allowing you
+    to easily fix them. Fixing these errors will automatically run this script
+    again (so be aware that it may take an even longer time than the first run).
+  </p>
+</div>
+
+<hr>
diff --git a/template/en/default/admin/sanitycheck/messages.html.tmpl b/template/en/default/admin/sanitycheck/messages.html.tmpl
new file mode 100644
index 000000000..c4dabd2ca
--- /dev/null
+++ b/template/en/default/admin/sanitycheck/messages.html.tmpl
@@ -0,0 +1,288 @@
+[%# 1.0@bugzilla.org %]
+[%# 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 Bugzilla Bug Tracking System.
+  #
+  # The Initial Developer of the Original Code is Frédéric Buclin.
+  #
+  # Contributor(s): Frédéric Buclin <LpSolit@gmail.com>
+  #%]
+
+[% PROCESS global/variables.none.tmpl %]
+
+[% san_message = BLOCK %]
+  [% IF san_tag == "checks_start" %]
+    OK, now running sanity checks.
+
+  [% ELSIF san_tag == "checks_completed" %]
+    Sanity check completed.
+
+  [% ELSIF san_tag == "attachment_reference_deletion_start" %]
+    OK, now removing all references to deleted attachments.
+
+  [% ELSIF san_tag == "attachment_reference_deletion_end" %]
+    All references to deleted attachments have been removed.
+
+  [% ELSIF san_tag == "bug_check_alert" %]
+    [% errortext FILTER html %]: [% INCLUDE bug_list badbugs = badbugs %]
+
+  [% ELSIF san_tag == "bug_check_repair" %]
+    <a href="sanitycheck.cgi?[% param FILTER url_quote %]=1">[% text FILTER html %]</a>.
+
+  [% ELSIF san_tag == "bug_check_creation_date" %]
+    Checking for [% terms.bugs %] with no creation date (which makes them invisible).
+
+  [% ELSIF san_tag == "bug_check_creation_date_error_text" %]
+    [% terms.Bugs %] with no creation date
+
+  [% ELSIF san_tag == "bug_check_creation_date_repair_text" %]
+    Repair missing creation date for these [% terms.bugs %]
+
+  [% ELSIF san_tag == "bug_check_res_dupl" %]
+    Checking resolution/duplicates
+
+  [% ELSIF san_tag == "bug_check_res_dupl_error_text" %]
+    [% terms.Bugs %] found on duplicates table that are not marked duplicate
+
+  [% ELSIF san_tag == "bug_check_res_dupl_error_text2" %]
+    [% terms.Bugs %] found marked resolved duplicate and not on duplicates table
+
+  [% ELSIF san_tag == "bug_check_status_res" %]
+    Checking statuses/resolutions
+
+  [% ELSIF san_tag == "bug_check_status_res_error_text" %]
+    [% terms.Bugs %] with open status and a resolution
+
+  [% ELSIF san_tag == "bug_check_status_res_error_text2" %]
+    [% terms.Bugs %] with non-open status and no resolution
+
+  [% ELSIF san_tag == "bug_check_status_everconfirmed" %]
+    Checking statuses/everconfirmed
+
+  [% ELSIF san_tag == "bug_check_status_everconfirmed_error_text" %]
+    [% terms.Bugs %] that are UNCONFIRMED but have everconfirmed set
+
+  [% ELSIF san_tag == "bug_check_status_everconfirmed_error_text2" %]
+    [% terms.Bugs %] with confirmed status but don't have everconfirmed set
+
+  [% ELSIF san_tag == "bug_check_votes_everconfirmed" %]
+    Checking votes/everconfirmed
+
+  [% ELSIF san_tag == "bug_check_votes_everconfirmed_error_text" %]
+    [% terms.Bugs %] that have enough votes to be confirmed but haven't been
+
+  [% ELSIF san_tag == "bug_check_control_values" %]
+    Checking for bad values in group_control_map
+
+  [% ELSIF san_tag == "bug_check_control_values_alert" %]
+    Found [% entries FILTER html %] bad group_control_map entries
+
+  [% ELSIF san_tag == "bug_check_control_values_violation" %]
+    Checking for [% terms.bugs %] with groups violating their product's group controls
+
+  [% ELSIF san_tag == "bug_check_control_values_error_text" %]
+    Have groups not permitted for their products
+
+  [% ELSIF san_tag == "bug_check_control_values_repair_text" %]
+    Permit the missing groups for the affected products
+    (set member control to <code>SHOWN</code>)
+
+  [% ELSIF san_tag == "bug_check_control_values_error_text2" %]
+    Are missing groups required for their products
+
+  [% ELSIF san_tag == "bug_creation_date_start" %]
+    OK, now fixing missing [% terms.bug %] creation dates.
+
+  [% ELSIF san_tag == "bug_creation_date_fixed" %]
+    [% bug_count FILTER html %] [%+ terms.bugs %] have been fixed.
+
+  [% ELSIF san_tag == "bug_reference_deletion_start" %]
+    OK, now removing all references to deleted [% terms.bugs %].
+
+  [% ELSIF san_tag == "bug_reference_deletion_end" %]
+    All references to deleted [% terms.bugs %] have been removed.
+
+  [% ELSIF san_tag == "cross_check_to" %]
+    Checking references to [% table FILTER html %].[% field FILTER html %]...
+
+  [% ELSIF san_tag == "cross_check_from" %]
+    ... from [% table FILTER html %].[% field FILTER html %].
+
+  [% ELSIF san_tag == "cross_check_alert" %]
+    Bad value '[% value FILTER html %]' found in
+    [%+ table FILTER html %].[% field FILTER html %]
+    [% IF keyname %]
+      [% IF keyname == "bug_id" %]
+        ([% "$terms.bug $key" FILTER bug_link(key) FILTER none %])
+      [% ELSE %]
+        ([% keyname FILTER html %] == '[% key FILTER html %]')
+      [% END %]
+    [% END %]
+
+  [% ELSIF san_tag == "cross_check_attachment_has_references" %]
+    <a href="sanitycheck.cgi?remove_invalid_attach_references=1">Remove
+    invalid references to non existent attachments.</a>
+
+  [% ELSIF san_tag == "cross_check_bug_has_references" %]
+    <a href="sanitycheck.cgi?remove_invalid_bug_references=1">Remove
+    invalid references to non existent [% terms.bugs %].</a>
+
+  [% ELSIF san_tag == "double_cross_check_to" %]
+    Checking references to [% table FILTER html %].[% field1 FILTER html %] /
+    [%+ table FILTER html %].[% field2 FILTER html %]...
+
+  [% ELSIF san_tag == "double_cross_check_from" %]
+    ... from [% table FILTER html %].[% field1 FILTER html %] /
+    [%+ table FILTER html %].[% field2 FILTER html %].
+
+  [% ELSIF san_tag == "double_cross_check_alert" %]
+    Bad values '[% value1 FILTER html %]', '[% value2 FILTER html %]' found
+    in [% table FILTER html %].[% field1 FILTER html %] /
+    [%+ table FILTER html %].[% field2 FILTER html %].
+    [% IF keyname %]
+      [% IF keyname == "bug_id" %]
+        ([% "$terms.bug $key" FILTER bug_link(key) FILTER none %])
+      [% ELSE %]
+        ([% keyname FILTER html %] == '[% key FILTER html %]')
+      [% END %]
+    [% END %]
+
+  [% ELSIF san_tag == "flag_check_start" %]
+    Checking for flags being in the wrong product/component.
+
+  [% ELSIF san_tag == "flag_deletion_start" %]
+    OK, now deleting invalid flags.
+
+  [% ELSIF san_tag == "flag_deletion_end" %]
+    Invalid flags deleted.
+
+  [% ELSIF san_tag == "flag_alert" %]
+    Invalid flag [% flag_id FILTER html %] for
+    [% IF attach_id %]
+      attachment [% attach_id FILTER html %] in
+    [% END %]
+    [%+ "$terms.bug $bug_id" FILTER bug_link(bug_id) FILTER none %].
+
+  [% ELSIF san_tag == "flag_fix" %]
+    <a href="sanitycheck.cgi?remove_invalid_flags=1">Click
+    here to delete invalid flags</a>
+
+  [% ELSIF san_tag == "group_control_map_entries_creation" %]
+    OK, now creating <code>SHOWN</code> member control entries
+    for product/group combinations lacking one.
+
+  [% ELSIF san_tag == "group_control_map_entries_update" %]
+    Updating <code>NA/<em>xxx</em></code> group control setting
+    for group <em>[% group_name FILTER html %]</em> to
+    <code>SHOWN/<em>xxx</em></code> in product
+    <em>[% product_name FILTER html %]</em>.
+
+  [% ELSIF san_tag == "group_control_map_entries_generation" %]
+    Generating <code>SHOWN/NA</code> group control setting
+    for group <em>[% group_name FILTER html %]</em> in product
+    <em>[% product_name FILTER html %]</em>.
+
+  [% ELSIF san_tag == "group_control_map_entries_repaired" %]
+    Repaired [% counter FILTER html %] defective group control settings.
+
+  [% ELSIF san_tag == "keyword_check_start" %]
+    Checking keywords table.
+
+  [% ELSIF san_tag == "keyword_check_alert" %]
+    Duplicate entry in keyworddefs for id [% id FILTER html %].
+
+  [% ELSIF san_tag == "keyword_check_invalid_name" %]
+    Bogus name in keyworddefs for id [% id FILTER html %].
+
+  [% ELSIF san_tag == "keyword_check_invalid_id" %]
+    Bogus keywordids [% id FILTER html %] found in keywords table.
+
+  [% ELSIF san_tag == "keyword_check_duplicated_ids" %]
+    Duplicate keyword IDs found in [% "$terms.bug $id" FILTER bug_link(id) FILTER none %].
+
+  [% ELSIF san_tag == "keyword_cache_start" %]
+    Checking cached keywords.
+
+  [% ELSIF san_tag == "keyword_cache_alert" %]
+    [% badbugs.size FILTER none %] [%+ terms.bugs %] found with
+    incorrect keyword cache: [% INCLUDE bug_list badbugs = badbugs %]
+
+  [% ELSIF san_tag == "keyword_cache_fixing" %]
+    OK, now fixing keyword cache.
+
+  [% ELSIF san_tag == "keyword_cache_fixed" %]
+    Keyword cache fixed.
+
+  [% ELSIF san_tag == "keyword_cache_rebuild" %]
+    <a href="sanitycheck.cgi?rebuildkeywordcache=1">Click here to
+    rebuild the keyword cache</a>.
+
+  [% ELSIF san_tag == "profile_login_start" %]
+    Checking profile logins.
+
+  [% ELSIF san_tag == "profile_login_alert" %]
+    Bad profile email address, id=[% id FILTER html %],
+    &lt;[% email FILTER html %]&gt;.
+
+  [% ELSIF san_tag == "repair_bugs" %]
+    Repair these [% terms.bugs %].
+
+  [% ELSIF san_tag == "send_bugmail_start" %]
+    OK, now attempting to send unsent mail.
+
+  [% ELSIF san_tag == "send_bugmail_status" %]
+    [% bug_count FILTER html %] [%+ terms.bugs %] found with
+    possibly unsent mail.
+
+  [% ELSIF san_tag == "send_bugmail_end" %]
+    Unsent mail has been sent.
+
+  [% ELSIF san_tag == "unsent_bugmail_check" %]
+    Checking for unsent mail
+
+  [% ELSIF san_tag == "unsent_bugmail_alert" %]
+    [% terms.Bugs %] that have changes but no mail sent for at least
+    half an hour: [% INCLUDE bug_list badbugs = badbugs %]
+
+  [% ELSIF san_tag == "unsent_bugmail_fix" %]
+    <a href="sanitycheck.cgi?rescanallBugMail=1">Send these mails</a>.
+
+  [% ELSIF san_tag == "vote_cache_rebuild_start" %]
+    OK, now rebuilding vote cache.
+
+  [% ELSIF san_tag == "vote_cache_rebuild_end" %]
+    Vote cache has been rebuilt.
+
+  [% ELSIF san_tag == "vote_cache_rebuild_fix" %]
+    <a href="sanitycheck.cgi?rebuildvotecache=1">Click here to
+    rebuild the vote cache</a>
+
+  [% ELSIF san_tag == "vote_cache_alert" %]
+    Bad vote cache for [% "$terms.bug $id" FILTER bug_link(id) FILTER none %]
+
+  [% ELSIF san_tag == "vote_count_start" %]
+    Checking cached vote counts.
+
+  [% ELSIF san_tag == "vote_count_alert" %]
+    Bad vote sum for [% terms.bug %] [%+ id FILTER html %].
+
+  [% END %]
+[% END %]
+
+[% san_message FILTER html %]
+
+
+[% BLOCK bug_list %]
+  [% FOREACH bug_id = badbugs %]
+    [%+ bug_id FILTER bug_link(bug_id) FILTER none %][% ", " IF !loop.last %]
+  [% END %]
+  (<a href="buglist.cgi?bug_id=[% badbugs.join(",") FILTER url_quote %]">as buglist</a>).
+[% END %]
diff --git a/template/en/default/global/messages.html.tmpl b/template/en/default/global/messages.html.tmpl
index b0d92b3d1..ef03f7614 100644
--- a/template/en/default/global/messages.html.tmpl
+++ b/template/en/default/global/messages.html.tmpl
@@ -374,6 +374,11 @@
     set to zero automatically as part of marking this [% terms.bug %]
     as either RESOLVED or CLOSED.
 
+  [% ELSIF message_tag == "sanitycheck" %]
+    [%# We use this way to call sanitycheck-specific messages so that
+      # we can still use get_text(). %]
+    [% PROCESS "admin/sanitycheck/messages.html.tmpl" %]
+
   [% ELSIF message_tag == "sudo_started" %]
     [% title = "Sudo session started" %]
       The sudo session has been started.  For the next 6 hours, or until you