*** empty log message ***
[freeside.git] / 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
45 &init($user);
46
47 my $conf = new FS::Conf;
48
49 my $clientd = "/usr/local/sbin/freeside-selfservice-clientd"; #better name?
50
51 my $warnkids=0;
52 while (1) {
53   my($writer,$reader,$error) = (new IO::Handle, new IO::Handle, new IO::Handle);
54   warn "connecting to $machine\n" if $Debug;
55
56   $ssh_pid = sshopen2($machine,$reader,$writer,$clientd,$tag);
57
58 #  nstore_fd(\*writer, {'hi'=>'there'});
59
60   warn "entering main loop\n" if $Debug;
61   my $undisp = 0;
62   my $keepalive_count = 0;
63   my $s = IO::Select->new( $reader );
64   while (1) {
65
66     &reap_kids;
67
68     warn "waiting for packet from client\n" if $Debug && !$undisp;
69     $undisp = 1;
70     my @handles = $s->can_read(5);
71     unless ( @handles ) {
72       &shutdown if $shutdown;
73       if ( $keepalives && $keepalive_count++ > 10 ) {
74         $keepalive_count = 0;
75         lock_write;
76         nstore_fd( { _token => '_keepalive' }, $writer );
77         unlock_write;
78       }
79       next;
80     }
81
82     $undisp = 0;
83
84     warn "receiving packet from client\n" if $Debug;
85
86     my $packet = eval { fd_retrieve($reader); };
87     if ( $@ ) {
88       warn "Storable error receiving packet from client".
89            " (assuming lost connection): $@\n"
90         if $Debug;
91       if ( $ssh_pid ) {
92         warn "sending TERM signal to ssh process $ssh_pid\n" if $Debug;
93         kill 'TERM', $ssh_pid;
94         $ssh_pid = 0;
95       }
96       last;
97     }
98     warn "packet received\n".
99          join('', map { " $_=>$packet->{$_}\n" } keys %$packet )
100       if $Debug > 2;
101
102     if ( $packet->{_packet} eq '_enable_keepalive' ) {
103       warn "enabling keep alives\n" if $Debug;
104       $keepalives=1;
105       next;
106     }
107
108     #prevent runaway forking
109     my $warnkids = 0;
110     while ( $kids >= $max_kids ) {
111       warn "WARNING: maximum $kids children reached\n" unless $warnkids++;
112       &reap_kids;
113       sleep 1;
114     }
115
116     warn "forking child\n" if $Debug;
117     defined( my $pid = fork ) or die "can't fork: $!";
118     if ( $pid ) {
119       $kids++;
120       $kids{$pid} = 1;
121       warn "child $pid spawned\n" if $Debug;
122     } else { #kid time
123
124       ##get new db handle
125       #$FS::UID::dbh->{InactiveDestroy} = 1;
126       #forksuidsetup($user);
127
128       #get db handle
129       adminsuidsetup($user);
130
131       my $type = $packet->{_packet};
132       warn "calling $type handler\n" if $Debug; 
133       my $rv = eval { FS::ClientAPI->dispatch($type, $packet); };
134       if ( $@ ) {
135         warn my $error = "WARNING: error dispatching $type: $@";
136         $rv = { _error => $error };
137       }
138       $rv->{_token} = $packet->{_token}; #identifier
139
140       open(LOCKFILE,">$lock_file") or die "can't open $lock_file: $!";
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
204   open(LOCKFILE,">$lock_file") or die "can't open $lock_file: $!";
205   chown $FS::UID::freeside_uid, $freeside_gid, $lock_file;
206
207   $) = $freeside_gid;
208   $( = $freeside_gid;
209   #if freebsd can't setuid(), presumably it can't setgid() either.  grr fleabsd
210   ($(,$)) = ($),$();
211   $) = $freeside_gid;
212
213   $> = $FS::UID::freeside_uid;
214   $< = $FS::UID::freeside_uid;
215   #freebsd is sofa king broken, won't setuid()
216   ($<,$>) = ($>,$<);
217   $> = $FS::UID::freeside_uid;
218   #eslaf
219
220   $ENV{HOME} = (getpwuid($>))[7]; #for ssh
221   #adminsuidsetup $user;
222
223   #$log_file = "/usr/local/etc/freeside/selfservice.". $FS::UID::datasrc; #MACHINE NAME
224   $log_file = "/usr/local/etc/freeside/selfservice.$machine.log";
225
226   open STDOUT, '>/dev/null'
227                             or die "Can't write to /dev/null: $!";
228   setsid                  or die "Can't start a new session: $!";
229   open STDERR, '>&STDOUT' or die "Can't dup stdout: $!";
230
231   $SIG{__DIE__} = \&_die;
232   $SIG{__WARN__} = \&_logmsg;
233
234   warn "freeside-selfservice-server starting\n";
235
236 }
237
238 sub shutdown {
239   &reap_kids;
240   my $wait = 12; #wait up to 1 minute
241   while ( $kids > 0 && $wait-- ) {
242     warn "waiting for $kids children to terminate";
243     sleep 5;
244     &reap_kids;
245   }
246   warn "abandoning $kids children" if $kids;
247   kill 'TERM', $ssh_pid if $ssh_pid;
248   die "exiting";
249 }
250
251 sub _die {
252   my $msg = shift;
253   unlink $pid_file if -e $pid_file;
254   _logmsg($msg);
255 }
256
257 sub _logmsg {
258   chomp( my $msg = shift );
259   _do_logmsg( "[server] [". scalar(localtime). "] [$$] $msg\n" );
260 }
261
262 sub _do_logmsg {
263   chomp( my $msg = shift );
264   my $log = new IO::File ">>$log_file";
265   flock($log, LOCK_EX);
266   seek($log, 0, 2);
267   print $log "$msg\n";
268   flock($log, LOCK_UN);
269   close $log;
270 }
271
272 sub lock_write {
273   warn "locking $lock_file mutex for write to write stream\n" if $Debug > 1;
274
275   #broken on freebsd?
276   #flock($writer, LOCK_EX) or die "FATAL: can't lock write stream: $!";
277
278   flock(LOCKFILE, LOCK_EX) or die "FATAL: can't lock $lock_file: $!";
279
280 }
281
282 sub unlock_write {
283   warn "unlocking $lock_file mutex\n" if $Debug > 1;
284
285   #broken on freebsd?
286   #flock($writer, LOCK_UN) or die "WARNING: can't release write lock: $!";
287
288   flock(LOCKFILE, LOCK_UN) or die "FATAL: can't unlock $lock_file: $!";
289
290 }
291
292 sub usage {
293   die "Usage:\n\n  freeside-selfservice-server user machine\n";
294 }
295