1 package OpenSRF::System;
2 use strict; use warnings;
5 use OpenSRF::Utils::Logger qw(:level);
6 use OpenSRF::Transport::Listener;
7 use OpenSRF::Transport;
8 use OpenSRF::UnixServer;
10 use OpenSRF::Utils::LogServer;
12 use OpenSRF::EX qw/:try/;
13 use POSIX ":sys_wait_h";
14 use OpenSRF::Utils::Config;
15 use OpenSRF::Utils::SettingsParser;
16 use OpenSRF::Utils::SettingsClient;
17 use OpenSRF::Application;
18 use Net::Server::PreFork;
21 my $bootstrap_config_file;
23 my( $self, $config ) = @_;
24 $bootstrap_config_file = $config;
27 =head2 Name/Description
31 To start the system: OpenSRF::System->bootstrap();
33 Simple system process management and automation. After instantiating the class, simply call
34 bootstrap() to launch the system. Each launched process is stored as a process-id/method-name
35 pair in a local hash. When we receive a SIG{CHILD}, we loop through this hash and relaunch
36 any child processes that may have terminated.
38 Currently automated processes include launching the internal Unix Servers, launching the inbound
39 connections for each application, and starting the system shell.
42 Note: There should be only one instance of this class
43 alive at any given time. It is designed as a globel process handler and, hence, will cause much
44 oddness if you call the bootstrap() method twice or attempt to create two of these by trickery.
45 There is a single instance of the class created on the first call to new(). This same instance is
46 returned on subsequent calls to new().
54 # ----------------------------------------------
56 $SIG{INT} = sub { instance()->killall(); };
58 $SIG{HUP} = sub{ instance()->hupall(); };
60 #$SIG{CHLD} = \&process_automation;
65 # put $instance in a closure and return it for requests to new()
66 # since there should only be one System instance running
69 sub instance { return __PACKAGE__->new(); }
74 $class = ref( $class ) || $class;
76 $self->{'pid_hash'} = {};
77 bless( $self, $class );
84 # ----------------------------------------------
85 # Commands to execute at system launch
89 return "OpenSRF::UnixServer->new( '$app')->serve()";
94 return "OpenSRF::Transport::Listener->new( '$app' )->initialize()->listen()";
98 # ----------------------------------------------
101 sub load_bootstrap_config {
103 if(OpenSRF::Utils::Config->current) {
107 if(!$bootstrap_config_file) {
108 die "Please provide a bootstrap config file to OpenSRF::System!\n" .
109 "use OpenSRF::System qw(/path/to/bootstrap_config);";
112 OpenSRF::Utils::Config->load( config_file => $bootstrap_config_file );
114 JSON->register_class_hint( name => "OpenSRF::Application", hint => "method", type => "hash" );
116 OpenSRF::Transport->message_envelope( "OpenSRF::Transport::SlimJabber::MessageWrapper" );
117 OpenSRF::Transport::PeerHandle->set_peer_client( "OpenSRF::Transport::SlimJabber::PeerConnection" );
118 OpenSRF::Transport::Listener->set_listener( "OpenSRF::Transport::SlimJabber::Inbound" );
119 OpenSRF::Application->server_class('client');
124 my $self = __PACKAGE__->instance();
125 load_bootstrap_config();
126 OpenSRF::Utils::Logger::set_config();
127 my $bsconfig = OpenSRF::Utils::Config->current;
129 # Start a process group and make me the captain
131 $0 = "OpenSRF System";
133 # -----------------------------------------------
134 # Launch the settings sever if necessary...
135 my $are_settings_server = 0;
136 if( (my $cfile = $bsconfig->bootstrap->settings_config) ) {
137 my $parser = OpenSRF::Utils::SettingsParser->new();
139 # since we're (probably) the settings server, we can go ahead and load the real config file
140 $parser->initialize( $cfile );
141 $OpenSRF::Utils::SettingsClient::host_config =
142 $parser->get_server_config($bsconfig->env->hostname);
144 my $client = OpenSRF::Utils::SettingsClient->new();
145 my $apps = $client->config_value("activeapps", "appname");
146 if(ref($apps) ne "ARRAY") { $apps = [$apps]; }
148 if(!defined($apps) || @$apps == 0) {
149 print "No apps to load, exiting...";
153 for my $app (@$apps) {
154 # verify we are a settings server and launch
155 if( $app eq "opensrf.settings" and
156 $client->config_value("apps","opensrf.settings", "language") =~ /perl/i ) {
158 $are_settings_server = 1;
159 $self->launch_settings();
161 $self->launch_settings_listener();
167 # Launch everything else
168 OpenSRF::System->bootstrap_client(client_name => "system_client");
169 my $client = OpenSRF::Utils::SettingsClient->new();
170 my $apps = $client->config_value("activeapps", "appname" );
171 if(!ref($apps)) { $apps = [$apps]; }
173 if(!defined($apps) || @$apps == 0) {
174 print "No apps to load, exiting...";
178 my $server_type = $client->config_value("server_type");
179 $server_type ||= "basic";
181 my $con = OpenSRF::Transport::PeerHandle->retrieve;
188 if( $server_type eq "prefork" ) {
189 $server_type = "Net::Server::PreFork";
191 $server_type = "Net::Server::Single";
194 _log( " * Server type: $server_type", INTERNAL );
199 throw OpenSRF::EX::PANIC ("Cannot set $server_type: $@" );
202 push @OpenSRF::UnixServer::ISA, $server_type;
204 _log( " * System boostrap" );
206 # --- Boot the Unix servers
207 $self->launch_unix($apps);
213 # --- Boot the listeners
214 $self->launch_listener($apps);
218 _log( " * System is ready..." );
221 # my $ps = `ps ax | grep " Open" | grep -v grep | sort -r -k5`;
222 # print "\n --- PS --- \n$ps --- PS ---\n\n";
224 while( 1 ) { sleep; }
230 # ----------------------------------------------
231 # Bootstraps a single client connection.
233 # named params are 'config_file' and 'client_name'
235 sub bootstrap_client {
238 my $con = OpenSRF::Transport::PeerHandle->retrieve;
240 if($con and $con->tcp_connected) {
246 $bootstrap_config_file =
247 $params{config_file} || $bootstrap_config_file;
249 my $app = $params{client_name} || "client";
252 load_bootstrap_config();
253 OpenSRF::Utils::Logger::set_config();
254 OpenSRF::Transport::PeerHandle->construct( $app );
259 if (my $con = OpenSRF::Transport::PeerHandle->retrieve) {
260 return 1 if ($con->tcp_connected);
265 sub bootstrap_logger {
267 OpenSRF::Utils::LogServer->serve();
271 # ----------------------------------------------
272 # Cycle through the known processes, reap the dead child
273 # and put a new child in its place. (MMWWAHAHHAHAAAA!)
275 sub process_automation {
277 my $self = __PACKAGE__->instance();
279 foreach my $pid ( keys %{$self->pid_hash} ) {
281 if( waitpid( $pid, WNOHANG ) == $pid ) {
283 my $method = $self->pid_hash->{$pid};
284 delete $self->pid_hash->{$pid};
286 my $newpid = OpenSRF::Utils::safe_fork();
288 OpenSRF::Utils::Logger->debug( "Relaunching $method", ERROR );
289 _log( "Relaunching => $method" );
292 $self->pid_hash( $newpid, $method );
294 else { eval $method; exit; }
298 $SIG{CHLD} = \&process_automation;
303 sub launch_settings {
305 # XXX the $self like this and pid automation will not work with this setup....
307 @OpenSRF::UnixServer::ISA = qw(OpenSRF Net::Server::PreFork);
309 my $pid = OpenSRF::Utils::safe_fork();
311 $self->pid_hash( $pid , "launch_settings()" );
314 my $apname = "opensrf.settings";
315 #$0 = "OpenSRF App [$apname]";
316 eval _unixserver( $apname );
317 if($@) { die "$@\n"; }
321 @OpenSRF::UnixServer::ISA = qw(OpenSRF);
326 sub launch_settings_listener {
329 my $app = "opensrf.settings";
330 my $pid = OpenSRF::Utils::safe_fork();
332 $self->pid_hash( $pid , _listener( $app ) );
336 $0 = "OpenSRF listener [$apname]";
337 eval _listener( $app );
343 # ----------------------------------------------
344 # Launch the Unix Servers
347 my( $self, $apps ) = @_;
349 my $client = OpenSRF::Utils::SettingsClient->new();
351 foreach my $app ( @$apps ) {
354 my $lang = $client->config_value( "apps", $app, "language");
355 next unless $lang =~ /perl/i;
356 next if $app eq "opensrf.settings";
358 _log( " * Starting UnixServer for $app..." );
360 my $pid = OpenSRF::Utils::safe_fork();
362 $self->pid_hash( $pid , _unixserver( $app ) );
366 $0 = "OpenSRF App ($apname)";
367 eval _unixserver( $app );
373 # ----------------------------------------------
374 # Launch the inbound clients
376 sub launch_listener {
378 my( $self, $apps ) = @_;
379 my $client = OpenSRF::Utils::SettingsClient->new();
381 foreach my $app ( @$apps ) {
384 my $lang = $client->config_value( "apps", $app, "language");
385 next unless $lang =~ /perl/i;
386 next if $app eq "opensrf.settings";
388 _log( " * Starting Listener for $app..." );
390 my $pid = OpenSRF::Utils::safe_fork();
392 $self->pid_hash( $pid , _listener( $app ) );
396 $0 = "OpenSRF listener [$apname]";
397 eval _listener( $app );
403 # ----------------------------------------------
410 my $pid = OpenSRF::Utils::safe_fork();
412 if( $pid ) { $self->pid_hash( $pid , _shell() ); }
415 for( my $x = 0; $x != 10; $x++ ) {
425 # ----------------------------------------------
428 my( $self, $pid, $method ) = @_;
429 $self->{'pid_hash'}->{$pid} = $method
430 if( $pid and $method );
431 return $self->{'pid_hash'};
434 # ----------------------------------------------
435 # If requested, the System can shut down.
439 $SIG{CHLD} = 'IGNORE';
440 $SIG{INT} = 'IGNORE';
441 kill( 'INT', -$$ ); #kill all in process group
446 # ----------------------------------------------
450 _log( "HUPping brood" );
451 $SIG{CHLD} = 'IGNORE';
452 $SIG{HUP} = 'IGNORE';
453 set_config(); # reload config
455 # $SIG{CHLD} = \&process_automation;
456 $SIG{HUP} = sub{ instance()->hupall(); };
460 # ----------------------------------------------
461 # Log to debug, and stdout
465 OpenSRF::Utils::Logger->debug( $string, INFO );
466 print $string . "\n";
469 # ----------------------------------------------
472 select( undef, undef, undef, 0.3 );