bin/opensrf-perl.pl

   1 #!/usr/bin/perl
   2 # ---------------------------------------------------------------
   3 # Copyright (C) 2008  Georgia Public Library Service
   4 # Bill Erickson <erickson@esilibrary.com>
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 # ---------------------------------------------------------------
  16 use strict; use warnings;
  17 use Getopt::Long;
  18 use Net::Domain qw/hostfqdn/;
  19 use POSIX qw/setsid :sys_wait_h/;
  20 use OpenSRF::Utils::Logger q/$logger/;
  21 use OpenSRF::System;
  22 use OpenSRF::Transport::PeerHandle;
  23 use OpenSRF::Utils::SettingsClient;
  24 use OpenSRF::Transport::Listener;
  25 use OpenSRF::Utils;
  26 use OpenSRF::Utils::Config;
  27
  28 my $opt_action = undef;
  29 my $opt_service = undef;
  30 my $opt_config = undef;
  31 my $opt_pid_dir = '/tmp';
  32 my $opt_no_daemon = 0;
  33 my $opt_settings_pause = 0;
  34 my $opt_help = 0;
  35 my $sclient;
  36 my $hostname = hostfqdn();
  37 my @hosted_services;
  38
  39 GetOptions(
  40     'action=s' => \$opt_action,
  41     'service=s' => \$opt_service,
  42     'config=s' => \$opt_config,
  43     'pid-dir=s' => \$opt_pid_dir,
  44     'no-daemon' => \$opt_no_daemon,
  45     'settings-startup-pause=i' => \$opt_settings_pause,
  46     'help' => \$opt_help,
  47 );
  48
  49
  50 sub haltme {
  51     kill('INT', -$$); #kill all in process group
  52     exit;
  53 };
  54 $SIG{INT} = \&haltme;
  55 $SIG{TERM} = \&haltme;
  56
  57 sub get_pid_file {
  58     my $service = shift;
  59     return "$opt_pid_dir/$service.pid";
  60 }
  61
  62 # stop a specific service
  63 sub do_stop {
  64     my $service = shift;
  65     my $pid_file = get_pid_file($service);
  66     if(-e $pid_file) {
  67         my $pid = `cat $pid_file`;
  68         kill('INT', $pid);
  69         waitpid($pid, 0);
  70         unlink $pid_file;
  71     } else {
  72         msg("$service not running");
  73     }
  74     return 1;
  75 }
  76
  77 sub do_init {
  78     OpenSRF::System->bootstrap_client(config_file => $opt_config);
  79     die "Unable to bootstrap client for requests\n"
  80         unless OpenSRF::Transport::PeerHandle->retrieve;
  81
  82     load_settings(); # load the settings config if we can
  83
  84     my $sclient = OpenSRF::Utils::SettingsClient->new;
  85     my $apps = $sclient->config_value("activeapps", "appname");
  86
  87     # disconnect the top-level network handle
  88     OpenSRF::Transport::PeerHandle->retrieve->disconnect;
  89
  90     if($apps) {
  91         $apps = [$apps] unless ref $apps;
  92         for my $app (@$apps) {
  93             push(@hosted_services, $app)
  94                 if $sclient->config_value('apps', $app, 'language') =~ /perl/i;
  95         }
  96     }
  97     return 1;
  98 }
  99
 100 # start a specific service
 101 sub do_start {
 102     my $service = shift;
 103     if(-e get_pid_file($service)) {
 104         msg("$service is already running");
 105         return;
 106     }
 107
 108     load_settings() if $service eq 'opensrf.settings';
 109
 110     my $sclient = OpenSRF::Utils::SettingsClient->new;
 111     my $apps = $sclient->config_value("activeapps", "appname");
 112     OpenSRF::Transport::PeerHandle->retrieve->disconnect;
 113
 114     if(grep { $_ eq $service } @hosted_services) {
 115         return unless do_daemon($service);
 116         launch_net_server($service);
 117         launch_listener($service);
 118         $0 = "OpenSRF controller [$service]";
 119         while(my $pid = waitpid(-1, 0)) {
 120             $logger->debug("Cleaning up Perl $service process $pid");
 121         }
 122     }
 123
 124     msg("$service is not configured to run on $hostname");
 125     return 1;
 126 }
 127
 128 sub do_start_all {
 129     if(grep {$_ eq 'opensrf.settings'} @hosted_services) {
 130         do_start('opensrf.settings');
 131         # in batch mode, give opensrf.settings plenty of time to start
 132         # before any non-Perl services try to connect
 133         sleep $opt_settings_pause if $opt_settings_pause;
 134     }
 135     for my $service (@hosted_services) {
 136         do_start($service) unless $service eq 'opensrf.settings';
 137     }
 138     return 1;
 139 }
 140
 141 sub do_stop_all {
 142     do_stop($_) for @hosted_services;
 143     return 1;
 144 }
 145
 146 # daemonize us.  return true if we're the child, false if parent
 147 sub do_daemon {
 148     return 1 if $opt_no_daemon;
 149     my $service = shift;
 150     my $pid_file = get_pid_file($service);
 151     #exit if OpenSRF::Utils::safe_fork();
 152     return 0 if OpenSRF::Utils::safe_fork();
 153     chdir('/');
 154     setsid();
 155     close STDIN;
 156     close STDOUT;
 157     close STDERR;
 158     `echo $$ > $pid_file`;
 159     return 1;
 160 }
 161
 162 # parses the local settings file
 163 sub load_settings {
 164     my $conf = OpenSRF::Utils::Config->current;
 165     my $cfile = $conf->bootstrap->settings_config;
 166     return unless $cfile;
 167     my $parser = OpenSRF::Utils::SettingsParser->new();
 168     $parser->initialize( $cfile );
 169     $OpenSRF::Utils::SettingsClient::host_config =
 170         $parser->get_server_config($conf->env->hostname);
 171 }
 172
 173 # starts up the unix::server master process
 174 sub launch_net_server {
 175     my $service = shift;
 176     push @OpenSRF::UnixServer::ISA, 'Net::Server::PreFork';
 177     unless(OpenSRF::Utils::safe_fork()) {
 178         $0 = "OpenSRF Drone [$service]";
 179         OpenSRF::UnixServer->new($service)->serve;
 180         exit;
 181     }
 182     return 1;
 183 }
 184
 185 # starts up the inbound listener process
 186 sub launch_listener {
 187     my $service = shift;
 188     unless(OpenSRF::Utils::safe_fork()) {
 189         $0 = "OpenSRF listener [$service]";
 190         OpenSRF::Transport::Listener->new($service)->initialize->listen;
 191         exit;
 192     }
 193     return 1;
 194 }
 195
 196 sub msg {
 197     my $m = shift;
 198     print "* $m\n";
 199 }
 200
 201 sub do_help {
 202     print <<HELP;
 203
 204     Usage: perl $0 --pid_dir /var/run/opensrf --config /etc/opensrf/opensrf_core.xml --service opensrf.settings --action start
 205
 206     --action <action>
 207         Actions include start, stop, restart, and start_all, stop_all, and restart_all
 208
 209     --service <service>
 210         Specifies which OpenSRF service to control
 211
 212     --config <file>
 213         OpenSRF configuration file
 214
 215     --pid-dir <dir>
 216         Directory where process-specific PID files are kept
 217
 218     --no-daemon
 219         Do not detach and run as a daemon process.  Useful for debugging.
 220
 221     --settings-startup-pause
 222         How long to give the opensrf.settings server to start up when running
 223         in batch mode (start_all).  The purpose is to give plenty of time for
 224         the settings server to be up and active before any non-Perl services
 225         attempt to connect.
 226
 227     --help
 228         Print this help message
 229 HELP
 230 exit;
 231 }
 232
 233
 234 do_help() if $opt_help or not $opt_action;
 235 do_init() and do_start($opt_service) if $opt_action eq 'start';
 236 do_stop($opt_service) if $opt_action eq 'stop';
 237 do_init() and do_stop($opt_service) and do_start($opt_service) if $opt_action eq 'restart';
 238 do_init() and do_start_all() if $opt_action eq 'start_all';
 239 do_init() and do_stop_all() if $opt_action eq 'stop_all';
 240 do_init() and do_stop_all() and do_start_all() if $opt_action eq 'restart_all';
 241
 242