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       open(LOCKFILE,">$lock_file") or die "can't open $lock_file: $!";
 142       lock_write;
 143       warn "sending response\n" if $Debug;
 144       nstore_fd($rv, $writer) or die "FATAL: can't send response: $!";
 145       $writer->flush or die "FATAL: can't flush: $!";
 146       unlock_write;
 147
 148       warn "child exiting\n" if $Debug;
 149       exit; #end-of-kid
 150     }
 151
 152   }
 153
 154   &shutdown if $shutdown;
 155   warn "connection lost, reconnecting\n" if $Debug;
 156   sleep 3;
 157
 158 }
 159
 160 ###
 161 # utility subroutines
 162 ###
 163
 164 sub reap_kids {
 165   #warn "reaping kids\n";
 166   foreach my $pid ( keys %kids ) {
 167     my $kid = waitpid($pid, WNOHANG);
 168     if ( $kid > 0 ) {
 169       $kids--;
 170       delete $kids{$kid};
 171     }
 172   }
 173   #warn "done reaping\n";
 174 }
 175
 176 sub init {
 177   my $user = shift;
 178
 179   chdir "/" or die "Can't chdir to /: $!";
 180   open STDIN, '/dev/null' or die "Can't read /dev/null: $!";
 181   defined(my $pid = fork) or die "Can't fork: $!";
 182   if ( $pid ) {
 183     print "freeside-selfservice-server to $machine started with pid $pid\n"; #logging to $log_file
 184     exit unless $pid_file;
 185     my $pidfh = new IO::File ">$pid_file" or exit;
 186     print $pidfh "$pid\n";
 187     exit;
 188   }
 189
 190 #  sub REAPER { my $pid = wait; $SIG{CHLD} = \&REAPER; $kids--; }
 191 #  #sub REAPER { my $pid = wait; $kids--; $SIG{CHLD} = \&REAPER; }
 192 #  $SIG{CHLD} =  \&REAPER;
 193
 194   $shutdown = 0;
 195   $SIG{HUP} = sub { warn "SIGHUP received; shutting down\n"; $shutdown++; };
 196   $SIG{INT} = sub { warn "SIGINT received; shutting down\n"; $shutdown++; };
 197   $SIG{TERM} = sub { warn "SIGTERM received; shutting down\n"; $shutdown++; };
 198   $SIG{QUIT} = sub { warn "SIGQUIT received; shutting down\n"; $shutdown++; };
 199   $SIG{PIPE} = sub { warn "SIGPIPE received; shutting down\n"; $shutdown++; };
 200
 201   #false laziness w/freeside-queued
 202   my $freeside_gid = scalar(getgrnam('freeside'))
 203     or die "can't setgid to freeside group\n";
 204   $) = $freeside_gid;
 205   $( = $freeside_gid;
 206   #if freebsd can't setuid(), presumably it can't setgid() either.  grr fleabsd
 207   ($(,$)) = ($),$();
 208   $) = $freeside_gid;
 209
 210   $> = $FS::UID::freeside_uid;
 211   $< = $FS::UID::freeside_uid;
 212   #freebsd is sofa king broken, won't setuid()
 213   ($<,$>) = ($>,$<);
 214   $> = $FS::UID::freeside_uid;
 215   #eslaf
 216
 217   $ENV{HOME} = (getpwuid($>))[7]; #for ssh
 218   #adminsuidsetup $user;
 219
 220   #$log_file = "/usr/local/etc/freeside/selfservice.". $FS::UID::datasrc; #MACHINE NAME
 221   $log_file = "/usr/local/etc/freeside/selfservice.$machine.log";
 222
 223   open STDOUT, '>/dev/null'
 224                             or die "Can't write to /dev/null: $!";
 225   setsid                  or die "Can't start a new session: $!";
 226   open STDERR, '>&STDOUT' or die "Can't dup stdout: $!";
 227
 228   $SIG{__DIE__} = \&_die;
 229   $SIG{__WARN__} = \&_logmsg;
 230
 231   warn "freeside-selfservice-server starting\n";
 232
 233 }
 234
 235 sub shutdown {
 236   &reap_kids;
 237   my $wait = 12; #wait up to 1 minute
 238   while ( $kids > 0 && $wait-- ) {
 239     warn "waiting for $kids children to terminate";
 240     sleep 5;
 241     &reap_kids;
 242   }
 243   warn "abandoning $kids children" if $kids;
 244   kill 'TERM', $ssh_pid if $ssh_pid;
 245   die "exiting";
 246 }
 247
 248 sub _die {
 249   my $msg = shift;
 250   unlink $pid_file if -e $pid_file;
 251   _logmsg($msg);
 252 }
 253
 254 sub _logmsg {
 255   chomp( my $msg = shift );
 256   _do_logmsg( "[server] [". scalar(localtime). "] [$$] $msg\n" );
 257 }
 258
 259 sub _do_logmsg {
 260   chomp( my $msg = shift );
 261   my $log = new IO::File ">>$log_file";
 262   flock($log, LOCK_EX);
 263   seek($log, 0, 2);
 264   print $log "$msg\n";
 265   flock($log, LOCK_UN);
 266   close $log;
 267 }
 268
 269 sub lock_write {
 270   warn "locking $lock_file mutex for write to write stream\n" if $Debug > 1;
 271
 272   #broken on freebsd?
 273   #flock($writer, LOCK_EX) or die "FATAL: can't lock write stream: $!";
 274
 275   flock(LOCKFILE, LOCK_EX) or die "FATAL: can't lock $lock_file: $!";
 276
 277 }
 278
 279 sub unlock_write {
 280   warn "unlocking $lock_file mutex\n" if $Debug > 1;
 281
 282   #broken on freebsd?
 283   #flock($writer, LOCK_UN) or die "WARNING: can't release write lock: $!";
 284
 285   flock(LOCKFILE, LOCK_UN) or die "FATAL: can't unlock $lock_file: $!";
 286
 287 }
 288
 289 sub usage {
 290   die "Usage:\n\n  freeside-selfservice-server user machine\n";
 291 }
 292