src/perlmods/OpenSRF/System.pm

   1 package OpenSRF::System;
   2 use strict; use warnings;
   3 use base 'OpenSRF';
   4 use OpenSRF::Utils::Logger qw(:level);
   5 use OpenSRF::Transport::Listener;
   6 use OpenSRF::Transport;
   7 use OpenSRF::UnixServer;
   8 use OpenSRF::Utils;
   9 use OpenSRF::Utils::LogServer;
  10 use OpenSRF::DOM;
  11 use OpenSRF::EX qw/:try/;
  12 use POSIX ":sys_wait_h";
  13 use OpenSRF::Utils::Config;
  14 use OpenSRF::Utils::SettingsParser;
  15 use OpenSRF::Utils::SettingsClient;
  16 use Net::Server::PreFork;
  17 use strict;
  18
  19 my $bootstrap_config_file;
  20 sub import {
  21         my( $self, $config ) = @_;
  22         $bootstrap_config_file = $config;
  23 }
  24
  25 =head2 Name/Description
  26
  27 OpenSRF::System
  28
  29 To start the system: OpenSRF::System->bootstrap();
  30
  31 Simple system process management and automation.  After instantiating the class, simply call
  32 bootstrap() to launch the system.  Each launched process is stored as a process-id/method-name
  33 pair in a local hash.  When we receive a SIG{CHILD}, we loop through this hash and relaunch
  34 any child processes that may have terminated.
  35
  36 Currently automated processes include launching the internal Unix Servers, launching the inbound
  37 connections for each application, and starting the system shell.
  38
  39
  40 Note: There should be only one instance of this class
  41 alive at any given time.  It is designed as a globel process handler and, hence, will cause much
  42 oddness if you call the bootstrap() method twice or attempt to create two of these by trickery.
  43 There is a single instance of the class created on the first call to new().  This same instance is
  44 returned on subsequent calls to new().
  45
  46 =cut
  47
  48 $| = 1;
  49
  50 sub DESTROY {}
  51
  52 # ----------------------------------------------
  53
  54 $SIG{INT} = sub { instance()->killall(); };
  55
  56 $SIG{HUP} = sub{ instance()->hupall(); };
  57
  58 #$SIG{CHLD} = \&process_automation;
  59
  60
  61 {
  62         # ---
  63         # put $instance in a closure and return it for requests to new()
  64         # since there should only be one System instance running
  65         # -----
  66         my $instance;
  67         sub instance { return __PACKAGE__->new(); }
  68         sub new {
  69                 my( $class ) = @_;
  70
  71                 if( ! $instance ) {
  72                         $class = ref( $class ) || $class;
  73                         my $self = {};
  74                         $self->{'pid_hash'} = {};
  75                         bless( $self, $class );
  76                         $instance = $self;
  77                 }
  78                 return $instance;
  79         }
  80 }
  81
  82 # ----------------------------------------------
  83 # Commands to execute at system launch
  84
  85 sub _unixserver {
  86         my( $app ) = @_;
  87         return "OpenSRF::UnixServer->new( '$app')->serve()";
  88 }
  89
  90 sub _listener {
  91         my( $app ) = @_;
  92
  93 =head
  94         my $service = $app;
  95         my $username = $app;
  96         my $password = "jkjkasdf";
  97         my $jserver = "elroy";
  98         my $port = "5222";
  99         my $hostname = "elroy.pls-hq.org";
 100         my $unix_file = "/pines/var/sock/$app" . "_unix.sock";
 101         my $router = 'router\@elroy/router';
 102         return "exec(\"/pines/cvs/ILS/OpenSRF/src/forker/oils_inbound $service $username " .
 103                 "$password $jserver $port $hostname $unix_file $router\")";
 104 =cut
 105
 106         return "OpenSRF::Transport::Listener->new( '$app' )->initialize()->listen()";
 107 }
 108
 109
 110 # ----------------------------------------------
 111 # Boot up the system
 112
 113 sub load_bootstrap_config {
 114
 115         if(OpenSRF::Utils::Config->current) {
 116                 return;
 117         }
 118
 119         warn "Loading $bootstrap_config_file\n";
 120         if(!$bootstrap_config_file) {
 121                 die "Please provide a bootstrap config file to OpenSRF::System!\n" .
 122                         "use OpenSRF::System qw(/path/to/bootstrap_config);";
 123         }
 124
 125         OpenSRF::Utils::Config->load( config_file => $bootstrap_config_file );
 126
 127         JSON->register_class_hint( name => "OpenSRF::Application", hint => "", type => "hash" );
 128
 129         OpenSRF::Transport->message_envelope(  "OpenSRF::Transport::SlimJabber::MessageWrapper" );
 130         OpenSRF::Transport::PeerHandle->set_peer_client(  "OpenSRF::Transport::SlimJabber::PeerConnection" );
 131         OpenSRF::Transport::Listener->set_listener( "OpenSRF::Transport::SlimJabber::Inbound" );
 132 }
 133
 134 sub bootstrap {
 135
 136         my $self = __PACKAGE__->instance();
 137         load_bootstrap_config();
 138         OpenSRF::Utils::Logger::set_config();
 139         my $bsconfig = OpenSRF::Utils::Config->current;
 140
 141         # Start a process group and make me the captain
 142         setpgrp( 0, 0 );
 143         $0 = "System";
 144
 145         # -----------------------------------------------
 146         # Launch the settings sever if necessary...
 147         my $are_settings_server = 0;
 148         if( (my $cfile = $bsconfig->bootstrap->settings_config) ) {
 149                 my $parser = OpenSRF::Utils::SettingsParser->new();
 150
 151                 # since we're (probably) the settings server, we can go ahead and load the real config file
 152                 $parser->initialize( $cfile );
 153                 $OpenSRF::Utils::SettingsClient::host_config =
 154                         $parser->get_server_config($bsconfig->env->hostname);
 155
 156                 my $client = OpenSRF::Utils::SettingsClient->new();
 157                 my $apps = $client->config_value("activeapps", "appname");
 158                 if(!ref($apps) eq "ARRAY") { $apps = [$apps]; }
 159
 160                 for my $app (@$apps) {
 161                         # verify we are a settings server and launch
 162                         if( $app eq "settings" ) {
 163                                 $are_settings_server = 1;
 164                                 $self->launch_settings();
 165                                 sleep 1;
 166                                 $self->launch_settings_listener();
 167                                 last;
 168                         }
 169                 }
 170         }
 171
 172         # Launch everything else
 173         my $client = OpenSRF::Utils::SettingsClient->new();
 174         my $apps = $client->config_value("activeapps", "appname" );
 175         if(!ref($apps)) { $apps = [$apps]; }
 176         my $server_type = $client->config_value("server_type");
 177         $server_type ||= "basic";
 178
 179         my $con = OpenSRF::Transport::PeerHandle->retrieve;
 180         if($con) {
 181                 $con->disconnect;
 182         }
 183
 184
 185
 186         if(  $server_type eq "prefork" ) {
 187                 $server_type = "Net::Server::PreFork";
 188         } else {
 189                 $server_type = "Net::Server::Single";
 190         }
 191
 192         _log( " * Server type: $server_type", INTERNAL );
 193
 194         eval "use $server_type";
 195
 196         if( $@ ) {
 197                 throw OpenSRF::EX::PANIC ("Cannot set $server_type: $@" );
 198         }
 199
 200         push @OpenSRF::UnixServer::ISA, $server_type;
 201
 202         _log( " * System boostrap" );
 203
 204         # --- Boot the Unix servers
 205         $self->launch_unix($apps);
 206
 207         _sleep();
 208
 209         # --- Boot the listeners
 210         $self->launch_listener($apps);
 211
 212         _sleep();
 213
 214         _log( " * System is ready..." );
 215
 216         sleep 1;
 217         my $ps = `ps ax | grep " Open" | grep -v grep | sort -r -k5`;
 218
 219         print "\n --- PS --- \n$ps --- PS ---\n\n";
 220
 221         while( 1 ) { sleep; }
 222         exit;
 223 }
 224
 225
 226
 227 # ----------------------------------------------
 228 # Bootstraps a single client connection.
 229
 230 sub bootstrap_client {
 231         my $self = shift;
 232
 233         my %params = @_;
 234
 235         $bootstrap_config_file =
 236                 $params{config_file} || $bootstrap_config_file;
 237
 238         my $app = $params{client_name} || "client";
 239
 240
 241         load_bootstrap_config();
 242         OpenSRF::Utils::Logger::set_config();
 243         OpenSRF::Transport::PeerHandle->construct( $app );
 244
 245 }
 246
 247 sub bootstrap_logger {
 248         $0 = "Log Server";
 249         OpenSRF::Utils::LogServer->serve();
 250 }
 251
 252
 253 # ----------------------------------------------
 254 # Cycle through the known processes, reap the dead child
 255 # and put a new child in its place. (MMWWAHAHHAHAAAA!)
 256
 257 sub process_automation {
 258
 259         my $self = __PACKAGE__->instance();
 260
 261         foreach my $pid ( keys %{$self->pid_hash} ) {
 262
 263                 if( waitpid( $pid, WNOHANG ) == $pid ) {
 264
 265                         my $method = $self->pid_hash->{$pid};
 266                         delete $self->pid_hash->{$pid};
 267
 268                         my $newpid =  OpenSRF::Utils::safe_fork();
 269
 270                         OpenSRF::Utils::Logger->debug( "Relaunching $method", ERROR );
 271                         _log( "Relaunching => $method" );
 272
 273                         if( $newpid ) {
 274                                 $self->pid_hash( $newpid, $method );
 275                         }
 276                         else { eval $method; exit; }
 277                 }
 278         }
 279
 280         $SIG{CHLD} = \&process_automation;
 281 }
 282
 283
 284
 285 sub launch_settings {
 286
 287         #       XXX the $self like this and pid automation will not work with this setup....
 288         my($self) = @_;
 289         @OpenSRF::UnixServer::ISA = qw(OpenSRF Net::Server::PreFork);
 290
 291         my $pid = OpenSRF::Utils::safe_fork();
 292         if( $pid ) {
 293                 $self->pid_hash( $pid , "launch_settings()" );
 294         }
 295         else {
 296                 my $apname = "settings";
 297                 $0 = "OpenSRF App ($apname)";
 298                 eval _unixserver( "settings" );
 299                 if($@) { die "$@\n"; }
 300                 exit;
 301         }
 302
 303         @OpenSRF::UnixServer::ISA = qw(OpenSRF);
 304
 305 }
 306
 307
 308 sub launch_settings_listener {
 309
 310         my $self = shift;
 311         my $app = "settings";
 312         my $pid = OpenSRF::Utils::safe_fork();
 313         if ( $pid ) {
 314                 $self->pid_hash( $pid , _listener( $app ) );
 315         }
 316         else {
 317                 my $apname = $app;
 318                 $0 = "OpenSRF listener ($apname)";
 319                 eval _listener( $app );
 320                 exit;
 321         }
 322
 323 }
 324
 325 # ----------------------------------------------
 326 # Launch the Unix Servers
 327
 328 sub launch_unix {
 329         my( $self, $apps ) = @_;
 330
 331         foreach my $app ( @$apps ) {
 332                 next unless $app;
 333
 334                 if( $app eq "settings" ) { next; }
 335
 336                 _log( " * Starting UnixServer for $app..." );
 337
 338                 my $pid = OpenSRF::Utils::safe_fork();
 339                 if( $pid ) {
 340                         $self->pid_hash( $pid , _unixserver( $app ) );
 341                 }
 342                 else {
 343                         my $apname = $app;
 344                         $0 = "OpenSRF App ($apname)";
 345                         eval _unixserver( $app );
 346                         exit;
 347                 }
 348         }
 349 }
 350
 351 # ----------------------------------------------
 352 # Launch the inbound clients
 353
 354 sub launch_listener {
 355
 356         my( $self, $apps ) = @_;
 357
 358         foreach my $app ( @$apps ) {
 359
 360                 if( $app eq "settings" ) { next; }
 361
 362                 _log( " * Starting Listener for $app..." );
 363
 364                 my $pid = OpenSRF::Utils::safe_fork();
 365                 if ( $pid ) {
 366                         $self->pid_hash( $pid , _listener( $app ) );
 367                 }
 368                 else {
 369                         my $apname = $app;
 370                         $0 = "OpenSRF listener ($apname)";
 371                         eval _listener( $app );
 372                         exit;
 373                 }
 374         }
 375 }
 376
 377 # ----------------------------------------------
 378
 379 =head comment
 380 sub launch_shell {
 381
 382         my $self = shift;
 383
 384         my $pid = OpenSRF::Utils::safe_fork();
 385
 386         if( $pid ) { $self->pid_hash( $pid , _shell() ); }
 387         else {
 388                 $0 = "System Shell";
 389                 for( my $x = 0; $x != 10; $x++ ) {
 390                         eval _shell();
 391                         if( ! $@ ) { last; }
 392                 }
 393                 exit;
 394         }
 395 }
 396 =cut
 397
 398
 399 # ----------------------------------------------
 400
 401 sub pid_hash {
 402         my( $self, $pid, $method ) = @_;
 403         $self->{'pid_hash'}->{$pid} = $method
 404                 if( $pid and $method );
 405         return $self->{'pid_hash'};
 406 }
 407
 408 # ----------------------------------------------
 409 # If requested, the System can shut down.
 410
 411 sub killall {
 412
 413         $SIG{CHLD} = 'IGNORE';
 414         $SIG{INT} = 'IGNORE';
 415         kill( 'INT', -$$ ); #kill all in process group
 416         exit;
 417
 418 }
 419
 420 # ----------------------------------------------
 421 # Handle $SIG{HUP}
 422 sub hupall {
 423
 424         _log( "HUPping brood" );
 425         $SIG{CHLD} = 'IGNORE';
 426         $SIG{HUP} = 'IGNORE';
 427         set_config(); # reload config
 428         kill( 'HUP', -$$ );
 429 #       $SIG{CHLD} = \&process_automation;
 430         $SIG{HUP} = sub{ instance()->hupall(); };
 431 }
 432
 433
 434 # ----------------------------------------------
 435 # Log to debug, and stdout
 436
 437 sub _log {
 438         my $string = shift;
 439         OpenSRF::Utils::Logger->debug( $string, INFO );
 440         print $string . "\n";
 441 }
 442
 443 # ----------------------------------------------
 444
 445 sub _sleep {
 446         select( undef, undef, undef, 0.3 );
 447 }
 448
 449 1;
 450
 451