7 eval "use OpenSRF::Utils::Config;";
8 die "Please ensure that /openils/lib/perl5 is in your PERL5LIB environment variable.
9 You must run this script as the 'opensrf' user.\n" if ($@);
10 eval "use Error qw/:try/;";
11 die "Please install Error.pm.\n" if ($@);
12 eval "use UNIVERSAL::require;";
13 die "Please install the UNIVERSAL::require perl module.\n" if ($@);
14 eval "use Getopt::Long;";
15 die "Please install the Getopt::Long perl module.\n" if ($@);
16 eval "use Net::Domain;";
17 die "Please install the Net::Domain perl module.\n" if ($@);
24 my ($gather, $hostname, $core_config, $tmpdir) =
25 (0, Net::Domain::hostfqdn(), '/openils/conf/opensrf_core.xml', '/tmp/');
29 'hostname=s' => \$hostname,
30 'config_file=s' => \$core_config,
31 'tempdir=s' => \$tmpdir,
34 while (my $mod = <DATA>) {
36 my @list = split / /, $mod;
42 my $version = $m->VERSION;
43 print "$m version $version\n" if ($version);
49 warn "Please install $mod\n";
50 $perloutput .= "Please install the $mod Perl module.\n";
52 warn "Please install one of the following modules: $mod\n";
53 $perloutput .= "Please install one of the following modules: $mod\n";
59 use OpenSRF::Transport::SlimJabber::Client;
60 use OpenSRF::Utils::SettingsParser;
61 use OpenSRF::Utils::SettingsClient;
65 (my $conf_dir = $core_config) =~ s#(.*)/.*#$1#;
68 OpenSRF::Utils::Config->load(config_file => $core_config);
69 my $conf = OpenSRF::Utils::Config->current;
70 my $j_username = $conf->bootstrap->username;
71 my $j_password = $conf->bootstrap->passwd;
72 my $j_port = $conf->bootstrap->port;
73 # We should check for a domains element to catch likely upgrade errors
74 my $j_domain = $conf->bootstrap->domain;
75 my $settings_config = $conf->bootstrap->settings_config;
76 my $logfile = $conf->bootstrap->logfile;
77 (my $log_dir = $logfile) =~ s#(.*)/.*#$1#;
80 print "\nChecking Jabber connection\n";
82 my $client = OpenSRF::Transport::SlimJabber::Client->new(
84 username => $j_username,
85 password => $j_password,
93 unless($client->initialize()) {
94 $je = "* Unable to connect to jabber server $j_domain\n";
95 warn "* Unable to connect to jabber server $j_domain\n";
98 $je = "* Error connecting to jabber:\n" . shift() . "\n";
99 warn "* Error connecting to jabber:\n" . shift() . "\n";
102 print "* Jabber successfully connected\n" unless ($je);
103 $output .= ($je) ? $je : "* Jabber successfully connected\n";
105 my $xmlparser = XML::LibXML->new();
106 my $osrfxml = $xmlparser->parse_file($settings_config);
108 print "\nChecking database connections\n";
109 # Check database connections
110 my @databases = $osrfxml->findnodes('//database');
111 foreach my $database (@databases) {
112 my $db_name = $database->findvalue("./db");
114 $db_name = $database->findvalue("./name");
116 my $db_host = $database->findvalue("./host");
117 my $db_port = $database->findvalue("./port");
118 my $db_user = $database->findvalue("./user");
119 my $db_pw = $database->findvalue("./pw");
120 if (!$db_pw && $database->parentNode->parentNode->nodeName eq 'reporter') {
121 $db_pw = $database->findvalue("./password");
122 warn "* WARNING: Deprecated <password> element used for the <reporter> entry. ".
123 "Please use <pw> instead.\n" if ($db_pw);
127 foreach my $node ($database->findnodes("ancestor::node()")) {
128 next unless $node->nodeType == XML::LibXML::XML_ELEMENT_NODE;
129 $osrf_xpath .= "/" . $node->nodeName;
131 $output .= test_db_connect($db_name, $db_host, $db_port, $db_user, $db_pw, $osrf_xpath);
134 print "\nChecking database drivers to ensure <driver> matches <language>\n";
135 # Check database drivers
136 # if language eq 'C', driver eq 'pgsql'
137 # if language eq 'perl', driver eq 'Pg'
138 my @drivers = $osrfxml->findnodes('//driver');
139 foreach my $driver_node (@drivers) {
142 my @driver_xpath_nodes;
143 foreach my $node ($driver_node->findnodes("ancestor::node()")) {
144 next unless $node->nodeType == XML::LibXML::XML_ELEMENT_NODE;
145 $driver_xpath .= "/" . $node->nodeName;
146 push @driver_xpath_nodes, $node->nodeName;
149 my $driver = $driver_node->findvalue("child::text()");
150 while (pop(@driver_xpath_nodes) && scalar(@driver_xpath_nodes) > 0 && !$language) {
151 $lang_xpath = "/" . join('/', @driver_xpath_nodes) . "/language";
152 my @lang_nodes = $osrfxml->findnodes($lang_xpath);
153 next unless scalar(@lang_nodes > 0);
154 $language = $lang_nodes[0]->findvalue("child::text()");
156 if ($driver eq "pgsql") {
157 if ($driver_xpath =~ m#/reporter/#) {
158 $result = "* ERROR: reporter application must use driver 'Pg', but '$driver' is defined\n";
160 } elsif ($language eq "C") {
161 $result = "* OK: $driver language is $language in $lang_xpath\n";
163 $result = "* ERROR: $driver language is $language in $lang_xpath\n";
166 } elsif ($driver eq "Pg") {
167 if ($driver_xpath =~ m#/reporter/#) {
168 $result = "* OK: $driver language is undefined for reporter base configuration\n";
169 } elsif ($language eq "perl") {
170 $result = "* OK: $driver language is $language in $lang_xpath\n";
172 $result = "* ERROR: $driver language is $language in $lang_xpath\n";
176 $result = "* ERROR: Unknown driver $driver in $driver_xpath\n";
183 print "\nChecking libdbi and libdbi-drivers\n";
184 $output .= check_libdbd();
186 print "\nChecking hostname\n";
187 my @hosts = $osrfxml->findnodes('/opensrf/hosts/*');
188 foreach my $host (@hosts) {
189 next unless $host->nodeType == XML::LibXML::XML_ELEMENT_NODE;
190 my $osrfhost = $host->nodeName;
192 if ($osrfhost ne $hostname && $osrfhost ne "localhost") {
193 $result = " * ERROR: expected hostname '$hostname', found '$osrfhost' in <hosts> section of opensrf.xml\n";
196 } elsif ($osrfhost eq "localhost") {
197 $result = " * OK: found hostname 'localhost' in <hosts> section of opensrf.xml\n";
199 $result = " * OK: found hostname '$hostname' in <hosts> section of opensrf.xml\n";
201 print $result unless $he;
207 get_debug_info( $tmpdir, $log_dir, $conf_dir, $perloutput, $output );
210 sub test_db_connect {
211 my ($db_name, $db_host, $db_port, $db_user, $db_pw, $osrf_xpath) = @_;
213 my $dsn = "dbi:Pg:dbname=$db_name;host=$db_host;port=$db_port";
215 my ($dbh, $encoding, $langs);
217 $dbh = DBI->connect($dsn, $db_user, $db_pw);
219 $de = "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n";
220 warn "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n";
223 # Get server encoding
224 my $sth = $dbh->prepare("SHOW server_encoding");
226 $sth->bind_col(1, \$encoding);
230 # Get list of server languages
231 $sth = $dbh->prepare("SELECT lanname FROM pg_catalog.pg_language");
233 $langs = $sth->fetchall_arrayref([0]);
238 $de = "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n" . shift() . "\n";
239 warn "* $osrf_xpath :: Unable to connect to database $dsn, user=$db_user, password=$db_pw\n" . shift() . "\n";
241 print "* $osrf_xpath :: Successfully connected to database $dsn\n" unless ($de);
244 if ($encoding !~ m/(utf-?8|unicode)/i) {
245 $de .= "* ERROR: $osrf_xpath :: Database $dsn has encoding $encoding instead of UTF8 or UNICODE.\n";
246 warn "* ERROR: $osrf_xpath :: Database $dsn has encoding $encoding instead of UTF8 or UNICODE.\n";
248 print " * Database has the expected server encoding $encoding.\n";
251 my $result = check_db_langs($langs);
257 return ($de) ? $de : "* $osrf_xpath :: Successfully connected to database $dsn with encoding $encoding\n";
266 # Ensure the following PostgreSQL languages have been enabled
273 foreach my $lang (@$langs) {
274 my $lower = lc($$lang[0]);
275 $languages{$lower} = 1;
278 foreach my $lang (keys %languages) {
279 if (!$languages{$lang}) {
280 $errors .= " * ERROR: Language '$lang' is not enabled in the target database\n";
289 my @location = `locate libdbdpgsql.so | grep -v home | grep -v .libs`; # simple(ton) attempt to filter out build versions
291 my $res = "Libdbi postgres driver not found\n";
295 if (scalar(@location) > 1) {
297 my $res = "Found more than one location for libdbdpgsql.so.
298 We have found that system packages don't link against libdbi.so;
299 therefore, we strongly recommend compiling libdbi and libdbi-drivers from source.\n";
303 foreach my $loc (@location) {
304 my @linkage = `ldd $loc`;
305 if (!grep(/libdbi/, @linkage)) {
306 my $res = "$loc was not linked against libdbi - you probably need to compile libdbi-drivers from source with the --enable-libdbi configure switch.\n";
315 my $temp_dir = shift; # place we can write files
316 my $log = shift; # location of the log directory
317 my $config = shift; # location of the config files
318 my $perl_test = shift; # output from the Perl prereq testing
319 my $config_test = shift; # output from the config file testing
321 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
322 my $oils_time = sprintf("%04d-%02d-%02d_%02dh-%02d-%02d", $year+1900, $mon, $mday, $hour, $min, $sec);
324 # evil approach that requires no other Perl dependencies
326 my $oils_debug_dir = "$temp_dir/oils_$oils_time";
328 # Replace with something Perlish
329 mkdir($oils_debug_dir) or die $!;
331 # Replace with File::Copy
332 system("cp $log/*log $oils_debug_dir");
334 # Passwords will go through in the clear for now
335 system("cp $config/*xml $oils_debug_dir");
338 open(FH, ">", "$oils_debug_dir/perl_test.out") or die $!;
343 open(FH, ">", "$oils_debug_dir/xml_test.out") or die $!;
344 print FH $config_test;
347 # Tar this up - does any system not have tar?
348 system("tar czf oils_$oils_time.tar.gz oils_$oils_time");
350 # Clean up after ourselves, somewhat dangerously
351 system("rm -fr $oils_debug_dir");
353 print "Wrote your debug information to $temp_dir/oils_$oils_time.tar.gz.\n";
359 XML::LibXML::XPathContext
364 Class::DBI::AbstractSearch
367 Net::Z3950 Net::Z3950::ZOOM
375 DateTime::Format::ISO8601
376 DateTime::Format::Mail
379 JavaScript::SpiderMonkey
384 Spreadsheet::WriteExcel::Big