#!/usr/bin/perl -w
#
# TWiki Collaboration Platform, http://TWiki.org/
#
# Copyright (C) 2000-2004 Peter Thoeny, peter@thoeny.com
#
# For licensing info read license.txt file in the TWiki root.
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details, published at
# http://www.gnu.org/copyleft/gpl.html
#
# DESCRIPTION: Test utility to see if CGI is running and enabled
# for the bin directory, and check a variety of TWiki, Perl and RCS
# setup.
# NOTE: Testenv should always run on older TWiki versions, as far as
# possible - so any dependency on TWiki modules should be carefully
# handled and error checked. If a newer feature or subroutine is not
# there, it's OK to fail silently and not do the associated tests.
# This is more painful to code, but it means that testenv can be downloaded
# from CVS and used on older TWiki versions to diagnose problems.
package TWiki;
use vars qw( $useLocale $setlibAvail );
my $brokenTWikiCfg;
BEGIN {
# Set default current working directory
if( $ENV{"SCRIPT_FILENAME"} && $ENV{"SCRIPT_FILENAME"} =~ /^(.+)\/[^\/]+$/ ) {
chdir $1;
}
# Set library paths in @INC, read TWiki.cfg and set locale, at compile time
# Try to use setlib.cfg, use default path if missing
if ( -r './setlib.cfg' ) {
require './setlib.cfg';
$setlibAvail = 1;
} else {
unshift @INC, '../lib';
$setlibAvail = 0;
}
# Read the configuration file now in order to set locale;
# includes checking for broken syntax etc. Need 'require'
# to get the $!/$@ to work.
$brokenTWikiCfg = 0;
unless( eval 'require "TWiki.cfg" ' ){ # Includes OS detection
# Capture the Perl error(s)
$brokenTWikiCfg = 1;
$brokenTWikiCfgError =
( $! ? "$!\n" : '') . # $! if not readable,
( $@ ? "$@\n" : ''); # $@ if not compileable
}
# Do a dynamic 'use locale' for this script
if( $useLocale ) {
require locale;
import locale ();
}
}
# use strict; # Recommended for mod_perl, enable for Perl 5.6.1 only
# Doesn't work well here, due to 'do "TWiki.cfg"'
# use diagnostics; # Debug only
&main();
sub checkBasicModules {
# Check whether basic CGI modules exist (some broken installations of
# Perl don't have this, even though they are standard modules), and warn user
my @basicMods = @_;
my $modMissing = 0;
my $mod;
foreach $mod (@basicMods) {
eval "use $mod";
if ($@) {
unless ($modMissing) {
print "Content-type: text/html\n\n";
print "Perl Module(s) missing\n";
print "\n";
print "Perl Module(s) missing
\n";
}
$modMissing = 1;
print "Warning: ";
print "Essential module $mod not installed - please check your Perl\n";
print "installation, including the setting of \@INC, and re-install Perl if necessary.
\n";
}
}
# If any critical modules missing, display @INC and give up
if ($modMissing) {
print "\@INC setting:
";
print join "
\n", @INC;
print "
\n";
print "\n\n";
exit;
}
}
sub main
{
my $perlverRequired = 5.00503; # Oldest supported version of Perl
my $perlverRequiredString = '5.005_03';
my $perlverRecommended = '5.6.1';
my $ActivePerlRecommendedBuild = 631; # Fixes PERL5SHELL bugs
# CGI.pm version, on some platforms - actually need CGI 2.93 for mod_perl
# 2.0 and CGI 2.90 for Cygwin Perl 5.8.0. See
# http://perl.apache.org/products/apache-modules.html#Porting_CPAN_modules_to_mod_perl_2_0_Status
my $cgiModVerRecommended = '2.93';
# Recommended mod_perl version if using mod_perl 2.0 (see Support.RegistryCookerBadFileDescriptor)
my $modPerlVersionRecommended = '1.99_12';
my $rcsverRequired = 5.7;
my @basicMods = qw( CGI CGI::Carp ); # Required for testenv to work
my @requiredMods = ( # Required for TWiki
@basicMods,
'File::Copy',
'File::Spec',
'FileHandle',
);
# Required on non-Unix platforms (mainly Windows)
my @requiredModsNonUnix = (
'Digest::SHA1', # For register script
'MIME::Base64', # For register script
'Net::SMTP', # For registration emails and mailnotify
);
# Optional modules on all platforms
my @optionalMods = (
'Algorithm::Diff', # For RcsLite (CPAN)
'MIME::Base64', # For HTTP Authentication to proxies (CPAN)
'POSIX', # For I18N (core module)
'Encode', # For I18N conversions (core module in Perl 5.8)
'Unicode::MapUTF8', # For I18N conversions (CPAN)
'Unicode::Map', # For I18N conversions (CPAN)
'Unicode::Map8', # For I18N conversions (CPAN)
'Jcode', # For I18N conversions (CPAN)
'Digest::MD5', # For MD5 encoded passwords in HtPasswdUser.pm
);
open(STDERR,'>&STDOUT'); # redirect errors to browser
$| = 1; # no buffering - FIXME: mod_perl issue?
# Check for modules required by this script
&checkBasicModules( @basicMods );
# Load CGI modules (run-time, after checking they are accessible)
require CGI;
require CGI::Carp;
import CGI::Carp qw( fatalsToBrowser );
my $query = new CGI;
print "Content-type: text/html\n\n";
print <
Test TWiki environment
Test the environment for TWiki
Please read the TWikiInstallationNotes for more information on TWiki installation.
EOM
# TWiki.cfg was read earlier, in BEGIN block.
# Check for broken TWiki.cfg and report any Perl error(s)
if ($brokenTWikiCfg) {
$brokenTWikiCfgError =~ s!\n!
\n!sg; # Format properly
print "TWiki.cfg error
\n";
print "WARNING: ";
print "TWiki.cfg is unreadable or has a configuration problem that is causing a Perl error - the following message(s) relate to TWiki.cfg and should help locate the problem.\n";
print "$brokenTWikiCfgError\n";
# EARLY EXIT
print "\n