Open-ILS/src/support-scripts/settings-tester.pl

   1 #!/usr/bin/perl
   2 # vim:noet:ts=4:
   3
   4 BEGIN {
   5         eval "use OpenSRF::Utils::Config;";
   6         die "Please ensure that /openils/lib/perl5 is in your PERL5LIB environment variable.
   7         You must run this script as the 'opensrf' user.\n" if ($@);
   8         eval "use Error qw/:try/;";
   9         die "Please install Error.pm.\n" if ($@);
  10         eval "use UNIVERSAL::require;";
  11         die "Please install the UNIVERSAL::Require perl module.\n" if ($@);
  12         eval "use Getopt::Long;";
  13         die "Please install the Getopt::Long perl module.\n" if ($@);
  14         eval "use Net::Domain;";
  15         die "Please install the Net::Domain perl module.\n" if ($@);
  16 }
  17
  18 my $output = '';
  19 my $perloutput = '';
  20
  21 my ($gather, $hostname, $core_config, $tmpdir) =
  22         (0, Net::Domain::hostfqdn(), '/openils/conf/opensrf_core.xml', '/tmp/');
  23
  24 GetOptions(
  25         'gather' => \$gather,
  26         'hostname=s' => \$hostname,
  27         'config_file=s' => \$core_config,
  28         'tempdir=s' => \$tmpdir,
  29 );
  30
  31 while (my $mod = <DATA>) {
  32         chomp $mod;
  33         warn "Please install $mod\n" unless ($mod->use);
  34         $perloutput .= "Please install the $mod Perl module.\n";
  35         print "$mod version ".${$mod."::VERSION"}."\n" unless ($@);
  36 }
  37
  38 use OpenSRF::Transport::SlimJabber::Client;
  39 use OpenSRF::Utils::SettingsParser;
  40 use OpenSRF::Utils::SettingsClient;
  41 use Data::Dumper;
  42 use DBI;
  43
  44 (my $conf_dir = $core_config) =~ s#(.*)/.*#$1#;
  45
  46
  47 OpenSRF::Utils::Config->load(config_file => $core_config);
  48 my $conf = OpenSRF::Utils::Config->current;
  49 my $j_username    = $conf->bootstrap->username;
  50 my $j_password    = $conf->bootstrap->passwd;
  51 my $j_port    = $conf->bootstrap->port;
  52 my $j_domain    = $conf->bootstrap->domains->[0];
  53 my $settings_config = $conf->bootstrap->settings_config;
  54 my $logfile    = $conf->bootstrap->logfile;
  55 (my $log_dir = $logfile) =~ s#(.*)/.*#$1#;
  56
  57
  58 print "\nChecking Jabber connection\n";
  59 # connect to jabber
  60 my $client = OpenSRF::Transport::SlimJabber::Client->new(
  61     port => $j_port,
  62     username => $j_username,
  63     password => $j_password,
  64     host => $j_domain,
  65     resource => 'test123'
  66 );
  67
  68
  69 my $je = undef;
  70 try {
  71     unless($client->initialize()) {
  72         $je = "* Unable to connect to jabber server $j_domain\n";
  73         warn "* Unable to connect to jabber server $j_domain\n";
  74     }
  75 } catch Error with {
  76     $je = "* Error connecting to jabber:\n" . shift() . "\n";
  77     warn "* Error connecting to jabber:\n" . shift() . "\n";
  78 };
  79
  80 print "* Jabber successfully connected\n" unless ($je);
  81 $output .= ($je) ? $je : "* Jabber successfully connected\n";
  82
  83 my $xmlparser = XML::LibXML->new();
  84 my $osrfxml = $xmlparser->parse_file($settings_config);
  85
  86 print "\nChecking database connections\n";
  87 # Check database connections
  88 my @databases = $osrfxml->findnodes('//database');
  89 foreach my $database (@databases) {
  90         my $db_name = $database->findvalue("./db");
  91         if (!$db_name) {
  92                 $db_name = $database->findvalue("./name");
  93         }
  94         my $db_host = $database->findvalue("./host");
  95         my $db_port = $database->findvalue("./port");
  96         my $db_user = $database->findvalue("./user");
  97         my $db_pw = $database->findvalue("./pw");
  98         my $osrf_xpath;
  99         foreach my $node ($database->findnodes("ancestor::node()")) {
 100                 next unless $node->nodeType == XML::LibXML::XML_ELEMENT_NODE;
 101                 $osrf_xpath .= "/" . $node->nodeName;
 102         }
 103         $output .= test_db_connect($db_name, $db_host, $db_port, $db_user, $db_pw, $osrf_xpath);
 104 }
 105
 106 print "\nChecking database drivers to ensure <driver> matches <language>\n";
 107 # Check database drivers
 108 # if language eq 'C', driver eq 'pgsql'
 109 # if language eq 'perl', driver eq 'Pg'
 110 my @drivers = $osrfxml->findnodes('//driver');
 111 foreach my $driver_node (@drivers) {
 112         my $language;
 113         my $driver_xpath;
 114         my @driver_xpath_nodes;
 115         foreach my $node ($driver_node->findnodes("ancestor::node()")) {
 116                 next unless $node->nodeType == XML::LibXML::XML_ELEMENT_NODE;
 117                 $driver_xpath .= "/" . $node->nodeName;
 118                 push @driver_xpath_nodes, $node->nodeName;
 119         }
 120         my $lang_xpath;
 121         my $driver = $driver_node->findvalue("child::text()");
 122         while (pop(@driver_xpath_nodes) && scalar(@driver_xpath_nodes) > 0 && !$language) {
 123                 $lang_xpath = "/" . join('/', @driver_xpath_nodes) . "/language";
 124                 my @lang_nodes = $osrfxml->findnodes($lang_xpath);
 125                 next unless scalar(@lang_nodes > 0);
 126                 $language = $lang_nodes[0]->findvalue("child::text()");
 127         }
 128         my $result;
 129         if ($driver eq "pgsql") {
 130                 if ($language eq "C") {
 131                         $result = "* OK: $driver language is $language in $lang_xpath\n";
 132                 } else {
 133                         $result = "* ERROR: $driver language is $language in $lang_xpath\n";
 134                         warn $result;
 135                 }
 136         } elsif ($driver eq "Pg") {
 137                 if ($language eq "perl") {
 138                         $result = "* OK: $driver language is $language in $lang_xpath\n";
 139                 } elsif ($driver_xpath =~ /reporter/) {
 140                         $result = "* OK: $driver language is undefined for reporter base configuration\n";
 141                 } else {
 142                         $result = "* ERROR: $driver language is $language in $lang_xpath\n";
 143                         warn $result;
 144                 }
 145         } else {
 146                 $result = "* ERROR: Unknown driver $driver in $driver_xpath\n";
 147                 warn $result;
 148         }
 149         print $result;
 150         $output .= $result;
 151 }
 152
 153 print "\nChecking libdbi and libdbi-drivers\n";
 154 $output .= check_libdbd();
 155
 156 print "\nChecking hostname\n";
 157 my @hosts = $osrfxml->findnodes('/opensrf/hosts/*');
 158 foreach my $host (@hosts) {
 159         next unless $host->nodeType == XML::LibXML::XML_ELEMENT_NODE;
 160         my $osrfhost = $host->nodeName;
 161         my $he;
 162         if ($osrfhost ne $hostname && $osrfhost ne "localhost") {
 163                 $result = " * ERROR: expected hostname '$hostname', found '$osrfhost' in <hosts> section of opensrf.xml\n";
 164                 warn $result;
 165                 $he = 1;
 166         } elsif ($osrfhost eq "localhost") {
 167                 $result = " * OK: found hostname 'localhost' in <hosts> section of opensrf.xml\n";
 168         } else {
 169                 $result = " * OK: found hostname '$hostname' in <hosts> section of opensrf.xml\n";
 170         }
 171         print $result unless $he;
 172         $output .= $result;
 173 }
 174
 175
 176 if ($gather) {
 177         get_debug_info( $tmpdir, $log_dir, $conf_dir, $perloutput, $output );
 178 }
 179
 180 sub test_db_connect {
 181         my ($db_name, $db_host, $db_port, $db_user, $db_pw, $osrf_xpath) = @_;
 182
 183         my $dsn = "dbi:Pg:dbname=$db_name;host=$db_host;port=$db_port";
 184         my $de = undef;
 185         my $dbh, $encoding;
 186         try {
 187                 $dbh = DBI->connect($dsn, $db_user, $db_pw);
 188                 unless($dbh) {
 189                         $de = "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n";
 190                         warn "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n";
 191                 }
 192                 my $sth = $dbh->prepare("show server_encoding");
 193                 $sth->execute;
 194                 $sth->bind_col(1, \$encoding);
 195                 $sth->fetch;
 196                 $sth->finish;
 197                 $dbh->disconnect;
 198         } catch Error with {
 199                 $de = "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n" . shift() . "\n";
 200                 warn "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n" . shift() . "\n";
 201         };
 202         print "* $osrf_xpath :: Successfully connected to database $dsn\n" unless ($de);
 203         if ($encoding !~ m/(utf-?8|unicode)/i) {
 204                 $de .= "* ERROR: $osrf_xpath :: Database $dsn has encoding $encoding instead of UTF8 or UNICODE.\n";
 205                 warn "* ERROR: $osrf_xpath :: Database $dsn has encoding $encoding instead of UTF8 or UNICODE.\n";
 206         } else {
 207                 print "  * Database has the expected server encoding $encoding.\n";
 208         }
 209         return ($de) ? $de : "* $osrf_xpath :: Successfully connected to database $dsn with encoding $encoding\n";
 210
 211 }
 212
 213 sub check_libdbd {
 214         my $results;
 215         my $de = undef;
 216         my @location = `locate libdbdpgsql.so |grep -v home`; # simple(ton) attempt to filter out build versions
 217         if (scalar(@location) > 1) {
 218
 219                 my $res = "Found more than one location for libdbdpgsql.so.
 220   We have found that system packages don't link against libdbi.so;
 221   therefore, we strongly recommend compiling libdbi and libdbi-drivers from source.\n";
 222                 $results .= $res;
 223                 print $res;
 224         }
 225         foreach my $loc (@location) {
 226                 my @linkage = `ldd $loc`;
 227                 if (!grep(/libdbi/, @linkage)) {
 228                         my $res = "$loc was not linked against libdbi - you probably need to compile libdbi-drivers from source with the --enable-libdbi configure switch.\n";
 229                         $results .= $res;
 230                         print $res;
 231                 }
 232         }
 233         return $results;
 234 }
 235
 236 sub get_debug_info {
 237   my $temp_dir = shift; # place we can write files
 238   my $log = shift; # location of the log directory
 239   my $config = shift; # location of the config files
 240   my $perl_test = shift; # output from the Perl prereq testing
 241   my $config_test = shift; # output from the config file testing
 242
 243   my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
 244   my $oils_time = sprintf("%04d-%02d-%02d_%02dh-%02d-%02d", $year+1900, $mon, $mday, $hour, $min, $sec);
 245
 246   # evil approach that requires no other Perl dependencies
 247   chdir($temp_dir);
 248   my $oils_debug_dir = "$temp_dir/oils_$oils_time";
 249
 250   # Replace with something Perlish
 251   mkdir($oils_debug_dir) or die $!;
 252
 253   # Replace with File::Copy
 254   system("cp $log/*log $oils_debug_dir");
 255
 256   # Passwords will go through in the clear for now
 257   system("cp $config/*xml $oils_debug_dir");
 258
 259   # Get Perl output
 260   open(FH, ">", "$oils_debug_dir/perl_test.out") or die $!;
 261   print FH $perl_test;
 262   close(FH);
 263
 264   # Get XML output
 265   open(FH, ">", "$oils_debug_dir/xml_test.out") or die $!;
 266   print FH $config_test;
 267   close(FH);
 268
 269   # Tar this up - does any system not have tar?
 270   system("tar czf oils_$oils_time.tar.gz oils_$oils_time");
 271
 272   # Clean up after ourselves, somewhat dangerously
 273   system("rm -fr $oils_debug_dir");
 274
 275   print "Wrote your debug information to $temp_dir/oils_$oils_time.tar.gz.\n";
 276 }
 277
 278 __DATA__
 279 LWP::UserAgent
 280 XML::LibXML
 281 XML::LibXSLT
 282 Net::Server::PreFork
 283 Cache::Memcached
 284 Class::DBI
 285 Class::DBI::AbstractSearch
 286 Template
 287 DBD::Pg
 288 Net::Z3950
 289 MARC::Record
 290 MARC::Charset
 291 MARC::File::XML
 292 Text::Aspell
 293 CGI
 294 DateTime::TimeZone
 295 DateTime
 296 DateTime::Format::ISO8601
 297 Unix::Syslog
 298 GD::Graph3d
 299 JavaScript::SpiderMonkey
 300 Log::Log4perl
 301 Email::Send
 302 Text::CSV