Bug 190223: Complete templatization for editkeywords.cgi; reviewed by kiko, jth, gerv; r/a=justdave.

1 files changed, 42 insertions, 140 deletions

diff --git a/editkeywords.cgi b/editkeywords.cgi
index c51580272..cf20d7a07 100755
--- a/editkeywords.cgi
+++ b/editkeywords.cgi
@@ -1,4 +1,4 @@
-#!/usr/bin/perl -w
+#!/usr/bin/perl -wT
 # -*- Mode: perl; indent-tabs-mode: nil -*-
 #
 # The contents of this file are subject to the Mozilla Public
@@ -29,83 +29,19 @@ use Bugzilla::Config qw(:DEFAULT $datadir);
 
 use vars qw($template $vars);
 
-my $localtrailer = "<A HREF=\"editkeywords.cgi\">edit</A> more keywords";
-
-
-#
-# Displays a text like "a.", "a or b.", "a, b or c.", "a, b, c or d."
-# 
-# XXX This implementation of PutTrailer outputs a default link back to
-# the query page instead of the index, which is inconsistent with other
-# PutTrailer() implementations.
-#
-
-sub PutTrailer (@)
-{
-    my (@links) = ("Back to the <A HREF=\"query.cgi\">query page</A>", @_);
-
-    my $count = $#links;
-    my $num = 0;
-    print "<P>\n";
-    foreach (@links) {
-        print $_;
-        if ($num == $count) {
-            print ".\n";
-        }
-        elsif ($num == $count-1) {
-            print " or ";
-        }
-        else {
-            print ", ";
-        }
-        $num++;
-    }
-    PutFooter();
-}
-
-
-#
-# Displays the form to edit a keyword's parameters
-#
-
-sub EmitFormElements ($$$)
-{
-    my ($id, $name, $description) = @_;
-
-    $name = value_quote($name);
-    $description = value_quote($description);
-
-    print qq{<INPUT TYPE="HIDDEN" NAME=id VALUE=$id>};
-
-    print "  <TR><TH ALIGN=\"right\">Name:</TH>\n";
-    print "  <TD><INPUT SIZE=64 MAXLENGTH=64 NAME=\"name\" VALUE=\"$name\"></TD>\n";
-    print "</TR><TR>\n";
-
-    print "  <TH ALIGN=\"right\">Description:</TH>\n";
-    print "  <TD><TEXTAREA ROWS=4 COLS=64 WRAP=VIRTUAL NAME=\"description\">$description</TEXTAREA></TD>\n";
-    print "</TR>\n";
-
-}
-
 
 sub Validate ($$) {
     my ($name, $description) = @_;
     if ($name eq "") {
-        print "You must enter a non-blank name for the keyword. Please press\n";
-        print "<b>Back</b> and try again.\n";
-        PutTrailer($localtrailer);
+        ThrowUserError("keyword_blank_name");
         exit;
     }
     if ($name =~ /[\s,]/) {
-        print "You may not use commas or whitespace in a keyword name.\n";
-        print "Please press <b>Back</b> and try again.\n";
-        PutTrailer($localtrailer);
+        ThrowUserError("keyword_invalid_name");
         exit;
     }    
     if ($description eq "") {
-        print "You must enter a non-blank description of the keyword.\n";
-        print "Please press <b>Back</b> and try again.\n";
-        PutTrailer($localtrailer);
+        ThrowUserError("keyword_blank_description");
         exit;
     }
 }
@@ -121,10 +57,7 @@ confirm_login();
 print Bugzilla->cgi->header();
 
 unless (UserInGroup("editkeywords")) {
-    PutHeader("Not allowed");
-    print "Sorry, you aren't a member of the 'editkeywords' group.\n";
-    print "And so, you aren't allowed to add, modify or delete keywords.\n";
-    PutTrailer();
+    ThrowUserError("keyword_access_denied");
     exit;
 }
 
@@ -136,51 +69,31 @@ detaint_natural($::FORM{id});
 
 
 if ($action eq "") {
-    PutHeader("Select keyword");
-    my $tableheader = qq{
-<TABLE BORDER=1 CELLPADDING=4 CELLSPACING=0>
-<TR BGCOLOR="#6666FF">
-<TH ALIGN="left">Edit keyword ...</TH>
-<TH ALIGN="left">Description</TH>
-<TH ALIGN="left">Bugs</TH>
-<TH ALIGN="left">Action</TH>
-</TR>
-};
-    print $tableheader;
-    my $line_count = 0;
-    my $max_table_size = 50;
+    my @keywords;
 
     SendSQL("SELECT keyworddefs.id, keyworddefs.name, keyworddefs.description,
                     COUNT(keywords.bug_id)
              FROM keyworddefs LEFT JOIN keywords ON keyworddefs.id = keywords.keywordid
              GROUP BY keyworddefs.id
              ORDER BY keyworddefs.name");
+
     while (MoreSQLData()) {
         my ($id, $name, $description, $bugs) = FetchSQLData();
-        $description ||= "<FONT COLOR=\"red\">missing</FONT>";
-        $bugs ||= 'none';
-        if ($line_count == $max_table_size) {
-            print "</table>\n$tableheader";
-            $line_count = 0;
-        }
-        $line_count++;
-            
-        print qq{
-<TR>
-<TH VALIGN="top"><A HREF="editkeywords.cgi?action=edit&id=$id">$name</TH>
-<TD VALIGN="top">$description</TD>
-<TD VALIGN="top" ALIGN="right">$bugs</TD>
-<TH VALIGN="top"><A HREF="editkeywords.cgi?action=delete&id=$id">Delete</TH>
-</TR>
-};
+        my $keyword = {};
+        $keyword->{'id'} = $id;
+        $keyword->{'name'} = $name;
+        $keyword->{'description'} = $description;
+        $keyword->{'bug_count'} = $bugs;
+        push(@keywords, $keyword);
     }
-    print qq{
-<TR>
-<TD VALIGN="top" COLSPAN=3>Add a new keyword</TD><TD><A HREF="editkeywords.cgi?action=add">Add</TD>
-</TR>
-</TABLE>
-};
-    PutTrailer();
+
+    print Bugzilla->cgi->header();
+
+    $vars->{'keywords'} = \@keywords;
+    $template->process("admin/keywords/list.html.tmpl",
+                       $vars)
+      || ThrowTemplateError($template->error());
+
     exit;
 }
     
@@ -200,8 +113,6 @@ if ($action eq 'add') {
 #
 
 if ($action eq 'new') {
-    PutHeader("Adding new keyword");
-
     # Cleanups and valididy checks
 
     my $name = trim($::FORM{name} || '');
@@ -212,9 +123,8 @@ if ($action eq 'new') {
     SendSQL("SELECT id FROM keyworddefs WHERE name = " . SqlQuote($name));
 
     if (FetchOneColumn()) {
-        print "The keyword '$name' already exists. Please press\n";
-        print "<b>Back</b> and try again.\n";
-        PutTrailer($localtrailer);
+        $vars->{'name'} = $name;
+        ThrowUserError("keyword_already_exists");
         exit;
     }
 
@@ -244,9 +154,13 @@ if ($action eq 'new') {
     # Make versioncache flush
     unlink "$datadir/versioncache";
 
-    print "OK, done.<p>\n";
-    PutTrailer("<a href=\"editkeywords.cgi\">edit</a> more keywords",
-        "<a href=\"editkeywords.cgi?action=add\">add</a> another keyword");
+    print Bugzilla->cgi->header();
+
+    $vars->{'name'} = $name;
+    $template->process("admin/keywords/created.html.tmpl",
+                       $vars)
+      || ThrowTemplateError($template->error());
+
     exit;
 }
 
@@ -259,8 +173,6 @@ if ($action eq 'new') {
 #
 
 if ($action eq 'edit') {
-    PutHeader("Edit keyword");
-
     my $id  = trim($::FORM{id} || 0);
     # get data of keyword
     SendSQL("SELECT name,description
@@ -268,35 +180,28 @@ if ($action eq 'edit') {
              WHERE id=$id");
     my ($name, $description) = FetchSQLData();
     if (!$name) {
-        print "Something screwy is going on.  Please try again.\n";
-        PutTrailer($localtrailer);
+        $vars->{'id'} = $id;
+        ThrowCodeError("invalid_keyword_id", $vars);
         exit;
     }
-    print "<FORM METHOD=POST ACTION=editkeywords.cgi>\n";
-    print "<TABLE  BORDER=0 CELLPADDING=4 CELLSPACING=0>\n";
 
-    EmitFormElements($id, $name, $description);
-    
-    print "<TR>\n";
-    print "  <TH ALIGN=\"right\">Bugs:</TH>\n";
-    print "  <TD>";
     SendSQL("SELECT count(*)
              FROM keywords
              WHERE keywordid = $id");
     my $bugs = '';
     $bugs = FetchOneColumn() if MoreSQLData();
-    print $bugs || 'none';
 
-    print "</TD>\n</TR></TABLE>\n";
+    $vars->{'keyword_id'} = $id;
+    $vars->{'name'} = $name;
+    $vars->{'description'} = $description;
+    $vars->{'bug_count'} = $bugs;
 
-    print "<INPUT TYPE=HIDDEN NAME=\"action\" VALUE=\"update\">\n";
-    print "<INPUT TYPE=SUBMIT VALUE=\"Update\">\n";
+    print Bugzilla->cgi->header();
 
-    print "</FORM>";
+    $template->process("admin/keywords/edit.html.tmpl",
+                       $vars)
+      || ThrowTemplateError($template->error());
 
-    my $x = $localtrailer;
-    $x =~ s/more/other/;
-    PutTrailer($x);
     exit;
 }
 
@@ -317,11 +222,8 @@ if ($action eq 'update') {
     my $tmp = FetchOneColumn();
 
     if ($tmp && $tmp != $id) {
-        PutHeader("Update keyword");
-
-        print "The keyword '$name' already exists. Please press\n";
-        print "<b>Back</b> and try again.\n";
-        PutTrailer($localtrailer);
+        $vars->{'name'} = $name;
+        ThrowUserError("keyword_already_exists", $vars);
         exit;
     }