FS/bin/freeside-selfservice-server

   1 #!/usr/bin/perl -w
   2 #
   3 # freeside-selfservice-server
   4
   5 # alas, much false laziness with freeside-queued and fs_signup_server.  at
   6 # least it is slated to replace fs_{signup,passwd,mailadmin}_server
   7 # should probably generalize the version in here, or better yet use
   8 # Proc::Daemon or somesuch
   9
  10 use strict;
  11 use vars qw( $Debug %kids $kids $max_kids $shutdown $log_file $ssh_pid
  12              $keepalives );
  13 use subs qw( lock_write unlock_write );
  14 use Fcntl qw(:flock);
  15 use POSIX qw(:sys_wait_h setsid);
  16 use IO::Handle;
  17 use IO::Select;
  18 use IO::File;
  19 use Storable 2.09 qw(nstore_fd fd_retrieve);
  20 use Net::SSH qw(sshopen2);
  21 use FS::UID qw(adminsuidsetup forksuidsetup);
  22 use FS::ClientAPI;
  23
  24 use FS::Conf;
  25 use FS::cust_bill;
  26 use FS::cust_pkg;
  27
  28 $Debug = 1; # 2 will turn on more logging
  29             # 3 will log packet contents, including passwords
  30
  31 $shutdown = 0;
  32 $max_kids = '10'; #?
  33 $keepalives = 0; #let clientd turn it on, so we don't barf on old ones
  34 $kids = 0;
  35
  36 my $user = shift or die &usage;
  37 my $machine = shift or die &usage;
  38 my $tag = scalar(@ARGV) ? shift : '';
  39
  40 # $FS::UID::datasrc not posible
  41 my $pid_file = "/var/run/freeside-selfservice-server.$user.$machine.pid";
  42
  43 my $lock_file = "/usr/local/etc/freeside/selfservice.$machine.writelock";
  44 open(LOCKFILE,">$lock_file") or die "can't open $lock_file: $!";
  45
  46 &init($user);
  47
  48 my $conf = new FS::Conf;
  49
  50 my $clientd = "/usr/local/sbin/freeside-selfservice-clientd"; #better name?
  51
  52 my $warnkids=0;
  53 while (1) {
  54   my($writer,$reader,$error) = (new IO::Handle, new IO::Handle, new IO::Handle);
  55   warn "connecting to $machine\n" if $Debug;
  56
  57   $ssh_pid = sshopen2($machine,$reader,$writer,$clientd,$tag);
  58
  59 #  nstore_fd(\*writer, {'hi'=>'there'});
  60
  61   warn "entering main loop\n" if $Debug;
  62   my $undisp = 0;
  63   my $keepalive_count = 0;
  64   my $s = IO::Select->new( $reader );
  65   while (1) {
  66
  67     &reap_kids;
  68
  69     warn "waiting for packet from client\n" if $Debug && !$undisp;
  70     $undisp = 1;
  71     my @handles = $s->can_read(5);
  72     unless ( @handles ) {
  73       &shutdown if $shutdown;
  74       if ( $keepalives && $keepalive_count++ > 10 ) {
  75         $keepalive_count = 0;
  76         lock_write;
  77         nstore_fd( { _token => '_keepalive' }, $writer );
  78         unlock_write;
  79       }
  80       next;
  81     }
  82
  83     $undisp = 0;
  84
  85     warn "receiving packet from client\n" if $Debug;
  86
  87     my $packet = eval { fd_retrieve($reader); };
  88     if ( $@ ) {
  89       warn "Storable error receiving packet from client".
  90            " (assuming lost connection): $@\n"
  91         if $Debug;
  92       if ( $ssh_pid ) {
  93         warn "sending TERM signal to ssh process $ssh_pid\n" if $Debug;
  94         kill 'TERM', $ssh_pid;
  95         $ssh_pid = 0;
  96       }
  97       last;
  98     }
  99     warn "packet received\n".
 100          join('', map { " $_=>$packet->{$_}\n" } keys %$packet )
 101       if $Debug > 2;
 102
 103     if ( $packet->{_packet} eq '_enable_keepalive' ) {
 104       warn "enabling keep alives\n" if $Debug;
 105       $keepalives=1;
 106       next;
 107     }
 108
 109     #prevent runaway forking
 110     my $warnkids = 0;
 111     while ( $kids >= $max_kids ) {
 112       warn "WARNING: maximum $kids children reached\n" unless $warnkids++;
 113       &reap_kids;
 114       sleep 1;
 115     }
 116
 117     warn "forking child\n" if $Debug;
 118     defined( my $pid = fork ) or die "can't fork: $!";
 119     if ( $pid ) {
 120       $kids++;
 121       $kids{$pid} = 1;
 122       warn "child $pid spawned\n" if $Debug;
 123     } else { #kid time
 124
 125       ##get new db handle
 126       #$FS::UID::dbh->{InactiveDestroy} = 1;
 127       #forksuidsetup($user);
 128
 129       #get db handle
 130       adminsuidsetup($user);
 131
 132       my $type = $packet->{_packet};
 133       warn "calling $type handler\n" if $Debug;
 134       my $rv = eval { FS::ClientAPI->dispatch($type, $packet); };
 135       if ( $@ ) {
 136         warn my $error = "WARNING: error dispatching $type: $@";
 137         $rv = { _error => $error };
 138       }
 139       $rv->{_token} = $packet->{_token}; #identifier
 140
 141       lock_write;
 142       warn "sending response\n" if $Debug;
 143       nstore_fd($rv, $writer) or die "FATAL: can't send response: $!";
 144       $writer->flush or die "FATAL: can't flush: $!";
 145       unlock_write;
 146
 147       warn "child exiting\n" if $Debug;
 148       exit; #end-of-kid
 149     }
 150
 151   }
 152
 153   &shutdown if $shutdown;
 154   warn "connection lost, reconnecting\n" if $Debug;
 155   sleep 3;
 156
 157 }
 158
 159 ###
 160 # utility subroutines
 161 ###
 162
 163 sub reap_kids {
 164   #warn "reaping kids\n";
 165   foreach my $pid ( keys %kids ) {
 166     my $kid = waitpid($pid, WNOHANG);
 167     if ( $kid > 0 ) {
 168       $kids--;
 169       delete $kids{$kid};
 170     }
 171   }
 172   #warn "done reaping\n";
 173 }
 174
 175 sub init {
 176   my $user = shift;
 177
 178   chdir "/" or die "Can't chdir to /: $!";
 179   open STDIN, '/dev/null' or die "Can't read /dev/null: $!";
 180   defined(my $pid = fork) or die "Can't fork: $!";
 181   if ( $pid ) {
 182     print "freeside-selfservice-server to $machine started with pid $pid\n"; #logging to $log_file
 183     exit unless $pid_file;
 184     my $pidfh = new IO::File ">$pid_file" or exit;
 185     print $pidfh "$pid\n";
 186     exit;
 187   }
 188
 189 #  sub REAPER { my $pid = wait; $SIG{CHLD} = \&REAPER; $kids--; }
 190 #  #sub REAPER { my $pid = wait; $kids--; $SIG{CHLD} = \&REAPER; }
 191 #  $SIG{CHLD} =  \&REAPER;
 192
 193   $shutdown = 0;
 194   $SIG{HUP} = sub { warn "SIGHUP received; shutting down\n"; $shutdown++; };
 195   $SIG{INT} = sub { warn "SIGINT received; shutting down\n"; $shutdown++; };
 196   $SIG{TERM} = sub { warn "SIGTERM received; shutting down\n"; $shutdown++; };
 197   $SIG{QUIT} = sub { warn "SIGQUIT received; shutting down\n"; $shutdown++; };
 198   $SIG{PIPE} = sub { warn "SIGPIPE received; shutting down\n"; $shutdown++; };
 199
 200   #false laziness w/freeside-queued
 201   my $freeside_gid = scalar(getgrnam('freeside'))
 202     or die "can't setgid to freeside group\n";
 203   $) = $freeside_gid;
 204   $( = $freeside_gid;
 205   #if freebsd can't setuid(), presumably it can't setgid() either.  grr fleabsd
 206   ($(,$)) = ($),$();
 207   $) = $freeside_gid;
 208
 209   $> = $FS::UID::freeside_uid;
 210   $< = $FS::UID::freeside_uid;
 211   #freebsd is sofa king broken, won't setuid()
 212   ($<,$>) = ($>,$<);
 213   $> = $FS::UID::freeside_uid;
 214   #eslaf
 215
 216   $ENV{HOME} = (getpwuid($>))[7]; #for ssh
 217   #adminsuidsetup $user;
 218
 219   #$log_file = "/usr/local/etc/freeside/selfservice.". $FS::UID::datasrc; #MACHINE NAME
 220   $log_file = "/usr/local/etc/freeside/selfservice.$machine.log";
 221
 222   open STDOUT, '>/dev/null'
 223                             or die "Can't write to /dev/null: $!";
 224   setsid                  or die "Can't start a new session: $!";
 225   open STDERR, '>&STDOUT' or die "Can't dup stdout: $!";
 226
 227   $SIG{__DIE__} = \&_die;
 228   $SIG{__WARN__} = \&_logmsg;
 229
 230   warn "freeside-selfservice-server starting\n";
 231
 232 }
 233
 234 sub shutdown {
 235   &reap_kids;
 236   my $wait = 12; #wait up to 1 minute
 237   while ( $kids > 0 && $wait-- ) {
 238     warn "waiting for $kids children to terminate";
 239     sleep 5;
 240     &reap_kids;
 241   }
 242   warn "abandoning $kids children" if $kids;
 243   kill 'TERM', $ssh_pid if $ssh_pid;
 244   die "exiting";
 245 }
 246
 247 sub _die {
 248   my $msg = shift;
 249   unlink $pid_file if -e $pid_file;
 250   _logmsg($msg);
 251 }
 252
 253 sub _logmsg {
 254   chomp( my $msg = shift );
 255   _do_logmsg( "[server] [". scalar(localtime). "] [$$] $msg\n" );
 256 }
 257
 258 sub _do_logmsg {
 259   chomp( my $msg = shift );
 260   my $log = new IO::File ">>$log_file";
 261   flock($log, LOCK_EX);
 262   seek($log, 0, 2);
 263   print $log "$msg\n";
 264   flock($log, LOCK_UN);
 265   close $log;
 266 }
 267
 268 sub lock_write {
 269   warn "locking $lock_file mutex for write to write stream\n" if $Debug > 1;
 270
 271   #broken on freebsd?
 272   #flock($writer, LOCK_EX) or die "FATAL: can't lock write stream: $!";
 273
 274   flock(LOCKFILE, LOCK_EX) or die "FATAL: can't lock $lock_file: $!";
 275
 276 }
 277
 278 sub unlock_write {
 279   warn "unlocking $lock_file mutex\n" if $Debug > 1;
 280
 281   #broken on freebsd?
 282   #flock($writer, LOCK_UN) or die "WARNING: can't release write lock: $!";
 283
 284   flock(LOCKFILE, LOCK_UN) or die "FATAL: can't unlock $lock_file: $!";
 285
 286 }
 287
 288 sub usage {
 289   die "Usage:\n\n  freeside-selfservice-server user machine\n";
 290 }
 291