From 397beebc19dfac0417a64fdbcfb4e6657f6ad9f5 Mon Sep 17 00:00:00 2001 From: "terry%mozilla.org" <> Date: Fri, 7 Jan 2000 05:16:13 +0000 Subject: Add support for a new "keywords" feature. This lets some central authority maintain a list of keywords, and users can associate any keyword with any bug. The new functionality won't appear until at least one keyword is defined. Note that you *must* run the "checksetup.pl" script after updating this change, in order to create the new required tables "keywords" and "keyworddefs". --- bug_form.pl | 19 +++ buglist.cgi | 42 +++++- checksetup.pl | 13 ++ describekeywords.cgi | 74 ++++++++++ editkeywords.cgi | 379 +++++++++++++++++++++++++++++++++++++++++++++++++++ globals.pl | 12 ++ process_bug.cgi | 80 ++++++++++- query.cgi | 43 ++++-- 8 files changed, 646 insertions(+), 16 deletions(-) create mode 100755 describekeywords.cgi create mode 100755 editkeywords.cgi diff --git a/bug_form.pl b/bug_form.pl index 3d7179d78..63db92d02 100644 --- a/bug_form.pl +++ b/bug_form.pl @@ -37,6 +37,7 @@ sub bug_form_pl_sillyness { $zz = @::legal_priority; $zz = @::legal_resolution_no_dup; $zz = @::legal_severity; + $zz = @::keywordsbyname; } my %knownattachments; @@ -329,6 +330,24 @@ if (Param("usestatuswhiteboard")) { "; } +if (@::legal_keywords) { + SendSQL("SELECT keyworddefs.name + FROM keyworddefs, keywords + WHERE keywords.bug_id = $id AND keyworddefs.id = keywords.keywordid + ORDER BY keyworddefs.name"); + my @list; + while (MoreSQLData()) { + push(@list, FetchOneColumn()); + } + my $value = value_quote(join(',', @list)); + print qq{ + +Keywords: + + +}; +} + print "Attachments:\n"; SendSQL("select attach_id, creation_ts, description from attachments where bug_id = $id"); while (MoreSQLData()) { diff --git a/buglist.cgi b/buglist.cgi index 403a689dd..211259dca 100755 --- a/buglist.cgi +++ b/buglist.cgi @@ -235,7 +235,8 @@ from bugs, profiles assign, profiles report left join profiles qacont on bugs.qa_contact = qacont.userid, - versions projector + versions projector, + keywords where bugs.assigned_to = assign.userid and bugs.reporter = report.userid @@ -292,6 +293,27 @@ if (defined $::FORM{'sql'}) { } } +if ($::FORM{'keywords'}) { + GetVersionTable(); + my @list; + foreach my $v (split(',', $::FORM{'keywords'})) { + my $id = $::keywordsbyname{trim($v)}; + if ($id) { + push(@list, "keywords.keywordid = $id"); + } else { + print "Unknown keyword named $v.\n"; + print "

The legal keyword names are "; + print "listed here.\n"; + print "

Please click the Back button and try again.\n"; + exit; + } + } + if (@list) { + $query .= "and keywords.bug_id = bugs.bug_id and (" . + join(" $::FORM{'keywords_type'} ", @list) . ")\n"; + } +} + foreach my $id ("1", "2") { if (!defined ($::FORM{"email$id"})) { @@ -750,8 +772,22 @@ document.write(\" + if (@::legal_keywords) { + print qq{ +Keywords: + + + + +}; + } + + + print " diff --git a/checksetup.pl b/checksetup.pl index 7b02ec0d5..cf7a83978 100755 --- a/checksetup.pl +++ b/checksetup.pl @@ -637,7 +637,19 @@ $table{votes} = index(who), index(bug_id)'; +$table{keywords} = + 'bug_id mediumint not null, + keywordid smallint not null, + index(bug_id), + index(keywordid)'; + +$table{keyworddefs} = + 'id smallint not null primary key, + name varchar(64) not null, + description mediumtext, + + unique(name)'; @@ -727,6 +739,7 @@ AddGroup 'tweakparams', 'Can tweak operating parameters'; AddGroup 'editgroupmembers', 'Can put people in and out of groups that they are members of.'; AddGroup 'creategroups', 'Can create and destroy groups.'; AddGroup 'editcomponents', 'Can create, destroy, and edit components.'; +AddGroup 'editkeywords', 'Can create, destroy, and edit keywords.'; diff --git a/describekeywords.cgi b/describekeywords.cgi new file mode 100755 index 000000000..4da535c7c --- /dev/null +++ b/describekeywords.cgi @@ -0,0 +1,74 @@ +#!/usr/bonsaitools/bin/perl -w +# -*- Mode: perl; indent-tabs-mode: nil -*- +# +# 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 Terry Weissman. +# Portions created by Terry Weissman are +# Copyright (C) 2000 Terry Weissman. All +# Rights Reserved. +# +# Contributor(s): Terry Weissman + +use diagnostics; +use strict; + +require "CGI.pl"; + +ConnectToDatabase(); + +print "Content-type: text/html\n\n"; + +PutHeader("Bugzilla keyword description"); + +print qq{ + + + + + + +}; + +SendSQL("SELECT 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 ($name, $description, $bugs) = FetchSQLData(); + if ($bugs) { + my $q = url_quote($name); + $bugs = qq{$bugs}; + } else { + $bugs = "none"; + } + print qq{ + + + + + +}; +} + +print "
NameDescriptionBugs
$name$description$bugs

\n"; + +quietly_check_login(); + +if (UserInGroup("editkeywords")) { + print "

Edit keywords

\n"; +} + +navigation_header(); diff --git a/editkeywords.cgi b/editkeywords.cgi new file mode 100755 index 000000000..03525f725 --- /dev/null +++ b/editkeywords.cgi @@ -0,0 +1,379 @@ +#!/usr/bonsaitools/bin/perl -w +# -*- Mode: perl; indent-tabs-mode: nil -*- +# +# 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 Terry Weissman. +# Portions created by Terry Weissman are +# Copyright (C) 2000 Terry Weissman. All +# Rights Reserved. +# +# Contributor(s): Terry Weissman + +use diagnostics; +use strict; + +require "CGI.pl"; + +my $localtrailer = "edit more keywords"; + + +# +# Displays a text like "a.", "a or b.", "a, b or c.", "a, b, c or d." +# + +sub PutTrailer (@) +{ + my (@links) = ("Back to the query page", @_); + + my $count = $#links; + my $num = 0; + print "

\n"; + foreach (@links) { + print $_; + if ($num == $count) { + print ".\n"; + } + elsif ($num == $count-1) { + print " or "; + } + else { + print ", "; + } + $num++; + } + print "\n\n"; +} + + +# +# 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{}; + + print " Name:\n"; + print " \n"; + print "\n"; + + print " Description:\n"; + print " \n"; + print "\n"; + +} + + +sub Validate ($$) { + my ($name, $description) = @_; + if ($name eq "") { + print "You must enter a non-blank name for the keyword. Please press\n"; + print "Back and try again.\n"; + PutTrailer($localtrailer); + exit; + } + if ($name =~ /,/) { + print "You may not use commas in a keyword name.\n"; + print "Please press Back and try again.\n"; + PutTrailer($localtrailer); + exit; + } + if ($description eq "") { + print "You must enter a non-blank description of the keyword.\n"; + print "Please press Back and try again.\n"; + PutTrailer($localtrailer); + exit; + } +} + + +# +# Preliminary checks: +# + +confirm_login(); + +print "Content-type: text/html\n\n"; + +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(); + exit; +} + + +my $action = trim($::FORM{action} || ''); + + +if ($action eq "") { + PutHeader("Select keyword"); + print qq{ + + + + + + + +}; + 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 ||= "missing"; + $bugs ||= 'none'; + print qq{ + + + + + + +}; + } + print qq{ + + + +
Edit keyword ...DescriptionBugsAction
$name$description$bugsDelete
Add a new keywordAdd
+}; + PutTrailer(); + exit; +} + + +if ($action eq 'add') { + PutHeader("Add keyword"); + print "

\n"; + print "\n"; + + EmitFormElements(-1, '', ''); + + print "
\n
\n"; + print "\n"; + print "\n"; + print ""; + + my $other = $localtrailer; + $other =~ s/more/other/; + PutTrailer($other); + exit; +} + +# +# action='new' -> add keyword entered in the 'action=add' screen +# + +if ($action eq 'new') { + PutHeader("Adding new keyword"); + + # Cleanups and valididy checks + + my $name = trim($::FORM{name} || ''); + my $description = trim($::FORM{description} || ''); + + Validate($name, $description); + + SendSQL("SELECT id FROM keyworddefs WHERE name = " . SqlQuote($name)); + + if (FetchOneColumn()) { + print "The keyword '$name' already exists. Please press\n"; + print "Back and try again.\n"; + PutTrailer($localtrailer); + exit; + } + + + # Pick an unused number. Be sure to recycle numbers that may have been + # deleted in the past. This code is potentially slow, but it happens + # rarely enough, and there really aren't ever going to be that many + # keywords anyway. + + SendSQL("SELECT id FROM keyworddefs ORDER BY id"); + + my $newid = 1; + + while (MoreSQLData()) { + my $oldid = FetchOneColumn(); + if ($oldid > $newid) { + last; + } + $newid = $oldid + 1; + } + + # Add the new keyword. + SendSQL("INSERT INTO keyworddefs (id, name, description) VALUES ($newid, " . + SqlQuote($name) . "," . + SqlQuote($description) . ")"); + + # Make versioncache flush + unlink "data/versioncache"; + + print "OK, done.

\n"; + PutTrailer($localtrailer); + exit; +} + + + +# +# action='edit' -> present the edit keywords from +# +# (next action would be 'update') +# + +if ($action eq 'edit') { + PutHeader("Edit keyword"); + + my $id = trim($::FORM{id} || 0); + # get data of keyword + SendSQL("SELECT name,description + FROM keyworddefs + WHERE id=$id"); + my ($name, $description) = FetchSQLData(); + if (!$name) { + print "Something screwy is going on. Please try again.\n"; + PutTrailer($localtrailer); + exit; + } + print "

\n"; + print "\n"; + + EmitFormElements($id, $name, $description); + + print "\n"; + print " \n"; + print " \n
Bugs:"; + SendSQL("SELECT count(*) + FROM keywords + WHERE keywordid = $id"); + my $bugs = ''; + $bugs = FetchOneColumn() if MoreSQLData(); + print $bugs || 'none'; + + print "
\n"; + + print "\n"; + print "\n"; + + print "
"; + + my $x = $localtrailer; + $x =~ s/more/other/; + PutTrailer($x); + exit; +} + + +# +# action='update' -> update the keyword +# + +if ($action eq 'update') { + PutHeader("Update keyword"); + + my $id = $::FORM{id}; + my $name = trim($::FORM{name} || ''); + my $description = trim($::FORM{description} || ''); + + Validate($name, $description); + + SendSQL("SELECT id FROM keyworddefs WHERE name = " . SqlQuote($name)); + + my $tmp = FetchOneColumn(); + + if ($tmp && $tmp != $id) { + print "The keyword '$name' already exists. Please press\n"; + print "Back and try again.\n"; + PutTrailer($localtrailer); + exit; + } + + SendSQL("UPDATE keyworddefs SET name = " . SqlQuote($name) . + ", description = " . SqlQuote($description) . + " WHERE id = $id"); + + print "Keyword updated.
\n"; + + # Make versioncache flush + unlink "data/versioncache"; + + PutTrailer($localtrailer); + exit; +} + + +if ($action eq 'delete') { + PutHeader("Delete keyword"); + my $id = $::FORM{id}; + + SendSQL("SELECT name FROM keyworddefs WHERE id=$id"); + my $name = FetchOneColumn(); + + if (!$::FORM{reallydelete}) { + + SendSQL("SELECT count(*) + FROM keywords + WHERE keywordid = $id"); + + my $bugs = FetchOneColumn(); + + if ($bugs) { + + + print qq{ +There are $bugs bugs which have this keyword set. Are you sure you want +to delete the $name keyword? + +
+ + + + +
+}; + + PutTrailer($localtrailer); + exit; + } + } + + SendSQL("DELETE FROM keywords WHERE keywordid = $id"); + SendSQL("DELETE FROM keyworddefs WHERE id = $id"); + + print "Keyword $name deleted.\n"; + + # Make versioncache flush + unlink "data/versioncache"; + + PutTrailer($localtrailer); + exit; +} + +PutHeader("Error"); +print "I don't have a clue what you want.
\n"; + +foreach ( sort keys %::FORM) { + print "$_: $::FORM{$_}
\n"; +} diff --git a/globals.pl b/globals.pl index e6f426af8..63998f859 100644 --- a/globals.pl +++ b/globals.pl @@ -336,6 +336,18 @@ sub GenerateVersionTable { print FID GenerateCode('@::legal_target_milestone'); print FID GenerateCode('%::milestoneurl'); } + + SendSQL("SELECT id, name FROM keyworddefs ORDER BY name"); + while (MoreSQLData()) { + my ($id, $name) = FetchSQLData(); + $::keywordsbyid{$id} = $name; + $::keywordsbyname{$name} = $id; + push(@::legal_keywords, $name); + } + print FID GenerateCode('@::legal_keywords'); + print FID GenerateCode('%::keywordsbyname'); + print FID GenerateCode('%::keywordsbyid'); + print FID "1;\n"; close FID; rename $tmpname, "data/versioncache" || die "Can't rename $tmpname to versioncache"; diff --git a/process_bug.cgi b/process_bug.cgi index 858f04319..3919dadb0 100755 --- a/process_bug.cgi +++ b/process_bug.cgi @@ -30,7 +30,13 @@ require "CGI.pl"; use vars %::versions, %::components, - %::COOKIE; + %::COOKIE, + %::keywordsbyname, + %::legal_keywords, + %::legal_opsys, + %::legal_platform, + %::legal_priority, + %::legal_severity; confirm_login(); @@ -351,6 +357,28 @@ if ($#idlist < 0) { exit; } + +my @keywordlist; +my %keywordseen; + +if ($::FORM{'keywords'}) { + foreach my $keyword (split(/,/, $::FORM{'keywords'})) { + $keyword = trim($keyword); + my $i = $::keywordsbyname{$keyword}; + if (!$i) { + print "Unknown keyword named $keyword.\n"; + print "

The legal keyword names are "; + print "listed here.\n"; + print "

Please click the Back button and try again.\n"; + exit; + } + if (!$keywordseen{$i}) { + push(@keywordlist, $i); + $keywordseen{$i} = 1; + } + } +} + if ($::comma eq "") { if (!defined $::FORM{'comment'} || $::FORM{'comment'} =~ /^\s*$/) { print "Um, you apparently did not change anything on the selected\n"; @@ -385,6 +413,23 @@ sub SnapShotDeps { } +sub SnapShotKeywords { + my ($id) = (@_); + SendSQL("SELECT keyworddefs.name + FROM keyworddefs, keywords + WHERE keywords.bug_id = $id AND keyworddefs.id = keywords.keywordid + ORDER BY keyworddefs.name"); + my @list; + while (MoreSQLData()) { + push(@list, FetchOneColumn()); + } + return join(',', @list); +} + + +my $keywordaction = $::FORM{'keywordaction'} || "makeexact"; + + my $whoid = DBNameToIdAndCheck($::FORM{'who'}); my $timestamp; @@ -399,13 +444,14 @@ sub LogDependencyActivity { } # this loop iterates once for each bug to be processed (eg when this script -# is called by with multiple bugs selected from buglist.cgi instead of +# is called with multiple bugs selected from buglist.cgi instead of # show_bug.cgi). # foreach my $id (@idlist) { my %dependencychanged; - SendSQL("lock tables bugs write, bugs_activity write, cc write, profiles write, dependencies write, votes write"); + SendSQL("lock tables bugs write, bugs_activity write, cc write, profiles write, dependencies write, votes write, keywords write, keyworddefs read"); my @oldvalues = SnapShotBug($id); + my $oldkeywords = SnapShotKeywords($id); if (defined $::FORM{'delta_ts'} && $::FORM{'delta_ts'} ne $delta_ts) { print " @@ -494,6 +540,27 @@ The changes made were: } } + if (@::legal_keywords) { + # There are three kinds of "keywordsaction": makeexact, add, delete. + # For makeexact, we delete everything, and then add our things. + # For add, we delete things we're adding (to make sure we don't + # end up having them twice), and then we add them. + # For delete, we just delete things on the list. + if ($keywordaction eq "makeexact") { + SendSQL("DELETE FROM keywords WHERE bug_id = $id"); + } + foreach my $keyword (@keywordlist) { + if ($keywordaction ne "makeexact") { + SendSQL("DELETE FROM keywords + WHERE bug_id = $id AND keywordid = $keyword"); + } + if ($keywordaction ne "delete") { + SendSQL("INSERT INTO keywords + (bug_id, keywordid) VALUES ($id, $keyword)"); + } + } + } + my $query = "$basequery\nwhere bug_id = $id"; # print "

$query
\n"; @@ -582,7 +649,12 @@ The changes made were: # what has changed since before we wrote out the new values. # my @newvalues = SnapShotBug($id); - foreach my $col (@::log_columns) { + + push(@oldvalues, $oldkeywords); + push(@newvalues, SnapShotKeywords($id)); + foreach my $c (@::log_columns, "keywords") { + my $col = $c; # We modify it, don't want to modify array + # values in place. my $old = shift @oldvalues; my $new = shift @newvalues; if (!defined $old) { diff --git a/query.cgi b/query.cgi index 5cb40f147..a0ae1f0b3 100755 --- a/query.cgi +++ b/query.cgi @@ -77,7 +77,7 @@ foreach my $name ("bug_status", "resolution", "assigned_to", "rep_platform", "changedin", "votes", "short_desc", "short_desc_type", "long_desc", "long_desc_type", "bug_file_loc", "bug_file_loc_type", "status_whiteboard", - "status_whiteboard_type") { + "status_whiteboard_type", "keywords") { $default{$name} = ""; $type{$name} = 0; } @@ -367,17 +367,20 @@ print $jscript; my @logfields = ("[Bug creation]", @::log_columns); -print " -
+print qq{ + - - - - - - + + + + + + +}; + +print " + + +}; +} + print "
Status:Resolution:Platform:OpSys:Priority:Severity:Status:Resolution:Platform:OpSys:Priority:Severity:
@@ -538,6 +541,25 @@ if (Param("usestatuswhiteboard")) { StringSearch("Status whiteboard", "status_whiteboard"); } +if (@::legal_keywords) { + my $def = value_quote($default{'keywords'}); + print qq{ +
Keywords:

@@ -591,6 +613,9 @@ if (UserInGroup("tweakparams")) { if (UserInGroup("editcomponents")) { print "Edit Bugzilla products and components
\n"; } +if (UserInGroup("editkeywords")) { + print "Edit Bugzilla keywords
\n"; +} if (defined $::COOKIE{"Bugzilla_login"}) { print "Log in as someone besides $::COOKIE{'Bugzilla_login'}
\n"; } -- cgit v1.2.3-24-g4f1b