source: gs3-extensions/solr/trunk/src/perllib/solrserver.pm@ 24483

Last change on this file since 24483 was 24483, checked in by davidb, 10 years ago
Reworking of code that detects existing running instance of Solr/Jetty server. This was due to Windows version of Perl not implementing '' on an open call. Code currently messy and needs a further tidy up.
File size: 10.6 KB
Line 
1###########################################################################
2#
3# solrserver.pm -- class for starting and stopping the Solr/jetty server
4# A component of the Greenstone digital library software
5# from the New Zealand Digital Library Project at the
6# University of Waikato, New Zealand.
7#
8# Copyright (C) 1999 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 2 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program; if not, write to the Free Software
22# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23#
24###########################################################################
25
26
27package solrserver;
28
29use strict;
30#no strict 'refs';
31
32use solrutil;
33
34my $key_count = 0;
35
36sub new {
37 my $class = shift(@_);
38
39 $key_count++;
40 my $self = { 'jetty_stop_key' => "greenstone-solr-".$$."-".$key_count };
41
42 my $search_path = &solrutil::get_search_path();
43
44 my $server_jar = &util::filename_cat("lib","java","solr-jetty-server.jar");
45 my $full_server_jar = solrutil::locate_file($search_path,$server_jar);
46 $self->{'full_server_jar'} = $full_server_jar;
47
48 $self->{'jetty_explicitly_started'} = undef;
49
50 my $jetty_server_port = $ENV{'SOLR_JETTY_PORT'};
51 my $base_url = "http://localhost:$jetty_server_port/solr/";
52 my $admin_url = "http://localhost:$jetty_server_port/solr/admin/cores";
53
54 $self->{'base-url'} = $base_url;
55 $self->{'admin-url'} = $admin_url;
56
57 return bless $self, $class;
58}
59
60
61
62sub _wget_service
63{
64 my $self = shift (@_);
65 my ($output_format,$url,$cgi_get_args) = @_;
66
67 my $full_url = $url;
68
69 $url .= "?$cgi_get_args" if (defined $cgi_get_args);
70
71 my $cmd = "wget -O - \"$url\" 2>&1";
72
73## print STDERR "**** wget cmd: $cmd\n";
74
75 my $preamble_output = "";
76 my $xml_output = "";
77 my $error_output = undef;
78
79 my $in_preamble = ($output_format eq "xml") ? 1 : 0;
80
81 if (open(WIN,"$cmd |")) {
82
83 my $line;
84 while (defined ($line=<WIN>)) {
85
86 if ($line =~ m/ERROR \d+:/) {
87 chomp $line;
88 $error_output = $line;
89 last;
90 }
91 elsif ($line =~ m/failed: Connection refused/) {
92 chomp $line;
93 $error_output = $line;
94 last;
95 }
96 elsif ($in_preamble) {
97 if ($line =~ m/<.*>/) {
98 $in_preamble = 0;
99 }
100 else {
101 $preamble_output .= $line;
102 }
103 }
104
105 if (! $in_preamble) {
106 $xml_output .= $line;
107 }
108 }
109 close(WIN);
110
111 }
112 else {
113 $error_output = "Error: failed to run $cmd\n";
114 $error_output .= " $!\n";
115 }
116
117 my $output = { 'preamble' => $preamble_output,
118 'output' => $xml_output,
119 'error' => $error_output };
120
121 return $output;
122}
123
124
125sub _base_service
126{
127 my $self = shift (@_);
128 my ($cgi_get_args) = @_;
129
130 my $base_url = $self->{'base-url'};
131
132 return $self->_wget_service("html",$base_url,$cgi_get_args);
133}
134
135sub _admin_service
136{
137 my $self = shift (@_);
138 my ($cgi_get_args) = @_;
139
140 my $admin_url = $self->{'admin-url'};
141
142 return $self->_wget_service("xml",$admin_url,$cgi_get_args);
143}
144
145
146sub server_running
147{
148 my $self = shift @_;
149
150 my $output = $self->_base_service();
151
152 my $have_error = defined $output->{'error'};
153
154 my $running = !$have_error;
155
156 return $running;
157}
158
159
160sub admin_ping_core
161{
162 my $self = shift @_;
163 my ($core) = @_;
164
165 my $cgi_get_args = "action=STATUS&core=$core";
166
167 my $ping_status = 1;
168
169 my $output = $self->_admin_service($cgi_get_args);
170
171 if (defined $output->{'error'}) {
172 # severe error, such as failing to connect to the server
173 $ping_status = 0;
174
175 my $url = $output->{'url'};
176 my $preamble = $output->{'preamble'};
177 my $error = $output->{'error'};
178
179 print STDERR "----\n";
180 print STDERR "Error: Failed to get XML response from:\n";
181 print STDERR " $url\n";
182 print STDERR "Output was:\n";
183 print STDERR $preamble if ($preamble ne "");
184 print STDERR "$error\n";
185 print STDERR "----\n";
186 }
187 else {
188
189 # If the collection doesn't exist yet, then there will be
190 # an empty element of the form:
191 # <lst name="collect-doc"/>
192 # where 'collect' is the actual name of the collection,
193 # such as demo
194
195 my $xml_output = $output->{'output'};
196
197 my $empty_element="<lst\\s+name=\"$core\"\\s*\\/>";
198
199 $ping_status = !($xml_output =~ m/$empty_element/s);
200 }
201
202
203 return $ping_status;
204}
205
206
207sub admin_reload_core
208{
209 my $self = shift @_;
210 my ($core) = @_;
211
212 my $cgi_get_args = "action=RELOAD&core=$core";
213
214 $self->_admin_service($cgi_get_args);
215}
216
217
218sub admin_create_core
219{
220 my $self = shift @_;
221 my ($core) = @_;
222
223 my ($ds_idx) = ($core =~ m/^.*-(.*)$/);
224
225 my $cgi_get_args = "action=CREATE&name=$core";
226
227 my $collect_home = $ENV{'GSDLCOLLECTDIR'};
228 my $etc_dirname = &util::filename_cat($collect_home,"etc");
229
230 my $build_dir = $self->{'build_dir'};
231 my $idx_dirname = &util::filename_cat($build_dir,$ds_idx);
232
233 $cgi_get_args .= "&instanceDir=$etc_dirname";
234 $cgi_get_args .= "&dataDir=$idx_dirname";
235
236 $self->_admin_service($cgi_get_args);
237}
238
239
240
241sub start
242{
243 my $self = shift @_;
244
245 my $solr_home = $ENV{'GEXT_SOLR'};
246 my $jetty_stop_port = $ENV{'JETTY_STOP_PORT'};
247 my $jetty_server_port = $ENV{'SOLR_JETTY_PORT'};
248
249 chdir($solr_home);
250
251 my $solr_etc = &util::filename_cat($solr_home,"etc");
252
253 my $server_props = "-DSTOP.PORT=$jetty_stop_port";
254 $server_props .= " -DSTOP.KEY=".$self->{'jetty_stop_key'};
255 $server_props .= " -Dsolr.solr.home=$solr_etc";
256
257 my $full_server_jar = $self->{'full_server_jar'};
258
259 my $server_java_cmd = "java $server_props -jar \"$full_server_jar\"";
260
261## print STDERR "**** server cmd start = $server_java_cmd\n";
262
263 my $server_status = "unknown";
264
265 my $server_already_running = $self->server_running();
266
267## print STDERR "**** already running = $server_already_running\n";
268
269 if ($server_already_running) {
270 $server_status = "already-running";
271 }
272 elsif (open(STARTIN,"$server_java_cmd 2>&1 |")) {
273
274 my $line;
275 while (defined($line=<STARTIN>)) {
276 # Scan through output until you see a line like:
277 # 2011-08-22 .. :INFO::Started SocketConnector@0.0.0.0:8983
278 # which signifies that the server has started up and is
279 # "ready and listening"
280
281## print STDERR "**** $line";
282
283 # skip annoying "not listening" message
284 next if ($line =~ m/WARN:\s*Not listening on monitor port/);
285
286 if (($line =~ m/^(WARN|ERROR|SEVERE):/)
287 || ($line =~ m/^[0-9 :-]*(WARN|ERROR|SEVERE)::/)) {
288 print "Jetty startup: $line";
289 }
290
291 if ($line =~ m/WARN::failed SocketConnector/) {
292 if ($line =~ m/Address already in use/) {
293 $server_status = "already-running";
294 }
295 else {
296 $server_status = "failed-to-start";
297 }
298 last;
299 }
300
301 if ($line =~ m/INFO::Started SocketConnector/) {
302 $server_status = "explicitly-started";
303 last;
304 }
305 }
306 }
307 else {
308 print STDERR "Error: failed to start solr-jetty-server\n";
309 print STDERR "$!\n";
310 print STDERR "Command attempted was:\n";
311 print STDERR " $server_java_cmd\n";
312 print STDERR "run from directory:\n";
313 print STDERR " $solr_home\n";
314 print STDERR "----\n";
315
316 exit -1;
317 }
318
319 if ($server_status eq "explicitly-started") {
320 $self->{'jetty_explicitly_started'} = 1;
321 print "Jetty server ready and listening for connections on port";
322 print " $jetty_server_port\n";
323
324 # now we know the server is ready to accept connections, fork a
325 # child process that continues to listen to the output and
326 # prints out any lines that are not INFO lines
327
328 if (fork()==0) {
329 # child process
330
331 my $line;
332 while (defined ($line = <STARTIN>)) {
333
334# if (($line =~ m/^(WARN|ERROR|SEVERE):/)
335# || ($line =~ m/^[0-9 :-]*(WARN|ERROR|SEVERE)::/)) {
336# print "Jetty $line";
337# }
338
339
340 # skip info lines
341 next if ($line =~ m/^INFO:/);
342 next if ($line =~ m/^[0-9 :-]*INFO::/);
343 next if ($line =~ m/^\d{2}\/\d{2}\/\d{4}\s+/);
344 next if ($line =~ m/^\d{4}-\d{2}-\d{2}\s+/);
345
346## next if ($line =~ m/^\s*\w+{.*}/);
347
348 # if here, then some non-trival message has been logged
349 print "Jetty/Solr processing: $line";
350 }
351 close(STARTIN);
352
353 # And now stop nicely
354 exit 0;
355 }
356 # otherwise let the parent continue on
357 }
358 elsif ($server_status eq "already-running") {
359 print STDERR "Using existing server detected on port $jetty_server_port\n";
360 $self->{'jetty_explicitly_started'} = 0;
361
362 # silently stop our unneeded jetty server, using its unique key
363
364# my $options = { 'do_wait' => 0, 'output_verbosity' => 2 };
365
366# $self->stop($options);
367
368 # Consume any remaining (buffered) output (not interested in values)
369# my $line;
370# while (defined ($line = <STARTIN>)) {
371 # skip info lines
372# }
373# close(STARTIN);
374 }
375 elsif ($server_status eq "failed-to-start") {
376 print STDERR "Started Solr/Jetty web server on port $jetty_server_port";
377 print STDERR ", but encountered an initialization error\n";
378 exit -1;
379 }
380
381}
382
383sub explicitly_started
384{
385 my $self = shift @_;
386
387 return $self->{'jetty_explicitly_started'};
388}
389
390
391
392sub stop
393{
394 my $self = shift @_;
395 my ($options) = @_;
396
397 my $solr_home = $ENV{'GEXT_SOLR'};
398
399 chdir($solr_home);
400
401 # defaults
402 my $do_wait = 1;
403 my $output_verbosity = 1;
404
405 if (defined $options) {
406 if (defined $options->{'do_wait'}) {
407 $do_wait = $options->{'do_wait'};
408 }
409 if (defined $options->{'output_verbosity'}) {
410 $output_verbosity = $options->{'output_verbosity'};
411 }
412 }
413
414 my $full_server_jar = $self->{'full_server_jar'};
415 my $jetty_stop_port = $ENV{'JETTY_STOP_PORT'};
416
417 my $server_props = "-DSTOP.PORT=$jetty_stop_port";
418 $server_props .= " -DSTOP.KEY=".$self->{'jetty_stop_key'};
419 my $server_java_cmd = "java $server_props -jar \"$full_server_jar\" --stop";
420
421## print STDERR "**** java server stop cmd:\n $server_java_cmd\n";
422
423 if (open(STOPIN,"$server_java_cmd 2>&1 |")) {
424
425 my $line;
426 while (defined($line=<STOPIN>)) {
427 print "Jetty shutdown: $line" if ($output_verbosity>1);
428 }
429 close(STOPIN);
430
431 if ($do_wait) {
432 wait(); # let the child process finish
433 }
434
435 if ($output_verbosity>0) {
436 print "Jetty server shutdown\n";
437 }
438 }
439 else {
440 print STDERR "Error: failed to stop solr-jetty-server\n";
441 print STDERR "$!\n";
442 print STDERR "Command attempted was:\n";
443 print STDERR " $server_java_cmd\n";
444 print STDERR "run from directory:\n";
445 print STDERR " $solr_home\n";
446 print STDERR "----\n";
447
448 exit -2;
449 }
450}
451
452
453
4541;
Note: See TracBrowser for help on using the repository browser.