summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormkanat%bugzilla.org <>2006-05-23 03:11:53 +0200
committermkanat%bugzilla.org <>2006-05-23 03:11:53 +0200
commited1bcec007e5c0103be4ee53fe8d304a1a1d7c73 (patch)
tree2230f47eea060ed8814a4bdbcab49af04ac67105
parent164988606e964028ac2639e58556625b111407b4 (diff)
downloadbugzilla-ed1bcec007e5c0103be4ee53fe8d304a1a1d7c73.tar.gz
bugzilla-ed1bcec007e5c0103be4ee53fe8d304a1a1d7c73.tar.xz
Bug 328642: Params should be in Bugzilla->params instead of being a Bugzilla::Config subroutine
Patch By Max Kanat-Alexander <mkanat@bugzilla.org> r=LpSolit, a=justdave
-rw-r--r--Bugzilla.pm38
-rw-r--r--Bugzilla/Config.pm117
-rwxr-xr-xchecksetup.pl11
3 files changed, 89 insertions, 77 deletions
diff --git a/Bugzilla.pm b/Bugzilla.pm
index d72dba70f..349b05f5f 100644
--- a/Bugzilla.pm
+++ b/Bugzilla.pm
@@ -28,7 +28,7 @@ use strict;
use Bugzilla::Auth;
use Bugzilla::Auth::Persist::Cookie;
use Bugzilla::CGI;
-use Bugzilla::Config;
+use Bugzilla::Config qw(:DEFAULT :locations);
use Bugzilla::Constants;
use Bugzilla::DB;
use Bugzilla::Template;
@@ -38,6 +38,7 @@ use Bugzilla::Util;
use Bugzilla::Field;
use File::Basename;
+use Safe;
#####################################################################
# Constants
@@ -70,7 +71,7 @@ use constant SHUTDOWNHTML_EXIT_SILENTLY => [
# This code must go here. It cannot go anywhere in Bugzilla::CGI, because
# it uses Template, and that causes various dependency loops.
if (!$^C
- && Param("shutdownhtml")
+ && Bugzilla->params->{"shutdownhtml"}
&& lsearch(SHUTDOWNHTML_EXEMPT, basename($0)) == -1)
{
# Allow non-cgi scripts to exit silently (without displaying any
@@ -128,6 +129,13 @@ sub cgi {
return $_cgi;
}
+my $_params;
+sub params {
+ my $class = shift;
+ $_params ||= _load_param_values();
+ return $_params;
+}
+
my $_user;
sub user {
my $class = shift;
@@ -324,6 +332,26 @@ sub _cleanup {
undef $_dbh;
}
+sub _load_param_values {
+ my %params;
+ if (-e "$datadir/params") {
+ # Note that checksetup.pl sets file permissions on '$datadir/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("$datadir/params");
+ die "Error reading $datadir/params: $!" if $!;
+ die "Error evaluating $datadir/params: $@" if $@;
+
+ # Now read the param back out from the sandbox
+ %params = %{$s->varglob('param')};
+ }
+ return \%params;
+}
+
sub END {
_cleanup();
}
@@ -473,4 +501,10 @@ Switch from using the main database to using the shadow database.
Change the database object to refer to the main database.
+=item C<params>
+
+The current Parameters of Bugzilla, as a hashref. If C<data/params>
+does not exist, then we return an empty hashref. If C<data/params>
+is unreadable or is not valid perl, we C<die>.
+
=back
diff --git a/Bugzilla/Config.pm b/Bugzilla/Config.pm
index 09e2e3a95..c0fae6eb8 100644
--- a/Bugzilla/Config.pm
+++ b/Bugzilla/Config.pm
@@ -96,8 +96,6 @@ Exporter::export_ok_tags('admin', 'db', 'locations', 'params');
# Bugzilla version
$Bugzilla::Config::VERSION = "2.23.1+";
-use Safe;
-
use vars qw(@param_list);
# Data::Dumper is required as needed, below. The problem is that then when
@@ -110,43 +108,9 @@ use vars qw(@param_list);
local $Data::Dumper::Indent;
}
-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 "$datadir/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 '$datadir/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("$datadir/params");
- die "Error reading $datadir/params: $!" if $!;
- die "Error evaluating $datadir/params: $@" if $@;
-
- # Now read the param back out from the sandbox
- %param = %{$s->varglob('param')};
- }
-}
-
-# Load in the datafiles
-_load_datafiles();
-
-# Stick the params into a hash
+do $localconfig;
my %params;
-
# Load in the param definitions
foreach my $item ((glob "$libpath/Bugzilla/Config/*.pm")) {
$item =~ m#/([^/]+)\.pm$#;
@@ -168,16 +132,19 @@ foreach my $item ((glob "$libpath/Bugzilla/Config/*.pm")) {
sub Param {
my ($param) = @_;
+ my %param_values = %{Bugzilla->params};
+
# By this stage, the param must be in the hash
die "Can't find param named $param" unless (exists $params{$param});
# When module startup code runs (which is does even via -c, when using
# |use|), we may try to grab params which don't exist yet. This affects
# tests, so have this as a fallback for the -c case
- return $params{$param}->{default} if ($^C && not exists $param{$param});
+ return $params{$param}->{default}
+ if ($^C && not exists $param_values{$param});
# If we have a value for the param, return it
- return $param{$param} if exists $param{$param};
+ return $param_values{$param} if exists $param_values{$param};
# Else error out
die "No value for param $param (try running checksetup.pl again)";
@@ -200,7 +167,7 @@ sub SetParam {
die "Param $name is not valid: $err" unless $err eq '';
}
- $param{$name} = $value;
+ Bugzilla->params->{$name} = $value;
}
sub UpdateParams {
@@ -210,69 +177,71 @@ sub UpdateParams {
# the backend code (ie this) from the actual params.
# We don't care about that, though
+ my $param = Bugzilla->params;
+
# Old bugzilla versions stored the version number in the params file
# We don't want it, so get rid of it
- delete $param{'version'};
+ delete $param->{'version'};
# Change from usebrowserinfo to defaultplatform/defaultopsys combo
- if (exists $param{'usebrowserinfo'}) {
- if (!$param{'usebrowserinfo'}) {
- if (!exists $param{'defaultplatform'}) {
- $param{'defaultplatform'} = 'Other';
+ if (exists $param->{'usebrowserinfo'}) {
+ if (!$param->{'usebrowserinfo'}) {
+ if (!exists $param->{'defaultplatform'}) {
+ $param->{'defaultplatform'} = 'Other';
}
- if (!exists $param{'defaultopsys'}) {
- $param{'defaultopsys'} = 'Other';
+ if (!exists $param->{'defaultopsys'}) {
+ $param->{'defaultopsys'} = 'Other';
}
}
- delete $param{'usebrowserinfo'};
+ delete $param->{'usebrowserinfo'};
}
# Change from a boolean for quips to multi-state
- if (exists $param{'usequip'} && !exists $param{'enablequips'}) {
- $param{'enablequips'} = $param{'usequip'} ? 'on' : 'off';
- delete $param{'usequip'};
+ if (exists $param->{'usequip'} && !exists $param->{'enablequips'}) {
+ $param->{'enablequips'} = $param->{'usequip'} ? 'on' : 'off';
+ delete $param->{'usequip'};
}
# Change from old product groups to controls for group_control_map
# 2002-10-14 bug 147275 bugreport@peshkin.net
- if (exists $param{'usebuggroups'} && !exists $param{'makeproductgroups'}) {
- $param{'makeproductgroups'} = $param{'usebuggroups'};
+ if (exists $param->{'usebuggroups'} && !exists $param->{'makeproductgroups'}) {
+ $param->{'makeproductgroups'} = $param->{'usebuggroups'};
}
- if (exists $param{'usebuggroupsentry'}
- && !exists $param{'useentrygroupdefault'}) {
- $param{'useentrygroupdefault'} = $param{'usebuggroupsentry'};
+ if (exists $param->{'usebuggroupsentry'}
+ && !exists $param->{'useentrygroupdefault'}) {
+ $param->{'useentrygroupdefault'} = $param->{'usebuggroupsentry'};
}
# Modularise auth code
- if (exists $param{'useLDAP'} && !exists $param{'loginmethod'}) {
- $param{'loginmethod'} = $param{'useLDAP'} ? "LDAP" : "DB";
+ if (exists $param->{'useLDAP'} && !exists $param->{'loginmethod'}) {
+ $param->{'loginmethod'} = $param->{'useLDAP'} ? "LDAP" : "DB";
}
# set verify method to whatever loginmethod was
- if (exists $param{'loginmethod'} && !exists $param{'user_verify_class'}) {
- $param{'user_verify_class'} = $param{'loginmethod'};
- delete $param{'loginmethod'};
+ if (exists $param->{'loginmethod'} && !exists $param->{'user_verify_class'}) {
+ $param->{'user_verify_class'} = $param->{'loginmethod'};
+ delete $param->{'loginmethod'};
}
# Remove quip-display control from parameters
# and give it to users via User Settings (Bug 41972)
- if ( exists $param{'enablequips'}
- && !exists $param{'quip_list_entry_control'})
+ if ( exists $param->{'enablequips'}
+ && !exists $param->{'quip_list_entry_control'})
{
my $new_value;
- ($param{'enablequips'} eq 'on') && do {$new_value = 'open';};
- ($param{'enablequips'} eq 'approved') && do {$new_value = 'moderated';};
- ($param{'enablequips'} eq 'frozen') && do {$new_value = 'closed';};
- ($param{'enablequips'} eq 'off') && do {$new_value = 'closed';};
- $param{'quip_list_entry_control'} = $new_value;
- delete $param{'enablequips'};
+ ($param->{'enablequips'} eq 'on') && do {$new_value = 'open';};
+ ($param->{'enablequips'} eq 'approved') && do {$new_value = 'moderated';};
+ ($param->{'enablequips'} eq 'frozen') && do {$new_value = 'closed';};
+ ($param->{'enablequips'} eq 'off') && do {$new_value = 'closed';};
+ $param->{'quip_list_entry_control'} = $new_value;
+ delete $param->{'enablequips'};
}
# --- DEFAULTS FOR NEW PARAMS ---
foreach my $item (@param_list) {
my $name = $item->{'name'};
- $param{$name} = $item->{'default'} unless exists $param{$name};
+ $param->{$name} = $item->{'default'} unless exists $param->{$name};
}
# --- REMOVE OLD PARAMS ---
@@ -280,14 +249,14 @@ sub UpdateParams {
my @oldparams = ();
# Remove any old params
- foreach my $item (keys %param) {
+ foreach my $item (keys %$param) {
if (!grep($_ eq $item, map ($_->{'name'}, @param_list))) {
require Data::Dumper;
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Indent = 0;
- push (@oldparams, [$item, Data::Dumper->Dump([$param{$item}])]);
- delete $param{$item};
+ push (@oldparams, [$item, Data::Dumper->Dump([$param->{$item}])]);
+ delete $param->{$item};
}
}
@@ -305,7 +274,7 @@ sub WriteParams {
my ($fh, $tmpname) = File::Temp::tempfile('params.XXXXX',
DIR => $datadir );
- print $fh (Data::Dumper->Dump([ \%param ], [ '*param' ]))
+ print $fh (Data::Dumper->Dump([Bugzilla->params], ['*param']))
|| die "Can't write param file: $!";
close $fh;
diff --git a/checksetup.pl b/checksetup.pl
index 4a059f1c7..a2564f0a6 100755
--- a/checksetup.pl
+++ b/checksetup.pl
@@ -465,7 +465,16 @@ if ($^O =~ /MSWin/i) {
# Global definitions
###########################################################################
-use Bugzilla::Config qw(:DEFAULT :admin :locations);
+# These don't work as a "use," and they don't work as a "require" outside
+# of a BEGIN block. However, we're safe to them in a BEGIN block here since
+# we've already checked all of the pre-requisites above in the previous
+# BEGIN block.
+BEGIN {
+ require Bugzilla;
+
+ require Bugzilla::Config;
+ import Bugzilla::Config qw(:DEFAULT :admin :locations);
+}
# 12/17/00 justdave@syndicomm.com - removed declarations of the localconfig
# variables from this location. We don't want these declared here. They'll