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

Revision 29157, 14.7 KB (checked in by ak19, 5 years ago)

Fixed the command to run solr's jetty server on Windows

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
60sub set_jetty_stop_key {
61    my $self = shift (@_);
62    my ($stop_key) = @_;
63
64    $self->{'jetty_stop_key'} = $stop_key if defined $stop_key;
65}
66
67sub _wget_service
68{
69    my $self = shift (@_);
70    my ($output_format,$url,$cgi_get_args) = @_;
71
72    my $full_url = $url;
73
74    $url .= "?$cgi_get_args" if (defined $cgi_get_args);
75   
76    my $cmd = "wget -O - \"$url\" 2>&1";
77
78    my $preamble_output = "";   
79    my $xml_output = "";
80    my $error_output = undef;
81
82    my $in_preamble = ($output_format eq "xml") ? 1 : 0;
83   
84##    print STDERR "**** wgetcmd = \n $cmd\n";
85
86    if (open(WIN,"$cmd |")) {
87
88    my $line;
89    while (defined ($line=<WIN>)) {
90
91        if ($line =~ m/ERROR \d+:/) {
92        chomp $line;
93        $error_output = $line;
94        last;
95        }
96        elsif ($line =~ m/failed: Connection refused/) {
97        chomp $line;
98        $error_output = $line;
99        last;
100        }
101        elsif ($in_preamble) {
102        if ($line =~ m/<.*>/) {
103            $in_preamble = 0;
104        }
105        else {
106            $preamble_output .= $line;
107        }
108        }
109
110        if (! $in_preamble) {
111        $xml_output .= $line;
112        }
113    }
114    close(WIN);
115
116    }
117    else {
118    $error_output = "Error: failed to run $cmd\n";
119    $error_output .= "  $!\n";
120    }
121
122    my $output = { 'url'      => $full_url,
123           'preamble' => $preamble_output,
124           'output'   => $xml_output,
125           'error'    => $error_output };
126
127    return $output;
128}
129
130
131sub _base_service
132{
133    my $self = shift (@_);
134    my ($cgi_get_args) = @_;
135
136    my $base_url = $self->{'base-url'};
137
138    return $self->_wget_service("html",$base_url,$cgi_get_args);
139}
140 
141sub _admin_service
142{
143    my $self = shift (@_);
144    my ($cgi_get_args) = @_;
145
146    my $admin_url = $self->{'admin-url'};
147
148    return $self->_wget_service("xml",$admin_url,$cgi_get_args);
149}
150
151
152sub server_running
153{
154    my $self = shift @_;
155
156    my $output = $self->_base_service();
157
158    my $have_error = defined $output->{'error'};
159
160    my $running = ($have_error) ? 0 : 1;
161
162    return $running;
163}
164
165
166sub admin_ping_core
167{
168    my $self = shift @_;
169    my ($core) = @_;
170
171    my $cgi_get_args = "action=STATUS&core=$core";
172
173    my $ping_status = 1;
174
175    my $output = $self->_admin_service($cgi_get_args);
176
177    if (defined $output->{'error'}) {
178    # severe error, such as failing to connect to the server
179    $ping_status = 0;
180
181    my $url      = $output->{'url'};
182    my $preamble = $output->{'preamble'};
183    my $error    = $output->{'error'};
184   
185    print STDERR "----\n";
186    print STDERR "Error: Failed to get XML response from:\n";
187    print STDERR "         $url\n";
188    print STDERR "Output was:\n";
189    print STDERR $preamble if ($preamble ne "");
190    print STDERR "$error\n";
191    print STDERR "----\n";
192    }
193    else {
194   
195    # If the collection doesn't exist yet, then there will be
196    # an empty element of the form:
197    #   <lst name="collect-doc"/>
198    # where 'collect' is the actual name of the collection,
199    # such as demo
200
201    my $xml_output = $output->{'output'};
202   
203    my $empty_element="<lst\\s+name=\"$core\"\\s*\\/>";
204   
205    $ping_status = !($xml_output =~ m/$empty_element/s);
206    }
207
208    return $ping_status;
209}
210
211sub filtered_copy
212{
213    my $self = shift @_;
214
215    my $src_file = shift @_;
216    my $dst_file = shift @_;
217    my $re_substitutions = shift @_;
218
219    # $re_substitutions is a hashmap of the form: [re_key] => subst_str
220   
221    my $content = "";
222
223    if (open(FIN,'<:utf8',$src_file)) {
224
225    my $line;
226    while (defined($line=<FIN>)) {
227        $content .= $line;
228    }
229    }
230
231    close(FIN);
232
233    # perform RE string substitutions
234    foreach my $re_key (keys %$re_substitutions) {
235
236    my $subst_str = $re_substitutions->{$re_key};
237
238    # Perform substitution of the form:
239    #  $content =~ s/$re_key/$subst_str/g;
240    # but allow allow separator char (default '/')
241    # and flags (default 'g') to be parameterized
242
243    $content =~ s/$re_key/$subst_str/g;
244    }
245   
246    if (open(FOUT, '>:utf8', $dst_file)) {
247    print FOUT $content;
248    close(FOUT);
249    }
250    else {
251    print STDERR "Error: Failed to open file '$dst_file' for writing.\n$!\n";
252    }   
253}
254
255sub solr_xml_to_solr_xml_in
256{
257    my $self = shift @_;
258    my ($solr_xml_dir) = @_;
259   
260    my $gsdl3home = $ENV{'GSDL3HOME'};
261   
262    if (!defined $solr_xml_dir || !-d $solr_xml_dir) {
263    # if not passed in, use stored solr_live_home
264    $solr_xml_dir = $self->{'solr_live_home'};
265    }
266    my $solrxml_in = &util::filename_cat($solr_xml_dir, "solr.xml.in");
267    my $solrxml = &util::filename_cat($solr_xml_dir, "solr.xml");
268
269    my $gsdl3home_re = &util::filename_to_regex($gsdl3home);
270
271    my $replacement_map = { qr/$gsdl3home_re/ => "\@gsdl3home\@" };
272
273    $self->filtered_copy($solrxml,$solrxml_in,$replacement_map);
274}
275
276
277sub solr_xml_in_to_solr_xml
278{
279    my $self = shift @_;
280    my ($solr_xml_dir) = @_;
281
282    my $gsdl3home = $ENV{'GSDL3HOME'};
283    if (!defined $solr_xml_dir || !-d $solr_xml_dir) {
284    # if not passed in, use stored solr home
285    $solr_xml_dir = $self->{'solr_live_home'};
286    }
287    my $solrxml_in = &util::filename_cat($solr_xml_dir, "solr.xml.in");
288    my $solrxml = &util::filename_cat($solr_xml_dir, "solr.xml");
289   
290    my $gsdl3home_re = &util::filename_to_regex($gsdl3home);
291
292    my $replacement_map = { qr/\@gsdl3home\@/ => $gsdl3home_re };
293
294    $self->filtered_copy($solrxml_in,$solrxml,$replacement_map);
295}
296
297
298# Some of the Solr CoreAdmin API calls available.
299# See http://wiki.apache.org/solr/CoreAdmin
300sub admin_reload_core
301{
302    my $self = shift @_;
303    my ($core) = @_;
304
305    my $cgi_get_args = "action=RELOAD&core=$core";
306
307    $self->_admin_service($cgi_get_args);
308
309}
310
311sub admin_rename_core
312{
313    my $self = shift @_;
314    my ($oldcore, $newcore) = @_;
315
316    my $cgi_get_args = "action=RENAME&core=$oldcore&other=$newcore";
317
318    $self->_admin_service($cgi_get_args);
319
320}
321
322sub admin_swap_core
323{
324    my $self = shift @_;
325    my ($oldcore, $newcore) = @_;
326
327    my $cgi_get_args = "action=SWAP&core=$oldcore&other=$newcore";
328
329    $self->_admin_service($cgi_get_args);
330
331}
332
333# The ALIAS action is not supported in our version of solr (despite it
334# being marked as experimental in the documentation for Core Admin)
335sub admin_alias_core
336{
337    my $self = shift @_;
338    my ($oldcore, $newcore) = @_;
339
340    my $cgi_get_args = "action=ALIAS&core=$oldcore&other=$newcore";
341
342    $self->_admin_service($cgi_get_args);
343
344}
345
346sub admin_create_core
347{
348    my $self = shift @_;
349    my ($core, $data_parent_dir) = @_; # data_parent_dir is optional, can be index_dir. Defaults to builddir if not provided
350
351    my ($ds_idx) = ($core =~ m/^.*-(.*?)$/);
352
353    my $cgi_get_args = "action=CREATE&name=$core";
354
355    my $collect_home = $ENV{'GSDLCOLLECTDIR'};
356    my $etc_dirname = &util::filename_cat($collect_home,"etc");
357
358    if(!defined $data_parent_dir) {
359    $data_parent_dir = $self->{'build_dir'};
360    }
361   
362    my $idx_dirname = &util::filename_cat($data_parent_dir,$ds_idx); # "dataDir" 
363       
364    $cgi_get_args .= "&instanceDir=$etc_dirname";
365    $cgi_get_args .= "&dataDir=$idx_dirname";
366
367    $self->_admin_service($cgi_get_args);
368
369}
370
371# removes (unloads) core from the ext/solr/sorl.xml config file
372sub admin_unload_core
373{
374    my $self = shift @_;
375    my ($core, $delete) = @_;
376
377    my $cgi_get_args = "action=UNLOAD&core=$core"; # &deleteIndex=true from Solr3.3
378    if(defined $delete && $delete == 1) {
379    $cgi_get_args = $cgi_get_args."&deleteIndex=true";
380    }
381
382    $self->_admin_service($cgi_get_args);
383
384}
385
386sub start
387{
388    my $self = shift @_;
389    my ($verbosity) = @_;
390   
391    $verbosity = 1 unless defined $verbosity;
392
393    my $solr_home         = $ENV{'GEXT_SOLR'};
394    my $solr_live_home    = &util::filename_cat($ENV{'GSDL3HOME'}, "ext", "solr");
395    my $jetty_stop_port   = $ENV{'JETTY_STOP_PORT'};
396    my $jetty_server_port = $ENV{'SOLR_JETTY_PORT'};
397
398    chdir($solr_home);
399    #$self->{'solr_home'} = $solr_home;
400    $self->{'solr_live_home'} = $solr_live_home;
401##    my $solr_etc = &util::filename_cat($solr_home,"etc");
402
403    my $server_props = "-DSTOP.PORT=$jetty_stop_port";
404    $server_props .= " -DSTOP.KEY=".$self->{'jetty_stop_key'};
405    #$server_props .= " -Dsolr.solr.home=$solr_home";
406$server_props .= " -Dsolr.solr.home=$solr_live_home";
407    my $full_server_jar = $self->{'full_server_jar'};
408   
409    # https://wiki.apache.org/solr/SolrLogging
410    my $solr_slf4j    = &util::filename_cat($solr_home, "lib", "ext", "*");
411    my $solr_lib_java    = &util::filename_cat($solr_home, "lib", "java", "*");
412    my $solr_jar_dep = &util::pathname_cat($solr_lib_java, $solr_slf4j);
413   
414    my $solr_log4j    = &util::filename_cat($solr_home, "conf", "log4j.properties");   
415   
416    #my $server_java_cmd = "java -Dlog4j.configuration=file://$solr_log4j -classpath \"$solr_home/lib/java/*:$solr_slf4j/*\" $server_props -jar \"$full_server_jar\""; 
417    my $prefix = (defined $ENV{'GSDLOS'} && (($ENV{'GSDLOS'} =~ m/windows/) && ($^O ne "cygwin"))) ? "file:/" : "file://";
418    my $server_java_cmd = "java -Dlog4j.configuration=$prefix$solr_log4j -classpath \"$solr_jar_dep\" $server_props -jar \"$full_server_jar\"";
419
420
421    my $server_status = "unknown";
422
423    if ($self->server_running()) {
424    $server_status = "already-running";
425    }
426    elsif (open(STARTIN,"$server_java_cmd 2>&1 |")) {
427
428    print STDERR "**** starting up solr jetty server with cmd start =\n $server_java_cmd\n" if ($verbosity > 1);
429
430    my $line;
431    while (defined($line=<STARTIN>)) {
432        # Scan through output until you see a line like:
433        #   2011-08-22 .. :INFO::Started SocketConnector@0.0.0.0:8983
434        # which signifies that the server has started up and is
435        # "ready and listening"
436   
437        if (($line =~ m/^(WARN|ERROR|SEVERE):/)
438        || ($line =~ m/^[0-9 :-]*(WARN|ERROR|SEVERE)::/)) {
439        print "Jetty startup: $line";
440        }
441       
442        if ($line =~ m/WARN.*failed SocketConnector/) {
443        if ($line =~ m/Address already in use/) {
444            $server_status = "already-running";
445        }
446        else {
447            $server_status = "failed-to-start";
448        }
449        last;
450        }
451       
452        if ($line =~ m/INFO.*Started SocketConnector/) {
453        $server_status = "explicitly-started";
454        last;
455        }
456    }
457    }
458    else {
459    print STDERR "Error: failed to start solr-jetty-server\n";
460    print STDERR "$!\n";
461    print STDERR "Command attempted was:\n";
462    print STDERR "  $server_java_cmd\n";
463    print STDERR "run from directory:\n";
464    print STDERR "  $solr_home\n";
465    print STDERR "----\n";
466
467    exit -1;
468    }
469
470    if ($server_status eq "explicitly-started") {
471    $self->{'jetty_explicitly_started'} = 1;
472    print "Jetty server ready and listening for connections on port";
473    print " $jetty_server_port\n";
474       
475    # now we know the server is ready to accept connections, fork a
476    # child process that continues to listen to the output and
477    # prints out any lines that are not INFO lines
478
479    if (fork()==0) {
480        # child process
481
482        my $line;
483        while (defined ($line = <STARTIN>)) {
484
485#       if (($line =~ m/^(WARN|ERROR|SEVERE):/)
486#           || ($line =~ m/^[0-9 :-]*(WARN|ERROR|SEVERE)::/)) {
487#           print "Jetty $line";
488#       }
489
490        # skip info lines
491        next if ($line =~ m/^INFO:/);
492        next if ($line =~ m/^[0-9 :-]*INFO::/);
493        next if ($line =~ m/^\d{2}\/\d{2}\/\d{4}\s+/);
494        next if ($line =~ m/^\d{4}-\d{2}-\d{2}\s+/);
495
496##      next if ($line =~ m/^\s*\w+{.*}/);
497
498        # if here, then some non-trival message has been logged
499        print "Jetty/Solr processing: $line";
500        }
501        close(STARTIN);
502       
503        # And now stop nicely
504        exit 0;
505    }
506    # otherwise let the parent continue on
507    }
508    elsif ($server_status eq "already-running") {
509    print STDERR "Using existing server detected on port $jetty_server_port\n";
510    $self->{'jetty_explicitly_started'} = 0;
511    }
512    elsif ($server_status eq "failed-to-start") {
513    print STDERR "Started Solr/Jetty web server on port $jetty_server_port";
514    print STDERR ", but encountered an initialization error\n";
515    exit -1;
516    }
517
518}
519
520sub explicitly_started
521{
522    my $self = shift @_;
523
524    return $self->{'jetty_explicitly_started'};
525}
526
527sub stop
528{   
529    my $self = shift @_;
530    my ($options) = @_;
531
532    my $solr_home         = $ENV{'GEXT_SOLR'};
533
534    chdir($solr_home);
535
536    # defaults
537    my $do_wait = 1;
538    my $output_verbosity = 1;
539
540    if (defined $options) {
541    if (defined $options->{'do_wait'}) {
542        $do_wait = $options->{'do_wait'};
543    }
544    if (defined $options->{'output_verbosity'}) {
545        $output_verbosity = $options->{'output_verbosity'};
546    }
547    }
548
549    my $full_server_jar = $self->{'full_server_jar'};
550    my $jetty_stop_port = $ENV{'JETTY_STOP_PORT'};
551   
552    my $server_props = "-DSTOP.PORT=$jetty_stop_port";
553    $server_props   .= " -DSTOP.KEY=".$self->{'jetty_stop_key'};
554    my $server_java_cmd = "java $server_props -jar \"$full_server_jar\" --stop";
555
556    print STDERR "**** java server stop cmd:\n  $server_java_cmd\n" if ($output_verbosity>1);
557
558    if (open(STOPIN,"$server_java_cmd 2>&1 |")) {
559
560    my $line;
561    while (defined($line=<STOPIN>)) {
562        print "Jetty shutdown: $line" if ($output_verbosity>1);
563    }
564    close(STOPIN);
565
566    if ($do_wait) {
567        wait(); # let the child process finish
568    }
569
570    if ($output_verbosity>0) {
571        print "Jetty server shutdown\n";
572    }
573    }
574    else {
575    print STDERR "Error: failed to stop solr-jetty-server\n";
576    print STDERR "$!\n";
577    print STDERR "Command attempted was:\n";
578    print STDERR "  $server_java_cmd\n";
579    print STDERR "run from directory:\n";
580    print STDERR "  $solr_home\n";
581    print STDERR "----\n";
582
583    exit -2;
584    }
585}
586
587
588
5891;
Note: See TracBrowser for help on using the browser.