diff options
| -rwxr-xr-x | Bug.pm | 11 | ||||
| -rwxr-xr-x | Bugzilla/Bug.pm | 11 | ||||
| -rw-r--r-- | Bugzilla/Config.pm | 379 | ||||
| -rw-r--r-- | Bugzilla/Search.pm | 3 | ||||
| -rw-r--r-- | Bugzilla/Token.pm | 14 | ||||
| -rw-r--r-- | Bugzilla/Util.pm | 2 | ||||
| -rw-r--r-- | CGI.pl | 1 | ||||
| -rw-r--r-- | Token.pm | 14 | ||||
| -rwxr-xr-x | checksetup.pl | 77 | ||||
| -rw-r--r-- | defparams.pl | 1292 | ||||
| -rwxr-xr-x | doeditparams.cgi | 91 | ||||
| -rwxr-xr-x | editparams.cgi | 69 | ||||
| -rw-r--r-- | globals.pl | 188 | ||||
| -rwxr-xr-x | move.pl | 2 | ||||
| -rwxr-xr-x | syncshadowdb | 18 | ||||
| -rw-r--r-- | template/en/default/global/banner.html.tmpl | 2 | ||||
| -rwxr-xr-x | xml.cgi | 2 |
17 files changed, 1274 insertions, 902 deletions
@@ -32,6 +32,7 @@ package Bug; use CGI::Carp qw(fatalsToBrowser); my %ok_field; +use Bugzilla::Config; use Bugzilla::Util; for my $key (qw (bug_id alias product version rep_platform op_sys bug_status @@ -165,7 +166,7 @@ sub initBug { $self->{'cc'} = \@cc; } - if (&::Param("useqacontact") && (defined $self->{'qa_contact'}) ) { + if (Param("useqacontact") && (defined $self->{'qa_contact'}) ) { my $name = $self->{'qa_contact'} > 0 ? &::DBID_to_name($self->{'qa_contact'}) :""; if ($name) { $self->{'qa_contact'} = $name; @@ -273,8 +274,8 @@ sub emitXML { if (defined $self->{'longdescs'}) { for (my $i=0 ; $i < @{$self->{'longdescs'}} ; $i++) { next if ($self->{'longdescs'}[$i]->{'isprivate'} - && &::Param("insidergroup") - && !&::UserInGroup(&::Param("insidergroup"))); + && Param("insidergroup") + && !&::UserInGroup(Param("insidergroup"))); $xml .= " <long_desc>\n"; $xml .= " <who>" . &::DBID_to_name($self->{'longdescs'}[$i]->{'who'}) . "</who>\n"; @@ -289,8 +290,8 @@ sub emitXML { if (defined $self->{'attachments'}) { for (my $i=0 ; $i < @{$self->{'attachments'}} ; $i++) { next if ($self->{'attachments'}[$i]->{'isprivate'} - && &::Param("insidergroup") - && !&::UserInGroup(&::Param("insidergroup"))); + && Param("insidergroup") + && !&::UserInGroup(Param("insidergroup"))); $xml .= " <attachment>\n"; $xml .= " <attachid>" . $self->{'attachments'}[$i]->{'attachid'} . "</attachid>\n"; diff --git a/Bugzilla/Bug.pm b/Bugzilla/Bug.pm index 752cbfd2a..3cbb1e765 100755 --- a/Bugzilla/Bug.pm +++ b/Bugzilla/Bug.pm @@ -32,6 +32,7 @@ package Bug; use CGI::Carp qw(fatalsToBrowser); my %ok_field; +use Bugzilla::Config; use Bugzilla::Util; for my $key (qw (bug_id alias product version rep_platform op_sys bug_status @@ -165,7 +166,7 @@ sub initBug { $self->{'cc'} = \@cc; } - if (&::Param("useqacontact") && (defined $self->{'qa_contact'}) ) { + if (Param("useqacontact") && (defined $self->{'qa_contact'}) ) { my $name = $self->{'qa_contact'} > 0 ? &::DBID_to_name($self->{'qa_contact'}) :""; if ($name) { $self->{'qa_contact'} = $name; @@ -273,8 +274,8 @@ sub emitXML { if (defined $self->{'longdescs'}) { for (my $i=0 ; $i < @{$self->{'longdescs'}} ; $i++) { next if ($self->{'longdescs'}[$i]->{'isprivate'} - && &::Param("insidergroup") - && !&::UserInGroup(&::Param("insidergroup"))); + && Param("insidergroup") + && !&::UserInGroup(Param("insidergroup"))); $xml .= " <long_desc>\n"; $xml .= " <who>" . &::DBID_to_name($self->{'longdescs'}[$i]->{'who'}) . "</who>\n"; @@ -289,8 +290,8 @@ sub emitXML { if (defined $self->{'attachments'}) { for (my $i=0 ; $i < @{$self->{'attachments'}} ; $i++) { next if ($self->{'attachments'}[$i]->{'isprivate'} - && &::Param("insidergroup") - && !&::UserInGroup(&::Param("insidergroup"))); + && Param("insidergroup") + && !&::UserInGroup(Param("insidergroup"))); $xml .= " <attachment>\n"; $xml .= " <attachid>" . $self->{'attachments'}[$i]->{'attachid'} . "</attachid>\n"; diff --git a/Bugzilla/Config.pm b/Bugzilla/Config.pm new file mode 100644 index 000000000..76602e7ad --- /dev/null +++ b/Bugzilla/Config.pm @@ -0,0 +1,379 @@ +# -*- 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 Netscape Communications +# Corporation. Portions created by Netscape are +# Copyright (C) 1998 Netscape Communications Corporation. All +# Rights Reserved. +# +# Contributor(s): Terry Weissman <terry@mozilla.org> +# Dawn Endico <endico@mozilla.org> +# Dan Mosedale <dmose@mozilla.org> +# Joe Robins <jmrobins@tgix.com> +# Jake <jake@bugzilla.org> +# J. Paul Reed <preed@sigkill.com> +# Bradley Baetz <bbaetz@student.usyd.edu.au> +# Christopher Aillon <christopher@aillon.com> + +package Bugzilla::Config; + +=head1 NAME + +Bugzilla::Config - Configuration paramaters for Bugzilla + +=head1 SYNOPSIS + + # Getting paramaters + use Bugzilla::Config; + + my $fooSetting = Param('foo'); + + # Administration functions + use Bugzilla::Config qw(:admin); + + my @valid_params = GetParamList(); + my @removed_params = UpgradeParams(); + SetParam($param, $value); + WriteParams(); + + # Localconfig variables may also be imported + use Bugzilla::Config qw(:db); + print "Connecting to $db_name as $db_user with $db_pass\n"; + + # These variables do not belong in localconfig, and need to go + # somewhere better + use Bugzilla::Config($contenttypes $pages) + +=head1 DESCRIPTION + +This package contains ways to access Bugzilla configuration parameters. + +=cut + +use strict; + +use base qw(Exporter); + +use Bugzilla::Util; + +# Module stuff +@Bugzilla::Config::EXPORT = qw(Param); + +# Don't export localvars by default - people should have to explicitly +# ask for it, as a (probably futile) attempt to stop code using it +# when it shouldn't +# ChmodDataFile is here until that stuff all moves out of globals.pl +# into this file +@Bugzilla::Config::EXPORT_OK = qw($contenttypes $pages ChmodDataFile); +%Bugzilla::Config::EXPORT_TAGS = + ( + admin => [qw(GetParamList UpdateParams SetParam WriteParams)], + db => [qw($db_host $db_port $db_name $db_user $db_pass)], + ); +Exporter::export_ok_tags('admin', 'db'); + +# Bugzilla version +$Bugzilla::Config::VERSION = "2.17"; + +use Data::Dumper; + +# This only has an affect for Data::Dumper >= 2.12 (ie perl >= 5.8.0) +# Its just cosmetic, though, so that doesn't matter +$Data::Dumper::Sortkeys = 1; + +use File::Temp; +use Safe; + +use vars qw(@param_list); +my %param; + +# INITIALISATION CODE + +# XXX - mod_perl - need to register Apache init handler for params +sub _load_datafiles { + # read in localconfig variables + do 'localconfig'; + + if (-e 'data/params') { + # Handle reading old param files by munging the symbol table + # Don't have to do this if we use safe mode, since its evaled + # in a sandbox where $foo is in the same module as $::foo + #local *::param = \%param; + + # Note that checksetup.pl sets file permissions on 'data/params' + + # Using Safe mode is _not_ a guarantee of safety if someone does + # manage to write to the file. However, it won't hurt... + # See bug 165144 for not needing to eval this at all + my $s = new Safe; + + $s->rdo('data/params'); + die "Error evaluating data/params: $@" if $@; + + # Now read the param back out from the sandbox + %param = %{$s->varglob('param')}; + } +} + +# Load in the datafiles +_load_datafiles(); + +# Load in the param defintions +do 'defparams.pl'; + +# Stick the params into a hash +my %params; +foreach my $item (@param_list) { + $params{$item->{'name'}} = $item; +} + +# END INIT CODE + +# Subroutines go here + +=head1 FUNCTIONS + +=head2 Parameters + +Parameters can be set, retrieved, and updated. + +=over 4 + +=item C<Param($name)> + +Returns the Param with the specified name. Either a string, or, in the case +of multiple-choice parameters, an array reference. + +=cut + +sub Param { + my ($param) = @_; + + # By this stage, the param must be in the hash + die "Can't find param named $param" unless (exists $param{$param}); + + return $param{$param}; +} + +=item C<GetParamList()> + +Returns the list of known paramater types, from defparams.pl. Users should not +rely on this method; it is intended for editparams/doeditparams only + +The format for the list is specified in defparams.pl + +=cut + +sub GetParamList { + return @param_list; +} + +=item C<SetParam($name, $value)> + +Sets the param named $name to $value. Values are checked using the checker +function for the given param if one exists. + +=cut + +sub SetParam { + my ($name, $value) = @_; + + die "Unknown param $name" unless (exists $params{$name}); + + my $entry = $params{$name}; + + # sanity check the value + if (exists $entry->{'checker'}) { + my $err = $entry->{'checker'}->($value, $entry); + die "Param $name is not valid: $err" unless $err eq ''; + } + + $param{$name} = $value; +} + +=item C<UpdateParams()> + +Updates the parameters, by transitioning old params to new formats, setting +defaults for new params, and removing obsolete ones. + +Any removed params are returned in a list, with elements [$item, $oldvalue] +where $item is the entry in the param list. + +This change is not flushed to disk, use L<C<WriteParams()>> for that. + +=cut + +sub UpdateParams { + # --- PARAM CONVERSION CODE --- + + # Note that this isn't particuarly 'clean' in terms of separating + # the backend code (ie this) from the actual params. + # We don't care about that, though + + # Old bugzilla versions stored the version number in the params file + # We don't want it, so get rid of it + delete $param{'version'}; + + # Change from a boolean for quips to multi-state + if (exists $param{'usequip'} && !exists $param{'allowquips'}) { + $param{'allowquips'} = $param{'usequip'} ? 'on' : 'off'; + delete $param{'usequip'}; + } + + # --- DEFAULTS FOR NEW PARAMS --- + + foreach my $item (@param_list) { + my $name = $item->{'name'}; + $param{$name} = $item->{'default'} unless exists $param{$name}; + } + + # --- REMOVE OLD PARAMS --- + + my @oldparams = (); + + # Remove any old params + foreach my $item (keys %param) { + if (!grep($_ eq $item, map ($_->{'name'}, @param_list))) { + local $Data::Dumper::Terse = 1; + local $Data::Dumper::Indent = 0; + push (@oldparams, [$item, Data::Dumper->Dump([$param{$item}])]); + delete $param{$item}; + } + } + + return @oldparams; +} + +=item C<WriteParams()> + +Writes the parameters to disk. + +=cut + +sub WriteParams { + my ($fh, $tmpname) = File::Temp::tempfile('params.XXXXX', + DIR => 'data' ); + + print $fh (Data::Dumper->Dump([ \%param ], [ '*param' ])) + || die "Can't write param file: $!"; + + close $fh; + + rename $tmpname, "data/params" + || die "Can't rename $tmpname to data/params: $!"; + + ChmodDataFile('data/params', 0666); +} + +# Some files in the data directory must be world readable iff we don't have +# a webserver group. Call this function to do this. +# This will become a private function once all the datafile handling stuff +# moves into this package + +# This sub is not perldoc'd for that reason - noone should know about it +sub ChmodDataFile { + my ($file, $mask) = @_; + my $perm = 0770; + if ((stat('data'))[2] & 0002) { + $perm = 0777; + } + $perm = $perm & $mask; + chmod $perm,$file; +} + +=back + +=head2 Parameter checking functions + +All parameter checking functions are called with two parameters: + +=over 4 + +=item * + +The new value for the parameter + +=item * + +A reference to the entry in the param list for this parameter + +=back + +Functions should return error text, or the empty string if there was no error. + +=over 4 + +=item C<check_multi> + +Checks that a multi-valued parameter (ie type C<s> or type C<m>) satisfies +its contraints. + +=cut + +sub check_multi { + my ($value, $param) = (@_); + + if ($param->{'type'} eq "s") { + unless (lsearch($param->{'choices'}, $value) >= 0) { + return "Invalid choice '$value' for single-select list param '$param'"; + } + + return ""; + } + elsif ($param->{'type'} eq "m") { + foreach my $chkParam (@$value) { + unless (lsearch($param->{'choices'}, $chkParam) >= 0) { + return "Invalid choice '$chkParam' for multi-select list param '$param'"; + } + } + + return ""; + } + else { + return "Invalid param type '$param->{'type'}' for check_multi(); " . + "contact your Bugzilla administrator"; + } +} + +=item C<check_numeric> + +Checks that the value is a valid number + +=cut + +sub check_numeric { + my ($value) = (@_); + if ($value !~ /^[0-9]+$/) { + return "must be a numeric value"; + } + return ""; +} + +=item C<check_regexp> + +Checks that the value is a valid regexp + +=cut + +sub check_regexp { + my ($value) = (@_); + eval { qr/$value/ }; + return $@; +} + +=back + +=cut + +1; diff --git a/Bugzilla/Search.pm b/Bugzilla/Search.pm index b8cc9fed8..46921da28 100644 --- a/Bugzilla/Search.pm +++ b/Bugzilla/Search.pm @@ -34,6 +34,7 @@ use vars qw($userid $usergroupset); package Bugzilla::Search; +use Bugzilla::Config; use Bugzilla::Util; use Date::Format; @@ -314,7 +315,7 @@ sub init { "^long_?desc," => sub { my $table = "longdescs_$chartid"; push(@supptables, "longdescs $table"); - if (&::Param("insidergroup") && !&::UserInGroup(&::Param("insidergroup"))) { + if (Param("insidergroup") && !&::UserInGroup(Param("insidergroup"))) { push(@wherepart, "$table.isprivate < 1") ; } push(@wherepart, "$table.bug_id = bugs.bug_id"); diff --git a/Bugzilla/Token.pm b/Bugzilla/Token.pm index 6d0741133..a2604b0f5 100644 --- a/Bugzilla/Token.pm +++ b/Bugzilla/Token.pm @@ -29,6 +29,8 @@ use strict; # Bundle the functions in this file together into the "Token" package. package Token; +use Bugzilla::Config; + use Date::Format; # This module requires that its caller have said "require CGI.pl" to import @@ -75,14 +77,14 @@ sub IssueEmailChangeToken { my $template = $::template; my $vars = $::vars; - $vars->{'oldemailaddress'} = $old_email . &::Param('emailsuffix'); - $vars->{'newemailaddress'} = $new_email . &::Param('emailsuffix'); + $vars->{'oldemailaddress'} = $old_email . Param('emailsuffix'); + $vars->{'newemailaddress'} = $new_email . Param('emailsuffix'); $vars->{'max_token_age'} = $maxtokenage; $vars->{'token_ts'} = $token_ts; $vars->{'token'} = $token; - $vars->{'emailaddress'} = $old_email . &::Param('emailsuffix'); + $vars->{'emailaddress'} = $old_email . Param('emailsuffix'); my $message; $template->process("account/email/change-old.txt.tmpl", $vars, \$message) @@ -93,7 +95,7 @@ sub IssueEmailChangeToken { close SENDMAIL; $vars->{'token'} = $newtoken; - $vars->{'emailaddress'} = $new_email . &::Param('emailsuffix'); + $vars->{'emailaddress'} = $new_email . Param('emailsuffix'); $message = ""; $template->process("account/email/change-new.txt.tmpl", $vars, \$message) @@ -136,7 +138,7 @@ sub IssuePasswordToken { my $vars = $::vars; $vars->{'token'} = $token; - $vars->{'emailaddress'} = $loginname . &::Param('emailsuffix'); + $vars->{'emailaddress'} = $loginname . Param('emailsuffix'); $vars->{'max_token_age'} = $maxtokenage; $vars->{'token_ts'} = $token_ts; @@ -206,7 +208,7 @@ sub Cancel { my ($issuedate, $tokentype, $eventdata, $loginname, $realname) = &::FetchSQLData(); # Get the email address of the Bugzilla maintainer. - my $maintainer = &::Param('maintainer'); + my $maintainer = Param('maintainer'); # Format the user's real name and email address into a single string. my $username = $realname ? $realname . " <" . $loginname . ">" : $loginname; diff --git a/Bugzilla/Util.pm b/Bugzilla/Util.pm index 5e2e3feb7..f8d9c954f 100644 --- a/Bugzilla/Util.pm +++ b/Bugzilla/Util.pm @@ -258,3 +258,5 @@ sub trim { =back =cut + +1; @@ -33,6 +33,7 @@ use lib "."; # use Carp; # for confess use Bugzilla::Util; +use Bugzilla::Config; # commented out the following snippet of code. this tosses errors into the # CGI if you are perl 5.6, and doesn't if you have perl 5.003. @@ -29,6 +29,8 @@ use strict; # Bundle the functions in this file together into the "Token" package. package Token; +use Bugzilla::Config; + use Date::Format; # This module requires that its caller have said "require CGI.pl" to import @@ -75,14 +77,14 @@ sub IssueEmailChangeToken { my $template = $::template; my $vars = $::vars; - $vars->{'oldemailaddress'} = $old_email . &::Param('emailsuffix'); - $vars->{'newemailaddress'} = $new_email . &::Param('emailsuffix'); + $vars->{'oldemailaddress'} = $old_email . Param('emailsuffix'); + $vars->{'newemailaddress'} = $new_email . Param('emailsuffix'); $vars->{'max_token_age'} = $maxtokenage; $vars->{'token_ts'} = $token_ts; $vars->{'token'} = $token; - $vars->{'emailaddress'} = $old_email . &::Param('emailsuffix'); + $vars->{'emailaddress'} = $old_email . Param('emailsuffix'); my $message; $template->process("account/email/change-old.txt.tmpl", $vars, \$message) @@ -93,7 +95,7 @@ sub IssueEmailChangeToken { close SENDMAIL; $vars->{'token'} = $newtoken; - $vars->{'emailaddress'} = $new_email . &::Param('emailsuffix'); + $vars->{'emailaddress'} = $new_email . Param('emailsuffix'); $message = ""; $template->process("account/email/change-new.txt.tmpl", $vars, \$message) @@ -136,7 +138,7 @@ sub IssuePasswordToken { my $vars = $::vars; $vars->{'token'} = $token; - $vars->{'emailaddress'} = $loginname . &::Param('emailsuffix'); + $vars->{'emailaddress'} = $loginname . Param('emailsuffix'); $vars->{'max_token_age'} = $maxtokenage; $vars->{'token_ts'} = $token_ts; @@ -206,7 +208,7 @@ sub Cancel { my ($issuedate, $tokentype, $eventdata, $loginname, $realname) = &::FetchSQLData(); # Get the email address of the Bugzilla maintainer. - my $maintainer = &::Param('maintainer'); + my $maintainer = Param('maintainer'); # Format the user's real name and email address into a single string. my $username = $realname ? $realname . " <" . $loginname . ">" : $loginname; diff --git a/checksetup.pl b/checksetup.pl index 99ba4a36c..99a04d621 100755 --- a/checksetup.pl +++ b/checksetup.pl @@ -96,6 +96,8 @@ use strict; +use Bugzilla::Config qw(:DEFAULT :admin); + # 12/17/00 justdave@syndicomm.com - removed declarations of the localconfig # variables from this location. We don't want these declared here. They'll # automatically get declared in the process of reading in localconfig, and @@ -970,36 +972,33 @@ END # Just to be sure ... unlink "data/versioncache"; -# Remove parameters from the data/params file that no longer exist in Bugzilla. -if (-e "data/params") { - require "data/params"; - require "defparams.pl"; - use vars @::param_list; - my @oldparams; - +# Remove parameters from the data/params file that no longer exist in Bugzilla, +# and set the defaults for new ones + +my @oldparams = UpdateParams(); + +if (@oldparams) { open(PARAMFILE, ">>old-params.txt") || die "$0: Can't open old-params.txt for writing: $!\n"; - - foreach my $item (keys %::param) { - if (!grep($_ eq $item, @::param_list) && $item ne "version") { - push (@oldparams, $item); - print PARAMFILE "\n\n$item:\n$::param{$item}\n"; - - delete $::param{$item}; - } - } - - if (@oldparams) { - print "The following parameters are no longer used in Bugzilla, " . - "and so have been\nremoved from your parameters file and " . - "appended to old-params.txt:\n"; - print join(", ", @oldparams) . "\n\n"; + + print "The following parameters are no longer used in Bugzilla, " . + "and so have been\nremoved from your parameters file and " . + "appended to old-params.txt:\n"; + + foreach my $p (@oldparams) { + my ($item, $value) = @{$p}; + + print PARAMFILE "\n\n$item:\n$value\n"; + + print $item; + print ", " unless $item eq $oldparams[$#oldparams]->[0]; } - + print "\n"; close PARAMFILE; - WriteParams(); } +# WriteParams will only write out still-valid entries +WriteParams(); ########################################################################### # Set proper rights @@ -1239,14 +1238,12 @@ END { $dbh->disconnect if $dbh } # and that the generated images are accessible. # -if(-e "data/params") { - require "data/params"; - if( $::param{'webdotbase'} && $::param{'webdotbase'} !~ /^https?:/ ) { +if( Param('webdotbase') && Param('webdotbase') !~ /^https?:/ ) { printf("Checking for %15s %-9s ", "GraphViz", "(any)"); - if(-x $::param{'webdotbase'}) { - print "ok: found\n"; + if(-x Param('webdotbase')) { + print "ok: found\n"; } else { - print "not a valid executable: $::param{'webdotbase'}\n"; + print "not a valid executable: " . Param{'webdotbase'} . "\n"; } # Check .htaccess allows access to generated images @@ -1258,7 +1255,6 @@ if(-e "data/params") { } close HTACCESS; } - } } print "\n"; @@ -1948,23 +1944,8 @@ if ($sth->rows == 0) { my $pass2 = "*"; my $admin_ok = 0; my $admin_create = 1; - my $mailcheckexp = ""; - my $mailcheck = ""; - - # Here we look to see what the emailregexp is set to so we can - # check the email addy they enter. Bug 96675. If they have no - # params (likely but not always the case), we use the default. - if (-e "data/params") { - require "data/params"; # if they have a params file, use that - } - if ($::param{emailregexp}) { - $mailcheckexp = $::param{emailregexp}; - $mailcheck = $::param{emailregexpdesc}; - } else { - $mailcheckexp = '^[^@]+@[^@]+\\.[^@]+$'; - $mailcheck = 'A legal address must contain exactly one \'@\', - and at least one \'.\' after the @.'; - } + my $mailcheckexp = Param('emailregexp'); + my $mailcheck = Param('emailregexpdesc'); print "\nLooks like we don't have an administrator set up yet. Either this is your\n"; print "first time using Bugzilla, or your administrator's privs might have accidently\n"; diff --git a/defparams.pl b/defparams.pl index 1c696bdc7..8e931006f 100644 --- a/defparams.pl +++ b/defparams.pl @@ -23,6 +23,7 @@ # Joe Robins <jmrobins@tgix.com> # Jacob Steenhagen <jake@bugzilla.org> # J. Paul Reed <preed@sigkill.com> +# Bradley Baetz <bbaetz@student.usyd.edu.au> # # This file defines all the parameters that we have a GUI to edit within @@ -30,179 +31,117 @@ # ATTENTION!!!! THIS FILE ONLY CONTAINS THE DEFAULTS. # You cannot change your live settings by editing this file. -# Only adding new parameters is done here. Once the parameter exists, you +# Only adding new parameters is done here. Once the parameter exists, you # must use %baseurl%/editparams.cgi from the web to edit the settings. -use strict; - -# Shut up misguided -w warnings about "used only once". For some reason, -# "use vars" chokes on me when I try it here. - -sub defparams_pl_sillyness { - my $zz; - $zz = %::param_checker; - $zz = %::param_desc; - $zz = %::param_type; - $zz = %::MFORM; -} - -sub WriteParams { - foreach my $i (@::param_list) { - if (!defined $::param{$i}) { - if ($::param_type{$i} eq "m") { - ## For list params (single or multi), param_default is an array - ## with the second element as the default; we have to loop - ## through it to get them all for multi lists and we have to - ## select the second one by itself for single list (next branch - ## of the if) - my $multiParamStr = "[ "; - foreach my $defaultParam (@{$::param_default{$i}->[1]}) { - $multiParamStr .= "'$defaultParam', "; - } - - $multiParamStr .= " ]"; - - $::param{$i} = $multiParamStr; - } - elsif ($::param_type{$i} eq "s") { - $::param{$i} = $::param_default{$i}->[1]; - } - else { - $::param{$i} = $::param_default{$i}; - } - - if (!defined $::param{$i}) { - die "No default parameter ever specified for $i"; - } - } - } +# This file is included via |do|, mainly because of circular dependancy issues +# (such as globals.pl -> Bugzilla::Config -> this -> Bugzilla::Config) +# which preclude compile time loading. - my $tmpname = "data/params.$$"; - open(FID, ">$tmpname") || die "Can't create $tmpname"; - my $v = $::param{'version'}; - delete $::param{'version'}; # Don't write the version number out to - # the params file. - print FID GenerateCode('%::param'); - $::param{'version'} = $v; - print FID "1;\n"; - close FID; - rename $tmpname, "data/params" || die "Can't rename $tmpname to data/params"; - ChmodDataFile('data/params', 0666); -} +# Those issues may go away at some point, and the contents of this file +# moved somewhere else. Please try to avoid more dependancies from here +# to other code -## $checker is a CODE ref that points to a function that verifies the -## parameter for validity; it is called by doeditparams.cgi with the value -## of the param as the first arg and the param name as the 2nd arg (which -## many checker functions ignore, but a couple of them need it. - -sub DefParam { - my ($id, $desc, $type, $default, $checker) = (@_); - push @::param_list, $id; - $::param_desc{$id} = $desc; - $::param_type{$id} = $type; - $::param_default{$id} = $default; - if (defined $checker) { - $::param_checker{$id} = $checker; - } -} - -## Converts text parameters for single- and multi-select type params to their -## array indices; takes the name of the parameter and the value you want the -## index of; returns undef on failure. +# (Note that these aren't just added directly to Bugzilla::Config, because +# the backend prefs code is separate to this...) -sub get_select_param_index { - my ($paramName, $val) = (@_); - - return undef if ($::param_type{$paramName} !~ /^m|s$/); +use strict; +use vars qw(@param_list); - my $paramList = $::param_default{$paramName}->[0]; +# Checking functions for the various values +# Some generic checking functions are included in Bugzilla::Config - for (my $ndx = 0; $ndx < scalar(@{$paramList}); $ndx++) { - ## The first element of the $param_default array in selects is the - ## list of possible params; search through this array for a match. - return $ndx if ($val eq $paramList->[$ndx]); +sub check_priority { + my ($value) = (@_); + &::ConnectToDatabase(); + &::GetVersionTable(); + if (lsearch(\@::legal_priority, $value) < 0) { + return "Must be a legal priority value: one of " . + join(", ", @::legal_priority); } - - return undef; + return ""; } -sub check_multi { - my ($value, $param) = (@_); - - if ($::param_type{$param} eq "s") { - if (check_numeric($value) ne "") { - return "List param types must be digits"; - } - elsif ($value < 0 || $value > $#{$::param_default{$param}->[0]}) { - return "Invalid choice for single-select list param '$param'"; - } - else { - return ""; - } - } - elsif ($::param_type{$param} eq "m") { - foreach my $chkParam (@{$::MFORM{$param}}) { - if (check_numeric($chkParam) ne "") { - return "List param types must be digits"; - } - elsif ($chkParam < 0 || $chkParam > - $#{$::param_default{$param}->[0]}) { - return "Invalid choice for multi-select list param '$param'"; - } - } - +sub check_shadowdb { + my ($value) = (@_); + $value = trim($value); + if ($value eq "") { return ""; } - else { - return "Invalid param type for check_multi(); contact your BZ admin"; + &::ConnectToDatabase(); + &::SendSQL("SHOW DATABASES"); + while (&::MoreSQLData()) { + my $n = &::FetchOneColumn(); + if (lc($n) eq lc($value)) { + return "The $n database already exists. If that's really the name you want to use for the backup, please CAREFULLY make the existing database go away somehow, and then try again."; + } } + &::SendSQL("CREATE DATABASE $value"); + &::SendSQL("INSERT INTO shadowlog (command) VALUES ('SYNCUP')", 1); + return ""; } -sub check_numeric { - my ($value) = (@_); - if ($value !~ /^[0-9]+$/) { - return "must be a numeric value"; +sub check_urlbase { + my ($url) = (@_); + if ($url !~ m:^http.*/$:) { + return "must be a legal URL, that starts with http and ends with a slash."; } return ""; } - -sub check_shadowdb { + +sub check_webdotbase { my ($value) = (@_); $value = trim($value); if ($value eq "") { return ""; } - SendSQL("SHOW DATABASES"); - while (MoreSQLData()) { - my $n = FetchOneColumn(); - if (lc($n) eq lc($value)) { - return "The $n database already exists. If that's really the name you want to use for the backup, please CAREFULLY make the existing database go away somehow, and then try again."; + if($value !~ /^https?:/) { + if(! -x $value) { + return "The file path \"$value\" is not a valid executable. Please specify the complete file path to 'dot' if you intend to generate graphs locally."; + } + # Check .htaccess allows access to generated images + if(-e "data/webdot/.htaccess") { + open HTACCESS, "data/webdot/.htaccess"; + if(! grep(/png/,<HTACCESS>)) { + return "Dependency graph images are not accessible.\nDelete data/webdot/.htaccess and re-run checksetup.pl to rectify.\n"; + } + close HTACCESS; } } - SendSQL("CREATE DATABASE $value"); - SendSQL("INSERT INTO shadowlog (command) VALUES ('SYNCUP')", 1); return ""; } -@::param_list = (); - - - -# OK, here are the definitions themselves. +# OK, here are the parameter definitions themselves. +# +# Each definition is a hash with keys: # -# The type of parameters (the third parameter to DefParam) can be one -# of the following: +# name - name of the param +# desc - description of the param (for editparams.cgi) +# type - see below +# choices - (optional) see below +# default - default value for the param +# checker - (optional) checking function for validating parameter entry +# It is called with the value of the param as the first arg and a +# reference to the param's hash as the second argument +# +# The type value can be one of the following: # # t -- A short text entry field (suitable for a single line) # l -- A long text field (suitable for many lines) # b -- A boolean value (either 1 or 0) # m -- A list of values, with many selectable (shows up as a select box) -# To specify the list of values, make the 'default value' for DefParam() -# a reference to two anonymous arrays, the first being the list of options -# and the second being a list of defaults (which must appear in the +# To specify the list of values, make the 'choices' key be an array +# reference of the valid choices. The 'default' key should be an array +# reference for the list of selected values (which must appear in the # first anonymous array), i.e.: -# DefParam("multiselect", "A list of options, choose many", -# "m", [ ['a','b','c','d'], ['a', 'd'] ], \&check_multi); +# { +# name => 'multiselect', +# desc => 'A list of options, choose many', +# type => 'm', +# choices => [ 'a', 'b', 'c', 'd' ], +# default => [ 'a', 'd' ], +# checker => \&check_multi +# } # # Here, 'a' and 'd' are the default options, and the user may pick any # combination of a, b, c, and d as valid options. @@ -211,134 +150,186 @@ sub check_shadowdb { # for list (single and multiple) parameter types. # # s -- A list of values, with one selectable (shows up as a select box) -# To specify the list of values, make the default value a reference to -# an anonymous array with two items inside of it, the first being an -# array of the possible values and the second being the scalar that is -# the default default value, i.e.: -# DefParam("singleselect", "A list of options, choose one", "s", -# [ ['a','b','c'], 'b'], \&check_multi); -# +# To specify the list of values, make the 'choices' key be an array +# reference of the valid choices. The 'default' key should be one of +# those values, i.e.: +# { +# name => 'singleselect', +# desc => 'A list of options, choose one', +# type => 's', +# choices => [ 'a', 'b', 'c' ], +# default => 'b', +# checker => \&check_multi +# } +# # Here, 'b' is the default option, and 'a' and 'c' are other possible # options, but only one at a time! # # &check_multi should always be used as the param verification function # for list (single and multiple) parameter types. -DefParam("maintainer", - "The email address of the person who maintains this installation of Bugzilla.", - "t", - 'THE MAINTAINER HAS NOT YET BEEN SET'); - -DefParam("urlbase", - "The URL that is the common initial leading part of all Bugzilla URLs.", - "t", - "http://cvs-mirror.mozilla.org/webtools/bugzilla/", - \&check_urlbase); - -sub check_urlbase { - my ($url) = (@_); - if ($url !~ m:^http.*/$:) { - return "must be a legal URL, that starts with http and ends with a slash."; - } - return ""; -} - -DefParam("cookiepath", - "Directory path under your document root that holds your Bugzilla installation. Make sure to begin with a /.", - "t", - "/"); - -DefParam("enablequips", - "If this is on, Bugzilla displays a silly quip at the beginning of buglists, and lets users add to the list of quips. If this is frozen, Bugzilla will display the quip but not permit new additions.", - "s", - [['on','frozen','off'], (($::param{"usequip"} || 1) ? 'on' : 'off')], - \&check_multi); - - -# Added parameter - JMR, 2/16/00 -DefParam("usebuggroups", - "If this is on, Bugzilla will associate a bug group with each product in the database, and use it for querying bugs.", - "b", - 0); - -# Added parameter - JMR, 2/16/00 -DefParam("usebuggroupsentry", - "If this is on, Bugzilla will use product bug groups to restrict who can enter bugs. Requires usebuggroups to be on as well.", - "b", - 0); - -DefParam("shadowdb", - "If non-empty, then this is the name of another database in which Bugzilla will keep a shadow read-only copy of everything. This is done so that long slow read-only operations can be used against this db, and not lock up things for everyone else. Turning on this parameter will create the given database; be careful not to use the name of an existing database with useful data in it!", - "t", - "", - \&check_shadowdb); - -DefParam("queryagainstshadowdb", - "If this is on, and the shadowdb is set, then queries will happen against the shadow database.", - "b", - 0); - - -# Adding in four parameters for LDAP authentication. -JMR, 7/28/00 -DefParam("useLDAP", - "Turn this on to use an LDAP directory for user authentication ". - "instead of the Bugzilla database. (User profiles will still be ". - "stored in the database, and will match against the LDAP user by ". - "email address.)", - "b", - 0); - - -DefParam("LDAPserver", - "The name (and optionally port) of your LDAP server. (e.g. ldap.company.com, or ldap.company.com:portnum)", - "t", - ""); - - -DefParam("LDAPBaseDN", - "The BaseDN for authenticating users against. (e.g. \"ou=People,o=Company\")", - "t", - ""); - - -DefParam("LDAPmailattribute", - "The name of the attribute of a user in your directory that ". - "contains the email address.", - "t", - "mail"); -#End of LDAP parameters - - -DefParam("mostfreqthreshold", - "The minimum number of duplicates a bug needs to show up on the <a href=\"duplicates.cgi\">most frequently reported bugs page</a>. If you have a large database and this page takes a long time to load, try increasing this number.", - "t", - "2"); - - -DefParam("mybugstemplate", - "This is the URL to use to bring up a simple 'all of my bugs' list for a user. %userid% will get replaced with the login name of a user.", - "t", - "buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=%userid%&emailtype1=exact&emailassigned_to1=1&emailreporter1=1"); - - -DefParam("shutdownhtml", - "If this field is non-empty, then Bugzilla will be completely disabled and this text will be displayed instead of all the Bugzilla pages.", - "l", - ""); - -DefParam("sendmailnow", - "If this is on, Bugzilla will tell sendmail to send any e-mail immediately. If you have a large number of users with a large amount of e-mail traffic, enabling this option may dramatically slow down Bugzilla. Best used for smaller installations of Bugzilla.", - "b", - 0); - -DefParam("passwordmail", -q{The email that gets sent to people to tell them their password. Within -this text, %mailaddress% gets replaced by the person's email address, -%login% gets replaced by the person's login (usually the same thing), and -%password% gets replaced by their password. %<i>anythingelse</i>% gets -replaced by the definition of that parameter (as defined on this page).}, - "l", - q{From: bugzilla-daemon +# XXXX - would be nice for doeditparams to 'know' about types s and m, and call +# check_multi without it having to be explicitly specified here - bbaetz + +@param_list = ( + { + name => 'maintainer', + desc => 'The email address of the person who maintains this installation ' . + 'of Bugzilla.', + type => 't', + default => 'THE MAINTAINER HAS NOT YET BEEN SET' + }, + + { + name => 'urlbase', + desc => 'The URL that is the common initial leading part of all Bugzilla ' . + 'URLs.', + type => 't', + default => 'http://cvs-mirror.mozilla.org/webtools/bugzilla/', + checker => \&check_urlbase + }, + + { + name => 'cookiepath', + desc => 'Directory path under your document root that holds your ' . + 'Bugzilla installation. Make sure to begin with a /.', + type => 't', + default => '/' + }, + + { + name => 'enablequips', + desc => 'If this is on, Bugzilla displays a silly quip at the beginning ' . + 'of buglists, and lets users add to the list of quips. If this ' . + 'is frozen, Bugzilla will display the quip but not permit new ' . + 'additions.', + type => 's', + choices => ['on','frozen','off'], + default => 'on', + checker => \&check_multi + }, + + { + name => 'usebuggroups', + desc => 'If this is on, Bugzilla will associate a bug group with each ' . + 'product in the database, and use it for querying bugs.', + type => 'b', + default => 0 + }, + + { + name => 'usebuggroupsentry', + desc => 'If this is on, Bugzilla will use product bug groups to restrict ' . + 'who can enter bugs. Requires usebuggroups to be on as well.', + type => 'b', + default => 0 + }, + + { + name => 'shadowdb', + desc => 'If non-empty, then this is the name of another database in ' . + 'which Bugzilla will keep a shadow read-only copy of everything. ' . + 'This is done so that long slow read-only operations can be used ' . + 'against this db, and not lock up things for everyone else. ' . + 'Turning on this parameter will create the given database ; be ' . + 'careful not to use the name of an existing database with useful ' . + 'data in it!', + type => 't', + default => '', + checker => \&check_shadowdb + }, + + { + name => 'queryagainstshadowdb', + desc => 'If this is on, and the shadowdb is set, then queries will ' . + 'happen against the shadow database.', + type => 'b', + default => 0, + }, + + { + name => 'useLDAP', + desc => 'Turn this on to use an LDAP directory for user authentication ' . + 'instead of the Bugzilla database. (User profiles will still be ' . + 'stored in the database, and will match against the LDAP user by ' . + 'email address.)', + type => 'b', + default => 0 + }, + + { + name => 'LDAPserver', + desc => 'The name (and optionally port) of your LDAP server. (e.g. ' . + 'ldap.company.com, or ldap.company.com:portnum)', + type => 't', + default => '' + }, + + { + name => 'LDAPBaseDN', + desc => 'The BaseDN for authenticating users against. (e.g. ' . + '"ou=People,o=Company")', + type => 't', + default => '' + }, + + { + name => 'LDAPmailattribute', + desc => 'The name of the attribute of a user in your directory that ' . + 'contains the email address.', + type => 't', + default => 'mail' + }, + + { + name => 'mostfreqthreshold', + desc => 'The minimum number of duplicates a bug needs to show up on the ' . + '<a href="duplicates.cgi">most frequently reported bugs page</a>. ' . + 'If you have a large database and this page takes a long time to ' . + 'load, try increasing this number.', + type => 't', + default => '2' + }, + + { + name => 'mybugstemplate', + desc => 'This is the URL to use to bring up a simple \'all of my bugs\' ' . + 'list for a user. %userid% will get replaced with the login ' . + 'name of a user.', + type => 't', + default => 'buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=%userid%&emailtype1=exact&emailassigned_to1=1&emailreporter1=1' + }, + + { + name => 'shutdownhtml', + desc => 'If this field is non-empty, then Bugzilla will be completely ' . + 'disabled and this text will be displayed instead of all the ' . + 'Bugzilla pages.', + type => 'l', + default => '' + }, + + { + name => 'sendmailnow', + desc => 'If this is on, Bugzilla will tell sendmail to send any e-mail ' . + 'immediately. If you have a large number of users with a large ' . + 'amount of e-mail traffic, enabling this option may dramatically ' . + 'slow down Bugzilla. Best used for smaller installations of ' . + 'Bugzilla.', + type => 'b', + default => 0 + }, + + { + name => 'passwordmail', + desc => 'The email that gets sent to people to tell them their password.' . + 'Within this text, %mailaddress% gets replaced by the person\'s ' . + 'email address, %login% gets replaced by the person\'s login ' . + '(usually the same thing), and %password% gets replaced by their ' . + 'password. %<i>anythingelse</i>% gets replaced by the ' . + 'definition of that parameter (as defined on this page).', + type => 'l', + default => 'From: bugzilla-daemon To: %mailaddress% Subject: Your Bugzilla password. @@ -349,25 +340,27 @@ To use the wonders of Bugzilla, you can use the following: To change your password, go to: %urlbase%userprefs.cgi -}); - - -DefParam("newchangedmail", -q{The email that gets sent to people when a bug changes. Within this -text, %to% gets replaced with the e-mail address of the person recieving -the mail. %bugid% gets replaced by the bug number. %diffs% gets -replaced with what's changed. %neworchanged% is "New:" if this mail is -reporting a new bug or empty if changes were made to an existing one. -%summary% gets replaced by the summary of this bug. %reasonsheader% -is replaced by an abbreviated list of reasons why the user is getting the email, -suitable for use in an email header (such as X-Bugzilla-Reason). -%reasonsbody% is replaced by text that explains why the user is getting the email -in more user friendly text than %reasonsheader%. -%<i>anythingelse</i>% gets replaced by the definition of -that parameter (as defined on this -page).}, - "l", -"From: bugzilla-daemon +' + }, + + { + name => 'newchangedmail', + desc => 'The email that gets sent to people when a bug changes. Within ' . + 'this text, %to% gets replaced with the e-mail address of the ' . + 'person recieving the mail. %bugid% gets replaced by the bug ' . + 'number. %diffs% gets replaced with what\'s changed. ' . + '%neworchanged% is "New:" if this mail is reporting a new bug or ' . + 'empty if changes were made to an existing one. %summary% gets ' . + 'replaced by the summary of this bug. %reasonsheader% is ' . + 'replaced by an abbreviated list of reasons why the user is ' . + 'getting the email, suitable for use in an email header (such ' . + 'as X-Bugzilla-Reason). %reasonsbody% is replaced by text that ' . + 'explains why the user is getting the email in more user ' . + 'friendly text than %reasonsheader%. %<i>anythingelse</i>% gets ' . + 'replaced by the definition of that parameter (as defined on ' . + 'this page).', + type => 'l', + default => 'From: bugzilla-daemon To: %to% Subject: [Bug %bugid%] %neworchanged%%summary% X-Bugzilla-Reason: %reasonsheader% @@ -378,21 +371,31 @@ X-Bugzilla-Reason: %reasonsheader% -%reasonsbody%"); - - - -DefParam("whinedays", - "The number of days that we'll let a bug sit untouched in a NEW state before our cronjob will whine at the owner.", - "t", - 7, - \&check_numeric); - - -DefParam("whinemail", - "The email that gets sent to anyone who has a NEW bug that hasn't been touched for more than <b>whinedays</b>. Within this text, %email% gets replaced by the offender's email address. %userid% gets replaced by the offender's bugzilla login (which, in most installations, is the same as the email address.) %<i>anythingelse</i>% gets replaced by the definition of that parameter (as defined on this page).<p> It is a good idea to make sure this message has a valid From: address, so that if the mail bounces, a real person can know that there are bugs assigned to an invalid address.", - "l", - q{From: %maintainer% +%reasonsbody%' + }, + + { + name => 'whinedays', + desc => 'The number of days that we\'ll let a bug sit untouched in a NEW ' . + 'state before our cronjob will whine at the owner.', + type => 't', + default => 7 + }, + + { + name => 'whinemail', + desc => 'The email that gets sent to anyone who has a NEW bug that '. + 'hasn\'t been touched for more than <b>whinedays</b>. Within ' . + 'this text, %email% gets replaced by the offender\'s email ' . + 'address. %userid% gets replaced by the offender\'s bugzilla ' . + 'login (which, in most installations, is the same as the email ' . + ' address.) %<i>anythingelse</i>% gets replaced by the definition ' . + 'of that parameter (as defined on this page).<p> It is a good ' . + 'idea to make sure this message has a valid From: address, so ' . + 'that if the mail bounces, a real person can know that there are ' . + 'bugs assigned to an invalid address.', + type => 'l', + default => 'From: %maintainer% To: %email% Subject: Your Bugzilla buglist needs attention. @@ -408,180 +411,197 @@ decide on an initial action. Generally, this means one of three things: -(1) You decide this bug is really quick to deal with (like, it's INVALID), +(1) You decide this bug is really quick to deal with (like, it\'s INVALID), and so you get rid of it immediately. -(2) You decide the bug doesn't belong to you, and you reassign it to someone - else. (Hint: if you don't know who to reassign it to, make sure that +(2) You decide the bug doesn\'t belong to you, and you reassign it to someone + else. (Hint: if you don\'t know who to reassign it to, make sure that the Component field seems reasonable, and then use the "Reassign bug to owner of selected component" option.) -(3) You decide the bug belongs to you, but you can't solve it this moment. +(3) You decide the bug belongs to you, but you can\'t solve it this moment. Just use the "Accept bug" command. To get a list of all NEW bugs, you can use this URL (bookmark it if you like!): - %urlbase%buglist.cgi?bug_status=NEW&assigned_to=%userid% + %urlbase%buglist.cgi?bug_status=NEW&assigned_to=%userid% Or, you can use the general query page, at %urlbase%query.cgi. -Appended below are the individual URLs to get to all of your NEW bugs that -haven't been touched for a week or more. - -You will get this message once a day until you've dealt with these bugs! - -}); - - - -DefParam("defaultquery", - "This is the default query that initially comes up when you submit a bug. It's in URL parameter format, which makes it hard to read. Sorry!", - "t", - "bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailqa_contact2=1&order=%22Importance%22"); - - -DefParam("letsubmitterchoosepriority", - "If this is on, then people submitting bugs can choose an initial priority for that bug. If off, then all bugs initially have the default priority selected below.", - "b", - 1); - - -sub check_priority { - my ($value) = (@_); - GetVersionTable(); - if (lsearch(\@::legal_priority, $value) < 0) { - return "Must be a legal priority value: one of " . - join(", ", @::legal_priority); - } - return ""; -} - -DefParam("defaultpriority", - "This is the priority that newly entered bugs are set to.", - "t", - "P2", - \&check_priority); - - -DefParam("usetargetmilestone", - "Do you wish to use the Target Milestone field?", - "b", - 0); - -DefParam("nummilestones", - "If using Target Milestone, how many milestones do you wish to - appear?", - "t", - 10, - \&check_numeric); - -DefParam("curmilestone", - "If using Target Milestone, Which milestone are we working toward right now?", - "t", - 1, - \&check_numeric); - -DefParam("musthavemilestoneonaccept", - "If you are using Target Milestone, do you want to require that the milestone be set in order for a user to ACCEPT a bug?", - "b", - 0); - -DefParam("useqacontact", - "Do you wish to use the QA Contact field?", - "b", - 0); - -DefParam("usestatuswhiteboard", - "Do you wish to use the Status Whiteboard field?", - "b", - 0); - -DefParam("usebrowserinfo", - "Do you want bug reports to be assigned an OS & Platform based on the browser - the user makes the report from?", - "b", - 1); - -DefParam("usevotes", - "Do you wish to allow users to vote for bugs? Note that in order for this to be effective, you will have to change the maximum votes allowed in a product to be non-zero in <a href=\"editproducts.cgi\">the product edit page</a>.", - "b", - 1); - -DefParam("usebugaliases", - "Do you wish to use bug aliases, which allow you to assign bugs - an easy-to-remember name by which you can refer to them?", - "b", - 0); - -DefParam("webdotbase", - "It is possible to show graphs of dependent bugs. You may set this parameter to -any of the following: -<ul> -<li>A complete file path to \'dot\' (part of <a -href=\"http://www.graphviz.org\">GraphViz</a>) will generate the graphs -locally.</li> -<li>A URL prefix pointing to an installation of the <a -href=\"http://www.research.att.com/~north/cgi-bin/webdot.cgi\">webdot -package</a> will generate the graphs remotely.</li> -<li>A blank value will disable dependency graphing.</li> -</ul> -The default value is a publically-accessible webdot server. If you change -this value, make certain that the webdot server can read files from your -data/webdot directory. On Apache you do this by editing the .htaccess file, -for other systems the needed measures may vary. You can run checksetup.pl -to recreate the .htaccess file if it has been lost.", - "t", - "http://www.research.att.com/~north/cgi-bin/webdot.cgi/%urlbase%", - \&check_webdotbase); - -sub check_webdotbase { - my ($value) = (@_); - $value = trim($value); - if ($value eq "") { - return ""; - } - if($value !~ /^https?:/) { - if(! -x $value) { - return "The file path \"$value\" is not a valid executable. Please specify the complete file path to 'dot' if you intend to generate graphs locally."; - } - # Check .htaccess allows access to generated images - if(-e "data/webdot/.htaccess") { - open HTACCESS, "data/webdot/.htaccess"; - if(! grep(/png/,<HTACCESS>)) { - return "Dependency graph images are not accessible.\nDelete data/webdot/.htaccess and re-run checksetup.pl to rectify.\n"; - } - close HTACCESS; - } - } - return ""; -} - -sub checkregexp { - my ($value) = (@_); - eval { qr/$value/ }; - return $@; -} - -DefParam("emailregexp", - 'This defines the regexp to use for legal email addresses. The default tries to match fully qualified email addresses. Another popular value to put here is <tt>^[^@]+$</tt>, which means "local usernames, no @ allowed."', - "t", - q:^[^@]+@[^@]+\\.[^@]+$:, - \&checkregexp); - -DefParam("emailregexpdesc", - "This describes in english words what kinds of legal addresses are allowed by the <tt>emailregexp</tt> param.", - "l", - "A legal address must contain exactly one '\@', and at least one '.' after the \@."); - -DefParam("emailsuffix", - "This is a string to append to any email addresses when actually sending mail to that address. It is useful if you have changed the <tt>emailregexp</tt> param to only allow local usernames, but you want the mail to be delivered to username\@my.local.hostname.", - "t", - ""); - - -DefParam("voteremovedmail", -q{This is a mail message to send to anyone who gets a vote removed from a bug for any reason. %to% gets replaced by the person who used to be voting for this bug. %bugid% gets replaced by the bug number. %reason% gets replaced by a short reason describing why the vote(s) were removed. %votesremoved%, %votesold% and %votesnew% is the number of votes removed, before and after respectively. %votesremovedtext%, %votesoldtext% and %votesnewtext% are these as sentences, eg "You had 2 votes on this bug." %count% is also supported for backwards compatibility. %<i>anythingelse</i>% gets replaced by the definition of that parameter (as defined on this page).}, - "l", -"From: bugzilla-daemon +Appended below are the individual URLs to get to all of your NEW bugs that +haven\'t been touched for a week or more. + +You will get this message once a day until you\'ve dealt with these bugs! + +' + }, + + { + name => 'defaultquery', + desc => 'This is the default query that initially comes up when you ' . + 'submit a bug. It\'s in URL parameter format, which makes it ' . + 'hard to read. Sorry!', + type => 't', + default => 'bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailqa_contact2=1&order=%22Importance%22' + }, + + { + name => 'letsubmitterchoosepriority', + desc => 'If this is on, then people submitting bugs can choose an ' . + 'initial priority for that bug. If off, then all bugs initially ' . + 'have the default priority selected below.', + type => 'b', + default => 1 + }, + + { + name => 'defaultpriority', + desc => 'This is the priority that newly entered bugs are set to.', + type => 't', + default => 'P2', + checker => \&check_priority + }, + + { + name => 'usetargetmilestone', + desc => 'Do you wish to use the Target Milestone field?', + type => 'b', + default => 0 + }, + + { + name => 'nummilestones', + desc => 'If using Target Milestone, how many milestones do you wish to + appear?', + type => 't', + default => 10, + checker => \&check_numeric + }, + + { + name => 'curmilestone', + desc => 'If using Target Milestone, Which milestone are we working ' . + 'toward right now?', + type => 't', + default => 1, + checker => \&check_numeric + }, + + { + name => 'musthavemilestoneonaccept', + desc => 'If you are using Target Milestone, do you want to require that ' . + 'the milestone be set in order for a user to ACCEPT a bug?', + type => 'b', + default => 0 + }, + + { + name => 'useqacontact', + desc => 'Do you wish to use the QA Contact field?', + type => 'b', + default => 0 + }, + + { + name => 'usestatuswhiteboard', + desc => 'Do you wish to use the Status Whiteboard field?', + type => 'b', + default => 0 + }, + + { + name => 'usebrowserinfo', + desc => 'Do you want bug reports to be assigned an OS & Platform based ' . + 'on the browser the user makes the report from?', + type => 'b', + default => 1 + }, + + { + name => 'usevotes', + desc => 'Do you wish to allow users to vote for bugs? Note that in order ' . + 'for this to be effective, you will have to change the maximum ' . + 'votes allowed in a product to be non-zero in ' . + '<a href="editproducts.cgi">the product edit page</a>.', + type => 'b', + default => 1 + }, + + { + name => 'usebugaliases', + desc => 'Do you wish to use bug aliases, which allow you to assign bugs ' . + 'an easy-to-remember name by which you can refer to them?', + type => 'b', + default => 0 + }, + + { + name => 'webdotbase', + desc => 'It is possible to show graphs of dependent bugs. You may set ' . + 'this parameter to any of the following: + <ul> + <li>A complete file path to \'dot\' (part of <a + href="http://www.graphviz.org">GraphViz</a>) will generate the graphs + locally.</li> + <li>A URL prefix pointing to an installation of the <a + href="http://www.research.att.com/~north/cgi-bin/webdot.cgi">webdot + package</a> will generate the graphs remotely.</li> + <li>A blank value will disable dependency graphing.</li> + </ul> + The default value is a publically-accessible webdot server. If you change + this value, make certain that the webdot server can read files from your + data/webdot directory. On Apache you do this by editing the .htaccess file, + for other systems the needed measures may vary. You can run checksetup.pl + to recreate the .htaccess file if it has been lost.', + type => 't', + default => 'http://www.research.att.com/~north/cgi-bin/webdot.cgi/%urlbase%', + checker => \&check_webdotbase + }, + + { + name => 'emailregexp', + desc => 'This defines the regexp to use for legal email addresses. The ' . + 'default tries to match fully qualified email addresses. Another ' . + 'popular value to put here is <tt>^[^@]+$</tt>, which means ' . + '"local usernames, no @ allowed."', + type => 't', + default => q:^[^@]+@[^@]+\\.[^@]+$:, + checker => \&check_regexp + }, + + { + name => 'emailregexpdesc', + desc => 'This describes in english words what kinds of legal addresses ' . + 'are allowed by the <tt>emailregexp</tt> param.', + type => 'l', + default => 'A legal address must contain exactly one \'@\', and at least ' . + 'one \'.\' after the @.' + }, + + { + name => 'emailsuffix', + desc => 'This is a string to append to any email addresses when actually ' . + 'sending mail to that address. It is useful if you have changed ' . + 'the <tt>emailregexp</tt> param to only allow local usernames, ' . + 'but you want the mail to be delivered to username@my.local.hostname.', + type => 't', + default => '' + }, + + { + name => 'voteremovedmail', + desc => 'This is a mail message to send to anyone who gets a vote removed ' . + 'from a bug for any reason. %to% gets replaced by the person who ' . + 'used to be voting for this bug. %bugid% gets replaced by the ' . + 'bug number. %reason% gets replaced by a short reason describing ' . + 'why the vote(s) were removed. %votesremoved%, %votesold% and ' . + '%votesnew% is the number of votes removed, before and after ' . + 'respectively. %votesremovedtext%, %votesoldtext% and ' . + '%votesnewtext% are these as sentences, eg "You had 2 votes on ' . + 'this bug." %count% is also supported for backwards ' . + 'compatibility. %<i>anythingelse</i>% gets replaced by the ' . + 'definition of that parameter (as defined on this page).', + type => 'l', + default => 'From: bugzilla-daemon To: %to% Subject: [Bug %bugid%] Some or all of your votes have been removed. @@ -594,132 +614,238 @@ Some or all of your votes have been removed from bug %bugid%. Reason: %reason% %urlbase%show_bug.cgi?id=%bugid% -"); - -DefParam("allowbugdeletion", - q{The pages to edit products and components and versions can delete all associated bugs when you delete a product (or component or version). Since that is a pretty scary idea, you have to turn on this option before any such deletions will ever happen.}, - "b", - 0); - - -DefParam("allowemailchange", - q{Users can change their own email address through the preferences. Note that the change is validated by emailing both addresses, so switching this option on will not let users use an invalid address.}, - "b", - 0); +' + }, + + { + name => 'allowbugdeletion', + desc => 'The pages to edit products and components and versions can delete ' . + 'all associated bugs when you delete a product (or component or ' . + 'version). Since that is a pretty scary idea, you have to turn on ' . + 'this option before any such deletions will ever happen.', + type => 'b', + default => 0 + }, + + { + name => 'allowemailchange', + desc => 'Users can change their own email address through the preferences. ' . + 'Note that the change is validated by emailing both addresses, so ' . + 'switching this option on will not let users use an invalid address.', + type => 'b', + default => 0 + }, + + { + name => 'allowuserdeletion', + desc => 'The pages to edit users can also let you delete a user. But there ' . + 'is no code that goes and cleans up any references to that user in ' . + 'other tables, so such deletions are kinda scary. So, you have to ' . + 'turn on this option before any such deletions will ever happen.', + type => 'b', + default => 0 + }, + + { + name => 'browserbugmessage', + desc => 'If bugzilla gets unexpected data from the browser, in addition to ' . + 'displaying the cause of the problem, it will output this HTML as ' . + 'well.', + type => 'l', + default => 'this may indicate a bug in your browser.' + }, + + { + name => 'commentonaccept', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'he accepts the bug', + type => 'b', + default => 0 + }, + + { + name => 'commentonclearresolution', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug\'s resolution is cleared', + type => 'b', + default => 0 + }, + + { + name => 'commentonconfirm', + desc => 'If this option is on, the user needs to enter a short comment ' . + 'when confirming a bug', + type => 'b', + default => 0 + }, + + { + name => 'commentonresolve', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug is resolved', + type => 'b', + default => 0 + }, + + { + name => 'commentonreassign', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug is reassigned', + type => 'b', + default => 0 + }, + + { + name => 'commentonreassignbycomponent', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug is reassigned by component', + type => 'b', + default => 0 + }, + { + name => 'commentonreopen', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug is reopened', + type => 'b', + default => 0 + }, + + { + name => 'commentonverify', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug is verified', + type => 'b', + default => 0 + }, + + { + name => 'commentonclose', + desc => 'If this option is on, the user needs to enter a short comment if ' . + 'the bug is closed', + type => 'b', + default => 0 + }, + + { + name => 'commentonduplicate', + desc => 'If this option is on, the user needs to enter a short comment ' . + 'if the bug is marked as duplicate', + type => 'b', + default => 0 + }, + + { + name => 'supportwatchers', + desc => 'Support one user watching (ie getting copies of all related ' . + 'email about) another\'s bugs. Useful for people going on ' . + 'vacation, and QA folks watching particular developers\' bugs', + type => 'b', + default => 0 + }, + + { + name => 'move-enabled', + desc => 'If this is on, Bugzilla will allow certain people to move bugs ' . + 'to the defined database.', + type => 'b', + default => 0 + }, + + { + name => 'move-button-text', + desc => 'The text written on the Move button. Explain where the bug is ' . + 'being moved to.', + type => 't', + default => 'Move To Bugscape' + }, + + { + name => 'move-to-url', + desc => 'The URL of the database we allow some of our bugs to be moved to.', + type => 't', + default => '' + }, + + { + name => 'move-to-address', + desc => 'To move bugs, an email is sent to the target database. This is ' . + 'the email address that database uses to listen for incoming bugs.', + type => 't', + default => 'bugzilla-import' + }, + + { + name => 'moved-from-address', + desc => 'To move bugs, an email is sent to the target database. This is ' . + 'the email address from which this mail, and error messages are ' . + 'sent.', + type => 't', + default => 'bugzilla-admin' + }, + + { + name => 'movers', + desc => 'A list of people with permission to move bugs and reopen moved ' . + 'bugs (in case the move operation fails).', + type => 't', + default => '' + }, + + { + name => 'moved-default-product', + desc => 'Bugs moved from other databases to here are assigned to this ' . + 'product.', + type => 't', + default => '' + }, + + { + name => 'moved-default-component', + desc => 'Bugs moved from other databases to here are assigned to this ' . + 'component.', + type => 't', + default => '' + }, + + # The maximum size (in bytes) for patches and non-patch attachments. + # The default limit is 1000KB, which is 24KB less than mysql's default + # maximum packet size (which determines how much data can be sent in a + # single mysql packet and thus how much data can be inserted into the + # database) to provide breathing space for the data in other fields of + # the attachment record as well as any mysql packet overhead (I don't + # know of any, but I suspect there may be some.) + + { + name => 'maxpatchsize', + desc => 'The maximum size (in kilobytes) of patches. Bugzilla will not ' . + 'accept patches greater than this number of kilobytes in size.' . + 'To accept patches of any size (subject to the limitations of ' . + 'your server software), set this value to zero.', + type => 't', + default => '1000', + checker => \&check_numeric + }, + + { + name => 'maxattachmentsize', + desc => 'The maximum size (in kilobytes) of non-patch attachments. ' . + 'Bugzilla will not accept attachments greater than this number' . + 'of kilobytes in size. To accept attachments of any size ' . + '(subject to the limitations of your server software), set this ' . + 'value to zero.', + type => 't', + default => '1000', + checker => \&check_numeric + }, + + { + name => 'insidergroup', + desc => 'The name of the group of users who can see/change private ' . + 'comments and attachments.', + type => 't', + default => '' + }, +); - -DefParam("allowuserdeletion", - q{The pages to edit users can also let you delete a user. But there is no code that goes and cleans up any references to that user in other tables, so such deletions are kinda scary. So, you have to turn on this option before any such deletions will ever happen.}, - "b", - 0); - -DefParam("browserbugmessage", - "If bugzilla gets unexpected data from the browser, in addition to displaying the cause of the problem, it will output this HTML as well.", - "l", - "this may indicate a bug in your browser.\n"); - -# -# Parameters to force users to comment their changes for different actions. -DefParam("commentonaccept", - "If this option is on, the user needs to enter a short comment if he accepts the bug", - "b", 0 ); -DefParam("commentonclearresolution", - "If this option is on, the user needs to enter a short comment if the bugs resolution is cleared", - "b", 0 ); -DefParam("commentonconfirm", - "If this option is on, the user needs to enter a short comment when confirming a bug", - "b", 0 ); -DefParam("commentonresolve", - "If this option is on, the user needs to enter a short comment if the bug is resolved", - "b", 0 ); -DefParam("commentonreassign", - "If this option is on, the user needs to enter a short comment if the bug is reassigned", - "b", 0 ); -DefParam("commentonreassignbycomponent", - "If this option is on, the user needs to enter a short comment if the bug is reassigned by component", - "b", 0 ); -DefParam("commentonreopen", - "If this option is on, the user needs to enter a short comment if the bug is reopened", - "b", 0 ); -DefParam("commentonverify", - "If this option is on, the user needs to enter a short comment if the bug is verified", - "b", 0 ); -DefParam("commentonclose", - "If this option is on, the user needs to enter a short comment if the bug is closed", - "b", 0 ); -DefParam("commentonduplicate", - "If this option is on, the user needs to enter a short comment if the bug is marked as duplicate", - "b", 0 ); -DefParam("supportwatchers", - "Support one user watching (ie getting copies of all related email" . - " about) another's bugs. Useful for people going on vacation, and" . - " QA folks watching particular developers' bugs", - "b", 0 ); - - -DefParam("move-enabled", - "If this is on, Bugzilla will allow certain people to move bugs to the defined database.", - "b", - 0); -DefParam("move-button-text", - "The text written on the Move button. Explain where the bug is being moved to.", - "t", - 'Move To Bugscape'); -DefParam("move-to-url", - "The URL of the database we allow some of our bugs to be moved to.", - "t", - ''); -DefParam("move-to-address", - "To move bugs, an email is sent to the target database. This is the email address that database - uses to listen for incoming bugs.", - "t", - 'bugzilla-import'); -DefParam("moved-from-address", - "To move bugs, an email is sent to the target database. This is the email address from which - this mail, and error messages are sent.", - "t", - 'bugzilla-admin'); -DefParam("movers", - "A list of people with permission to move bugs and reopen moved bugs (in case the move operation fails).", - "t", - ''); -DefParam("moved-default-product", - "Bugs moved from other databases to here are assigned to this product.", - "t", - ''); -DefParam("moved-default-component", - "Bugs moved from other databases to here are assigned to this component.", - "t", - ''); - -# The maximum size (in bytes) for patches and non-patch attachments. -# The default limit is 1000KB, which is 24KB less than mysql's default -# maximum packet size (which determines how much data can be sent in a -# single mysql packet and thus how much data can be inserted into the -# database) to provide breathing space for the data in other fields of -# the attachment record as well as any mysql packet overhead (I don't -# know of any, but I suspect there may be some.) - -DefParam("maxpatchsize", - "The maximum size (in kilobytes) of patches. Bugzilla will not - accept patches greater than this number of kilobytes in size. - To accept patches of any size (subject to the limitations of - your server software), set this value to zero." , - "t", - '1000'); - -DefParam("maxattachmentsize" , - "The maximum size (in kilobytes) of non-patch attachments. Bugzilla - will not accept attachments greater than this number of kilobytes - in size. To accept attachments of any size (subject to the - limitations of your server software), set this value to zero." , - "t" , - '1000'); - -DefParam("insidergroup", - "The name of the group of users who can see/change private comments - and attachments.", - "t", - ''); 1; diff --git a/doeditparams.cgi b/doeditparams.cgi index b7c834979..3bdab3eb4 100755 --- a/doeditparams.cgi +++ b/doeditparams.cgi @@ -25,13 +25,11 @@ use strict; use lib qw(.); +use Bugzilla::Config qw(:DEFAULT :admin); + require "CGI.pl"; -require "defparams.pl"; -# Shut up misguided -w warnings about "used only once": -use vars %::param, - %::param_default, - @::param_list; +use vars %::MFORM; ConnectToDatabase(); confirm_login(); @@ -45,62 +43,57 @@ if (!UserInGroup("tweakparams")) { exit; } - PutHeader("Saving new parameters"); -foreach my $i (@::param_list) { -# print "Processing $i...<BR>\n"; - if (exists $::FORM{"reset-$i"}) { - if ($::param_type{$i} eq "s") { - my $index = get_select_param_index($i, $::param_default{$i}->[1]); - die "Param not found for '$i'" if ($index eq undef); - $::FORM{$i} = $index; +foreach my $i (GetParamList()) { + my $name = $i->{'name'}; + my $value = $::FORM{$name}; + if (exists $::FORM{"reset-$name"}) { + $value = $i->{'default'}; + } else { + if ($i->{'type'} eq 'm') { + # This simplifies the code below + $value = \@{$::MFORM{$name}}; + } else { + # Get rid of windows/mac-style line endings. + $value =~ s/\r\n?/\n/g; + + # assume single linefeed is an empty string + $value =~ s/^\n$//; } - elsif ($::param_type{$i} eq "m") { - # For 'multi' selects, default is the 2nd anon array of the default - @{$::MFORM{$i}} = (); - foreach my $defaultPrm (@{$::param_default{$i}->[1]}) { - my $index = get_select_param_index($i, $defaultPrm); - die "Param not found for '$i'" if ($index eq undef); - push(@{$::MFORM{$i}}, $index); + } + my $changed; + if ($i->{'type'} eq 'm') { + my @old = sort @{Param($name)}; + my @new = sort @$value; + if (scalar(@old) != scalar(@new)) { + $changed = 1; + } else { + $changed = 0; # Assume not changed... + for (my $cnt = 0; $cnt < scalar(@old); ++$cnt) { + if ($old[$cnt] ne $new[$cnt]) { + # entry is different, therefore changed + $changed = 1; + last; + } } } - else { - $::FORM{$i} = $::param_default{$i}; - } + } else { + $changed = ($value eq Param($name) ? 0 : 1); } - $::FORM{$i} =~ s/\r\n?/\n/g; # Get rid of windows/mac-style line endings. - $::FORM{$i} =~ s/^\n$//; # assume single linefeed is an empty string - if ($::FORM{$i} ne Param($i)) { - if (defined $::param_checker{$i}) { - my $ref = $::param_checker{$i}; - my $ok = &$ref($::FORM{$i}, $i); + if ($changed) { + if (exists $i->{'checker'}) { + my $ok = $i->{'checker'}->($value, $i); if ($ok ne "") { - print "New value for $i is invalid: $ok<p>\n"; + print "New value for " . html_quote($name) . + " is invalid: $ok<p>\n"; print "Please hit <b>Back</b> and try again.\n"; PutFooter(); exit; } } - print "Changed $i.<br>\n"; -# print "Old: '" . url_quote(Param($i)) . "'<BR>\n"; -# print "New: '" . url_quote($::FORM{$i}) . "'<BR>\n"; - if ($::param_type{$i} eq "s") { - $::param{$i} = $::param_default{$i}->[0]->[$::FORM{$i}]; - } - elsif ($::param_type{$i} eq "m") { - my $multiParamStr = "[ "; - foreach my $chosenParam (@{$::MFORM{$i}}) { - $multiParamStr .= - "'$::param_default{$i}->[0]->[$chosenParam]', "; - } - $multiParamStr .= " ]"; - - $::param{$i} = $multiParamStr; - } - else { - $::param{$i} = $::FORM{$i}; - } + print "Changed " . html_quote($name) . "<br>\n"; + SetParam($name, $value); } } diff --git a/editparams.cgi b/editparams.cgi index ef9e14946..372eb4d7b 100755 --- a/editparams.cgi +++ b/editparams.cgi @@ -25,13 +25,9 @@ use strict; use lib "."; -require "CGI.pl"; -require "defparams.pl"; +use Bugzilla::Config qw(:DEFAULT :admin); -# Shut up misguided -w warnings about "used only once": -use vars @::param_desc, - @::param_list, - @::param_default; +require "CGI.pl"; ConnectToDatabase(); confirm_login(); @@ -59,18 +55,19 @@ print "<form method=post action=doeditparams.cgi><table>\n"; my $rowbreak = "<tr><td colspan=2><hr></td></tr>"; print $rowbreak; -foreach my $i (@::param_list) { - print "<tr><th align=right valign=top>$i:</th><td>$::param_desc{$i}</td></tr>\n"; - print "<tr><td valign=top><input type=checkbox name=reset-$i>Reset</td><td>\n"; - my $value = Param($i); - SWITCH: for ($::param_type{$i}) { +foreach my $i (GetParamList()) { + my $name = $i->{'name'}; + my $value = Param($name); + print "<tr><th align=right valign=top>$name:</th><td>$i->{'desc'}</td></tr>\n"; + print "<tr><td valign=top><input type=checkbox name=reset-$name>Reset</td><td>\n"; + SWITCH: for ($i->{'type'}) { /^t$/ && do { - print "<input size=80 name=$i value=\"" . + print "<input size=80 name=$name value=\"" . value_quote($value) . "\">\n"; last SWITCH; }; /^l$/ && do { - print "<textarea wrap=hard name=$i rows=10 cols=80>" . + print "<textarea wrap=hard name=$name rows=10 cols=80>" . value_quote($value) . "</textarea>\n"; last SWITCH; }; @@ -84,64 +81,60 @@ foreach my $i (@::param_list) { $on = ""; $off = "checked"; } - print "<input type=radio name=$i value=1 $on>On\n"; - print "<input type=radio name=$i value=0 $off>Off\n"; + print "<input type=radio name=$name value=1 $on>On\n"; + print "<input type=radio name=$name value=0 $off>Off\n"; last SWITCH; }; /^m$/ && do { - my $optList = $::param_default{$i}->[0]; #'cause we use it so much + my @choices = @{$i->{'choices'}}; ## showing 5 options seems like a nice round number; this should ## probably be configurable; if you care, file a bug ;-) - my $boxSize = scalar(@{$optList}) < 5 ? scalar(@{$optList}) : 5; + my $boxSize = scalar(@choices) < 5 ? scalar(@choices) : 5; - print "<select multiple size=\"$boxSize\" name=\"$i\">\n"; + print "<select multiple size=\"$boxSize\" name=\"$name\">\n"; - for (my $optNum = 0; $optNum < scalar(@{$optList}); $optNum++) { + foreach my $item (@choices) { my $selected = ""; - foreach my $selectedVal (@{$value}) { - if ($selectedVal eq $optList->[$optNum]) { - $selected = "selected"; - last; - } + if (lsearch($value, $item) >= 0) { + $selected = "selected"; } - print "<option $selected value=\"$optNum\">" . - "$optList->[$optNum]</option>\n"; + print "<option $selected value=\"" . html_quote($item) . "\">" . + html_quote($item) . "</option>\n"; } print "</select>\n"; last SWITCH; }; /^s$/ && do { - print "<select name=\"$i\">\n"; - #'cause we use it so much below - my $optList = $::param_default{$i}->[0]; + print "<select name=\"$name\">\n"; + my @choices = @{$i->{'choices'}}; - for (my $optNum = 0; $optNum < scalar(@{$optList}); $optNum++) { + foreach my $item (@choices) { my $selected = ""; - if ($value eq $optList->[$optNum]) { + + if ($value eq $item) { $selected = "selected"; } - print "<option $selected value=\"$optNum\">" . - "$optList->[$optNum]</option>\n"; + print "<option $selected value=\"" . html_quote($item) . "\">" . + html_quote($item) . "</option>\n"; + } print "</select>\n"; last SWITCH; }; # DEFAULT - print "<font color=red><blink>Unknown param type $::param_type{$i}!!!</blink></font>\n"; + print "<font color=red><blink>Unknown param type $i->{'type'}!!!</blink></font>\n"; } print "</td></tr>\n"; print $rowbreak; } print "<tr><th align=right valign=top>version:</th><td> -What version of Bugzilla this is. This can't be modified here, but -<tt>%version%</tt> can be used as a parameter in places that understand -such parameters</td></tr> -<tr><td></td><td>" . Param('version') . "</td></tr>"; +What version of Bugzilla this is. This can't be modified. +<tr><td></td><td>" . $Bugzilla::Config::VERSION . "</td></tr>"; print "</table>\n"; diff --git a/globals.pl b/globals.pl index 5e38a56b9..21bdc46cf 100644 --- a/globals.pl +++ b/globals.pl @@ -28,6 +28,8 @@ use strict; use Bugzilla::Util; +# Bring ChmodDataFile in until this is all moved to the module +use Bugzilla::Config qw(:DEFAULT ChmodDataFile); # Shut up misguided -w warnings about "used only once". For some reason, # "use vars" chokes on me when I try it here. @@ -53,7 +55,6 @@ sub globals_pl_sillyness { $zz = @main::legal_target_milestone; $zz = @main::legal_versions; $zz = @main::milestoneurl; - $zz = %main::param_type; $zz = %main::proddesc; $zz = @main::prodmaxvotes; $zz = $main::superusergroupset; @@ -67,12 +68,8 @@ sub globals_pl_sillyness { # here # -$::db_host = "localhost"; -$::db_port = 3306; -$::db_name = "bugs"; -$::db_user = "bugs"; -$::db_pass = ""; - +# XXX - Move this to Bugzilla::Config once code which uses these has moved out +# of globals.pl do 'localconfig'; use DBI; @@ -99,9 +96,6 @@ $::ENV{'PATH'} = ''; $::SIG{TERM} = 'IGNORE'; $::SIG{PIPE} = 'IGNORE'; -# Contains the version string for the current running Bugzilla. -$::param{'version'} = '2.17'; - $::dontchange = "--do_not_change--"; $::chooseone = "--Choose_one:--"; $::defaultqueryname = "(Default query)"; @@ -119,18 +113,6 @@ $::superusergroupset = "9223372036854775807"; #} #$::SIG{__DIE__} = \&die_with_dignity; -# Some files in the data directory must be world readable iff we don't have -# a webserver group. Call this function to do this. -sub ChmodDataFile($$) { - my ($file, $mask) = @_; - my $perm = 0770; - if ((stat('data'))[2] & 0002) { - $perm = 0777; - } - $perm = $perm & $mask; - chmod $perm,$file; -} - sub ConnectToDatabase { my ($useshadow) = (@_); if (!defined $::db) { @@ -346,70 +328,7 @@ sub GetFieldID { return $fieldid; } -# Generate a string which, when later interpreted by the Perl compiler, will -# be the same as the given string. - -sub PerlQuote { - my ($str) = (@_); - return SqlQuote($str); - -# The below was my first attempt, but I think just using SqlQuote makes more -# sense... -# $result = "'"; -# $length = length($str); -# for (my $i=0 ; $i<$length ; $i++) { -# my $c = substr($str, $i, 1); -# if ($c eq "'" || $c eq '\\') { -# $result .= '\\'; -# } -# $result .= $c; -# } -# $result .= "'"; -# return $result; -} - - -# Given the name of a global variable, generate Perl code that, if later -# executed, would restore the variable to its current value. - -sub GenerateCode { - my ($name) = (@_); - my $result = $name . " = "; - if ($name =~ /^\$/) { - my $value = eval($name); - if (ref($value) eq "ARRAY") { - $result .= "[" . GenerateArrayCode($value) . "]"; - } else { - $result .= PerlQuote(eval($name)); - } - } elsif ($name =~ /^@/) { - my @value = eval($name); - $result .= "(" . GenerateArrayCode(\@value) . ")"; - } elsif ($name =~ '%') { - $result = ""; - foreach my $k (sort { uc($a) cmp uc($b)} eval("keys $name")) { - $result .= GenerateCode("\$" . substr($name, 1) . - "{" . PerlQuote($k) . "}"); - } - return $result; - } else { - die "Can't do $name -- unacceptable variable type."; - } - $result .= ";\n"; - return $result; -} - -sub GenerateArrayCode { - my ($ref) = (@_); - my @list; - foreach my $i (@$ref) { - push @list, PerlQuote($i); - } - return join(',', @list); -} - - - +# XXXX - this needs to go away sub GenerateVersionTable { SendSQL("SELECT versions.value, products.name " . "FROM versions, products " . @@ -505,8 +424,9 @@ sub GenerateVersionTable { print FID "# Any changes you make will be overwritten.\n"; print FID "#\n"; - print FID GenerateCode('@::log_columns'); - print FID GenerateCode('%::versions'); + use Data::Dumper; + print FID Data::Dumper->Dump([\@::log_columns, \%::versions], + ['*::log_columns', '*::versions']); foreach my $i (@list) { if (!defined $::components{$i}) { @@ -514,18 +434,23 @@ sub GenerateVersionTable { } } @::legal_versions = sort {uc($a) cmp uc($b)} keys(%varray); - print FID GenerateCode('@::legal_versions'); - print FID GenerateCode('%::components'); + print FID Data::Dumper->Dump([\@::legal_versions, \%::components], + ['*::legal_versions', '*::components']); @::legal_components = sort {uc($a) cmp uc($b)} keys(%carray); - print FID GenerateCode('@::legal_components'); - foreach my $i('product', 'priority', 'severity', 'platform', 'opsys', - 'bug_status', 'resolution') { - print FID GenerateCode('@::legal_' . $i); - } - print FID GenerateCode('@::settable_resolution'); - print FID GenerateCode('%::proddesc'); - print FID GenerateCode('@::enterable_products'); - print FID GenerateCode('%::prodmaxvotes'); + + print FID Data::Dumper->Dump([\@::legal_components, \@::legal_product, + \@::legal_priority, \@::legal_severity, + \@::legal_platform, \@::legal_opsys, + \@::legal_bug_status, \@::legal_resolution], + ['*::legal_components', '*::legal_product', + '*::legal_priority', '*::legal_severity', + '*::legal_platform', '*::legal_opsys', + '*::legal_bug_status', '*::legal_resolution']); + + print FID Data::Dumper->Dump([\@::settable_resolution, \%::proddesc, + \@::enterable_products, \%::prodmaxvotes], + ['*::settable_resolution', '*::proddesc', + '*::enterable_products', '*::prodmaxvotes']); if ($dotargetmilestone) { # reading target milestones in from the database - matthew@zeroknowledge.com @@ -548,9 +473,12 @@ sub GenerateVersionTable { } } - print FID GenerateCode('%::target_milestone'); - print FID GenerateCode('@::legal_target_milestone'); - print FID GenerateCode('%::milestoneurl'); + print FID Data::Dumper->Dump([\%::target_milestone, + \@::legal_target_milestone, + \%::milestoneurl], + ['*::target_milestone', + '*::legal_target_milestone', + '*::milestoneurl']); } SendSQL("SELECT id, name FROM keyworddefs ORDER BY name"); @@ -560,11 +488,13 @@ sub GenerateVersionTable { $name = lc($name); $::keywordsbyname{$name} = $id; } - print FID GenerateCode('@::legal_keywords'); - print FID GenerateCode('%::keywordsbyname'); + + print FID Data::Dumper->Dump([\@::legal_keywords, \%::keywordsbyname], + ['*::legal_keywords', '*::keywordsbyname']); print FID "1;\n"; close FID; + rename $tmpname, "data/versioncache" || die "Can't rename $tmpname to versioncache"; ChmodDataFile('data/versioncache', 0666); } @@ -589,10 +519,6 @@ sub ModTime { return $mtime; } - - -# This proc must be called before using legal_product or the versions array. - $::VersionTableLoaded = 0; sub GetVersionTable { return if $::VersionTableLoaded; @@ -617,7 +543,6 @@ sub GetVersionTable { $::VersionTableLoaded = 1; } - # Validates a given username as a new username # returns 1 if valid, 0 if invalid sub ValidateNewUser { @@ -1429,48 +1354,6 @@ sub RemoveVotes { } } -sub Param ($) { - my ($value) = (@_); - if (! defined $::param{$value}) { - # Um, maybe we haven't sourced in the params at all yet. - if (stat("data/params")) { - # Write down and restore the version # here. That way, we get - # around anyone who maliciously tries to tweak the version number - # by editing the params file. Not to mention that in 2.0, there - # was a bug that wrote the version number out to the params file... - my $v = $::param{'version'}; - require "data/params"; - $::param{'version'} = $v; - } - } - - if (! defined $::param{$value}) { - # Well, that didn't help. Maybe it's a new param, and the user - # hasn't defined anything for it. Try and load a default value - # for it. - require "defparams.pl"; - WriteParams(); - } - - # If it's still not defined, we're pimped. - die "Can't find param named $value" if (! defined $::param{$value}); - - ## Check to make sure the entry in $::param_type is there; if we don't, we - ## get 'use of uninitialized constant' errors (see bug 162217). - ## Interestingly enough, placing this check in the die above causes - ## deaths on some params (the "languages" param?) because they don't have - ## a type? Odd... seems like a bug to me... but what do I know? -jpr - - if (defined $::param_type{$value} && $::param_type{$value} eq "m") { - my $valueList = eval($::param{$value}); - return $valueList if (!($@) && ref($valueList) eq "ARRAY"); - die "Multi-list param '$value' eval() failure ('$@'); data/params is horked"; - } - else { - return $::param{$value}; - } -} - # Take two comma or space separated strings and return what # values were removed from or added to the new one. sub DiffStrings { @@ -1768,6 +1651,9 @@ $::vars = # User Agent - useful for detecting in templates 'user_agent' => $ENV{'HTTP_USER_AGENT'} , + + # Bugzilla version + 'VERSION' => $Bugzilla::Config::VERSION, }; 1; @@ -93,7 +93,7 @@ unless ($exporter =~ /($movers)/) { } my $xml = ""; -$xml .= Bug::XML_Header( Param("urlbase"), $::param{'version'}, +$xml .= Bug::XML_Header( Param("urlbase"), $Bugzilla::Config::VERSION, Param("maintainer"), $exporter ); print "<P>\n"; foreach my $id (split(/:/, $::FORM{'buglist'})) { diff --git a/syncshadowdb b/syncshadowdb index ffe87eea3..cb806bbe0 100755 --- a/syncshadowdb +++ b/syncshadowdb @@ -23,6 +23,10 @@ use strict; +use lib qw(.); + +use Bugzilla::Config qw(:DEFAULT :admin); + require "globals.pl"; require "defparams.pl"; @@ -106,7 +110,7 @@ if ($shutdown) { # Record the old shutdownhtml so it can be restored at the end (this will # only be an issue if we are called using the -force command line param) $wasshutdown = Param("shutdownhtml"); - $::param{'shutdownhtml'} = $shutdown_msg; + SetParam('shutdownhtml', $shutdown_msg); WriteParams(); # Now we need to wait for existing connections to this database to clear. We # do this by looking for connections to the main or shadow database using @@ -143,7 +147,7 @@ if ($shutdown) { # this happening. Verbose ("*** Waited for 10 minutes and there were still active \n" . " connections to the bugzilla database. Giving up."); - $::param{'shutdownhtml'} = $wasshutdown; + SetParam('shutdownhtml', $wasshutdown); WriteParams(); exit; } @@ -153,7 +157,7 @@ if ($shutdown) { my $wasusing = Param("queryagainstshadowdb"); -$::param{'queryagainstshadowdb'} = 1; # Force us to be able to use the +SetParam('queryagainstshadowdb', 1); # Force us to be able to use the # shadowdb, even if other processes # are not supposed to. @@ -185,13 +189,13 @@ if (!$syncall) { if ($syncall) { Verbose("Syncing up the shadow database by copying entire database in."); if ($wasusing) { - $::param{'queryagainstshadowdb'} = 0; + SetParam('queryagainstshadowdb',0); WriteParams(); if (! $shutdown) { Verbose("Disabled reading from the shadowdb. Sleeping 10 seconds to let other procs catch up."); sleep(10); } - $::param{'queryagainstshadowdb'} = 1; + SetParam('queryagainstshadowdb', 1); } my @tables; SendSQL("SHOW TABLES"); @@ -271,12 +275,12 @@ if ($syncall) { SendSQL("UNLOCK TABLES"); if ($wasusing) { Verbose("Reenabling other processes to read from the shadow db"); - $::param{'queryagainstshadowdb'} = 1; + SetParam('queryagainstshadowdb', 1); WriteParams(); } if ($shutdown) { Verbose("Restoring the original shutdown message (if any)"); - $::param{'shutdownhtml'} = $wasshutdown; + SetParam('shutdownhtml', $wasshutdown); WriteParams(); } Verbose("OK, done."); diff --git a/template/en/default/global/banner.html.tmpl b/template/en/default/global/banner.html.tmpl index 2b23de30c..8b1909b52 100644 --- a/template/en/default/global/banner.html.tmpl +++ b/template/en/default/global/banner.html.tmpl @@ -27,7 +27,7 @@ <tr> <td> <font color="#FFFFFF" size="8"><center> - Bugzilla Version [% Param("version") %] + Bugzilla Version [% VERSION %] </center></font> </td> </tr> @@ -46,7 +46,7 @@ my $exporter = $::COOKIE{"Bugzilla_login"} || undef; my @ids = split (/[, ]+/, $::FORM{'id'}); print "Content-type: text/xml\n\n"; -print Bug::XML_Header(Param("urlbase"), $::param{'version'}, +print Bug::XML_Header(Param("urlbase"), $Bugzilla::Config::VERSION, Param("maintainer"), $exporter); foreach my $id (@ids) { my $bug = new Bug(trim($id), $::userid); |