root/gs3-extensions/solr/trunk/src/perllib/solrserver.pm @ 24643

Revision 24643, 10.1 KB (checked in by davidb, 8 years ago)

Adjustments to code as a result of testing

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
34sub new {
35    my $class = shift(@_);
36    my ($build_dir) = @_;
37
38    my $self = { 'jetty_stop_key' => "greenstone-solr" };
39
40    $self->{'build_dir'} = $build_dir;
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    my $preamble_output = "";   
74    my $xml_output = "";
75    my $error_output = undef;
76
77    my $in_preamble = ($output_format eq "xml") ? 1 : 0;
78   
79##    print STDERR "**** wgetcmd = \n $cmd\n";
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 = { 'url'      => $full_url,
118           'preamble' => $preamble_output,
119           'output'   => $xml_output,
120           'error'    => $error_output };
121
122    return $output;
123}
124
125
126sub _base_service
127{
128    my $self = shift (@_);
129    my ($cgi_get_args) = @_;
130
131    my $base_url = $self->{'base-url'};
132
133    return $self->_wget_service("html",$base_url,$cgi_get_args);
134}
135 
136sub _admin_service
137{
138    my $self = shift (@_);
139    my ($cgi_get_args) = @_;
140
141    my $admin_url = $self->{'admin-url'};
142
143    return $self->_wget_service("xml",$admin_url,$cgi_get_args);
144}
145
146
147sub server_running
148{
149    my $self = shift @_;
150
151    my $output = $self->_base_service();
152
153    my $have_error = defined $output->{'error'};
154
155    my $running = !$have_error;
156
157    return $running;
158}
159
160
161sub admin_ping_core
162{
163    my $self = shift @_;
164    my ($core) = @_;
165
166    my $cgi_get_args = "action=STATUS&core=$core";
167
168    my $ping_status = 1;
169
170    my $output = $self->_admin_service($cgi_get_args);
171
172    if (defined $output->{'error'}) {
173    # severe error, such as failing to connect to the server
174    $ping_status = 0;
175
176    my $url      = $output->{'url'};
177    my $preamble = $output->{'preamble'};
178    my $error    = $output->{'error'};
179   
180    print STDERR "----\n";
181    print STDERR "Error: Failed to get XML response from:\n";
182    print STDERR "         $url\n";
183    print STDERR "Output was:\n";
184    print STDERR $preamble if ($preamble ne "");
185    print STDERR "$error\n";
186    print STDERR "----\n";
187    }
188    else {
189   
190    # If the collection doesn't exist yet, then there will be
191    # an empty element of the form:
192    #   <lst name="collect-doc"/>
193    # where 'collect' is the actual name of the collection,
194    # such as demo
195
196    my $xml_output = $output->{'output'};
197   
198    my $empty_element="<lst\\s+name=\"$core\"\\s*\\/>";
199   
200    $ping_status = !($xml_output =~ m/$empty_element/s);
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,$removeold) = @_;
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_home";
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
262    my $server_status = "unknown";
263
264    if ($self->server_running()) {
265    $server_status = "already-running";
266    }
267    elsif (open(STARTIN,"$server_java_cmd 2>&1 |")) {
268
269##  print STDERR "**** startup up server with cmd start =\n $server_java_cmd\n";
270
271    my $line;
272    while (defined($line=<STARTIN>)) {
273        # Scan through output until you see a line like:
274        #   2011-08-22 .. :INFO::Started SocketConnector@0.0.0.0:8983
275        # which signifies that the server has started up and is
276        # "ready and listening"
277   
278        if (($line =~ m/^(WARN|ERROR|SEVERE):/)
279        || ($line =~ m/^[0-9 :-]*(WARN|ERROR|SEVERE)::/)) {
280        print "Jetty startup: $line";
281        }
282       
283        if ($line =~ m/WARN::failed SocketConnector/) {
284        if ($line =~ m/Address already in use/) {
285            $server_status = "already-running";
286        }
287        else {
288            $server_status = "failed-to-start";
289        }
290        last;
291        }
292       
293        if ($line =~ m/INFO::Started SocketConnector/) {
294        $server_status = "explicitly-started";
295        last;
296        }
297    }
298    }
299    else {
300    print STDERR "Error: failed to start solr-jetty-server\n";
301    print STDERR "$!\n";
302    print STDERR "Command attempted was:\n";
303    print STDERR "  $server_java_cmd\n";
304    print STDERR "run from directory:\n";
305    print STDERR "  $solr_home\n";
306    print STDERR "----\n";
307
308    exit -1;
309    }
310
311    if ($server_status eq "explicitly-started") {
312    $self->{'jetty_explicitly_started'} = 1;
313    print "Jetty server ready and listening for connections on port";
314    print " $jetty_server_port\n";
315       
316    # now we know the server is ready to accept connections, fork a
317    # child process that continues to listen to the output and
318    # prints out any lines that are not INFO lines
319
320    if (fork()==0) {
321        # child process
322
323        my $line;
324        while (defined ($line = <STARTIN>)) {
325
326#       if (($line =~ m/^(WARN|ERROR|SEVERE):/)
327#           || ($line =~ m/^[0-9 :-]*(WARN|ERROR|SEVERE)::/)) {
328#           print "Jetty $line";
329#       }
330
331        # skip info lines
332        next if ($line =~ m/^INFO:/);
333        next if ($line =~ m/^[0-9 :-]*INFO::/);
334        next if ($line =~ m/^\d{2}\/\d{2}\/\d{4}\s+/);
335        next if ($line =~ m/^\d{4}-\d{2}-\d{2}\s+/);
336
337##      next if ($line =~ m/^\s*\w+{.*}/);
338
339        # if here, then some non-trival message has been logged
340        print "Jetty/Solr processing: $line";
341        }
342        close(STARTIN);
343       
344        # And now stop nicely
345        exit 0;
346    }
347    # otherwise let the parent continue on
348    }
349    elsif ($server_status eq "already-running") {
350    print STDERR "Using existing server detected on port $jetty_server_port\n";
351    $self->{'jetty_explicitly_started'} = 0;
352    }
353    elsif ($server_status eq "failed-to-start") {
354    print STDERR "Started Solr/Jetty web server on port $jetty_server_port";
355    print STDERR ", but encountered an initialization error\n";
356    exit -1;
357    }
358
359}
360
361sub explicitly_started
362{
363    my $self = shift @_;
364
365    return $self->{'jetty_explicitly_started'};
366}
367
368sub stop
369{   
370    my $self = shift @_;
371    my ($options) = @_;
372
373    my $solr_home         = $ENV{'GEXT_SOLR'};
374
375    chdir($solr_home);
376
377    # defaults
378    my $do_wait = 1;
379    my $output_verbosity = 1;
380
381    if (defined $options) {
382    if (defined $options->{'do_wait'}) {
383        $do_wait = $options->{'do_wait'};
384    }
385    if (defined $options->{'output_verbosity'}) {
386        $output_verbosity = $options->{'output_verbosity'};
387    }
388    }
389
390    my $full_server_jar = $self->{'full_server_jar'};
391    my $jetty_stop_port = $ENV{'JETTY_STOP_PORT'};
392   
393    my $server_props = "-DSTOP.PORT=$jetty_stop_port";
394    $server_props   .= " -DSTOP.KEY=".$self->{'jetty_stop_key'};
395    my $server_java_cmd = "java $server_props -jar \"$full_server_jar\" --stop";
396
397##    print STDERR "**** java server stop cmd:\n  $server_java_cmd\n";
398
399    if (open(STOPIN,"$server_java_cmd 2>&1 |")) {
400
401    my $line;
402    while (defined($line=<STOPIN>)) {
403        print "Jetty shutdown: $line" if ($output_verbosity>1);
404    }
405    close(STOPIN);
406
407    if ($do_wait) {
408        wait(); # let the child process finish
409    }
410
411    if ($output_verbosity>0) {
412        print "Jetty server shutdown\n";
413    }
414    }
415    else {
416    print STDERR "Error: failed to stop solr-jetty-server\n";
417    print STDERR "$!\n";
418    print STDERR "Command attempted was:\n";
419    print STDERR "  $server_java_cmd\n";
420    print STDERR "run from directory:\n";
421    print STDERR "  $solr_home\n";
422    print STDERR "----\n";
423
424    exit -2;
425    }
426}
427
428
429
4301;
Note: See TracBrowser for help on using the browser.